captive-api 0.2.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8c01528873d2980a29f6cfd4308c74703935baea3f6a87dc663262bb04e180
-  data.tar.gz: e6227c5524d603405bb70b9c911cc4354f229978002e275c404e54bd391eed31
+  metadata.gz: aa071cf3e2b74fa646d99645daa968329f02a82df71344a1dc8bf6f0959b7cab
+  data.tar.gz: 8dec67a5234fcacdcf177922403bffa3dc3ed71b61ff66c49e0013eab5516294
 SHA512:
-  metadata.gz: 12710c8b7c1ff65e017d03de9ddca94114b7da4d542982677087d044f0cca448e8b7c01f4557feff2c3ac72fcfa2d8f45ec03addb6cc195394ce2933bf163712
-  data.tar.gz: 4fe3637d1243ce48ed55289f707401ecaa0ca192970d3279fbc0948db013e8c140df1136b093f24d4c2787911fbe986d4968f08a0d000d878a501af3ebbad8c9
+  metadata.gz: a35b99b5b24cca392656620b2cb1f3df13e678f00639a9688ddbf43864ddadfcc8cd7bba7bc3c8acac19b44aee89533923f6eff3efd4e382afda746110f6234c
+  data.tar.gz: 7a878b264965496688cc8916f644ab1dfa52ff5ad84e11ce06f77f68fd57cc2da5436ba61d11c8f8b3a93c812f94a2d5096e80fc5227dda75d0b51c3d9b779e1

data/README.md

@@ -1,60 +1,22 @@
-# Captive::API
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Gem Version](https://img.shields.io/gem/v/captive-api.svg)](https://rubygems.org/gems/captive-api)
-
-Code commun des API de Captive
+# Captive::Api
+Short description and motivation.
 
 ## Usage
-
 How to use my plugin.
 
 Implementation :
 
 ```ruby
-module API
+module Api
   module V1
-    class BaseController < Captive::API::ApplicationController
+    class BaseController < Captive::Api::ApplicationController
       ...
     end
   end
 end
 ```
 
-The class `Captive::API::ApplicationController` includes 2 concerns :
-
-| Nom du concern |  Description  |
-|:-----|:--------:|
-| [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: 20 }
-```
-
-⚠️ The first page is `1` and not `0` !
-
-### RenderErrorConcern
-
-TODO
-
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -62,21 +24,17 @@ gem "captive-api"
 ```
 
 And then execute:
-
 ```bash
-bundle
+$ bundle
 ```
 
 Or install it yourself as:
-
 ```bash
-gem install captive-api
+$ gem install captive-api
 ```
 
 ## Contributing
-
 Contribution directions go here.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +1,8 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-require "rubocop/rake_task"
+load "rails/tasks/statistics.rake"
 
-RuboCop::RakeTask.new
-
-task default: %i(spec rubocop)
+require "bundler/gem_tasks"

data/app/controllers/captive/api/application_controller.rb

@@ -1,8 +1,8 @@
 module Captive
-  module API
+  module Api
     class ApplicationController < ActionController::API
-      include ::API::PaginationConcern
-      include ::API::RenderErrorConcern
+      include ::Api::PaginationConcern
+      include ::Api::RenderErrorConcern
     end
   end
 end

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

@@ -1,27 +1,18 @@
 # frozen_string_literal: true
 
-module API
-  ##
-  # Défini le nombre max d'items par page à 100
-  # `MAX_ITEMS_PAR_PAGE = 100`
-  #
-  # Défini le nombre par défaut d'items par page à 20
-  # DEFAULT_NB_ITEMS_PAR_PAGE = 20
+module Api
   module PaginationConcern
     extend ActiveSupport::Concern
 
-    included do |base|
-      base.const_set :MAX_ITEMS_PAR_PAGE, 100
-      base.const_set :DEFAULT_NB_ITEMS_PAR_PAGE, 20
+    included do
+      MAX_ITEMS_PAR_PAGE = 100
+      DEFAULT_NB_ITEMS_PAR_PAGE = 10
 
       def pagination
-        @pagination ||=
-          begin
-            par_page = (params[:per_page] || self.class::DEFAULT_NB_ITEMS_PAR_PAGE).to_i
-            par_page = self.class::MAX_ITEMS_PAR_PAGE if par_page > self.class::MAX_ITEMS_PAR_PAGE
-            page = (params[:page] || 1).to_i
-            { page: page, per_page: par_page }
-          end
+        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 }
       end
     end
   end

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

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-module API
-  ##
-  # Permet de catcher des erreurs pour rendre une page d'erreur en json
+module Api
   module RenderErrorConcern
     extend ActiveSupport::Concern
 
     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)
       end
@@ -19,12 +15,12 @@ module API
       def render_error_from_object(
         object,
         status: :unprocessable_entity,
-        message: "Erreur de validation"
+        message: 'Erreur de validation'
       )
         errors = object.errors.messages
-        Rails.logger.error("Impossible de sauvegarder l'objet #{object.class} : #{errors}")
+        Rails.logger.error("Impossible de sauvagarder l'objet #{object.class} : #{errors}")
         render_error(
-          message: message, errors: errors, status: status
+          message: message, errors: errors, status: :unprocessable_entity
         )
       end
 
@@ -34,12 +30,8 @@ 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)
+      def not_found
+        render_error(message: 'Erreur not found', status: :not_found)
       end
 
       def render_error(message:, status:, errors: [], code: nil)

data/app/jobs/captive/api/application_job.rb

@@ -1,5 +1,5 @@
 module Captive
-  module API
+  module Api
     class ApplicationJob < ActiveJob::Base
     end
   end

data/app/mailers/captive/api/application_mailer.rb

@@ -1,5 +1,5 @@
 module Captive
-  module API
+  module Api
     class ApplicationMailer < ActionMailer::Base
       default from: "from@example.com"
       layout "mailer"

data/app/models/captive/api/application_record.rb

@@ -1,5 +1,5 @@
 module Captive
-  module API
+  module Api
     class ApplicationRecord < ActiveRecord::Base
       self.abstract_class = true
     end

data/config/routes.rb

@@ -1,2 +1,2 @@
-Captive::API::Engine.routes.draw do
+Captive::Api::Engine.routes.draw do
 end

data/lib/captive/api/engine.rb

@@ -1,7 +1,7 @@
 module Captive
-  module API
+  module Api
     class Engine < ::Rails::Engine
-      isolate_namespace Captive::API
+      isolate_namespace Captive::Api
       config.generators.api_only = true
     end
   end

data/lib/captive/api/version.rb

@@ -0,0 +1,5 @@
+module Captive
+  module Api
+    VERSION = "1.0.0"
+  end
+end

data/lib/captive/api.rb

@@ -1,7 +1,8 @@
+require "captive/api/version"
 require "captive/api/engine"
 
 module Captive
-  module API
+  module Api
     # Your code goes here...
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captive-api
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 1.0.0
 platform: ruby
 authors:
-- Captive
 - Clément Prod'homme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.15.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.15.0
 description: Code commun des API de Captive
 email:
 - clement.prod-homme@captive.fr
@@ -69,17 +54,18 @@ files:
 - app/jobs/captive/api/application_job.rb
 - app/mailers/captive/api/application_mailer.rb
 - app/models/captive/api/application_record.rb
-- config/initializers/oj.rb
 - config/routes.rb
 - lib/captive/api.rb
 - lib/captive/api/engine.rb
+- lib/captive/api/version.rb
 - lib/tasks/captive/api_tasks.rake
 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-sdk/tree/v0.2.12/captive-api
+  source_code_uri: https://github.com/Captive-Studio/captive-api
 post_install_message: 
 rdoc_options: []
 require_paths:

data/config/initializers/oj.rb

@@ -1 +0,0 @@
-Oj.optimize_rails