api_resource 0.6.18 → 0.6.19

data/lib/api_resource/connection.rb

@@ -1,5 +1,5 @@
 require 'active_support/core_ext/benchmark'
-require 'rest_client'
+require 'httpclient'
 require 'net/https'
 require 'date'
 require 'time'
@@ -51,7 +51,7 @@ module ApiResource
       @timeout = timeout
     end
 
-     # make a put request
+     # make a get request
      # @return [String] response.body raises an
      #   ApiResource::ConnectionError if we
      #   have a timeout, general exception, or
@@ -62,7 +62,7 @@ module ApiResource
       headers = build_request_headers(headers, :get, site)
 
       self.with_caching(path, headers) do
-        format.decode(request(:get, path, headers))
+        format.decode(request(:get, path, {}, headers))
       end
     end
 
@@ -84,7 +84,7 @@ module ApiResource
       response = request(
         :put,
         path,
-        body,
+        format.encode(body),
         build_request_headers(headers, :put, self.site.merge(path))
       )
       # handle blank response and return true
@@ -111,7 +111,7 @@ module ApiResource
         request(
           :post,
           path,
-          body,
+          format.encode(body),
           build_request_headers(headers, :post, self.site.merge(path))
         )
       )
@@ -143,13 +143,18 @@ module ApiResource
       #   if result.code is not within 200..399
       def request(method, path, *arguments)
         handle_response(path) do
+          unless path =~ /\./
+            path += ".#{self.format.extension}"
+          end
           ActiveSupport::Notifications.instrument("request.api_resource") do |payload|
-
             # debug logging
             ApiResource.logger.info("#{method.to_s.upcase} #{site.scheme}://#{site.host}:#{site.port}#{path}")
             payload[:method]      = method
             payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
-            payload[:result]      = http(path).send(method, *arguments)
+            payload[:result]      = http.send(
+                                      method,
+                                      "#{site.scheme}://#{site.host}:#{site.port}#{path}",
+                                      *arguments)
           end
         end
       end
@@ -158,7 +163,7 @@ module ApiResource
       def handle_response(path, &block)
         begin
           result = yield
-        rescue RestClient::RequestTimeout
+        rescue HTTPClient::TimeoutError
           raise ApiResource::RequestTimeout.new("Request Time Out - Accessing #{path}}")
         rescue Exception => error
           if error.respond_to?(:http_code)
@@ -207,11 +212,16 @@ module ApiResource
 
       # Creates new Net::HTTP instance for communication with the
       # remote service and resources.
-      def http(path)
-        unless path =~ /\./
-          path += ".#{self.format.extension}"
+      def http
+        # TODO: Deal with proxies and such
+        unless @http
+          @http = HTTPClient.new
+          # TODO: This should be on the class level
+          @http.connect_timeout = ApiResource::Base.open_timeout
+          @http.receive_timeout = ApiResource::Base.timeout
         end
-        RestClient::Resource.new("#{site.scheme}://#{site.host}:#{site.port}#{path}", {:timeout => ApiResource::Base.timeout, :open_timeout => ApiResource::Base.open_timeout})
+
+        return @http
       end
 
       def build_request_headers(headers, verb, uri)

data/lib/api_resource/finders.rb

@@ -13,9 +13,9 @@ module ApiResource
 
 		module ClassMethods
 
-   	# This decides which finder method to call. 
+   	# This decides which finder method to call.
       # It accepts arguments of the form "scope", "options={}"
-      # where options can be standard rails options or :expires_in. 
+      # where options can be standard rails options or :expires_in.
       # If :expires_in is set, it caches it for expires_in seconds.
 
       # Need to support the following cases
@@ -36,13 +36,12 @@ module ApiResource
         expiry = @expiry
         ApiResource.with_ttl(expiry.to_f) do
           if numeric_find
-            if single_find && (@conditions.blank_conditions? || include_associations_only?)
+            if single_find && (@conditions.blank_conditions? || nested_find_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(: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
@@ -51,17 +50,12 @@ module ApiResource
               #      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
-
               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}
 
             final_cond = @conditions.merge!ApiResource::Conditions::ScopeCondition.new(new_condition, self)
@@ -69,7 +63,6 @@ module ApiResource
             fnd = ApiResource::Finders::ResourceFinder.new(self, final_cond)
             fnd.send(@scope)
           end
-
         end
       end
 
@@ -95,7 +88,7 @@ module ApiResource
       end
 
        def instantiate_collection(collection)
-        collection.collect{|record| 
+        collection.collect{|record|
           instantiate_record(record)
         }
       end
@@ -151,23 +144,29 @@ module ApiResource
 
         # Conditions sometimes call find, passing themselves as the last arg.
         if args.last.is_a?(ApiResource::Conditions::AbstractCondition)
-          cond  = args.slice!(args.length - 1) 
+          cond = args.slice!(args.length - 1)
         else
-          cond  = nil
+          cond = nil
         end
 
         # Support options being passed in as a hash.
-        options = args.extract_options!
+        options   = args.extract_options!
         if options.blank?
           options = nil
         end
 
-        @expiry = (options.is_a?(Hash) ? options.delete(:expires_in) : nil) || ApiResource::Base.ttl || 0
+        @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
+        @scope    = args
+
+        if Array.wrap(@scope).size == 1 && @scope.is_a?(Array)
+          @scope = @scope.first
+        end
+
+        true
       end
 
       def combine_conditions(options, condition)
@@ -192,7 +191,7 @@ module ApiResource
         @conditions = final_cond
       end
 
-      def include_associations_only?
+      def nested_find_only?
         if @conditions.blank_conditions?
           return false
         else

data/lib/api_resource/finders/single_finder.rb

@@ -31,7 +31,7 @@ module ApiResource
       protected
 
       def build_load_path
-        if self.condition.to_hash["id"].nil?
+        if self.condition.to_hash["id"].blank?
           raise "Invalid evaluation of a SingleFinder without an ID"
         end
 

data/lib/api_resource/mocks.rb

@@ -1,49 +1,55 @@
 require 'api_resource'
 
 module ApiResource
-  
+
   module Mocks
-  
+
     @@endpoints = {}
     @@path = nil
 
-    # A simple interface class to change the new connection to look like the 
+    # A simple interface class to change the new connection to look like the
     # old activeresource connection
     class Interface
-      
-      def initialize(path)
-        @path = path
+
+
+      def get(path, *args, &block)
+        uri = URI.parse(path)
+        path = uri.path + (uri.query.present? ? "?#{uri.query}" : '')
+        Connection.get(path, *args, &block)
       end
-      
-      def get(*args, &block)
-        Connection.send(:get, @path, *args, &block)
+      def post(path, *args, &block)
+        Connection.post(process_path(path), *args, &block)
       end
-      def post(*args, &block)
-        Connection.send(:post, @path, *args, &block)
+      def put(path, *args, &block)
+        Connection.put(process_path(path), *args, &block)
       end
-      def put(*args, &block)
-        Connection.send(:put, @path, *args, &block)
+      def delete(path, *args, &block)
+        Connection.delete(process_path(path), *args, &block)
       end
-      def delete(*args, &block)
-        Connection.send(:delete, @path, *args, &block)
+      def head(path, *args, &block)
+        Connection.head(process_path(path), *args, &block)
       end
-      def head(*args, &block)
-        Connection.send(:head, @path, *args, &block)
+
+      protected
+
+      def process_path(path)
+        uri = URI.parse(path)
+        return uri.path
       end
     end
 
-    # set ApiResource's http 
+    # set ApiResource's http
     def self.init
       ::ApiResource::Connection.class_eval do
         private
         alias_method :http_without_mock, :http
-        def http(path)
-          Interface.new(path)
+        def http
+          Interface.new
         end
       end
     end
-    
-    # set ApiResource's http 
+
+    # set ApiResource's http
     def self.remove
       ::ApiResource::Connection.class_eval do
         private
@@ -114,7 +120,7 @@ module ApiResource
 
       return {:responses => nil, :params => nil}
     end
-    
+
 
     private
     def self.with_path_and_format(path, format, &block)
@@ -123,13 +129,13 @@ module ApiResource
       @@path, @@format = nil, nil
       ret
     end
-    # define the 
+    # define the
     [:post, :put, :get, :delete, :head].each do |verb|
       instance_eval <<-EOE, __FILE__, __LINE__ + 1
         def #{verb}(response_body, opts = {}, &block)
 
           raise Exception.new("Must be called from within an endpoint block") unless @@path
-          opts = opts.reverse_merge({:status_code => 200, :response_headers => {}, :params => {}})        
+          opts = opts.reverse_merge({:status_code => 200, :response_headers => {}, :params => {}})
 
           @@endpoints[@@path] << [MockRequest.new(:#{verb}, @@path, :params => opts[:params], :format => @@format), MockResponse.new(response_body, :status_code => opts[:status_code], :headers => opts[:response_headers], :format => @@format, &block)]
         end
@@ -138,7 +144,7 @@ module ApiResource
 
     class MockResponse
       attr_reader :body, :headers, :code, :format, :block
-      def initialize(body, opts = {}, &block)     
+      def initialize(body, opts = {}, &block)
         opts = opts.reverse_merge({:headers => {}, :status_code => 200})
         @body = body
         @headers = opts[:headers]
@@ -197,7 +203,7 @@ module ApiResource
         @headers["Content-Length"] = @body.blank? ? "0" : @body.size.to_s
       end
 
-      # 
+      #
       def typecast_values(data)
         if data.is_a?(Hash)
           data.each_pair do |k,v|
@@ -240,8 +246,8 @@ module ApiResource
       self.requests = []
 
       #   body?       methods
-      { true  => %w(post put),
-        false => %w(get delete head) }.each do |has_body, methods|
+      { true  => %w(post put get),
+        false => %w(delete head) }.each do |has_body, methods|
         methods.each do |method|
           # def post(path, body, headers)
           #   request = ApiResource::Request.new(:post, path, body, headers)
@@ -249,7 +255,7 @@ module ApiResource
           #   if response = LifebookerClient::Mocks.find_response(request)
           #     response
           #   else
-          #     raise InvalidRequestError.new("Could not find a response 
+          #     raise InvalidRequestError.new("Could not find a response
           #     recorded for #{request.to_s} - Responses recorded are: -
           #       #{inspect_responses}")
           #   end
@@ -261,7 +267,7 @@ module ApiResource
               request = MockRequest.new(:#{method}, path, opts)
               self.requests << request
               if response = Mocks.find_response(request)
-                response[:response].tap{|resp| 
+                response[:response].tap{|resp|
                   resp.generate_response(
                     request.params
                       .with_indifferent_access

data/lib/api_resource/scopes.rb

@@ -2,17 +2,17 @@ module ApiResource
   module Scopes
 
     extend ActiveSupport::Concern
-    
+
     module ClassMethods
       # TODO: calling these methods should force loading of the resource definition
       def scopes
         return self.related_objects[:scopes]
       end
-      
+
       def scope?(name)
         self.related_objects[:scopes].has_key?(name.to_sym)
       end
-      
+
       def scope_attributes(name)
         raise "No such scope #{name}" unless self.scope?(name)
         self.related_objects[:scopes][name.to_sym]
@@ -27,15 +27,15 @@ module ApiResource
       def scope(scope_name, scope_definition)
 
         unless scope_definition.is_a?(Hash)
-          raise ArgumentError, "Expecting an attributes hash given #{scope_definition.inspect}" 
+          raise ArgumentError, "Expecting an attributes hash given #{scope_definition.inspect}"
         end
-        
+
         self.related_objects[:scopes][scope_name.to_sym] = scope_definition
 
         self.class_eval do
 
           define_singleton_method(scope_name) do |*args|
-          
+
             arg_names = scope_definition.keys
             arg_types = scope_definition.values
 
@@ -44,10 +44,10 @@ module ApiResource
             }
 
             arg_names.each_with_index do |arg_name, i|
-              
+
               # If we are dealing with a scope with multiple args
               if arg_types[i] == :rest
-                finder_opts[scope_name][arg_name] = 
+                finder_opts[scope_name][arg_name] =
                   args.slice(i, args.count)
               # Else we are only dealing with a single argument
               else
@@ -67,19 +67,77 @@ module ApiResource
           end
         end
       end
+
+      # 
+      # Apply scopes from params based on our resource
+      # definition
+      #
+      def add_scopes(params, base = self)
+        # scopes are stored as strings but we want to allow
+        params = params.with_indifferent_access
+        base = self.add_static_scopes(params, base)
+        return self.add_dynamic_scopes(params, base)
+      end
+
+      protected
+
+      def add_static_scopes(params, base)
+        self.static_scopes.each do |name|
+          if params[name].present?
+            base = base.send(name)
+          end
+        end
+        return base
+      end
+
+      def add_dynamic_scopes(params, base)
+        self.dynamic_scopes.each_pair do |name, args|
+          next if params[name].blank?
+          caller_args = []
+          args.each_pair do |subkey, type|
+            if type == :req || params[name][subkey].present?
+              caller_args << params[name][subkey]
+            end
+          end
+          base = base.send(name, *caller_args)
+        end
+        return base
+      end
+
+      #
+      # Wrapper method to define all scopes from the resource definition
+      #
+      # @return [Boolean] true
+      def define_all_scopes
+        if self.resource_definition["scopes"]
+          self.resource_definition["scopes"].each_pair do |name, opts|
+            self.scope(name, opts)
+          end
+        end
+        true
+      end
+
+      def dynamic_scopes
+        self.scopes.select { |name, args| args.present? }
+      end
+
+      def static_scopes
+        self.scopes.select { |name, args| args.blank? }.keys
+      end
+
     end
-    
+
     def scopes
       return self.class.scopes
     end
-    
+
     def scope?(name)
       return self.class.scope?(name)
     end
-    
+
     def scope_attributes(name)
       return self.class.scope_attributes(name)
     end
-    
+
   end
 end