standardapi 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcce074ca51a9c5d78cc73fee9c8849b54216100
-  data.tar.gz: 39e43f30d1541ada3c5d4e9fe8b8955fd2f3c677
+  metadata.gz: cb2bcb0df75b9410634d0fec29e4391a6830ba3e
+  data.tar.gz: 9ef3bc3fd6e4b4d7d5d704ae09255f20182bb04d
 SHA512:
-  metadata.gz: bf58c08c89b8585923f6328de5a1cdd48cf49c8b8edf14dcc72b682ee4275172b7b91e4174302fe29eb6e76c78f9c5c0aa8b93a05f2df14193959f5e41ca9b88
-  data.tar.gz: ec704819998b18aa742caa6d30d1a6b4d9403cfba95c46cc64e24ccfec0a8585647db6f821e61c87a96989887e8eed4d73bf356605f31007cb1754e92013d407
+  metadata.gz: e3ef2868b977624aa84a784020647292d90baa82fc98bf4c34a25fc86c32138b6c6d4c7e902f339f2b54532513ebb9ca4f10c385add0a42a5dfda4031fc02040
+  data.tar.gz: dbfd5941419c1a41fb27d96407a7e98855e8f790a6132fbefe7f54b27ad68de6f70369ff5c471ef0ea49505b6529fad78aafbf93dc885a3ce1fb4b039f73b806

data/lib/standard_api.rb

@@ -6,11 +6,13 @@ require 'jbuilder'
 require 'jbuilder/railtie'
 require 'active_record/filter'
 require 'active_record/sort'
+require 'active_support/core_ext/hash/indifferent_access'
 
 if !ActionView::Template.registered_template_handler(:jbuilder)
   ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
 end
 
+require 'standard_api/orders'
 require 'standard_api/includes'
 
 module StandardAPI
@@ -88,49 +90,11 @@ module StandardAPI
   end
 
   def includes
-    @includes ||= StandardAPI::Includes.normalize(params[:include] || [])
+    @includes ||= StandardAPI::Includes.normalize(params[:include])
   end
 
-  # TODO: sanitize orders
   def orders
-    normalized_order(params[:order])
-  end
-
-  def normalized_order(orderings)
-    return nil if orderings.nil?
-
-    orderings = Array(orderings)
-
-    orderings.map! do |order|
-      if order.is_a?(Symbol) || order.is_a?(String)
-        order = order.to_s
-        if order.index(".")
-          relation, column = order.split('.').map(&:to_sym)
-          { relation => [column] }
-        else
-          order.to_sym
-        end
-      elsif order.is_a?(Hash)
-        normalized_order = {}
-        order.each do |key, value|
-          key = key.to_s
-
-          if key.index(".")
-            relation, column = key.split('.').map(&:to_sym)
-            normalized_order[relation] ||= []
-            normalized_order[relation] << { column => value }
-          elsif value.is_a?(Hash) && value.keys.first.to_s != 'desc' && value.keys.first.to_s != 'asc'
-            normalized_order[key.to_sym] ||= []
-            normalized_order[key.to_sym] << value
-          else
-            normalized_order[key.to_sym] = value
-          end
-        end
-        normalized_order
-      end
-    end
-
-    orderings
+    @orders ||= params[:order]
   end
 
   # Used in #calculate

data/lib/standard_api/includes.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/hash/indifferent_access'
-# require 'active_support/core_ext/hash'
 module StandardAPI
   module Includes
 
@@ -17,6 +15,8 @@ module StandardAPI
         includes.flatten.compact.each { |v| normalized.merge!(normalize(v)) }
       when Hash
         includes.each_pair { |k, v| normalized[k] = normalize(v) }
+      when nil
+        {}
       else
         if ![true, 'true'].include?(includes)
           normalized[includes] = {}
@@ -33,8 +33,8 @@ module StandardAPI
     # sanitize({:key => {:value => {}}}, {:key => [:value]}) # => {:key => {:value => {}}}
     # sanitize({:key => {:value => {}}}, {:key => {:value => true}}) # => {:key => {:value => {}}}
     # sanitize({:key => {:value => {}}}, [:key]) => # Raises ParseError
-    def self.sanitize(includes, permit)
-      includes = normalize(includes)
+    def self.sanitize(includes, permit, normalized=false)
+      includes = normalize(includes) if !normalized
       permitted = ActiveSupport::HashWithIndifferentAccess.new
 
       if permit.is_a?(Array)
@@ -44,7 +44,7 @@ module StandardAPI
       permit = normalize(permit.with_indifferent_access)
       includes.each do |k, v|
         if permit.has_key?(k) || ['where', 'order'].include?(k.to_s)
-          permitted[k] = sanitize(v, permit[k] || {})
+          permitted[k] = sanitize(v, permit[k] || {}, true)
         else
           if [:raise, nil].include?(Rails.configuration.try(:action_on_unpermitted_includes))
             raise(ActionDispatch::ParamsParser::ParseError.new(<<-ERR.squish, nil))

data/lib/standard_api/orders.rb

@@ -0,0 +1,85 @@
+module StandardAPI
+  module Orders
+
+    # # :size                               => [:size]
+    # # { :size => :asc }                   => [{:size => :asc}]
+    # # { :size => :desc }                  => [{:size => :desc}]
+    # # {:size => {:desc => :nulls_first}}  => [{:size => {:desc => :nulls_first}}]
+    # # [:size, :id]                        => [:size, :id]
+    # # { :size => :asc, :id => :desc }     => [{ :size => :asc, :id => :desc }]
+    # # 'listings.size'                     => [{:listings => [:size]}]
+    # # { 'listings.size' => :asc }         => [{:listings => [{:size => :asc}]}]
+    # # { 'listings.size' => :desc }        => [{:listings => [{:size => :desc}]}]
+    # # ['listings.size', 'property.id']    => [{:listings => [:size]}, {:property => [:id]}]
+    # # { 'size' => :asc, 'property.id' => :desc } => [{:size => :asc}, {:property => [{:id => :desc}]}]
+    # # { :size => {:asc => :nulls_first}, 'property.id' => {:desc => :null_last} } => [{:size => {:asc => :nulls_first}}, {:property => [{:id => {:desc => :nulls_first}}]}]
+    # def self.normalize(orderings)
+    #   return nil if orderings.nil?
+    #   orderings = orderings.is_a?(Array) ? orderings : [orderings]
+    #
+    #   orderings.map! do |order|
+    #     case order
+    #     when Hash
+    #       normalized = ActiveSupport::HashWithIndifferentAccess.new
+    #       order.each do |key, value|
+    #         key = key.to_s
+    #         if key.index(".")
+    #           relation, column = key.split('.').map(&:to_sym)
+    #           normalized[relation] ||= []
+    #           normalized[relation] << { column => value }
+    #         elsif value.is_a?(Hash) && value.keys.first.to_s != 'desc' && value.keys.first.to_s != 'asc'
+    #           normalized[key.to_sym] ||= []
+    #           normalized[key.to_sym] << value
+    #         else
+    #           normalized[key.to_sym] = value
+    #         end
+    #       end
+    #       normalized
+    #     else
+    #       order = order.to_s
+    #       if order.index(".")
+    #         relation, column = order.split('.').map(&:to_sym)
+    #         { relation => [column] }
+    #       else
+    #         order.to_sym
+    #       end
+    #     end
+    #   end
+    # end
+
+    def self.sanitize(orders, permit, normalized=false)
+      return nil if orders.nil?
+
+      permit = [permit] if !permit.is_a?(Array)
+      permit = permit.flatten.map { |x| x.is_a?(Hash) ? x.with_indifferent_access : x.to_s }
+      permitted = []
+
+      case orders
+      when Hash
+        orders.each do |key, value|
+          if permit.include?(key.to_s)
+            value = value.symbolize_keys if value.is_a?(Hash)
+            permitted = { key.to_sym => value }
+          elsif permit.find { |x| x.is_a?(Hash) && x.has_key?(key.to_s) }
+            subpermit = permit.find { |x| x.is_a?(Hash) && x.has_key?(key.to_s) }[key.to_s]
+            sanitized_value = sanitize(value, subpermit, true)
+            permitted = { key.to_sym => sanitized_value }
+          else
+            raise(ActionDispatch::ParamsParser::ParseError.new("Invalid Ordering #{orders.inspect}", nil))
+          end
+        end
+      when Array
+        orders.each { |order| permitted << sanitize(order, permit, true); }
+      else
+        if permit.include?(orders.to_s)
+          permitted = orders
+        else
+          raise(ActionDispatch::ParamsParser::ParseError.new("Invalid Ordering #{orders.inspect}", nil))
+        end
+      end
+
+      permitted
+    end
+
+  end
+end

data/lib/standard_api/test_case.rb

@@ -38,8 +38,8 @@ module StandardAPI::TestCase
     self.class.model
   end
 
-  def create_model(attrs={})
-    create(model.name.underscore, attrs)
+  def create_model(*args)
+    create(model.name.underscore, *args)
   end
 
   def singular_name

data/lib/standard_api/test_case/index_tests.rb

@@ -24,6 +24,7 @@ module StandardAPI
 
       test '#index.json params[:order]' do
         orders.each do |order|
+          @controller.instance_variable_set('@orders', nil) # Hack for dealing with caching / multiple request per controller life
           if order.is_a?(Hash)
             order.values.last.each do |o|
               get :index, order: {order.keys.first => o}, format: 'json'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-sort
@@ -190,6 +190,7 @@ files:
 - README.md
 - lib/standard_api.rb
 - lib/standard_api/includes.rb
+- lib/standard_api/orders.rb
 - lib/standard_api/test_case.rb
 - lib/standard_api/test_case/calculate_tests.rb
 - lib/standard_api/test_case/create_tests.rb