captive-api 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 610b0277d1e8fa73791417902e5da68398a888944d4eddec9962b203432fa7a0
-  data.tar.gz: 701f6b9b8905044fc77ade30868f4ac37203ee181d71360df6b87bbd269caa95
+  metadata.gz: ab12a1c792bf550f36961f83688c299f75a9d6bc1153ef850aa5448be4283ec0
+  data.tar.gz: 72a79ff779a827484909877dc99b678a92315e35cd720b71950b34ffeb454780
 SHA512:
-  metadata.gz: 2582ca1e4bc6f2b6353348c352c62958ddbfb43f22f994788ad5bcf3a6efa4f4922956cdaf14c6dd46bd2c2b3396b2dd90da3e7feb5fe8d1550aa336edfe87e7
-  data.tar.gz: 4bf48698d424366d310d97210bb2263d715a4d1257b92b21dcd041c8818848c22e14f9518bcca641a16081bc20d4667307d59dd1226a9ba79c1efd4abb854699
+  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/app/controllers/concerns/api/render_error_concern.rb

@@ -8,6 +8,7 @@ module Api
 
     included do
       rescue_from ActiveRecord::RecordNotFound, with: :not_found
+      rescue_from ActionController::ParameterMissing, with: :handle_parameter_missing
 
       rescue_from CanCan::AccessDenied do |exception|
         render_error_from_exception(exception, status: :forbidden)
@@ -23,7 +24,7 @@ module Api
         errors = object.errors.messages
         Rails.logger.error("Impossible de sauvagarder l'objet #{object.class} : #{errors}")
         render_error(
-          message: message, errors: errors, status: :unprocessable_entity
+          message: message, errors: errors, status: status
         )
       end
 
@@ -33,6 +34,10 @@ module Api
         )
       end
 
+      def handle_parameter_missing(exception)
+        render_error_from_exception(exception, status: :bad_request)
+      end
+
       def not_found(exception)
         render_error(message: "#{exception.model} not found", status: :not_found)
       end

data/lib/captive/api/version.rb

@@ -1,5 +1,5 @@
 module Captive
   module Api
-    VERSION = "1.1.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.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Captive
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,7 +64,6 @@ homepage: https://www.captive.fr/
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
   homepage_uri: https://www.captive.fr/
   source_code_uri: https://github.com/Captive-Studio/captive-api
 post_install_message: