captive-api 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42ffdc7324be81460128d7033133e99a75d8464ef5810e7b5384faf18e2a9193
+  data.tar.gz: ea16ae814ef611ce847a77485631ffe2e9fcf3bb1e31952ec8ce6624d4763b63
+SHA512:
+  metadata.gz: a482588e1e93b8951cfd4c4551fb7b41af85f285ae9f0ef0c98e284a83c714db5f67b38370f2f4859e45914ba64c9fcf7d2130bef6c69146a969e382b836fc9a
+  data.tar.gz: 773a3091d79e141838d561ddb414ca4fcf14b938c5d22b608e7967add493ae42422b82631fa68615ae00134a79cd0a90d4b48273496bfa18496407e26bacff1c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Clément Prod'homme
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# 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
+
+## Usage
+
+How to use my plugin.
+
+Implementation :
+
+```ruby
+module API
+  module V1
+    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
+gem "captive-api"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)

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

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

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

@@ -0,0 +1,28 @@
+# 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 PaginationConcern
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.const_set :MAX_ITEMS_PAR_PAGE, 100
+      base.const_set :DEFAULT_NB_ITEMS_PAR_PAGE, 20
+
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module API
+  ##
+  # Permet de catcher des erreurs pour rendre une page d'erreur en json
+  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
+
+      protected
+
+      def render_error_from_object(
+        object,
+        status: :unprocessable_entity,
+        message: "Erreur de validation"
+      )
+        errors = object.errors.messages
+        Rails.logger.error("Impossible de sauvagarder l'objet #{object.class} : #{errors}")
+        render_error(
+          message: message, errors: errors, status: status
+        )
+      end
+
+      def render_error_from_exception(exception, status:, message: nil)
+        render_error(
+          message: exception.message, errors: exception.message, status: status
+        )
+      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
+
+      def render_error(message:, status:, errors: [], code: nil)
+        code ||= status.to_s
+        render json: {
+                 message: message,
+                 errors: errors,
+                 code: code,
+               },
+               status: status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Captive
+  module API
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

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

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

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

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

data/config/initializers/oj.rb

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

data/config/routes.rb

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

data/lib/captive/api/engine.rb

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

data/lib/captive/api.rb

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

data/lib/tasks/captive/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :captive_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: captive-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- Captive
+- Clément Prod'homme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/captive/api/application_controller.rb
+- app/controllers/concerns/api/pagination_concern.rb
+- app/controllers/concerns/api/render_error_concern.rb
+- 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/tasks/captive/api_tasks.rake
+homepage: https://www.captive.fr/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.captive.fr/
+  source_code_uri: https://github.com/Captive-Studio/captive-sdk/tree/v0.1.0.alpha/captive-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Code commun des API de Captive
+test_files: []