schema_based_api 2.1.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d0fa11327240df5877da54b0b1809baa1ed67740a2cc1223738d89965e28a91
+  data.tar.gz: ef0065c4a0853d41ff56552189f6fb3290209b1b52dd4c4b6f7d85199673495e
+SHA512:
+  metadata.gz: 3fac7557321ca4e7b3a49e81318cfb60e85ec2f69836575b11f49ed1833a938749a8662913c7c0014ed59cd635847f226a2285aeac2c3c5712aef4b0c0589b28
+  data.tar.gz: 9ccd8783f5e30a4b308ec2397da59a9fd66c205e2bf547d72b1bc45077028b900faf59d5eba8cf73091e2df1ea4e8498384cca8b2176f22399a4d5e0c733f372

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,64 @@
+# SchemaBasedApi
+I've always been a interested in effortless, no-fuss, conventions' based development, DRYness, and pragmatic programming, I've always thought that at this point of the technology evolution, we need not to configure too much to have our software run, and have the software adapt to data layers, from there build up automatically the APIs, visualizations etc. This is a first step to have a schema driven API, based on the data it has to serve, it also gives, thanks to meta programming, an insight on the actual schema, the translations available and the DSL which can change the way the data is presented, leading to a strong base for automatically build of UIs consuming the API (react, vue, angular based PWAs, maybe! ;-) ).
+
+Doing this means also narrowing a bit the scope of the tools, taking decisions, at least for the first iteratons of the project, so, this works well if the data is relational, so this is a convention taken as a prerequisite (postgres, mysql, mssql, etc.).
+
+# Goal
+
+To have a comprehensive and meaningful API right out of the box by just creating migrations in your rails app.
+
+# v2?
+
+Yes, the [v1](https://github.com/gabrieletassoni/thecore_api) was were it all started, many ideas are ported from there, but it was too coupled with thecore's rails_admin UI, making it impossible to create an UI-less, API only application, out of the box and directly from the DB schema, with all the bells and whistles I needed (mainly self adapting, data and schema driven API functionalities).
+
+# Standards Used
+
+* [JWT](https://medium.com/@billy.sf.cheng/a-rails-6-application-part-1-api-1ee5ccf7ed01) for authentication.
+* [CanCanCan](https://github.com/CanCanCommunity/cancancan) for authorization.
+* [Active Hash Relation](https://github.com/kollegorna/active_hash_relation) for DSL.
+* [Ransack](https://github.com/activerecord-hackery/ransack) query engine for complex searches going beyond CRUD's listing scope.
+* Catch all routing rule to add basic crud operations to any AR model in the app.
+
+# TODO
+
+* Integrate Authorization within ```GET info/schema``` requests in order to send to the client just the models for which a user has authorization.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schema_based_api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install schema_based_api
+```
+
+Then run the migrations:
+```bash
+$ rails db:migrate
+```
+
+This will setup a User model, Role model and the HABTM table between the two.
+
+Then, if you fire up your ```rails server``` you can already get a jwt and perform different operations.
+The default admin user created during the migration step has a randomly generated password you can find in a .passwords file in the root of your project, that's the initial password, in production you can replace that one, but for testing it proved handy to have it promptly available.
+
+If you want to manually test the API using [Insomnia](https://insomnia.rest/)
+
+## References
+THanks to all these people for ideas:
+
+* [Daniel](https://medium.com/@tdaniel/passing-refreshed-jwts-from-rails-api-using-headers-859f1cfe88e9) For a smart way to manage token expiration.
+
+## 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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SchemaBasedApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/commands/authenticate_user.rb

@@ -0,0 +1,32 @@
+class AuthenticateUser
+    class AccessDenied < StandardError
+        def message
+            "Cannot authenticate user."
+        end
+    end
+    prepend SimpleCommand
+    
+    def initialize(email, password)
+        @email = email
+        @password = password
+    end
+    
+    def call
+        JsonWebToken.encode(user_id: api_user.id) if api_user
+    end
+    
+    private
+    
+    attr_accessor :email, :password
+    
+    def api_user
+        user = User.find_by_email(email)
+        raise AccessDenied unless user.present?
+        
+        # Verify the password. You can create a blank method for now.
+        raise AccessDenied if user.authenticate(password).blank?
+        
+        return user
+    end
+    
+end

data/app/commands/authorize_api_request.rb

@@ -0,0 +1,33 @@
+class AuthorizeApiRequest
+    prepend SimpleCommand
+    
+    def initialize(headers = {})
+        @headers = headers
+    end
+    
+    def call
+        api_user
+    end
+    
+    private
+    
+    attr_reader :headers
+    
+    def api_user
+        @api_user ||= User.find(decoded_auth_token[:user_id]) if decoded_auth_token
+        @api_user || errors.add(:token, "Invalid token") && nil
+    end
+    
+    def decoded_auth_token
+        @decoded_auth_token ||= JsonWebToken.decode(http_auth_header)
+    end
+    
+    def http_auth_header
+        if headers['Authorization'].present?
+            return headers['Authorization'].split(' ').last
+        else
+            errors.add(:token, "Missing token")
+        end
+        nil
+    end
+end

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

@@ -0,0 +1,184 @@
+class Api::V2::ApplicationController < ActionController::API
+    include ActiveHashRelation
+    
+    before_action :authenticate_request
+    before_action :extract_model
+    before_action :find_record, only: [ :show, :destroy, :update ]
+    
+    attr_accessor :current_user
+    
+    # Actions will be authorized directly in the action
+    include CanCan::ControllerAdditions
+
+    include ::ApiExceptionManagement
+    
+    # Nullifying strong params for API
+    def params
+        request.parameters
+    end
+    
+    # TODO: Remove when not needed
+    # def dispatcher
+    #     # This method is only valid for ActiveRecords
+    #     # For any other model-less controller, the actions must be 
+    #     # defined in the route, and must exist in the controller definition.
+    #     # So, if it's not an activerecord, the find model makes no sense at all.
+    #     path = params[:path].split("/")
+    #     # Default convention for the requests: :controller/:id/:custom_action
+    #     # or :controller/:custom_action.
+    #     # With the ID as an Integer
+    #     # TODO: Extend to understand nested resources maybe testing if the 
+    #     # third param is a AR model, that can have an ID, etc..
+    #     controller = path.first
+    #     id = path.second
+    #     custom_action = path.third
+    #     # managing 
+    #     if request.get?
+    #         if id.blank?
+    #             # @page = params[:page]
+    #             # @per = params[:per]
+    #             # @pages_info = params[:pages_info]
+    #             # @count = params[:count]
+    #             # @query = params[:q]
+    #             index
+    #         elsif id.to_i.zero?
+    #             # String, so it's a custom action I must find in the @model (as a singleton method)
+    #             # GET :controller/:custom_action
+    #             return not_found! unless @model.respond_to?(id)
+    #             return render json: MultiJson.dump(@model.send(id, params)), status: 200
+    #         elsif !id.to_i.zero? && custom_action.blank?
+    #             # Integer, so it's an ID, I must show it
+    #             @record_id =  id.to_i
+    #             find_record
+    #             show
+    #         elsif !id.to_i.zero? && !custom_action.blank?
+    #             # GET :controller/:id/:custom_action
+    #             return not_found! unless @model.respond_to?(custom_action)
+    #             return render json: MultiJson.dump(@model.send(custom_action, id.to_i, params)), status: 200
+    #         end
+    #     elsif request.post?
+    #         if id.blank?
+    #             # @params = params
+    #             create
+    #         elsif id.to_i.zero?
+    #             # POST :controller/:custom_action
+    #             return not_found! unless @model.respond_to?(id)
+    #             return render json: MultiJson.dump(@model.send(id, params)), status: 200
+    #         end
+    #     elsif request.put?
+    #         if !id.to_i.zero? && custom_action.blank?
+    #             # @params = params
+    #             # Rails.logger.debug "IL SECONDO è ID in PUT? #{path.second.inspect}"
+    #             # find_record path.second.to_i
+    #             @record_id =  id.to_i
+    #             find_record
+    #             update
+    #         elsif !id.to_i.zero? && !custom_action.blank?
+    #             # PUT :controller/:id/:custom_action
+    #             # puts "ANOTHER SECOND AND THIRD"
+    #             return not_found! unless @model.respond_to?(custom_action)
+    #             return render json: MultiJson.dump(@model.send(custom_action, id.to_i, params)), status: 200
+    #         end
+    #     elsif request.delete?
+    #         # Rails.logger.debug "IL SECONDO è ID in delete? #{path.second.inspect}"
+    #         # find_record path.second.to_i
+    #         @record_id =  id.to_i
+    #         find_record
+    #         destroy
+    #     end
+    # end
+    
+    # GET :controller/
+    def index
+        authorize! :index, @model
+        # Rails.logger.debug params.inspect
+        # find the records
+        @q = (@model.column_names.include?("user_id") ? @model.where(user_id: current_user.id) : @model).ransack(@query.presence|| params[:q])
+        @records_all = @q.result(distinct: true)
+        page = (@page.presence || params[:page])
+        per = (@per.presence || params[:per])
+        pages_info = (@pages_info.presence || params[:pages_info])
+        count = (@count.presence || params[:count])
+        # Paging
+        @records = @records_all.page(page).per(per)
+        
+        # If there's the keyword pagination_info, then return a pagination info object
+        return render json: MultiJson.dump({count: @records_all.count,current_page_count: @records.count,next_page: @records.next_page,prev_page: @records.prev_page,is_first_page: @records.first_page?,is_last_page: @records.last_page?,is_out_of_range: @records.out_of_range?,pages_count: @records.total_pages,current_page_number: @records.current_page }) if !pages_info.blank?
+        
+        # puts "ALL RECORDS FOUND: #{@records_all.inspect}"
+        status = @records_all.blank? ? 404 : 200
+        # puts "If it's asked for page number, then paginate"
+        return render json: MultiJson.dump(@records, json_attrs), status: status if !page.blank? # (@json_attrs || {})
+        #puts "if you ask for count, then return a json object with just the number of objects"
+        return render json: MultiJson.dump({count: @records_all.count}) if !count.blank?
+        #puts "Default"
+        json_out = MultiJson.dump(@records_all, json_attrs)
+        #puts "JSON ATTRS: #{json_attrs}"
+        #puts "JSON OUT: #{json_out}"
+        render json: json_out, status: status #(@json_attrs || {})
+    end
+    
+    def show
+        authorize! :show, @record
+        result = @record.to_json(json_attrs)
+        render json: result, status: 200
+    end
+    
+    def create
+        @record = @model.new(@body)
+        authorize! :create, @record
+        @record.user_id = current_user.id if @model.column_names.include? "user_id"
+        
+        @record.save!
+        
+        render json: @record.to_json(json_attrs), status: 201
+    end
+    
+    def update
+        authorize! :update, @record
+        @record.update_attributes!(@body)
+        
+        render json: @record.to_json(json_attrs), status: 200
+    end
+    
+    def destroy
+        authorize! :destroy, @record
+        return api_error(status: 500) unless @record.destroy
+        head :ok
+    end
+    
+    private
+    
+    def authenticate_request
+        @current_user = AuthorizeApiRequest.call(request.headers).result
+        return unauthenticated! unless @current_user
+        current_user = @current_user
+        # Now every time the user fires off a successful GET request, 
+        # a new token is generated and passed to them, and the clock resets.
+        response.headers['Token'] = JsonWebToken.encode(user_id: current_user.id)
+    end
+    
+    def find_record
+        record_id ||= (params[:path].split("/").second.to_i rescue nil)
+        @record = @model.column_names.include?("user_id") ? @model.where(id: (record_id.presence || @record_id.presence || params[:id]), user_id: current_user.id).first : @model.find((@record_id.presence || params[:id]))
+        return not_found! if @record.blank?
+    end
+    
+    def json_attrs
+        ((@model.json_attrs.presence || @json_attrs.presence || {}) rescue {})
+    end
+    
+    def extract_model
+        # This method is only valid for ActiveRecords
+        # For any other model-less controller, the actions must be 
+        # defined in the route, and must exist in the controller definition.
+        # So, if it's not an activerecord, the find model makes no sense at all
+        # thus must return 404.
+        @model = (params[:ctrl].classify.constantize rescue params[:path].split("/").first.classify.constantize rescue controller_path.classify.constantize rescue controller_name.classify.constantize rescue nil)
+        # Getting the body of the request if it exists, it's ok the singular or 
+        # plural form, this helps with automatic tests with Insomnia.
+        @body = params[@model.model_name.singular].presence || params[@model.model_name.route_key]
+        # Only ActiveRecords can have this model caputed 
+        return not_found! if (!@model.new.is_a? ActiveRecord::Base rescue false)
+    end
+end

data/app/controllers/api/v2/authentication_controller.rb

@@ -0,0 +1,15 @@
+class Api::V2::AuthenticationController < ActionController::API
+    include ::ApiExceptionManagement
+
+    def authenticate
+        command = AuthenticateUser.call(params[:auth][:email], params[:auth][:password])
+        
+        if command.success?
+            response.headers['Token'] = command.result
+            render json: { message: ["Login successful!"] }
+        else
+            render json: { error: command.errors }, status: :unauthorized
+        end
+    end
+    
+end

data/app/controllers/api/v2/info_controller.rb

@@ -0,0 +1,68 @@
+class Api::V2::InfoController < Api::V2::ApplicationController
+  # Info uses a different auth method: username and password
+  skip_before_action :authenticate_request, only: [:version], raise: false
+  skip_before_action :extract_model
+  
+  # api :GET, '/api/v2/info/version', "Just prints the APPVERSION."
+  def version
+    render json: { version: SchemaBasedApi::VERSION }.to_json, status: 200
+  end
+
+  # api :GET, '/api/v2/info/roles'
+  # it returns the roles list
+  def roles
+    render json: ::Role.all.to_json, status: 200
+  end
+
+  # GET '/api/v2/info/translations'
+  def translations
+    render json: I18n.t(".", locale: (params[:locale].presence || :it)).to_json, status: 200
+  end
+
+  # GET '/api/v2/info/schema'
+  def schema
+    pivot = {}
+    # if Rails.env.development?
+    #   Rails.configuration.eager_load_namespaces.each(&:eager_load!) if Rails.version.to_i == 5 #Rails 5
+    #   Zeitwerk::Loader.eager_load_all if Rails.version.to_i >= 6 #Rails 6
+    # end
+    ApplicationRecord.subclasses.each do |d|
+      # Only if current user can read the model
+      if can? :read, d
+        model = d.to_s.underscore.tableize
+        pivot[model] ||= {}
+        d.columns_hash.each_pair do |key, val| 
+          pivot[model][key] = val.type unless key.ends_with? "_id"
+        end
+        # Only application record descendants to have a clean schema
+        pivot[model][:associations] ||= {
+          has_many: d.reflect_on_all_associations(:has_many).map { |a| 
+            a.name if (((a.options[:class_name].presence || a.name).to_s.classify.constantize.new.is_a? ApplicationRecord) rescue false)
+          }.compact, 
+          belongs_to: d.reflect_on_all_associations(:belongs_to).map { |a| 
+            a.name if (((a.options[:class_name].presence || a.name).to_s.classify.constantize.new.is_a? ApplicationRecord) rescue false)
+          }.compact
+        }
+        pivot[model][:methods] ||= (d.instance_methods(false).include?(:json_attrs) && !d.json_attrs.blank?) ? d.json_attrs[:methods] : nil
+      end
+    end
+    render json: pivot.to_json, status: 200
+  end
+
+  # GET '/api/v2/info/dsl'
+  def dsl
+    pivot = {}
+    # if Rails.env.development?
+    #   Rails.configuration.eager_load_namespaces.each(&:eager_load!) if Rails.version.to_i == 5 #Rails 5
+    #   Zeitwerk::Loader.eager_load_all if Rails.version.to_i >= 6 #Rails 6
+    # end
+    ApplicationRecord.subclasses.each do |d|
+      # Only if current user can read the model
+      if can? :read, d
+        model = d.to_s.underscore.tableize
+        pivot[model] = (d.instance_methods(false).include?(:json_attrs) && !d.json_attrs.blank?) ? d.json_attrs : nil
+      end
+    end
+    render json: pivot.to_json, status: 200
+  end
+end

data/app/controllers/api/v2/users_controller.rb

@@ -0,0 +1,9 @@
+class Api::V2::UsersController < Api::V2::ApplicationController
+  before_action :check_demoting, only: [ :update, :destroy ]
+  
+  private
+  
+  def check_demoting
+    unauthorized! StandardError.new("You cannot demote yourself") if (params[:id].to_i == current_user.id && (params[:user].keys.include?("admin") || params[:user].keys.include?("locked")))
+  end
+end

data/config/initializers/after_initialize_for_schema_based_api.rb

@@ -0,0 +1,7 @@
+require 'concerns/schema_based_api_user'
+
+Rails.application.configure do
+    config.after_initialize do
+        User.send(:include, SchemaBasedApiUser)
+    end
+end

data/config/initializers/cors_api_thecore.rb

@@ -0,0 +1,11 @@
+# config/initializers/cors.rb
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+  allow do
+    origins '*'
+    resource '*',
+      headers: %w(Token),
+      methods: :any,
+      expose: %w(Token),
+      max_age: 600
+  end
+end

data/config/initializers/knock.rb

@@ -0,0 +1,59 @@
+# Knock.setup do |config|
+
+#   ## Expiration claim
+#   ## ----------------
+#   ##
+#   ## How long before a token is expired. If nil is provided, token will
+#   ## last forever.
+#   ##
+#   ## Default:
+#   # config.token_lifetime = 1.day
+
+
+#   ## Audience claim
+#   ## --------------
+#   ##
+#   ## Configure the audience claim to identify the recipients that the token
+#   ## is intended for.
+#   ##
+#   ## Default:
+#   # config.token_audience = nil
+
+#   ## If using Auth0, uncomment the line below
+#   # config.token_audience = -> { Rails.application.secrets.auth0_client_id }
+
+#   ## Signature algorithm
+#   ## -------------------
+#   ##
+#   ## Configure the algorithm used to encode the token
+#   ##
+#   ## Default:
+#   # config.token_signature_algorithm = 'HS256'
+
+#   ## Signature key
+#   ## -------------
+#   ##
+#   ## Configure the key used to sign tokens.
+#   ##
+#   ## Default:
+#   # config.token_secret_signature_key = -> { Rails.application.secrets.secret_key_base }
+
+#   ## If using Auth0, uncomment the line below
+#   # config.token_secret_signature_key = -> { JWT.base64url_decode Rails.application.secrets.auth0_client_secret }
+
+#   ## Public key
+#   ## ----------
+#   ##
+#   ## Configure the public key used to decode tokens, if required.
+#   ##
+#   ## Default:
+#   # config.token_public_key = nil
+
+#   ## Exception Class
+#   ## ---------------
+#   ##
+#   ## Configure the exception to be used when user cannot be found.
+#   ##
+#   ## Default:
+#   # config.not_found_exception_class_name = 'ActiveRecord::RecordNotFound'
+# end

data/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/config/routes.rb

@@ -0,0 +1,33 @@
+# require 'ransack'
+
+Rails.application.routes.draw do
+    # REST API (Stateless)
+    namespace :api, constraints: { format: :json } do
+        namespace :v2 do
+            resources :users
+
+            namespace :info do
+                get :version
+                get :roles
+                get :translations
+                get :schema
+                get :dsl
+            end
+
+            post "authenticate" => "authentication#authenticate"
+            post ":ctrl/search" => 'application#index'
+
+            # Catchall routes
+            # # CRUD Show
+            get '*path/:id', to: 'application#show'
+            # # CRUD Index
+            get '*path', to: 'application#index'
+            # # CRUD Create
+            post '*path', to: 'application#create'
+            # # CRUD Update
+            put '*path/:id', to: 'application#update'
+            # # CRUD DElete
+            delete '*path/:id', to: 'application#destroy'
+        end
+    end
+end

data/lib/concerns/api_exception_management.rb

@@ -0,0 +1,67 @@
+module ApiExceptionManagement
+    extend ActiveSupport::Concern
+    
+    included do
+        rescue_from NoMethodError, with: :not_found!
+        rescue_from CanCan::AccessDenied, with: :unauthorized!
+        rescue_from AuthenticateUser::AccessDenied, with: :unauthenticated!
+        rescue_from ActionController::RoutingError, with: :not_found!
+        rescue_from ActiveModel::ForbiddenAttributesError, with: :fivehundred!
+        rescue_from ActiveRecord::RecordInvalid, with: :invalid!
+        rescue_from ActiveRecord::RecordNotFound, with: :not_found!
+        
+        def unauthenticated! exception = StandardError.new
+            response.headers['WWW-Authenticate'] = "Token realm=Application"
+            api_error status: 401, errors: [I18n.t("api.errors.bad_credentials", default: "Bad Credentials"), exception.message]
+        end
+        
+        def unauthorized! exception = StandardError.new
+            api_error status: 403, errors: [I18n.t("api.errors.unauthorized", default: "Unauthorized"), exception.message]
+            return
+        end
+        
+        def not_found! exception = StandardError.new
+            return api_error(status: 404, errors: [I18n.t("api.errors.not_found", default: "Not Found"), exception.message])
+        end
+        
+        def name_error!
+            api_error(status: 501, errors: [I18n.t("api.errors.name_error", default: "Name Error")])
+        end
+        
+        def no_method_error!
+            api_error(status: 501, errors: [I18n.t("api.errors.no_method_error", default: "No Method Error")])
+        end
+        
+        def invalid! exception = StandardError.new
+            api_error status: 422, errors: exception.record.errors
+        end
+        
+        def fivehundred! exception = StandardError.new
+            api_error status: 500, errors: [I18n.t("api.errors.fivehundred", default: "Internal Server Error"), exception.message]
+        end
+        
+        def api_error(status: 500, errors: [])
+            # puts errors.full_messages if !Rails.env.production? && errors.respond_to?(:full_messages)
+            head status && return if errors.empty?
+            
+            # For retrocompatibility, I try to send back only strings, as errors
+            errors_response = if errors.respond_to?(:full_messages) 
+                # Validation Errors
+                errors.full_messages.join(", ")
+            elsif errors.respond_to?(:error)
+                # Generic uncatched error
+                errors.error
+            elsif errors.respond_to?(:exception)
+                # Generic uncatchd error, if the :error property does not exist, exception will
+                errors.exception
+            elsif errors.is_a? Array
+                # An array of values, I like to have them merged
+                errors.join(", ")
+            else
+                # Uncatched Error, comething I don't know, I must return the errors as it is
+                errors
+            end
+            render json: {error: errors_response}, status: status
+        end
+    end
+end

data/lib/concerns/schema_based_api_user.rb

@@ -0,0 +1,9 @@
+module SchemaBasedApiUser
+    extend ActiveSupport::Concern
+    
+    included do
+        def authenticate password
+            self&.valid_password?(password) ? self : nil
+        end
+    end
+end

data/lib/json_web_token.rb

@@ -0,0 +1,14 @@
+class JsonWebToken
+    class << self
+      def encode(payload, expiry = 15.minutes.from_now.to_i)
+        JWT.encode(payload.merge(exp: expiry), Rails.application.secrets.secret_key_base)
+      end
+      
+      def decode(token)
+        body = JWT.decode(token, Rails.application.secrets.secret_key_base)[0]
+        HashWithIndifferentAccess.new body
+      rescue
+        nil
+      end
+    end
+  end

data/lib/schema_based_api.rb

@@ -0,0 +1,15 @@
+require "schema_based_api/engine"
+
+require 'thecore_auth_commons'
+require 'active_hash_relation'
+require 'rack/cors'
+require 'ransack'
+require 'json_web_token'
+require "kaminari"
+require "multi_json"
+
+require 'concerns/api_exception_management'
+
+module SchemaBasedApi
+  # Your code goes here...
+end

data/lib/schema_based_api/engine.rb

@@ -0,0 +1,12 @@
+module SchemaBasedApi
+  class Engine < ::Rails::Engine
+    # appending migrations to the main app's ones
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/schema_based_api/version.rb

@@ -0,0 +1,3 @@
+module SchemaBasedApi
+  VERSION = '2.1.12'
+end

data/lib/tasks/schema_based_api_tasks.rake

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

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: schema_based_api
+version: !ruby/object:Gem::Version
+  version: 2.1.12
+platform: ruby
+authors:
+- Gabriele Tassoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: thecore_auth_commons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simple_command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: active_hash_relation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby on Rails REST APIs built by convention using the DB schema as the
+  foundation.
+email:
+- gabriele.tassoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/commands/authenticate_user.rb
+- app/commands/authorize_api_request.rb
+- app/controllers/api/v2/application_controller.rb
+- app/controllers/api/v2/authentication_controller.rb
+- app/controllers/api/v2/info_controller.rb
+- app/controllers/api/v2/users_controller.rb
+- config/initializers/after_initialize_for_schema_based_api.rb
+- config/initializers/cors_api_thecore.rb
+- config/initializers/knock.rb
+- config/initializers/wrap_parameters.rb
+- config/routes.rb
+- lib/concerns/api_exception_management.rb
+- lib/concerns/schema_based_api_user.rb
+- lib/json_web_token.rb
+- lib/schema_based_api.rb
+- lib/schema_based_api/engine.rb
+- lib/schema_based_api/version.rb
+- lib/tasks/schema_based_api_tasks.rake
+homepage: https://github.com/gabrieletassoni/schema_based_api
+licenses:
+- MIT
+metadata: {}
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Convention based RoR engine which uses DB schema introspection to create
+  REST APIs.
+test_files: []