baseapi 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3e73410c8406195ecee9cafea68fb5e51af7002
-  data.tar.gz: f42abb494021317b75fcc3fdb59f56665eb93a0c
+  metadata.gz: a6f8c5e16034693c92e956e421277975f060297c
+  data.tar.gz: 6ecded08bc1d03c2f3b434e4d7d688b6a43c0aad
 SHA512:
-  metadata.gz: 94f9e21eec63f75e68802a9e7b881ece8925d639c58068289a98e327c4b174061f9e5c3e4e0deaae158163fca87dc66914ac421f758c7ccc36b2ab1e5941c23a
-  data.tar.gz: f279474c03b69be2619384c31cda734dd836a9e5171acbdf34f443d3c2e2c5f17638d9adede9265e6006e5ecb9f52b4510f71292a7c7612642c3d2639e7780c5
+  metadata.gz: eaee6b87986d514a069f07c5f15a1b42b0d3df9e4fc3865069cea4268319566df49dd107893af8be047dbc117659e92231c5bede60311d6cd4d9b67d86edfe18
+  data.tar.gz: d1702cfa15dc126229ac95b00b9b7bf07c0bc03c81b48da1d206cf16006c2bab78707d4eda25e04903262686f5430e5684d45755233c72c207202f0ffebc6df2

data/README.md

@@ -223,6 +223,27 @@ Delete the id to 1
       ]
     }
 
+### reserved word (v0.1.13~)
+
+We are using the following as a reserved word.
+
+- count
+- page
+- order
+- orderby
+
+It can not be used as a column name in the database.
+
+But, you can be avoided by specifying the prefix.
+
+    class User < ActiveRecord::Base
+      @reserved_word_prefix = '_'
+    end
+
+You can request as follows in doing so
+
+    GET   /users.json?_count=10&_page=2
+
 ### Override
 
 You can corresponding to the logical deletion, if you want to search condition to like and or, you will be able to override the processing in the Model

data/lib/baseapi/active_record/base_extension.rb

@@ -1,5 +1,7 @@
 module ActiveRecordBaseExtension extend ActiveSupport::Concern
 
+  @reserved_word_prefix = ''
+
   # override if necessary
   def _destroy
     destroy
@@ -7,6 +9,12 @@ module ActiveRecordBaseExtension extend ActiveSupport::Concern
 
   module ClassMethods
 
+    # reserved word prefix(count,page,order,orderby...)
+    # @return String
+    def get_reserved_word_prefix
+      @reserved_word_prefix
+    end
+
     # override if necessary
     # @return ActiveRecordRelation
     def _all

data/lib/baseapi/active_record/relation_extension.rb

@@ -16,24 +16,24 @@ module ActiveRecordRelationExtension
           models = self.model.send(function_name, models, key, values)
         # belongs_to, has_many search
         else
-          relationSearch = -> (models, currentModel, key, value, prifix = '', joins = []) {
+          relationSearch = -> (models, currentModel, key, value, prefix = '', joins = []) {
             joins.push key
             associations = currentModel.get_associations()
             associations.keys.each do |association|
               if currentModel.column_names.include?(key)
                 # call function
-                function_name = self.model.methods.include?("_#{prifix}_#{joins.join('_')}".to_sym) ? "_#{prifix}_#{joins.join('_')}" : "_#{prifix}"
+                function_name = self.model.methods.include?("_#{prefix}_#{joins.join('_')}".to_sym) ? "_#{prefix}_#{joins.join('_')}" : "_#{prefix}"
                 table_name = currentModel.name.underscore
                 hash = {key => value}
                 return self.model.send(function_name, models, table_name, hash)
               elsif associations[association].include?(key)
-                # prifix = first association
-                prifix = association if prifix == ''
+                # prefix = first association
+                prefix = association if prefix == ''
                 models.joins_array!(joins)
                 currentModel = key.camelize.singularize.constantize
                 value.each do |k, v|
                   # this fnuction collback
-                  models = relationSearch.call(models, currentModel, k, v, prifix, joins)
+                  models = relationSearch.call(models, currentModel, k, v, prefix, joins)
                 end
               end
             end
@@ -49,8 +49,9 @@ module ActiveRecordRelationExtension
   # 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;
+    prefix = self.model.get_reserved_word_prefix
+    count = params["#{prefix}count".to_sym].present? ? params["#{prefix}count".to_sym].to_i : -1;
+    page = params["#{prefix}page".to_sym].present? ? params["#{prefix}page".to_sym].to_i : 1;
     if count > 0
       if count.present? and count
         limit!(count)
@@ -64,8 +65,9 @@ module ActiveRecordRelationExtension
   # sort
   # @param  Hash    params
   def sorting!(params)
-    if params[:order].present? and params[:orderby].present?
-      order!({params[:orderby] => params[:order]})
+    prefix = self.model.get_reserved_word_prefix
+    if params["#{prefix}order".to_sym].present? and params["#{prefix}orderby".to_sym].present?
+      order!({params["#{prefix}orderby".to_sym] => params["#{prefix}order".to_sym]})
     end
   end
 

data/lib/baseapi/version.rb

@@ -1,3 +1,3 @@
 module Baseapi
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baseapi
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Moriyuki Arakawa