apique 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c185ec939c0e1327ab39f7a28e5c0d35c3638eb6
-  data.tar.gz: 446dbe26222728a725f071ff1682a40090f0178a
+  metadata.gz: 5ee5c5d499ded1ebb2f79cdc449d84223d09c9b6
+  data.tar.gz: d0d2b475eb89a5aec8f5f571fb471548dd03f299
 SHA512:
-  metadata.gz: f522d9cedae7c11e5b1dbe3cf275435bb32141398c9648963352da0cb94daafff6d97918a3dbc99d9c4819f1e000d3dfc24948a332ce24d23944f6316f69ee20
-  data.tar.gz: 0194de1b634a6045f269945e9851c106ecde80358632bcb3f038bfb680547c02cf3ca7ec8b81098e727335429d52ead576350d9bf2bec511b3a4e9c81f439f84
+  metadata.gz: 27dc8bfbfbf4dd6571865895d3da2fc6815b7db7544726e5f706d6515e01a77f9e7f9842ccdb19cd66ca4868b307d7d273ca487901abf1d37974730cc6c46d47
+  data.tar.gz: b1fe4d5183fb1ee8fcd599c8f107bd171217848c97b12418ce7b087f6acbf114af7399222fd87105719371257a575b5480ed33fb6924865a6b5b331f52d5b125

data/lib/apique/basics.rb

@@ -3,12 +3,12 @@ module Apique::Basics
   extend ActiveSupport::Concern
   
   included do
-    protect_from_forgery with: :null_session
-  
     before_action :authorize_access
     
-    rescue_from CanCan::AccessDenied do |e|
-      render json: {error: e.message}, status: :forbidden
+    if defined? CanCan
+      rescue_from CanCan::AccessDenied do |e|
+        render json: {error: e.message}, status: :forbidden
+      end
     end
     
     rescue_from NotImplementedError do |e|
@@ -39,13 +39,13 @@ module Apique::Basics
   # The plural name of the ORM class.
   # @return [String]
   def collection_name
-    @collection_name ||= params[:model]
+    @collection_name ||= params[:model] || controller_name.underscore.tr('/', '~')
   end
 
   # The ORM class of the resource.
   # @return [Class]
   def resource_class
-    @resource_class ||= collection_name.singularize.classify.constantize
+    @resource_class ||= collection_name.singularize.tr('~', '/').classify.constantize
   end
   
 end

data/lib/apique/filterable.rb

@@ -15,6 +15,9 @@ module Apique::Filterable
     params_types['q'] = [String, Hash]
   end
   
+  UUID_RE = /^[a-f\d]{8}(-[a-f\d]{4}){3}-[a-f\d]{12}$/
+  BOOL_RE = /^(true|false|t|f)$/
+  ISO8601_RE = /^\d{4}(-\d\d){2}T\d\d(:\d\d){2}(\.\d+)?Z([+-]\d\d:\d\d)?$/
   
   private
   
@@ -58,29 +61,55 @@ module Apique::Filterable
           # A call to a scope. A method must be defined as a scope to work on another ORM relation.
           collection = collection.public_send "search_by_#{k}", v
         else
-          is_text = [ActiveRecord::Type::String, ActiveRecord::Type::Text].include? resource_class.columns.find {|i| i.name == k}.cast_type
-          
-          if k =~ /_or_/
-            fields = k.split('_or_')
-            
-            if is_text
-              collection = collection.where [
-                fields.map {|i| "#{i} ILIKE ?"} * ' OR ',
-                *(["%#{v}%"] * fields.size)
-              ]
-            else
-              collection = collection.where [
-                fields.map {|i| "#{i} = ?"} * ' OR ',
-                *([v] * fields.size)
-              ]
-            end
-          else
-            if is_text
-              collection = collection.where ["#{k} ILIKE ?", "%#{v}%"]
-            else
-              collection = collection.where k => v
+          conditions = k.split('_or_').map do |k|
+            case get_cast_type(k)
+            when :text
+              if v.is_a? Array
+                ["#{k} IN (?)", v.select(&:present?)]
+              else
+                ["#{k} ILIKE ?", "%#{v}%"]
+              end
+            when :integer
+              if v.is_a? Hash
+                [:from, :to].each {|x| v[x] &&= v[x].to_i}
+                from_to_statement(k, v)
+              elsif enum_map = resource_class.defined_enums[k.to_s]
+                if v.is_a? Array
+                  ["#{k} IN (?)", v.map {|vi| enum_map[vi]}]
+                else
+                  ["#{k} = ?", enum_map[v]]
+                end
+              else
+                if v.is_a? Array
+                  ["#{k} IN (?)", v.map(&:to_i)]
+                else
+                  ["#{k} = ?", v.to_i]
+                end
+              end
+            when :uuid
+              if v.is_a? Array
+                ["#{k} IN (?)", v.select {|vi| v =~ UUID_RE}]
+              else
+                if v =~ UUID_RE
+                  ["#{k} = ?", v]
+                end
+              end
+            when :boolean
+              if v =~ BOOL_RE
+                ["#{k} = ?", v]
+              end
+            when :datetime
+              [:from, :to].each {|x| v.delete x if v[x] !~ ISO8601_RE}
+              from_to_statement(k, v)
             end
+          end.compact
+          
+          if conditions.blank?
+            collection = collection.none
+            break
           end
+          
+          collection = collection.where conditions.map(&:first)*' OR ', *conditions.map(&:last)
         end
       end
       
@@ -88,4 +117,39 @@ module Apique::Filterable
     end
   end
   
+  if ActiveRecord::VERSION::MAJOR >= 5
+    def get_cast_type_class(field)
+      resource_class.columns.find {|i| i.name == field}.instance_variable_get(:@cast_type).class
+    end
+  else
+    def get_cast_type_class(field)
+      resource_class.columns.find {|i| i.name == field}.cast_type
+    end
+  end
+  
+  def get_cast_type(field)
+    type = get_cast_type_class(field)
+    if [ActiveModel::Type::String, ActiveModel::Type::Text].find {|k| type <= k}
+      :text
+    elsif type <= ActiveModel::Type::Integer
+      :integer
+    elsif type <= ActiveModel::Type::Boolean
+      :boolean
+    elsif type <= ActiveModel::Type::DateTime
+      :datetime
+    elsif type <= ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Uuid
+      :uuid
+    end
+  end
+  
+  def from_to_statement(k, v)
+    if v[:from].present? and v[:to].present?
+      ["#{k} BETWEEN ? AND ?", v[:from], v[:to]]
+    elsif v[:from].present?
+      ["#{k} >= ?", v[:from]]
+    elsif v[:to].present?
+      ["#{k} <= ?", v[:to]]
+    end
+  end
+  
 end

data/lib/apique/listable.rb

@@ -7,9 +7,17 @@ module Apique::Listable
     # [Hash: param_key_string => {:desc, :example}]
     class_attribute :params_usage
     self.params_usage = {}
+    params_usage['f'] = {
+      desc: "f [String] serialize the collection in a specific format (optional)"
+    }
+    params_usage['j'] = {
+      desc: "j [Array<String>] join a set of relations (optional)"
+    }
     # [Hash: param_key_string => param_types_array]
     class_attribute :params_types
     self.params_types = {}
+    params_types['f'] = [String]
+    params_types['j'] = [Array]
     
     helper_method :subject_collection
   
@@ -23,7 +31,7 @@ module Apique::Listable
   
   # Exception will raise if a request query would contain an incorrect of malformed parameter.
   # This will provide the front-end with a description of the correct API usage.
-  class Apique::MalformedParameters < Exception
+  class ::Apique::MalformedParameters < Exception
     
     def initialize(request, param, params_usage, *args)
       message = "Bad request query: malformed parameter #{param}"
@@ -48,6 +56,7 @@ module Apique::Listable
   
   # GET /api/{plural_resource_name}
   def index
+    join_relations!
     if respond_to? :filter_collection!, true
       filter_collection!
     end
@@ -57,18 +66,24 @@ module Apique::Listable
     if respond_to? :paginate_collection!, true
       paginate_collection!
     end
-    render json: subject_collection
+    render json: subject_collection, apique_format: params[:f] || 'default'
   end
   
   
   private
   
   ### Basic getters-setters ###
+  
+  # The name of ivar to cache the filtered collection.
+  # @return [String]
+  def collection_variable_name
+    @collection_variable_name ||= "@#{collection_name.tr('~', '_')}"
+  end
 
   # Returns the collection from the created instance variable.
   # @return [DB collection proxy]
   def get_collection
-    instance_variable_get("@#{collection_name}") || set_collection
+    instance_variable_get(collection_variable_name) || set_collection
   end
   
   # Used as a helper to create DRYed json builders in inheritable controllers.
@@ -77,13 +92,20 @@ module Apique::Listable
   # Puts the collection into an instance variable.
   # In most cases, the collection exactly allowed for the user by CanCan rules should be an entry point.
   # @return [DB collection proxy]
-  def set_collection(collection = resource_class.accessible_by(current_ability))
-    instance_variable_set("@#{collection_name}", collection)
+  def set_collection(collection = defined?(CanCan) ? resource_class.accessible_by(current_ability) : resource_class.all)
+    instance_variable_set(collection_variable_name, collection)
   end
   
   
   ### Whitelists ###
   
+  # @virtual
+  # Pattern method for relations a user can join. Add whitelisting logic in a descendant using `super`.
+  # @return [ActionController::Parameters]
+  def join_params
+    params[:j].presence || ActionController::Parameters.new
+  end
+  
   # Check consistency of a query parameters for a list. Use it as a before filter if needed.
   # @raise [MalformedParameters] if the request query is malformed.
   def validate_query
@@ -100,4 +122,19 @@ module Apique::Listable
     end
   end
   
+  
+  ### Collection filters ###
+  
+  # Join (eager load) to the current collection the references specified by params[:j]
+  # @return [DB collection proxy]
+  def join_relations!
+    collection = get_collection
+    
+    if join_params.present?
+      collection = collection.includes(*join_params)
+    end
+    
+    set_collection collection
+  end
+  
 end

data/lib/apique/pickable.rb

@@ -31,11 +31,17 @@ module Apique::Pickable
   def resource_name
     @resource_name ||= collection_name.singularize
   end
+  
+  # The name of ivar to cache the picked resource.
+  # @return [String]
+  def resource_variable_name
+    @resource_variable_name ||= "@#{resource_name.tr('~', '_')}"
+  end
 
   # Returns the resource from the created instance variable.
   # @return [Object]
   def get_resource
-    instance_variable_get("@#{resource_name}") || set_resource
+    instance_variable_get(resource_variable_name) || set_resource
   end
   
   # Used as a helper to create DRYed json builders in inheritable controllers.
@@ -50,7 +56,7 @@ module Apique::Pickable
       raise RecordNotFound, "could not find a record of type #{resource_class} with id = #{params[:id]}"
     end
     
-    instance_variable_set("@#{resource_name}", resource)
+    instance_variable_set(resource_variable_name, resource)
   end
   
 end

data/lib/apique/sortable.rb

@@ -41,7 +41,7 @@ module Apique::Sortable
       end
     end
     if collection.order_values.blank?
-      collection = collection.order "id desc"
+      collection = collection.order "#{resource_class.primary_key} desc"
     end
     
     set_collection collection

data/lib/apique/version.rb

@@ -1,3 +1,3 @@
 module Apique
-  VERSION = "1.0.0"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apique
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Sergey Baev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler