baseapi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 562c675140df0d7fc675e570b5b984a3eff8249b
-  data.tar.gz: aad3e7568ca8c0b3bac6b554f285066a2744f469
+  metadata.gz: dca945b60e066f84367a241d9ffdf4f63b69742a
+  data.tar.gz: abd87f5100db1cb5418a82801edc7efcf507dd27
 SHA512:
-  metadata.gz: 38a522250027c0d2f6e696f4e15fbdea713f09c79bedd89fca55fc3b18779eae95b56fa360e2d8542f6de251411176ad4376cba607a3d48e3607b4f76bc1cdb0
-  data.tar.gz: ad8bf3e76b7d185b446b8760714af39a7839f7e9bf7eee716091e356cd99b0bbaaf375fc2d00940c81e733bdb4eba37842cd3e06b503e7bc814ce92e41b5cd49
+  metadata.gz: c009cb8fc952ec300a1194d82c3e8d83b70351455a4cd6d8069bd6a236e8047e29e905ea2d787b41f87361928e2cc030647ae3e01d7bce735912bc002af821d4
+  data.tar.gz: 06cbe31f266e92e7d20f55c7ddbe1401a8c0f7a80d12a539f255a2bbe3d5382e419ceb372f90b6840cf1512b331ba7a0780241ed8353f641cdb82f5e982129a1

data/README.md

@@ -32,7 +32,7 @@ Create a Model (app/models/user.rb):
 
 Extend the BaseApiController is when you create a Controller (app/controllers/users_controller.rb):
 
-    class CompaniesController < BaseApiController
+    class UsersController < BaseApiController
     end
 
 Routing configuration (config/routes.rb):
@@ -48,11 +48,13 @@ Routing configuration (config/routes.rb):
 
 Corresponding API:
 
-    /users.json	      index	   GET
-    /users/{id}.json	show     GET
-    /users.json	      create   POST
-    /users/{id}.json	update   PUT
-    /users/{id}.json	destroy  DELETE
+| url              | action  | method      |
+|------------------|---------|-------------|
+| /users.json      | index   | GET         |
+| /users/{id}.json | show    | GET         |
+| /users.json      | create  | POST        |
+| /users/{id}.json | update  | PATCH / PUT |
+| /users/{id}.json | destroy | DELETE      |
 
 
 ### Examples
@@ -71,8 +73,8 @@ Users table data
 
 | id | name     | company_id |
 |----|----------|------------|
-| 1  | arakawa  | 1          |
-| 2  | moriyuki | 2          |
+| 1  | hoge     | 1          |
+| 2  | huga     | 2          |
 
 Company table data
 
@@ -87,21 +89,37 @@ Get all
 
     GET   /users.json
 
+Specify the count
+
+    GET   /users.json?count=10
+
+Specify the page
+
+    GET   /users.json?page=2
+
+Specify the sorting order
+
+    GET   /users.json?order=desc&orderby=name
+
 Specify the name
 
-    GET   /users.json?name=arakawa
+    GET   /users.json?name=hoge
 
 Specify multiple possible
 
-    GET   /users.json?name[]=arakawa&name[]=moriyuki
+    GET   /users.json?name[]=hoge&name[]=huga
 
 Specify the belongs to company name
 
-    GET   /users.json?company[name]=arakawa
+Note that this is a single
+
+    GET   /users.json?company[name]=Google
 
 Specify the has many users name
 
-    GET   /companies.json?user[name]=hoge
+Note that this is a multiple
+
+    GET   /companies.json?users[name]=hoge
 
 #### action show
 
@@ -153,64 +171,93 @@ You can corresponding to the logical deletion, if you want to search condition t
 Get all
 
     class User < ActiveRecord::Base
-      def self._all
-      end
+      module ClassMethods
+        def self._all
+          self.all # default
+        end
     end
 
 delete
 
     class User < ActiveRecord::Base
       def _destroy
+        self.destroy # default
       end
     end
 
 column search
 
     class User < ActiveRecord::Base
-      def self._where(models, column, values)
-      end
+      module ClassMethods
+        def self._where(models, column, values)
+          column_match(models, column, values) # default
+        end
     end
 
 name column search
 
     class User < ActiveRecord::Base
-      def self._where_name(models, column, values)
-      end
+      module ClassMethods
+        def self._where_name(models, column, values)
+          column_match(models, column, values) # default
+        end
     end
 
 belongs_to search
 
     class User < ActiveRecord::Base
-      def self._belongs_to(models, table, hash)
-      end
+      module ClassMethods
+        def self._belongs_to(models, table, hash)
+          relation_match(models, table, hash) # default
+        end
     end
 
 company belongs_to search
 
     class User < ActiveRecord::Base
-      def self._belongs_to_company(models, table, hash)
-      end
+      module ClassMethods
+        def self._belongs_to_company(models, table, hash)
+          relation_match(models, table, hash) # default
+        end
     end
 
 has_many search
 
     class Company < ActiveRecord::Base
-      def self._has_many(models, table, hash)
-      end
+      module ClassMethods
+        def self._has_many(models, table, hash)
+          relation_match(models, table, hash) # default
+        end
     end
 
 users has_many search
 
     class Company < ActiveRecord::Base
-      def self._has_many_users(models, table, hash)
-      end
+      module ClassMethods
+        def self._has_many_users(models, table, hash)
+          relation_match(models, table, hash) # default
+        end
     end
 
 
-There is a useful function for the associated table Search
+There is a useful function for the table Search
 By default, it looks like the following
 'Like' search and, you can change the 'and' and 'or'
 
+Simply If you want to override the search processing of the name column
+column_match, you can use the column_like function.
+
+    class User < ActiveRecord::Base
+      def self._where_name(models, column, values)
+        column_match(models, column, values, operator:'or') # default is match OR
+        # column_like(models, column, values, operator:'or') # LIKE OR
+        # column_like(models, column, values, operator:'and') # LIKE AND
+      end
+    end
+
+If the search process of the related table is to override
+relation_match, you can use the relation_like function.
+
     class User < ActiveRecord::Base
       def self._belongs_to(models, table, hash)
         relation_match(models, table, hash, operator:'or') # default is match OR
@@ -221,6 +268,32 @@ By default, it looks like the following
 
 The short so please read the [code](https://github.com/arakawamoriyuki/baseapi/blob/master/lib/baseapi/active_record/base_extension.rb) for more information
 
+
+### jbuilder
+
+It uses basically
+
+    /app/views/baseapi/ooo.json.jbuilder
+
+but you can also make
+
+    /app/views/{models}/ooo.json.jbuilder
+
+It will return to a single data (action:show,create,delete,update)
+
+    model.json.jbuilder
+
+It will return multiple data (action:index)
+
+    models.json.jbuilder
+
+It will return an error content
+
+    error.json.jbuilder
+
+[jbuilder details here](https://github.com/rails/jbuilder)
+
+
 ## 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.

data/lib/baseapi/active_record/base_extension.rb

@@ -13,14 +13,49 @@ module ActiveRecordBaseExtension extend ActiveSupport::Concern
       self.all
     end
 
+
     # override or create method '_where_{column}' if necessary
     # @param    ActiveRecordRelation  models
     # @param    String                column    column name
-    # @param    Array                 values    search values
+    # @param    Array/String          values    search values
     def _where(models, column, values)
-      models.where!(column => values)
+      column_match(models, column, values)
+    end
+
+    # column exact match search
+    # @param    ActiveRecordRelation  models
+    # @param    String                column    column name
+    # @param    Array/String          values    search values
+    # @option   String                operator  'or' or 'and'
+    def column_match(models, column, values, operator:'or')
+      column_call(models, column, values, ->(column, value){
+        "#{column} = '#{value}'"
+      }, operator:operator)
+    end
+
+    # column like search
+    # @param    ActiveRecordRelation  models
+    # @param    String                column    column name
+    # @param    Array/String          values    search values
+    # @option   String                operator  'or' or 'and'
+    def column_like(models, column, values, operator:'or')
+      column_call(models, column, values, ->(column, value){
+        "#{column} like '%#{value}%'"
+      }, operator:operator)
     end
 
+    # @param    ActiveRecordRelation  models
+    # @param    String                column    column name
+    # @param    Array/String          values    search values
+    # @param    Callable              callable
+    # @option   String                operator  orかand
+    def column_call(models, column, values, callable, operator:'or')
+      column_values = values.instance_of?(Array) ? values : [values]
+      models.where!(column_values.map{|value| callable.call(column, value)}.join(" #{operator} "))
+      models
+    end
+
+
     # override or create method '_belongs_to_{table}' if necessary
     # @param    ActiveRecordRelation  models
     # @param    String                table     table name
@@ -75,6 +110,7 @@ module ActiveRecordBaseExtension extend ActiveSupport::Concern
       models
     end
 
+
     # get relation tables
     # @param  String  relate        'belongs_to','hasmany'..
     # @return Hash    associations  relation name => talbe name array

data/lib/baseapi/active_record/relation_extension.rb

@@ -1,29 +1,25 @@
 module ActiveRecordRelationExtension
-  # ----- model relation object methods -----
-  # def relation_object_method
-  # end
-  # Model.all.relation_object_method
 
-  # カラムの検索
-  # @param  Hash    params  検索パラメータ
+  # column search
+  # @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)
-          # 配列に対応する
+          # array change
           values = value.instance_of?(Array) ? value : [value]
           values.reject!(&:blank?)
-          # カラム用関数が定義されていればそれを使用
+          # call function
           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の検索
+        # belongs_to, has_many search
         associations.keys.each do |association|
           if associations[association].include?(key) and value.instance_of?(ActionController::Parameters)#hash型はActionController::Parameters
-            # カラム用関数が定義されていればそれを使用
+            # call function
             function_name = self.model.methods.include?("_#{association}_#{key}".to_sym) ? "_#{association}_#{key}" : "_#{association}"
             models = self.model.send(function_name, models, key, value)
           end
@@ -33,8 +29,8 @@ module ActiveRecordRelationExtension
     return models
   end
 
-  # ページャー
-  # @param  Hash    params  検索パラメータ
+  # pager
+  # @param  Hash    params
   def paging!(params)
     count = params[:count].present? ? params[:count].to_i : -1;
     page = params[:page].present? ? params[:page].to_i : 1;
@@ -48,8 +44,8 @@ module ActiveRecordRelationExtension
     end
   end
 
-  # ソート
-  # @param  Hash    params  検索パラメータ
+  # sort
+  # @param  Hash    params
   def sorting!(params)
     if params[:order].present? and params[:orderby].present?
       order!({params[:orderby] => params[:order]})

data/lib/baseapi/version.rb

@@ -1,3 +1,3 @@
 module Baseapi
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: baseapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Moriyuki Arakawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-08-03 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
@@ -46,9 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -77,12 +77,12 @@ 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: []