api_resource 0.3.14 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.14
+0.4.0

data/api_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "api_resource"
-  s.version = "0.3.14"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ethan Langevin"]
-  s.date = "2012-09-24"
+  s.date = "2012-10-24"
   s.description = "A replacement for ActiveResource for RESTful APIs that handles associated object and multiple data sources"
   s.email = "ejl6266@gmail.com"
   s.extra_rdoc_files = [
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/api_resource/associations/association_proxy.rb",
     "lib/api_resource/associations/belongs_to_remote_object_proxy.rb",
     "lib/api_resource/associations/dynamic_resource_scope.rb",
+    "lib/api_resource/associations/generic_scope.rb",
     "lib/api_resource/associations/has_many_remote_object_proxy.rb",
     "lib/api_resource/associations/has_many_through_remote_object_proxy.rb",
     "lib/api_resource/associations/has_one_remote_object_proxy.rb",
@@ -50,6 +51,8 @@ Gem::Specification.new do |s|
     "lib/api_resource/connection.rb",
     "lib/api_resource/core_extensions.rb",
     "lib/api_resource/custom_methods.rb",
+    "lib/api_resource/decorators.rb",
+    "lib/api_resource/decorators/caching_decorator.rb",
     "lib/api_resource/exceptions.rb",
     "lib/api_resource/formats.rb",
     "lib/api_resource/formats/json_format.rb",

data/lib/api_resource/associations/generic_scope.rb

@@ -0,0 +1,68 @@
+require 'api_resource/associations/resource_scope'
+
+module ApiResource
+  module Associations
+
+    class GenericScope < ResourceScope
+      attr_reader :name
+      attr_reader :params
+      attr_reader :types
+      attr_reader :values
+
+      # Gets called when a scope is called.  Stores everything in
+      # this class.  Sorry, couldn't be bothered to figure out the 
+      # class hierarchy.
+      #
+      # klass - ApiResourceBase class
+      # current_scope - sym for the scope
+      # *args - arguments being passed to the scope
+      def initialize(klass, current_scope, *args)
+
+        @name = current_scope # contains sym with scope ie :for_provider
+        @params = klass.related_objects[:scopes][current_scope].keys
+        @types = klass.related_objects[:scopes][current_scope].values
+
+        # Bail if we have crap
+        if @params == nil
+          raise "Scope #{@name} does not exist #{klass.name}.  Scopes: #{klass.related_objects[:scopes]}" 
+        end
+
+        # extract parent scope stuff
+        opts = {}
+        last_arg = args[args.count - 1]
+        if last_arg != nil && last_arg.is_a?(Hash) && last_arg[:parent] != nil
+          args = args.slice(0, args.count - 1)
+          opts = last_arg
+        end
+
+        # walk through parameters and types and assign values from *args to parameters
+        @values = []
+        @params.count.times do |i|
+          if @types[i] == :rest
+            @values << args.slice(i, args.count)
+          else
+            @values << args[i]
+          end
+        end
+
+        # Let the parent class do its magic.
+        super(klass, current_scope, opts)
+      end
+
+      # get the to_query value for this resource scope
+      def to_hash
+        # debugger
+        if @params.count == 0
+          scope_arguments = true 
+        else 
+          scope_arguments = {}
+          @params.count.times do |i|
+            scope_arguments[@params[i]] = @values[i] if @values[i] != nil
+          end
+        end
+        self.parent_hash.merge({@name => scope_arguments})
+      end
+    end
+  end
+end
+

data/lib/api_resource/associations/resource_scope.rb

@@ -1,11 +1,11 @@
 require 'api_resource/associations/scope'
 
 module ApiResource
-  
+
   module Associations
-    
+
     class ResourceScope < Scope
-      
+
       include Enumerable
 
       def internal_object
@@ -13,23 +13,19 @@ module ApiResource
           @internal_object ||= self.klass.send(:find, :all, :params => self.to_hash)
         end
       end
-      
+
       alias_method :all, :internal_object
-      
+
       def each(*args, &block)
         self.internal_object.each(*args, &block)
       end
-      
-      # get the relevant class
+
+      # Used by ApiResource::Scopes to create methods with the same name
+      # as the scope
+      #
+      # Weird place to have a factory... could have been on Scope or a separate class...
       def self.class_factory(hsh)
-        case hsh.values.first
-          when TrueClass, FalseClass
-            ApiResource::Associations::ResourceScope
-          when Array
-            ApiResource::Associations::MultiArgumentResourceScope
-          else
-            ApiResource::Associations::DynamicResourceScope
-        end
+        return ApiResource::Associations::GenericScope
       end
     end
   end

data/lib/api_resource/associations/scope.rb

@@ -1,7 +1,7 @@
 module ApiResource
-  
+
   module Associations
-    
+
     class Scope
 
       attr_accessor :klass, :current_scope, :internal_object
@@ -33,11 +33,11 @@ module ApiResource
         # This expression substitutes the options from opts into the default attributes of the scope, it will only copy keys that exist in the original
         self.scopes[self.current_scope] = opts.inject(self.scopes[current_scope]){|accum,(k,v)| accum.key?(k.to_s) ? accum.merge(k.to_s => v) : accum}
       end
-      
+
       def ttl
         @ttl || 0
       end
-      
+
       # Use this method to access the internal data, this guarantees that loading only occurs once per object
       def internal_object
         raise "Not Implemented: This method must be implemented in a subclass"
@@ -58,11 +58,20 @@ module ApiResource
       def to_hash
         self.parent_hash.merge(self.scopes[self.current_scope])
       end
-      
-      # gets the current hash and calls to_query on it
+
+      # takes empty hashes and replaces them with true so that to_query doesn't strip them out
+      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
+
+       # gets the current hash and calls to_query on it
       def to_query
         #We need to add the unescape because to_query breaks on nested arrays
-        CGI.unescape(self.to_hash.to_query)
+        CGI.unescape(to_query_safe_hash(self.to_hash).to_query)
       end
 
       def method_missing(method, *args, &block)
@@ -77,16 +86,24 @@ module ApiResource
       def to_s
         self.internal_object.to_s
       end
-      
+
       def inspect
         self.internal_object.inspect
       end
-      
+
       def blank?
         self.internal_object.blank?
       end
       alias_method :empty?, :blank?
 
+      def present?
+        self.internal_object.present?
+      end
+
+      def expires_in(ttl)
+        ApiResource::Decorators::CachingDecorator.new(self, ttl)
+      end
+
       protected
         # scope from the parent
         def parent_scope
@@ -109,7 +126,7 @@ module ApiResource
           raise ArgumentError, "Unknown scope #{scp}" unless self.scope?(scp.to_s)
         end
     end
-    
+
   end
-  
-end
+
+end

data/lib/api_resource/associations/single_object_proxy.rb

@@ -20,14 +20,6 @@ module ApiResource
           return load(contents)
         end
       end
-
-      def blank?
-        return @internal_object.blank?
-      end
-
-      def present?
-	      return @internal_object.present?
-      end
       
       def ==(other)
         return false if self.class != other.class

data/lib/api_resource/associations.rb

@@ -4,6 +4,7 @@ require 'api_resource/association_activation'
 require 'api_resource/associations/relation_scope'
 require 'api_resource/associations/resource_scope'
 require 'api_resource/associations/dynamic_resource_scope'
+require 'api_resource/associations/generic_scope'
 require 'api_resource/associations/multi_argument_resource_scope'
 require 'api_resource/associations/multi_object_proxy'
 require 'api_resource/associations/single_object_proxy'
@@ -214,4 +215,4 @@ module ApiResource
 
   end
   
-end
+end

data/lib/api_resource/decorators/caching_decorator.rb

@@ -0,0 +1,20 @@
+module ApiResource
+  module Decorators
+    class CachingDecorator
+      attr_reader :owner
+      attr_reader :ttl
+
+      def initialize(owner, ttl)
+        @owner = owner
+        @ttl = ttl
+      end
+
+
+      def method_missing(method_name, *args, &block)
+        ApiResource.with_ttl(self.ttl) do
+          self.owner.send(method_name, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/api_resource/decorators.rb

@@ -0,0 +1,6 @@
+module ApiResource
+  module Decorators
+    extend ActiveSupport::Autoload
+    autoload :CachingDecorator
+  end
+end

data/lib/api_resource/scopes.rb

@@ -8,6 +8,9 @@ module ApiResource
         return self.related_objects[:scopes]
       end
       
+      # Called by base.rb
+      # @param name is the name of the scope from the json
+      # @param hsh is always a hash with the arguments for the scope
       def scope(name, hsh)
         raise ArgumentError, "Expecting an attributes hash given #{hsh.inspect}" unless hsh.is_a?(Hash)
         self.related_objects[:scopes][name.to_sym] = hsh

data/lib/api_resource.rb

@@ -1,10 +1,6 @@
 require 'active_support'
 require 'active_support/inflector'
 require 'active_support/core_ext'
-#require 'active_support/core_ext/hash'
-#require 'active_support/core_ext/object'
-#require 'active_support/core_ext/class/attribute_accessors'
-#require 'active_support/core_ext/class/inheritable_attributes'
 require 'api_resource/core_extensions'
 
 require 'active_model'
@@ -28,6 +24,7 @@ module ApiResource
   autoload :Callbacks
   autoload :Connection
   autoload :CustomMethods
+  autoload :Decorators
   autoload :Formats
   autoload :Local
   autoload :LogSubscriber