captive-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa071cf3e2b74fa646d99645daa968329f02a82df71344a1dc8bf6f0959b7cab
+  data.tar.gz: 8dec67a5234fcacdcf177922403bffa3dc3ed71b61ff66c49e0013eab5516294
+SHA512:
+  metadata.gz: a35b99b5b24cca392656620b2cb1f3df13e678f00639a9688ddbf43864ddadfcc8cd7bba7bc3c8acac19b44aee89533923f6eff3efd4e382afda746110f6234c
+  data.tar.gz: 7a878b264965496688cc8916f644ab1dfa52ff5ad84e11ce06f77f68fd57cc2da5436ba61d11c8f8b3a93c812f94a2d5096e80fc5227dda75d0b51c3d9b779e1

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,40 @@
+# Captive::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+Implementation :
+
+```ruby
+module Api
+  module V1
+    class BaseController < Captive::Api::ApplicationController
+      ...
+    end
+  end
+end
+```
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

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,19 @@
+# frozen_string_literal: true
+
+module Api
+  module PaginationConcern
+    extend ActiveSupport::Concern
+
+    included do
+      MAX_ITEMS_PAR_PAGE = 100
+      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 }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Api
+  module RenderErrorConcern
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from ActiveRecord::RecordNotFound, with: :not_found
+      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: :unprocessable_entity
+        )
+      end
+
+      def render_error_from_exception(exception, status:, message: nil)
+        render_error(
+          message: exception.message, errors: exception.message, status: status
+        )
+      end
+
+      def not_found
+        render_error(message: 'Erreur 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/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/version.rb

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

data/lib/captive/api.rb

@@ -0,0 +1,8 @@
+require "captive/api/version"
+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,88 @@
+--- !ruby/object:Gem::Specification
+name: captive-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Clément Prod'homme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-29 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
+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/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-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: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Code commun des API de Captive
+test_files: []