baseapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d4dadca27b1dfff122e81fd28377fa34029d2a3
+  data.tar.gz: 52bd8d536bf6f31864fffd0bf55c10110e9bf222
+SHA512:
+  metadata.gz: 360017d2ffb93bb810c750fbfdb3964c86463f82c28ce314569d3d86ef39c7bef49a3ae7030e0b8f9716382afd404aabaa220df04e85bc3d8971699fe3ae3758
+  data.tar.gz: 504d7bdde8c48a28314e0792db3279c37fea2e0bf25b5421dcc88955934ed7c4c92380748cec0fe222b58b4304ca7578b37b64774899994e54bc4790b3ebf946

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 新川 盛幸
+
+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,39 @@
+# Baseapi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/baseapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'baseapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install baseapi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec baseapi` to use the code located in this directory, ignoring other installed copies of this gem.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/baseapi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/baseapi.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'baseapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "baseapi"
+  spec.version       = Baseapi::VERSION
+  spec.authors       = ["Moriyuki Arakawa"]
+  spec.email         = ["fire_extinguisher-@ezweb.ne.jp"]
+
+  spec.summary       = %q{ruby on rails gem baseapi}
+  spec.description   = %q{ruby on rails gem baseapi}
+  spec.homepage      = "https://github.com/arakawamoriyuki/baseapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "baseapi"
+
+# 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

data/bin/setup

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

data/exe/baseapi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'baseapi/cli'
+
+Baseapi::CLI.start

data/lib/baseapi.rb

@@ -0,0 +1,9 @@
+require "baseapi/version"
+
+# ActiveRecord::Relation Extension
+require 'baseapi/active_record/relation_extension'
+ActiveRecord::Relation.send(:include, ActiveRecordRelationExtension)
+
+# ActiveRecord::Base Extension
+require 'baseapi/active_record/base_extension'
+ActiveRecord::Base.send(:include, ActiveRecordBaseExtension)

data/lib/baseapi/active_record/base_extension.rb

@@ -0,0 +1,125 @@
+module ActiveRecordBaseExtension extend ActiveSupport::Concern
+
+  # override if necessary
+  def _destroy
+    destroy
+  end
+
+  module ClassMethods
+
+    # override if necessary
+    # @return ActiveRecordRelation
+    def _all
+      self.all
+    end
+
+    # override or create method '_where_{column}' if necessary
+    # @param    ActiveRecordRelation  models
+    # @param    String                column    column name
+    # @param    Array                 values    search values
+    def _where(models, column, values)
+      model.where!(column => values)
+    end
+
+    # override or create method '_belongs_to_{table}' if necessary
+    # @param    ActiveRecordRelation  models
+    # @param    String                table     table name
+    # @param    Hash                  hash      column name => search values
+    def _belongs_to(models, table, hash)
+      relation_match(models, table, hash)
+    end
+
+    # override or create method '_has_many_{table}' if necessary
+    # @param    ActiveRecordRelation  models
+    # @param    String                table     table name
+    # @param    Hash                  hash      column name => search values
+    def _has_many(models, table, hash)
+      relation_match(models, table, hash)
+    end
+
+    # Exact match search
+    # @param    ActiveRecordRelation  models
+    # @param    String                table     table name
+    # @param    Hash                  hash      column name => search values
+    # @option   String                operator  'or' or 'and'
+    def relation_match(models, table, hash, operator:'or')
+      relation_call(models, table, hash, ->(table, column, value){
+        "#{table}.#{column} = '#{value}'"
+      }, operator:operator)
+    end
+
+    # like search
+    # @param    ActiveRecordRelation  models
+    # @param    String                table     table name
+    # @param    Hash                  hash      column name => search values
+    # @option   String                operator  'or' or 'and'
+    def relation_like(models, table, hash, operator:'or')
+      relation_call(models, table, hash, ->(table, column, value){
+        "#{table}.#{column} like '%#{value}%'"
+      }, operator:operator)
+    end
+
+    # @param    ActiveRecordRelation  models
+    # @param    String                table     table name
+    # @param    Hash                  hash      column name => search values
+    # @param    Callable              callable
+    # @option   String                operator  orかand
+    def relation_call(models, table, hash, callable, operator:'or')
+      models.joins!(table.to_sym)
+      hash.each do |column, value|
+        if column.present? and value.present?
+          relation_values = value.instance_of?(Array) ? value : [value]
+          models.where!(relation_values.map{|value| callable.call(table.pluralize, column, value)}.join(" #{operator} "))
+        end
+      end
+      models
+    end
+
+    # get relation tables
+    # @param  String  relate        'belongs_to','hasmany'..
+    # @return Hash    associations  relation name => talbe name array
+    def get_associations(relate = nil)
+      associations = {
+        'belongs_to' => [],
+        'has_many'   => [],
+      }
+      self.reflect_on_all_associations.each do |association|
+        associations.each do |key, value|
+          if association.class.to_s == "ActiveRecord::Reflection::#{key.camelize}Reflection"
+            associations[key].push(association.name.to_s)
+          end
+        end
+      end
+      relate.present? ? associations[relate] : associations
+    end
+
+
+    # @param    Hash          params    getparams
+    #             String/Array  {column}  search column value
+    #             String        orderby   order column
+    #             String        order     sort order ('asc' or 'desc')
+    #             Integer       count     page count (all = '0' or '-1')
+    #             Integer       page      paged
+    def search(params)
+      models = self._all
+
+      # load
+      self.get_associations().each do |association_key, relations|
+        relations.each do |relation|
+          models.includes!(relation.to_sym)
+        end
+      end
+
+      # filter
+      models.filtering!(params)
+
+      # pager
+      models.paging!(params)
+
+      # sort
+      models.sorting!(params)
+
+      return models.uniq
+    end
+  end
+end

data/lib/baseapi/active_record/relation_extension.rb

@@ -0,0 +1,58 @@
+module ActiveRecordRelationExtension
+  # ----- model relation object methods -----
+  # def relation_object_method
+  # end
+  # Model.all.relation_object_method
+
+  # カラムの検索
+  # @param  Hash    params  検索パラメータ
+  def filtering!(params)
+    models = self
+    associations = self.model.get_associations()
+    params.each do |key, value|
+      if key.present? and value.present?
+        if column_names.include?(key)
+          # 配列に対応する
+          values = value.instance_of?(Array) ? value : [value]
+          values.reject!(&:blank?)
+          # カラム用関数が定義されていればそれを使用
+          function_name = self.model.methods.include?("_where_#{key}".to_sym) ? "_where_#{key}" : '_where'
+          models = self.model.send(function_name, models, key, values)
+        end
+
+        # belongs_to, has_manyの検索
+        associations.keys.each do |association|
+          if associations[association].include?(key) and value.instance_of?(ActionController::Parameters)#hash型はActionController::Parameters
+            # カラム用関数が定義されていればそれを使用
+            function_name = self.model.methods.include?("_#{association}_#{key}".to_sym) ? "_#{association}_#{key}" : "_#{association}"
+            models = self.model.send(function_name, models, key, value)
+          end
+        end
+      end
+    end
+    return models
+  end
+
+  # ページャー
+  # @param  Hash    params  検索パラメータ
+  def paging!(params)
+    count = params[:count].present? ? params[:count].to_i : -1;
+    page = params[:page].present? ? params[:page].to_i : 1;
+    if count > 0
+      if count.present? and count
+        limit!(count)
+        if page
+          offset!((page - 1) * count)
+        end
+      end
+    end
+  end
+
+  # ソート
+  # @param  Hash    params  検索パラメータ
+  def sorting!(params)
+    if params[:order].present? and params[:orderby].present?
+      order!({params[:orderby] => params[:order]})
+    end
+  end
+end

data/lib/baseapi/app/controllers/base_api_controller.rb

@@ -0,0 +1,89 @@
+class BaseApiController < ActionController::Base
+
+  before_action :set_Model
+  before_action :set_models, only: [:index]
+  before_action :set_model, only: [:show, :create, :update, :destroy]
+
+  # GET /{models}.json
+  # @param  Hash
+  # @return String  Json(Models)
+  def index
+    render 'models.json.jbuilder'
+  end
+
+  # GET /{models}/{id}.json
+  # @return String  Json(Model)
+  def show
+    render 'model.json.jbuilder'
+  end
+
+  # POST /{models}/{id}.json
+  # @param
+  # @return String  Json(Model)
+  def create
+    render 'model.json.jbuilder' if transaction(-> {
+      params.each do |key, value|
+        if key.present? and value.present? and @Model.column_names.include?(key)
+          @model.send("#{key}=", value)
+        end
+      end
+      @model.save
+    })
+  end
+
+  # PATCH/PUT /{models}/{id}.json
+  # @param
+  # @return String  Json(Model)
+  def update
+    render 'model.json.jbuilder' if transaction(-> {
+      params.each do |key, value|
+        if key.present? and value.present? and @Model.column_names.include?(key)
+          @model.send("#{key}=", value)
+        end
+      end
+      @model.save
+    })
+  end
+
+  # DELETE /{models}/{id}.json
+  # @param
+  # @return String  Json(Model)
+  def destroy
+    render 'model.json.jbuilder' if transaction(-> {
+      @model._destroy
+    })
+  end
+
+
+  private
+    # set Model class
+    def set_Model
+      @Model = params[:controller].camelize.singularize.constantize
+    end
+
+    # set model
+    def set_model
+      @model = params[:id].present? ? @Model.find(params[:id]) : @Model.new
+    end
+
+    # set models
+    def set_models
+      @models = @Model.search(params)
+    end
+
+    # transaction
+    # @param  callable  callable
+    # @return bool
+    def transaction (callable)
+      begin
+        @Model.transaction do
+          callable.call()
+        end
+      rescue => e
+        @message = e.message
+        render 'error.json.jbuilder'
+        return false
+      end
+      return true
+    end
+end

data/lib/baseapi/app/views/base_api/error.json.jbuilder

@@ -0,0 +1,3 @@
+json.error true
+json.message @message
+json.data {}

data/lib/baseapi/app/views/base_api/model.json.jbuilder

@@ -0,0 +1,3 @@
+json.error false
+json.message ''
+json.data @model

data/lib/baseapi/app/views/base_api/models.json.jbuilder

@@ -0,0 +1,3 @@
+json.error false
+json.message ''
+json.data @models

data/lib/baseapi/cli.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+require 'thor'
+require 'fileutils'
+
+module Baseapi
+  class CLI < Thor
+
+    desc "Base API setup", "create BaseApiController and jbuilder view."
+    def setup
+      dir = [
+        'app/views/base_api'
+      ]
+      dir.each do |path|
+        if !Dir.exists?(path)
+          Dir.mkdir(path)
+        end
+      end
+
+      files = {
+        'base_api_controller.rb'  => 'controllers',
+        'error.json.jbuilder'     => 'views/base_api',
+        'model.json.jbuilder'     => 'views/base_api',
+        'models.json.jbuilder'    => 'views/base_api',
+      }
+
+      files.each do |file, path|
+        src = File.expand_path("../app/#{path}/#{file}", __FILE__)
+        if File.exists?("app/#{path}/#{file}")
+          warn "[skip] app/#{path}/#{file} already exists"
+        else
+          FileUtils.cp(src, "app/#{path}/#{file}")
+        end
+      end
+    end
+  end
+end

data/lib/baseapi/version.rb

@@ -0,0 +1,3 @@
+module Baseapi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: baseapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moriyuki Arakawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: ruby on rails gem baseapi
+email:
+- fire_extinguisher-@ezweb.ne.jp
+executables:
+- baseapi
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baseapi.gemspec
+- bin/console
+- bin/setup
+- exe/baseapi
+- lib/baseapi.rb
+- lib/baseapi/active_record/base_extension.rb
+- lib/baseapi/active_record/relation_extension.rb
+- lib/baseapi/app/controllers/base_api_controller.rb
+- lib/baseapi/app/views/base_api/error.json.jbuilder
+- lib/baseapi/app/views/base_api/model.json.jbuilder
+- lib/baseapi/app/views/base_api/models.json.jbuilder
+- lib/baseapi/cli.rb
+- lib/baseapi/version.rb
+homepage: https://github.com/arakawamoriyuki/baseapi
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ruby on rails gem baseapi
+test_files: []