api-scheme 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0dc806b74dad245da064e9ca3f750999f1bda267
+  data.tar.gz: 6f0e255f4985f615909b206865ab34d782de4c09
+SHA512:
+  metadata.gz: cbd4b1a968ab50cff49de048bbf81ba6f79f72962b5fa6a03259bc661b4e283ec7b03dfd61fc5088f1f4edc7c253b8b7392e3cf3463aec0cd6e1aa4dc81d908c
+  data.tar.gz: 15fba0ab5d763c73826d944dbf92f06c598f210bd378bc72b348047c038d1cc8efe0ae3a58673f4582e2dd8d3b505c2a807dc6dcf6212eae5a9cb9cb739823b7

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*~
+*.sw*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-api-scheme.gemspec
+gemspec

data/README.md

@@ -0,0 +1,94 @@
+# Api::Scheme
+
+Provides simple error handling and param processing scheme
+to make API and other actions for Rail Action Controller
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-scheme'
+```
+
+or with explicit require:
+
+```ruby
+gem 'api-scheme', require: 'api/scheme'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-api-scheme
+
+## Usage
+
+Do:
+
+```ruby
+require 'api/scheme'
+```
+
+before usage. Then add the similar the following scheme
+into the rails action controller:
+
+```ruby
+class UsersController < ApplicationController
+  include Api::Scheme
+
+  error_map %W(ActionController::ParameterMissing)  => 400,
+            %W(ActiveRecord::RecordNotFound)        => 404,
+            %W(ActiveRecord::RecordInvalid)         => 422..0,
+            %W(ActiveRecord::RecordNotUnique)       => 422..1
+
+  param_map({
+    user: [
+      :first_name,
+      :last_name,
+      :email
+    ]
+  })
+
+  use_model 'User'
+
+  use_actions :index, :show, :create, :update, :destroy
+end
+```
+
+You can also use custom success, and error handlers as follows:
+
+```ruby
+  render_error_with :render_error
+  render_success_with :render_success
+
+  def render_error text, minor, major
+    render json: { text: text, code: minor }, status: major
+  end
+
+  def render_success data, status
+    render json: data, status
+  end
+```
+
+Or even define the action method yourself instead of using the defaults, thus just skip `use_actions` call,
+and declare required methods excplicitly in the controller.
+
+```ruby
+  def create
+    @user = User.create!(permitted_params)
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/majioa/rails-api-scheme.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api-scheme.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "api/scheme"
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-scheme"
+  spec.version       = Api::Scheme::VERSION
+  spec.authors       = ["Malo Skrylevo"]
+  spec.email         = ["majioa@yandex.ru"]
+
+  spec.summary       = %q{API Scheme for Rails Action Controller}
+  spec.description   = %q{Provides simple error handling and param processing scheme
+                          to make API and other actions for Rail Action Controller. This version
+                          obsoletes \`rails-api-scheme` gem}
+  spec.homepage      = "https://github.com/majioa/rails-api-scheme"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/api/scheme"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api/scheme.rb

@@ -0,0 +1,235 @@
+require "api/scheme/version"
+require "api/scheme/action"
+
+module Api::Scheme
+   def self.included klass
+      # NOTE put default render handlers to the module to use from as if is the ancestor
+      self.instance_variable_set(:@success_proc, :default_success_proc)
+      self.instance_variable_set(:@error_proc, :default_error_proc)
+
+      klass.class_eval %Q"
+         class << self
+            def error_map map
+               @error_map ||= map
+            end
+
+            def model_error_map map
+               @model_error_map ||= map
+            end
+
+            def param_map map
+               @param_map ||= map
+            end
+
+            def render_success_with method = nil, &prc
+               @success_proc ||= method || prc
+            end
+
+            def render_error_with method = nil, &prc
+               @error_proc ||= method || prc
+            end
+
+            def use_model name
+               @model_name = name
+            end
+
+            def use_actions *list
+               list.each do |action|
+                  Api::Scheme::Action.define_for(self, action)
+               end
+
+               Api::Scheme::Action::SCHEME.each do |method_name, cases|
+                  before = [ cases[:before] ].flatten.compact & list
+
+                  if before.present?
+                     Api::Scheme::Action.define_for(self, method_name)
+                     self.before_action(method_name, only: before)
+                  end
+               end
+            end
+         end
+      "
+
+      klass.rescue_from StandardError, with: :render_default_error
+   end
+
+   def _getter var
+      self.class.ancestors.reduce(nil) { |value, klass| value || klass.instance_variable_get(var) }
+   end
+
+   def error_map
+      error_map = _getter(:@error_map)
+
+      error_map ||= map
+      return error_map if _getter(:@error_map_parsed)
+
+      error_map = parse_error_map
+      self.class.instance_variable_set(:@error_map_parsed, true)
+      self.class.instance_variable_set(:@error_map, error_map)
+   end
+
+   def parse_error_map
+      error_map = _getter(:@error_map)
+      error_map.map do |(errors, code)|
+         list = errors.map do |e|
+            begin
+               e.constantize
+            rescue NameError
+               begin
+                  "#{self.class}::#{e}".constantize
+               rescue NameError
+                  begin
+                     send(:class_eval, e.camelize)
+                  rescue NameError
+                     raise InvalidErrorTypeError, e
+                  end
+               end
+            end
+         end
+
+         [ list, code ]
+      end.to_h
+   end
+
+   def code_parse code, e
+      json = { message: e.message, type: e.class }
+
+      case code
+      when Range
+         logger.error "#{e.class}: #{e.message}"
+
+         [ code.first, json.merge(error_code: code.last) ]
+      when NilClass
+         logger.error "#{e.class}: #{e.message}\n\t#{e.backtrace[0...50].join("\n\t")}"
+
+         [ 500, json ]
+      else
+         logger.error "#{e.class}: #{e.message}"
+
+         [ code, json ]
+      end
+   end
+
+   def get_code_of_model_error_map e
+      error_text = e.record.errors.messages.reduce(nil) {|s, (_, v)| s || v.join }
+
+      _getter(:@model_error_map).to_a.reverse.reduce(nil) do |code, (re, new_code)|
+         re =~ error_text && new_code || code
+      end
+   end
+
+   def get_code_of_error_map e
+      error_map.find do |errors, codes|
+         errors.any? { |error| e.kind_of?(error) }
+      end.try(:last)
+   end
+
+   def get_pure_code code
+      if code.is_a?(Range)
+         code.begin
+      else
+         code
+      end
+   end
+
+   def get_sub_code code
+      if code.is_a?(Range)
+         code.end
+      end
+   end
+
+   def get_code_text code
+      path = code.is_a?(Range) && "#{code.begin}.#{code.end}" || code.to_s
+
+      I18n.t("action_controller.#{controller_path}.errors.#{path}")
+   end
+
+   def render_default_success data, options = {}
+      success_proc = _getter(:@success_proc)
+
+      prc = success_proc.kind_of?(Proc) && success_proc || self.method(success_proc.to_s.to_sym)
+
+      prc[data, options]
+   end
+
+   def render_default_error e
+      code =
+      if e.to_s.split('::').last == 'Validations'
+         get_code_of_model_error_map(e)
+      else
+         get_code_of_error_map(e)
+      end
+
+      error_proc = _getter(:@error_proc)
+
+      prc = error_proc.kind_of?(Proc) && error_proc || self.method(error_proc.to_s.to_sym)
+      args = [get_code_text(code), get_sub_code(code), get_pure_code(code), code, e ]
+
+      prc[*args[0...prc.arity.abs]]
+   end
+
+   def default_success_proc data
+      render data: data, status: 200
+   end
+
+   def default_error_proc _, _, _, code, e
+      status, json = code_parse(code, e)
+
+      render data: json, status: status
+   end
+
+   def model
+      @model ||= _getter(:@model_name).constantize
+   end
+
+   def model_key
+      model.name.tableize.singularize
+   end
+
+   def models_key
+      model.name.tableize
+   end
+
+   def model_instance
+      self.instance_variable_get(:"@#{model_key}")
+   end
+
+   def model_instances
+      self.instance_variable_get(:"@#{models_key}")
+   end
+
+   def model_instance= value
+      self.instance_variable_set(:"@#{model_key}", value)
+   end
+
+   def model_instances= value
+      self.instance_variable_set(:"@#{models_key}", value)
+   end
+
+   def permitted_params_require key, map
+      params.require(key).permit(*map)
+   end
+
+   def permitted_params_permit keys
+      default = {}
+
+      keys.reduce(default) do |h, key|
+         value = /(?<name>.*)\?$/ =~ key ? params[name] : params.require(key)
+         value.nil? && h || h.merge( (name || key).to_sym => value )
+      end
+   end
+
+   def permitted_params
+      param_map = _getter(:@param_map)
+
+      if param_map.is_a?(Hash)
+         permitted_params_require(param_map.keys.first, param_map.values.first)
+      else
+         permitted_params_permit([ param_map ].flatten)
+      end
+   end
+
+   def validate_access_token
+      raise InvalidUserError if not current_user
+   end
+end

data/lib/api/scheme/action.rb

@@ -0,0 +1,60 @@
+require "api/scheme/version"
+
+module Api::Scheme::Action
+   SCHEME = {
+      fetch_model_instances: {
+         before: :index
+      },
+      fetch_model_instance: {
+         before: %i(show update destroy)
+      },
+      init_model_instance: {
+         before: :create
+      }
+   }
+
+   def index
+      render_default_success models_key => model_instances
+   end
+
+   def show
+      render_default_success model_key => model_instance
+   end
+
+   def create
+      model_instance.save!
+
+      render_default_success({ model_key => model_instance }, status: :created)
+   end
+   
+   def update
+      model_instance.update!(permitted_params)
+
+      render_default_success({ model_key => model_instance }, status: :ok)
+   end
+
+   def destroy
+      model_instance.destroy!
+
+      render_default_success({ model_key => model_instance }, status: :ok)
+   end
+
+   def fetch_model_instances
+      self.model_instances = model.all
+   end
+
+   def fetch_model_instance
+      self.model_instance = model.find(params[:id])
+   end
+
+   def init_model_instance
+      self.model_instance = model.new(permitted_params)
+   end
+
+   class << self
+      def define_for klass, name
+         method = self.instance_method(name)
+         klass.send(:define_method, name, method)
+      end
+   end
+end

data/lib/api/scheme/version.rb

@@ -0,0 +1,5 @@
+module Api
+   module Scheme
+      VERSION = "0.2"
+   end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: api-scheme
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Malo Skrylevo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Provides simple error handling and param processing scheme
+                            to make API and other actions for Rail Action Controller. This version
+                            obsoletes \`rails-api-scheme` gem
+email:
+- majioa@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- api-scheme.gemspec
+- bin/console
+- bin/setup
+- lib/api/scheme.rb
+- lib/api/scheme/action.rb
+- lib/api/scheme/version.rb
+homepage: https://github.com/majioa/rails-api-scheme
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: API Scheme for Rails Action Controller
+test_files: []