captive-api 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72b812dfba5731acc69f880513c4d445b6cc116ba1414769b7b2a80fe2ff059
-  data.tar.gz: 54aa16d8fef4481576db2a1b516370425028daeafdfba386ff39d59b76a554b2
+  metadata.gz: ab12a1c792bf550f36961f83688c299f75a9d6bc1153ef850aa5448be4283ec0
+  data.tar.gz: 72a79ff779a827484909877dc99b678a92315e35cd720b71950b34ffeb454780
 SHA512:
-  metadata.gz: c6ce7a15f9fe66265869f616b720d99b8adb4b2a4050db0a8cc86e61f8c8ab44dfa5de70d201a9dbac589b8f399ad909667bf605ac210347b331474253fa728b
-  data.tar.gz: e901f2a5e2e65a91f4f5602dd8528db230d73af5bc757eeb992c2bd7b2243c3136b56485d0f790656bf1433adb5f9342a50bbfe152c80fd328d1eab6aac65713
+  metadata.gz: 78a473ad837f0851c115b3868bf031d70dfec945f643d43348bd8de26fd04a8154e41bf8dd9cc9209cdd61c39807374851f0096da100c6d6e9f76b3b43edae3c
+  data.tar.gz: 20e6fd708d8f5fa147588553eaec6b8049e5dae6bd58e614a8da2acb2fc3f60a74228647a9ea89d186de2a74f289de08e735928e5cd3a74513162f1df30f598a

data/README.md

@@ -27,6 +27,31 @@ The class `Captive::Api::ApplicationController` includes 2 concerns :
 | [pagination](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/pagination_concern.rb) | Logique de pagination pour les index |
 | [render error](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/render_error_concern.rb) | Attrape certaines erreurs pour retourner une page d'erreur en json. Permet aussi d'utiliser les méthodes pour rendre des pages d'erreur json manuellement |
 
+### PaginationConcern
+
+#### `#pagination`
+
+You can use the pagination method like this : 
+
+```ruby
+@tenues = @tenues.page(pagination[:page])
+                 .per(pagination[:per_page])
+```
+
+*The method `page` and `per` come from [will_paginate](https://github.com/mislav/will_paginate)*
+
+The pagination method return an hash like this : 
+
+```ruby
+{ page: 1, per_page: 10 }
+```
+
+⚠️ The first page is `1` and not `0` !
+
+### RenderErrorConcern
+
+TODO
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/controllers/concerns/api/pagination_concern.rb

@@ -15,10 +15,12 @@ module Api
       DEFAULT_NB_ITEMS_PAR_PAGE = 10
 
       def pagination
-        par_page = (params[:per_page] || DEFAULT_NB_ITEMS_PAR_PAGE).to_i
-        par_page = MAX_ITEMS_PAR_PAGE if par_page > MAX_ITEMS_PAR_PAGE
-        page = (params[:page] || 1).to_i
-        @pagination ||= { page: page, per_page: par_page }
+        @pagination ||= begin
+          par_page = (params[:per_page] || DEFAULT_NB_ITEMS_PAR_PAGE).to_i
+          par_page = MAX_ITEMS_PAR_PAGE if par_page > MAX_ITEMS_PAR_PAGE
+          page = (params[:page] || 1).to_i
+          { page: page, per_page: par_page }
+        end
       end
     end
   end

data/lib/captive/api/version.rb

@@ -1,5 +1,5 @@
 module Captive
   module Api
-    VERSION = "1.2.0".freeze
+    VERSION = "1.2.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: captive-api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Captive