api_resource 0.6.21 → 0.6.22

data/lib/api_resource/conditions/abstract_condition.rb

@@ -1,133 +1,245 @@
 module ApiResource
 
-	module Conditions
-
-		class AbstractCondition
-
-			include Enumerable
-
-			attr_reader :conditions, :klass, :included_objects, 
-				:internal_object, :association, :remote_path
-			
-			# TODO: add the other load forcing methods here for collections
-			delegate :[], :[]=, :<<, :first, :second, :last, :blank?, :nil?, 
-				:include?, :push, :pop, :+, :concat, :flatten, :flatten!, :compact, 
-				:compact!, :empty?, :fetch, :map, :reject, :reject!, :reverse, 
-				:select, :select!, :size, :sort, :sort!, :uniq, :uniq!, :to_a, 
-				:sample, :slice, :slice!, :count, :present?, :delete_if,
-				:to => :internal_object
-
-			# need to figure out what to do with args in the subclass,
-			# parent is the set of scopes we have right now
-			def initialize(args, klass)
-				@klass = klass
-
-				@conditions = args.with_indifferent_access
-
-				@klass.load_resource_definition
-			end
-
-			def each(&block)
-				self.internal_object.each(&block)
-			end
-
-			def blank_conditions?
-				self.conditions.blank?
-			end
-
-			def eager_load?
-				self.included_objects.present?
-			end 
-
-			def included_objects
-				Array.wrap(@included_objects)
-			end
-
-			def to_query
-				CGI.unescape(to_query_safe_hash(self.to_hash).to_query)
-			end
-
-			def to_hash
-				self.conditions.to_hash
-			end
-
-			def internal_object
-				return @internal_object if @loaded
-				@internal_object = self.instantiate_finder.load
-				@loaded = true
-				@internal_object
-			end
-
-			def all(*args)
-				if args.blank?
-					self.internal_object
-				else
-					self.find(*([:all] + args))
-				end
-			end
-
-			# implement find that accepts an optional
-			# condition object 
-			def find(*args)
-				self.klass.find(*(args + [self]))
-			end
-
-			# TODO: review the hierarchy that makes this necessary
-			# consider changing it to alias method
-			def load
-				self.internal_object
-			end
-
-			def loaded?
-				@loaded == true
-			end
-
-			def reload
-				if instance_variable_defined?(:@internal_object)
-					remove_instance_variable(:@internal_object)
-				end
-				@loaded = false
-			end
-
-			def method_missing(sym, *args, &block)
-				result = @klass.send(sym, *args, &block)
-
-				if result.is_a?(ApiResource::Conditions::AbstractCondition)
-					return self.dup.merge!(result)
-				else
-					return result
-				end
-			end
-
-			def expires_in(time)
-				ApiResource::Decorators::CachingDecorator.new(self, time)
-			end
-
-			# TODO: Remove the bang, this doesn't modify anything
-			def merge!(cond)
-				@included_objects = (@included_objects || []).concat(cond.included_objects || []).uniq
-				@conditions = @conditions.merge(cond.to_hash)
-				@association = cond.association || self.association
-				@remote_path = self.remote_path ? self.remote_path : cond.remote_path
-				return self
-			end
-
-			protected
-
-			def instantiate_finder
-				ApiResource::Finders::ResourceFinder.new(self.klass, self)
-			end
-
-			def to_query_safe_hash(hash)
-				hash.each_pair do |k,v|
-					hash[k] = to_query_safe_hash(v) if v.is_a?(Hash)
-					hash[k] = true if v == {}
-				end
-				return hash
-			end
-
-		end
-
-	end
+  module Conditions
+
+    class AbstractCondition
+
+      include Enumerable
+
+      # @!attribute [r] association
+      #   @return [Boolean] Are we an association?
+      attr_reader :association
+
+      # @!attribute [r] conditions
+      #   @return [Hash] Hash of conditions
+      attr_reader :conditions
+
+      # @!attribute [r] included_objects
+      #   @return [Array<Symbol>] List of associations to eager load
+      attr_reader :included_objects
+
+      # @!attribute [r] internal_object
+      #   @return [Array<ApiResource::Base>] Underlying objects we found
+      attr_reader :internal_object
+
+      # @!attribute [r] klass
+      #   @return [Class] Owner class
+      attr_reader :klass
+
+      # @!attribute [r] remote_path
+      #   @return [String] Path to hit when we find stuff
+      attr_reader :remote_path
+
+      # TODO: add the other load forcing methods here for collections
+      delegate :[], :[]=, :<<, :first, :second, :last, :blank?, :nil?,
+        :include?, :push, :pop, :+, :concat, :flatten, :flatten!, :compact,
+        :compact!, :empty?, :fetch, :map, :reject, :reject!, :reverse,
+        :select, :select!, :size, :sort, :sort!, :uniq, :uniq!, :to_a,
+        :sample, :slice, :slice!, :count, :present?, :delete_if,
+        :to => :internal_object
+
+      # need to figure out what to do with args in the subclass,
+      # parent is the set of scopes we have right now
+      def initialize(args, klass)
+        @klass = klass
+        @conditions = args.with_indifferent_access
+        @klass.load_resource_definition
+      end
+
+      def all(*args)
+        if args.blank?
+          self.internal_object
+        else
+          self.find(*([:all] + args))
+        end
+      end
+
+      #
+      # Is this a find without any conditions
+      #
+      # @return [Boolean]
+      def blank_conditions?
+        self.conditions.blank?
+      end
+
+      #
+      # Accessor for the current page if we
+      # are paginated.  Returns 1 if we are not
+      # paginated or have an invalid page
+      #
+      # @return [Fixnum] [description]
+      def current_page
+        return 1 unless self.paginated?
+        return 1 if @conditions[:page].to_i < 1
+        return @conditions[:page].to_i
+      end
+
+      def each(&block)
+        self.internal_object.each(&block)
+      end
+
+      #
+      # Are we set up to eager load associations?
+      #
+      # @return [Boolean]
+      def eager_load?
+        self.included_objects.present?
+      end
+
+      def expires_in(time)
+        ApiResource::Decorators::CachingDecorator.new(self, time)
+      end
+
+      # implement find that accepts an optional
+      # condition object
+      def find(*args)
+        self.klass.find(*(args + [self]))
+      end
+
+      def included_objects
+        Array.wrap(@included_objects)
+      end
+
+      def internal_object
+        return @internal_object if @loaded
+        @internal_object = self.instantiate_finder
+        @internal_object.load
+        @loaded = true
+        @internal_object
+      end
+
+      # TODO: review the hierarchy that makes this necessary
+      # consider changing it to alias method
+      def load
+        self.internal_object
+      end
+
+      def loaded?
+        @loaded == true
+      end
+
+      # TODO: Remove the bang, this doesn't modify anything
+      def merge!(cond)
+
+        # merge included objects
+        @included_objects = self.included_objects | cond.included_objects
+
+        # handle pagination
+        if cond.paginated?
+          @paginated = true
+        end
+
+        # merge conditions
+        @conditions = @conditions.merge(cond.to_hash)
+
+        # handle associations
+        if cond.association
+          @association =  true
+        end
+        # handle remote path copying
+        @remote_path ||= cond.remote_path
+
+        return self
+      end
+
+      #
+      # The offset we are currently at in our query
+      # Returns 0 if we are not paginated
+      #
+      # @return [Fixnum]
+      def offset
+        return 0 unless self.paginated?
+        prev_page = self.current_page.to_i - 1
+        prev_page * self.per_page
+      end
+
+      #
+      # Reader for whether or not we are paginated
+      #
+      # @return [Boolean]
+      def paginated?
+        @paginated
+      end
+
+      #
+      # Number of records per page if paginated
+      # Returns 1 if number is out of range or if pagination
+      # is not enabled
+      #
+      # @return [Fixnum]
+      def per_page
+        return 1 unless self.paginated?
+        return 1 if @conditions["per_page"].to_i < 1
+        return @conditions["per_page"].to_i
+      end
+
+      def reload
+        if instance_variable_defined?(:@internal_object)
+          remove_instance_variable(:@internal_object)
+        end
+        @loaded = false
+      end
+
+      def to_query
+        CGI.unescape(to_query_safe_hash(self.to_hash).to_query)
+      end
+
+      def to_hash
+        self.conditions.to_hash
+      end
+
+      #
+      # Total number of records found in the collection
+      # if it is paginated
+      #
+      # @return [Fixnum]
+      def total_entries
+        self.internal_object.total_entries
+      end
+
+      #
+      # The total number of pages in our collection
+      # or 1 if it is not paginated
+      #
+      # @return [Fixnum]
+      def total_pages
+        return 1 unless self.paginated?
+        return (self.total_entries / self.per_page.to_f).ceil
+      end
+
+      protected
+
+      #
+      # Proxy all calls to the base finder class
+      # @param  sym [Symbol] Method name
+      # @param  *args [Array<Mixed>] Args
+      # @param  &block [Proc] Block
+      #
+      # @return [Mixed]
+      def method_missing(sym, *args, &block)
+        result = @klass.send(sym, *args, &block)
+
+        if result.is_a?(ApiResource::Conditions::AbstractCondition)
+          return self.dup.merge!(result)
+        else
+          return result
+        end
+      end
+
+      def instantiate_finder
+        ApiResource::Finders::ResourceFinder.new(self.klass, self)
+      end
+
+      def to_query_safe_hash(hash)
+        hash.each_pair do |k,v|
+          hash[k] = to_query_safe_hash(v) if v.is_a?(Hash)
+          hash[k] = true if v == {}
+        end
+        return hash
+      end
+
+    end
+
+  end
 
 end

data/lib/api_resource/conditions/include_condition.rb

@@ -4,7 +4,13 @@ module ApiResource
 
 		class IncludeCondition < AbstractCondition
 
-			def initialize(klass, incs)
+      #
+      # Constructor
+      #
+      # @param  klass [Class] Finder
+      # @param  incs [Array<Symbol>, Symbol] Associations to include
+      #
+      def initialize(klass, incs)
 				super({}, klass)
 				@included_objects = Array.wrap(incs)
 			end

data/lib/api_resource/conditions/pagination_condition.rb

@@ -0,0 +1,37 @@
+module ApiResource
+
+  module Conditions
+
+    #
+    # Class to handle pagination params, passing
+    # of pagination params along to the server, and the
+    # retrieval of the headers from the response
+    #
+    # @author [dlangevin]
+    #
+    class PaginationCondition < AbstractCondition
+
+      #
+      # Constructor - sets up the pagination options
+      # @param  opts = {} [Hash] Pagination opts
+      # @option opts [Fixnum] :page (1) Page we are on
+      # @option opts [Fixnum] :per_page (10) Number per page
+      def initialize(klass, opts = {})
+        @page = opts[:page] || 1
+        @per_page = opts[:per_page] || 10
+        super({ page: @page, per_page: @per_page }, klass)
+      end
+
+      #
+      # Are we paginated?
+      #
+      # @return [Boolean] true
+      def paginated?
+        true
+      end
+
+    end
+
+  end
+
+end

data/lib/api_resource/conditions/where_condition.rb

@@ -0,0 +1,19 @@
+module ApiResource
+
+  module Conditions
+
+    #
+    # Class to handle pagination params, passing
+    # of pagination params along to the server, and the
+    # retrieval of the headers from the response
+    #
+    # @author [dlangevin]
+    #
+    class WhereCondition < AbstractCondition
+      def initialize(klass, opts)
+        super(opts, klass)
+      end
+
+    end
+  end
+end

data/lib/api_resource/conditions.rb

@@ -7,10 +7,12 @@ module ApiResource
 
 		autoload :AbstractCondition
 		autoload :AssociationCondition
-		autoload :SingleObjectAssociationCondition
-		autoload :MultiObjectAssociationCondition
 		autoload :IncludeCondition
+		autoload :MultiObjectAssociationCondition
+		autoload :PaginationCondition
+		autoload :SingleObjectAssociationCondition
 		autoload :ScopeCondition
+		autoload :WhereCondition
 
 		module ClassMethods
 
@@ -30,6 +32,20 @@ module ApiResource
 
 			end
 
+			def paginate(opts = {})
+				self.load_resource_definition
+
+				# Everything looks good so just create the scope
+				ApiResource::Conditions::PaginationCondition.new(self, opts)
+
+			end
+
+			def where(opts = {})
+				self.load_resource_definition
+
+				ApiResource::Conditions::WhereCondition.new(self, opts)
+			end
+
 		end
 
 	end

data/lib/api_resource/connection.rb

@@ -62,17 +62,28 @@ module ApiResource
       headers = build_request_headers(headers, :get, site)
 
       self.with_caching(path, headers) do
-        format.decode(request(:get, path, {}, headers))
+        request(:get, path, {}, headers)
       end
     end
 
     def delete(path, headers = self.headers)
-      request(:delete, path, {}, build_request_headers(headers, :delete, self.site.merge(path)))
+      request(
+        :delete,
+        path,
+        {},
+        build_request_headers(headers, :delete, self.site.merge(path))
+      )
       return true
     end
 
     def head(path, headers = self.headers)
-      request(:head, path, {}, build_request_headers(headers, :head, self.site.merge(path)))
+      request(
+        :head,
+        path,
+        {},
+        build_request_headers(headers, :head, self.site.merge(path))
+      )
+      return true
     end
 
     # make a put request
@@ -97,7 +108,7 @@ module ApiResource
           "[DEPRECATION] Returning a response body from a PUT " +
           "is deprecated. \n#{response.pretty_inspect} was returned."
         )
-        return format.decode(response)
+        return response
       end
     end
 
@@ -107,13 +118,11 @@ module ApiResource
    #   have a timeout, general exception, or
    #   if result.code is not within 200..399
    def post(path, body = {}, headers = self.headers)
-      format.decode(
-        request(
-          :post,
-          path,
-          format.encode(body),
-          build_request_headers(headers, :post, self.site.merge(path))
-        )
+      request(
+        :post,
+        path,
+        format.encode(body),
+        build_request_headers(headers, :post, self.site.merge(path))
       )
     end
 
@@ -171,7 +180,12 @@ module ApiResource
             ApiResource.logger.error(error.message)
             result = error.response
           else
-            raise ApiResource::ConnectionError.new(nil, :message => "Unknown error #{error}")
+            exception = ApiResource::ConnectionError.new(
+              nil,
+              :message => "Unknown error #{error}"
+            )
+            exception.set_backtrace(error.backtrace)
+            raise exception
           end
         end
         return propogate_response_or_error(result, result.code)
@@ -182,7 +196,7 @@ module ApiResource
           when 301,302
             raise ApiResource::Redirection.new(response)
           when 200..399
-            response.body
+            return ApiResource::Response.new(response)
           when 400
             raise ApiResource::BadRequest.new(response)
           when 401

data/lib/api_resource/exceptions.rb

@@ -1,8 +1,8 @@
 module ApiResource
   class ConnectionError < StandardError # :nodoc:
-    
+
     cattr_accessor :http_code
-    
+
     attr_reader :response
 
     def initialize(response, options = {})
@@ -15,9 +15,9 @@ module ApiResource
       message = "Failed."
 
       if response.respond_to?(:code)
-        message << "  Response code = #{response.code}." 
+        message << "  Response code = #{response.code}."
       end
-      
+
       if response.respond_to?(:body)
         begin
           body = JSON.parse(response.body).pretty_inspect
@@ -26,15 +26,15 @@ module ApiResource
         end
         message << "\nResponse message = #{body}."
       end
-      
+
       message << "\n#{@message}"
       message << "\n#{@path}"
     end
-    
+
     def http_code
       self.class.http_code
     end
-    
+
   end
 
   # Raised when a Timeout::Error occurs.
@@ -72,7 +72,7 @@ module ApiResource
 
   # 404 Not Found
   class ResourceNotFound < ClientError; self.http_code = 404; end # :nodoc:
-  
+
   # 406 Not Acceptable
   class NotAcceptable < ClientError; self.http_code = 406; end
 
@@ -81,7 +81,7 @@ module ApiResource
 
   # 410 Gone
   class ResourceGone < ClientError; self.http_code = 410; end # :nodoc:
-  
+
   class UnprocessableEntity < ClientError; self.http_code = 422; end
 
   # 5xx Server Error
@@ -89,9 +89,9 @@ module ApiResource
 
   # 405 Method Not Allowed
   class MethodNotAllowed < ClientError # :nodoc:
-    
+
     self.http_code = 405
-    
+
     def allowed_methods
       @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
     end