v.0.2.4

apidoc/api_project.js

@@ -1 +1,24 @@
-define({  "name": "bibleAPI",  "version": "0.2.0",  "description": "A RESTful API for Bible",  "title": "bibleAPI",  "url": "https://bibleapi.co/",  "header": {    "title": "bibleAPI",    "index": "Home",    "indexHref": "https://bibleapi.co"  },  "template": {    "forceLanguage": "en"  },  "sampleUrl": false,  "defaultVersion": "0.0.0",  "apidoc": "0.3.0",  "generator": {    "name": "apidoc",    "time": "2018-12-08T23:25:23.298Z",    "url": "http://apidocjs.com",    "version": "0.17.6"  }});
+define({
+  "name": "bibleAPI",
+  "version": "0.2.0",
+  "description": "A RESTful API for Bible",
+  "title": "bibleAPI",
+  "url": "https://bibleapi.co/",
+  "header": {
+    "title": "bibleAPI",
+    "index": "Home",
+    "indexHref": "https://bibleapi.co"
+  },
+  "template": {
+    "forceLanguage": "en"
+  },
+  "sampleUrl": false,
+  "defaultVersion": "0.0.0",
+  "apidoc": "0.3.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2019-01-15T11:06:53.593Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.6"
+  }
+});

apidoc/api_project.json

@@ -1 +1,24 @@
-{  "name": "bibleAPI",  "version": "0.2.0",  "description": "A RESTful API for Bible",  "title": "bibleAPI",  "url": "https://bibleapi.co/",  "header": {    "title": "bibleAPI",    "index": "Home",    "indexHref": "https://bibleapi.co"  },  "template": {    "forceLanguage": "en"  },  "sampleUrl": false,  "defaultVersion": "0.0.0",  "apidoc": "0.3.0",  "generator": {    "name": "apidoc",    "time": "2018-12-08T23:25:23.298Z",    "url": "http://apidocjs.com",    "version": "0.17.6"  }}
+{
+  "name": "bibleAPI",
+  "version": "0.2.0",
+  "description": "A RESTful API for Bible",
+  "title": "bibleAPI",
+  "url": "https://bibleapi.co/",
+  "header": {
+    "title": "bibleAPI",
+    "index": "Home",
+    "indexHref": "https://bibleapi.co"
+  },
+  "template": {
+    "forceLanguage": "en"
+  },
+  "sampleUrl": false,
+  "defaultVersion": "0.0.0",
+  "apidoc": "0.3.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2019-01-15T11:06:53.593Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.6"
+  }
+}

app/Controllers/Http/RequestController.js

@@ -39,7 +39,7 @@ class RequestController {
    *      "date": "2018-12-08T22:16:52.000Z"
    *    }]
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    *
    * @apiErrorExample {text} Error-Response:
    *    HTTP/1.1 429 Too Many Requests
@@ -82,7 +82,7 @@ class RequestController {
    *      "count": "3",
    *    }]
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    *
    * @apiErrorExample {text} Error-Response:
    *    HTTP/1.1 429 Too Many Requests

app/Controllers/Http/SearchController.js

@@ -45,7 +45,7 @@ class SearchController {
    *      "text": "No princípio Deus criou os céus e a terra."
    *    }
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    * @apiError VerseNotFound When the verse was not found
    *
    * @apiErrorExample {text} Error-Response:
@@ -162,7 +162,7 @@ class SearchController {
     ]
 }
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    * @apiError VerseNotFound When the verse was not found
    *
    * @apiErrorExample {text} Error-Response:
@@ -273,7 +273,7 @@ class SearchController {
     ...
 ]
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    *
    * @apiErrorExample {text} Error-Response:
    *    HTTP/1.1 429 Too Many Requests
@@ -315,13 +315,14 @@ class SearchController {
     {
         "abbrev": "gn",
         "author": "Moisés",
+        "comment": "Uma vez que este livro anônimo integra o Pentateuco unificado",
         "chapters": 50,
         "group": "Pentateuco",
         "name": "Gênesis",
         "testament": "VT"
     }
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    * @apiError VerseNotFound When the verse was not found
    *
    * @apiErrorExample {text} Error-Response:
@@ -346,6 +347,7 @@ class SearchController {
           abbrev: book.abbrev,
           author: book.author,
           chapters: book.chapters,
+          comment: book.comment,
           group: book.group,
           name: book.name,
           testament: book.testament
@@ -395,7 +397,7 @@ class SearchController {
         ]
     }
    *
-   * @apiError TooManyRequests When performing more than 3 requests at the same endpoint in an interval less than 5 minutes
+   * @apiError TooManyRequests When performing more than 50 requests at the same endpoint in an interval less than 5 minutes
    * @apiError VerseNotFound When the verse was not found
    * @apiError BadRequest When the required parameters are not sent
    *

database/migrations/1532136697805_book_schema.js

@@ -8,7 +8,7 @@ class BookSchema extends Schema {
       table.increments()
       table.integer('chapters').notNullable()
       table.string('abbrev').notNullable()
-      table.string('comment').notNullable()
+      table.text('comment').notNullable()
       table.string('group').notNullable()
       table.string('testament').notNullable()
       table.string('name').notNullable()

package.json

@@ -8,7 +8,7 @@
     "node": "10.7.0"
   },
   "scripts": {
-    "build": "webpack --mode production",
+    "build": "webpack --mode production && ENV_SILENT=true node ace migration:run --force",
     "doc": "apidoc -i app/ -o apidoc/ -t ../apidoc-bs3-template/template",
     "migrations": "adonis migration:reset && adonis migration:run && adonis seed --files='Seeder.js'",
     "prestart": "yarn build",

resources/locales/en/general.json

@@ -1,5 +1,5 @@
 {
-  "description": "RESTful API with multiple versions of the Holy Bible in more than 10 languages",
+  "description": "Bible API - RESTful API with multiple versions of the Holy Bible in more than 10 languages",
   "english": "English",
   "portuguese": "Portuguese",
   "statusPage": "Status page",

resources/locales/pt/general.json

@@ -1,5 +1,5 @@
 {
-  "description": "API REST com múltiplas versões da Bíblia Sagrada em mais de 10 idiomas",
+  "description": "Bíblia API - API REST com múltiplas versões da Bíblia Sagrada em mais de 10 idiomas",
   "english": "Inglês",
   "portuguese": "Português",
   "statusPage": "Página de status",

start/routes.js

@@ -15,39 +15,39 @@ Route.post('api/users', 'UserController.create')
 Route.post('api/sessions', 'SessionController.create')
 
 Route.get('api/requests/count/:period?', 'RequestController.count').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get('api/requests/:period?', 'RequestController.show').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get('api/requests/month', 'RequestController.month').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get('api/requests/week', 'RequestController.week').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get('api/books/', 'SearchController.getBooks').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get('api/books/:book', 'SearchController.getBook').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )
 
 Route.get(
   'api/verses/:version/:book/:chapter',
   'SearchController.getChapter'
-).middleware('throttle:3:300')
+).middleware('throttle:50:300')
 
 Route.get(
   'api/verses/:version/:book/:chapter/:number',
   'SearchController.getVerse'
-).middleware('throttle:3:300')
+).middleware('throttle:50:300')
 
 Route.post('api/search/', 'SearchController.search').middleware(
-  'throttle:3:300'
+  'throttle:50:300'
 )