universal_api 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aed9e391b7b26ef3390a052aa602defcb9aff4c
+  data.tar.gz: 8bdf8285037b45cc046fde9e3841b5c339fd62fb
+SHA512:
+  metadata.gz: d1d0c59fd7c1977392fd93c45378b287833c6ee2eab0d8b3c79abe297f63a3f79f1d32837f3cfb58ec9e88db4cab28f8f2138b5fcfa2d3fde7318552bfb08c40
+  data.tar.gz: 735d1c9f5b4a0eefb7c4d36ec59faaece19dba52269f0cc3a22f18ce00e50e2957995e1d261a8263e8044c0ee2353e32202e9ee4786bda69465d4acd5d857585

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'UniversalApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/concerns/universal_api/controller.rb

@@ -0,0 +1,109 @@
+require 'active_support/concern'
+
+module UniversalApi
+  module Controller
+    extend ActiveSupport::Concern
+    
+    def index
+      @res = @model_class
+      @res = @res.page(params[:page].to_i) if params[:page]
+      @res = @res.limit(params[:limit] ? params[:limit].to_i : UniversalApi.page_size) unless params[:limitless]
+      select_list = permitted_select_values
+      @res = @res.select(select_list) if select_list
+      @res = @res.ransack(q_ransack).result    
+    end
+    
+    def show
+    end
+    
+    def create
+      invalid_resource!(@res) unless @res = @model_class.create!(permitted_params)
+    end
+    
+    def update
+      invalid_resource!(@res) unless @res.update!(permitted_params)
+      @res.reload
+    end
+    
+    def destroy
+      @res.destroy
+      raise @res.errors[:base].to_s unless @res.errors[:base].empty?
+      respond_to do |format|
+        format.any(:html) { render nothing: true, status: 204 }
+        format.any(:xml, :json) { render request.format.to_sym => { success: true }, status: 204 }
+      end
+    end
+    
+    protected
+      # Используем параметр q_defaults для передачи значений по-умолчанию, чтобы они не затирали значения в q
+      # Use parameter q_defaults for transferring defaults without interferring with values in q
+      def q_ransack
+        q_defaults = params[:q_defaults] || {}
+        q_defaults.merge(params[:q] || {})
+      end
+    
+      def permitted_select_values
+        if params[:select]
+          case params[:select]
+          when String
+            permitted_select_value params[:select]
+          when Array
+            [@model_class.primary_key] + params[:select].map { |field| permitted_select_value field }.compact
+          end
+        end
+      end
+      
+      def permitted_select_value field
+        @select_fields ||= @model_class.column_names + extra_select_values
+        (@select_fields.include? field) ? field : nil
+      end
+      
+      def extra_select_values
+        []
+      end
+      
+      def permitted_params
+        respond_to do |format|
+          format.json do
+            params.permit![_wrapper_options.name]
+            params[_wrapper_options.name].extract! @model_class.primary_key
+            params[_wrapper_options.name]
+          end
+          format.xml do
+            data = Hash.from_xml(request.body.read).first[1]
+            data.delete @model_class.primary_key
+            data
+          end
+        end
+      end
+      
+      def get_model_name
+        params[:model_name] || controller_name.classify
+      end
+      
+      def prepare_model
+        model_name = get_model_name
+        
+        raise "Model class not present" if model_name.nil? || model_name.strip == ""
+        
+        @model_class = model_name.constantize
+        
+        raise "Model class is not ActiveRecord" unless @model_class < ActiveRecord::Base
+      end
+      
+      def find_record
+        where_params = {}
+        
+        raise ActionController::ParameterMissing unless params[:id]
+        
+        params[:id].split(',').each do |param_pair|
+          v, k = param_pair.split("=").reverse
+          where_params[(k || "id").to_sym] = v
+        end
+        
+        @res = @model_class.where(where_params).first
+        
+        raise ActiveRecord::RecordNotFound unless @res
+      end
+  end
+end

data/app/controllers/universal_api/application_controller.rb

@@ -0,0 +1,5 @@
+module UniversalApi
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/universal_api/base_controller.rb

@@ -0,0 +1,8 @@
+module UniversalApi
+  class BaseController < UniversalApi::ApplicationController
+    include UniversalApi::Controller
+    
+    before_action :prepare_model, only: [:index, :show, :create, :update, :destroy]
+    before_action :find_record, only: [:show, :update, :destroy]
+  end
+end

data/app/views/universal_api/application/create.json.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/app/views/universal_api/application/create.xml.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/app/views/universal_api/application/index.json.erb

@@ -0,0 +1 @@
+<%= @res.to_json.html_safe %>

data/app/views/universal_api/application/index.xml.erb

@@ -0,0 +1 @@
+<%= @res.to_xml(skip_types: true).html_safe %>

data/app/views/universal_api/application/show.json.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/app/views/universal_api/application/show.xml.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/app/views/universal_api/application/update.json.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/app/views/universal_api/application/update.xml.erb

@@ -0,0 +1 @@
+<%= render template: '/universal_api/application/index' %>

data/config/routes.rb

@@ -0,0 +1,10 @@
+UniversalApi::Engine.routes.draw do
+  
+  scope "/:model_name", controller: 'base' do
+    get '/', action: 'index'
+    get '/:id', action: 'show'
+    post '/', action: 'create'
+    put '/:id', action: 'update'
+    delete '/:id', action: 'destroy'
+  end
+end

data/lib/universal_api.rb

@@ -0,0 +1,7 @@
+require "universal_api/engine"
+
+module UniversalApi
+  mattr_accessor :page_size
+  
+  @@page_size = 100
+end

data/lib/universal_api/engine.rb

@@ -0,0 +1,5 @@
+module UniversalApi
+  class Engine < ::Rails::Engine
+    isolate_namespace UniversalApi
+  end
+end

data/lib/universal_api/version.rb

@@ -0,0 +1,3 @@
+module UniversalApi
+  VERSION = "0.0.11"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/models/test_model.rb

@@ -0,0 +1,3 @@
+class TestModel < ActiveRecord::Base
+  self.table_name = 'test_table'
+end

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "universal_api"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,78 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_files = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end