api_resource 0.6.17 → 0.6.18

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eecd2283b1df3b5e9cbbebdeded82ac62eadaf57
+  data.tar.gz: b12734c1fb1b5dcabe606f704d9b7d6ab9628ba0
+SHA512:
+  metadata.gz: 369173ff08a0384adc0b89891033668c84a66c3a1f2a92c822fb84b33e98eb968474239881cbb54f12f73b68dbafb0e9c00031a1bfe10a9b9820740a128143b2
+  data.tar.gz: 0d454b872616d96c7aa3952cfbbccffdc96f0df84b97d2d03ef4e7fc5126d499de774bac08e2d2f8adfadf207744f2885fd47d04f9b06b4c26e33319b94af38a

data/lib/api_resource/finders.rb

@@ -29,112 +29,45 @@ module ApiResource
         # make sure we have class data before loading
         self.load_resource_definition
 
-        # Conditions sometimes call find, passing themselves as the last arg.
-        if arguments.last.is_a?(ApiResource::Conditions::AbstractCondition)
-          cond  = arguments.slice!(arguments.length - 1) 
-        else
-          cond  = nil
-        end
-
-        # Support options being passed in as a hash.
-        options = arguments.extract_options! || {}
-
-        # Remaining arguments are the scope.
-        scope   = arguments
+        initialize_arguments!(arguments)
 
         # TODO: Make this into a class attribute properly (if it isn't already)
         # this is a little bit of a hack because options can sometimes be a Condition
-        expiry = (options.is_a?(Hash) ? options.delete(:expires_in) : nil) || ApiResource::Base.ttl || 0
+        expiry = @expiry
         ApiResource.with_ttl(expiry.to_f) do
-
-          # If we have a condition or options to process...
-          if cond || options.present?
-
-            # Convert options hash to scope condition.
-            if options.is_a?(Hash)
-              opts = options.with_indifferent_access.delete(:params) || options || {}
-              options = ApiResource::Conditions::ScopeCondition.new(opts, self)
-            end
-
-            # Combine all combinations of conditions and options
-            if cond
-              if options
-                final_cond = cond.merge!(options)
-              else
-                final_cond = cond
-              end
-            elsif options
-              final_cond = options
-            end
-
-            # If we have one argument, it's either a word argument
-            # like first, last, or all, or its a number.
-            if Array.wrap(scope).size == 1
-              scope = scope.first if scope.is_a?(Array)
-
-              # Create the finder with the conditions, then call the scope.
-              # e.g. Class.scope(1).first
-              if [:all, :first, :last].include?(scope)
-                fnd = ApiResource::Finders::ResourceFinder.new(self, final_cond)
-                fnd.send(scope)
-
+          if numeric_find
+            if single_find && (@conditions.blank_conditions? || include_associations_only?)
               # If we have no conditions or they are only prefixes or
-              # includes,and only one argument (not a word) then we 
+              # includes, and only one argument (not a word) then we 
               # only have a single item to find.
-              # e.g. Class.includes.find(1)
-              elsif final_cond.blank_conditions? || final_cond.conditions.include?(:foreign_key_id)
-                scope = scope.first if scope.is_a?(Array)
-                final_cond = final_cond.merge!(ApiResource::Conditions::ScopeCondition.new({:id => scope}, self))
-
-                ApiResource::Finders::SingleFinder.new(self, final_cond).load
-              else
-
-                # Otherwise we are chaining a find onto
-                # the end of a set of conditions.
-                # e.g. Class.scope(1).find(1)
-                fnd = final_cond.merge!(ApiResource::Conditions::ScopeCondition.new({:find => {:ids => scope}}, self))
-                fnd.send(:all)
-              end
+              # e.g. Class.includes(:association).find(1)
+              #      Class.find(1)
+              @scope = @scope.first if @scope.is_a?(Array)
+              final_cond = @conditions.merge!(ApiResource::Conditions::ScopeCondition.new({:id => @scope}, self))
 
+              ApiResource::Finders::SingleFinder.new(self, final_cond).load
             else
+              # e.g. Class.scope(1).find(1)
+              #      Class.includes(:association).find(1,2)
+              #      Class.find(1,2)
+              #      Class.active.find(1)
+              if Array.wrap(@scope).size == 1 && @scope.is_a?(Array)
+                @scope = @scope.first
+              end
 
-              # We are searching for multiple ids.
-              # e.g. Class.scope(1).find(1,2)
-              fnd = final_cond.merge!(ApiResource::Conditions::ScopeCondition.new({:find => {:ids => scope}}, self))
+              fnd = @conditions.merge!(ApiResource::Conditions::ScopeCondition.new({:find => {:ids => @scope}}, self))
               fnd.send(:all)
             end
-
           else
+            # e.g. Class.scope(1).first
+            #      Class.first
+            @scope = @scope.first if @scope.is_a?(Array)
+            new_condition = @scope == :all ? {} : {@scope => true}
 
-            # No conditions
-            if Array.wrap(scope).size == 1
-              scope = scope.first if scope.is_a?(Array)
-
-              # We are calling first, last, or all on the class itself.
-              # e.g. Class.first
-              if [:all, :first, :last].include?(scope)
-                final_cond = ApiResource::Conditions::ScopeCondition.new({scope => true}, self)
-
-                fnd = ApiResource::Finders::ResourceFinder.new(self, final_cond)
-                fnd.send(scope)
-              else
-
-                # We are performing a simple find of a single object
-                # e.g. Class.find(1)
-                scope = scope.first if scope.is_a?(Array)
-                final_cond = ApiResource::Conditions::ScopeCondition.new({:id => scope}, self)
-
-                ApiResource::Finders::SingleFinder.new(self, final_cond).load
-              end
-
-            else
-              # We are performing a find on multiple objects
-              # e.g. Class.find(1,2)
-              ApiResource::Conditions::ScopeCondition.new({:find => {:ids => scope}}, self)
-              fnd.send(:all)
-
-            end
+            final_cond = @conditions.merge!ApiResource::Conditions::ScopeCondition.new(new_condition, self)
 
+            fnd = ApiResource::Finders::ResourceFinder.new(self, final_cond)
+            fnd.send(@scope)
           end
 
         end
@@ -179,7 +112,97 @@ module ApiResource
         ret
       end
 
-		end 
+      protected
+
+      def arg_ary
+        if @scope.blank?
+          return :none
+        elsif Array.wrap(@scope).size == 1
+          return :single
+        else
+          return :multiple
+        end
+      end
+
+      def arg_type
+        arg = Array.wrap(@scope).first
+
+        case arg
+          when :first, :last
+            :bookend
+          when :all
+            :all_records
+          else
+            :number
+        end
+      end
+
+      def numeric_find
+        arg_type == :number
+      end
+
+      def single_find
+        return arg_ary == :single
+      end
+
+      def initialize_arguments!(args)
+
+        args = Array.wrap(args)
+
+        # Conditions sometimes call find, passing themselves as the last arg.
+        if args.last.is_a?(ApiResource::Conditions::AbstractCondition)
+          cond  = args.slice!(args.length - 1) 
+        else
+          cond  = nil
+        end
+
+        # Support options being passed in as a hash.
+        options = args.extract_options!
+        if options.blank?
+          options = nil
+        end
+
+        @expiry = (options.is_a?(Hash) ? options.delete(:expires_in) : nil) || ApiResource::Base.ttl || 0
+
+        combine_conditions(options, cond)
+
+        # Remaining args are the scope.
+        @scope   = args
+      end
+
+      def combine_conditions(options, condition)
+        # Convert options hash to scope condition.
+        if options.is_a?(Hash)
+          opts = options.with_indifferent_access.delete(:params) || options || {}
+          options = ApiResource::Conditions::ScopeCondition.new(opts, self)
+        end
+
+        final_cond = ApiResource::Conditions::ScopeCondition.new({}, self)
+        # Combine all combinations of conditions and options
+        if condition
+          if options
+            final_cond = condition.merge!(options)
+          else
+            final_cond = condition
+          end
+        elsif options
+          final_cond = options
+        end
+
+        @conditions = final_cond
+      end
+
+      def include_associations_only?
+        if @conditions.blank_conditions?
+          return false
+        else
+          return @conditions.conditions.include?(:foreign_key_id) &&
+            @conditions.conditions.size == 1
+        end
+      end
+
+    end
+
 	end
 
 end

data/lib/api_resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = "0.6.17"
+  VERSION = "0.6.18"
 end

data/spec/lib/finders_spec.rb

@@ -53,6 +53,25 @@ describe ApiResource::Finders do
 		val.should be_a(TestResource)
 	end
 
+	it "should pass first and last as params" do
+		TestResource.connection.expects(:get)
+			.with("/test_resources.json?first=true")
+
+		val = TestResource.first
+
+		TestResource.connection.expects(:get)
+			.with("/test_resources.json?last=true")
+
+		val = TestResource.last
+	end
+
+	it "should not pass all as a param, even when all records are requested" do
+		TestResource.connection.expects(:get)
+			.with("/test_resources.json")
+
+		val = TestResource.all
+	end
+
 	it "should be able to chain find on top of an includes call" do
 		TestResource.connection.expects(:get).with("/test_resources/1.json").returns({"id" => 1, "has_many_object_ids" => [1,2]})
 		HasManyObject.connection.expects(:get).with("/has_many_objects.json?ids%5B%5D=1&ids%5B%5D=2").returns([])

data/spec/lib/prefixes_spec.rb

@@ -50,7 +50,7 @@ describe "With Prefixes" do
     it "should use the prefix to find records" do
       prefix_model.send(:connection).expects(:get)
         .with(
-          "/foreign/123/prefix_models.json"
+          "/foreign/123/prefix_models.json?first=true"
         )
         .returns([])
       PrefixModel.first(:params => {:foreign_key_id => 123})

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_resource
 version: !ruby/object:Gem::Version
-  version: 0.6.17
-  prerelease: 
+  version: 0.6.18
 platform: ruby
 authors:
 - Ethan Langevin
@@ -11,76 +10,67 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: spork
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yarjuf
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -88,7 +78,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -96,289 +85,253 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-spork
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hash_dealer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: differ
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A replacement for ActiveResource for RESTful APIs that handles associated
@@ -494,27 +447,26 @@ files:
 - spec/tmp/DIR
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ActiveRecord for restful APIs
 test_files:
 - spec/lib/api_resource_spec.rb