api_resource 0.2.1

data/lib/api_resource/associations/dynamic_resource_scope.rb

@@ -0,0 +1,23 @@
+require 'api_resource/associations/resource_scope'
+
+module ApiResource
+  module Associations
+    class DynamicResourceScope < ResourceScope
+      
+      attr_accessor :dynamic_value
+      # initializer - set up the dynamic value
+      def initialize(klass, current_scope, dynamic_value, opts = {})
+        self.dynamic_value = dynamic_value
+        super(klass, current_scope, opts)
+      end
+      # get the to_query value for this resource scope
+      def to_hash
+        hsh = self.scopes[self.current_scope].clone
+        hsh.each_pair do |k,v|
+          hsh[k] = self.dynamic_value
+        end
+        self.parent_hash.merge(hsh)
+      end
+    end
+  end
+end

data/lib/api_resource/associations/has_many_remote_object_proxy.rb

@@ -0,0 +1,16 @@
+require 'api_resource/associations/multi_object_proxy'
+module ApiResource
+  module Associations
+    class HasManyRemoteObjectProxy < MultiObjectProxy
+      def initialize(klass_name, contents, owner)
+        super
+        return if self.internal_object.present? || self.remote_path
+        # now if we have an owner and a foreign key, we set the data up to load
+        if owner
+          self.load({"service_uri" => self.klass.collection_path(self.owner.class.to_s.foreign_key => self.owner.id)}.merge(self.klass.scopes))
+        end
+        true
+      end
+    end
+  end
+end

data/lib/api_resource/associations/has_one_remote_object_proxy.rb

@@ -0,0 +1,24 @@
+require 'api_resource/associations/single_object_proxy'
+module ApiResource
+  module Associations
+    class HasOneRemoteObjectProxy < SingleObjectProxy
+      def initialize(klass_name, contents, owner)
+        super
+        return if self.internal_object
+        # now if we have an owner and a foreign key, we set the data up to load
+        if owner
+          self.load({"service_uri" => self.klass.collection_path(self.owner.class.to_s.foreign_key => self.owner.id)}.merge(self.klass.scopes))
+        end
+        true
+      end
+      protected
+      # load data from the remote server
+      # In a has_one, we can get back an Array, so we use the first element
+      def load_from_remote(options)
+        data = super(options)
+        data = data.first if data.is_a?(Array)
+        data
+      end
+    end
+  end
+end

data/lib/api_resource/associations/multi_argument_resource_scope.rb

@@ -0,0 +1,15 @@
+require 'api_resource/associations/dynamic_resource_scope'
+
+module ApiResource
+  module Associations
+    class MultiArgumentResourceScope < DynamicResourceScope
+      # initialize with a variable number of dynamic arguments
+      def initialize(klass, current_scope, *dynamic_value)
+        # pull off opts
+        opts = dynamic_value.extract_options!
+        # we always dynamic value to be an Array, so we don't use the splat here
+        super(klass, current_scope, dynamic_value.flatten, opts)
+      end
+    end
+  end
+end

data/lib/api_resource/associations/multi_object_proxy.rb

@@ -0,0 +1,73 @@
+require 'api_resource/associations/association_proxy'
+
+module ApiResource
+  
+  module Associations
+   
+      class MultiObjectProxy < AssociationProxy
+
+        include Enumerable
+
+        def all
+          self.internal_object
+        end
+
+        def each(*args, &block)
+          self.internal_object.each(*args, &block)
+        end
+
+        def serializable_hash(options)
+          self.internal_object.collect{|obj| obj.serializable_hash(options) }
+        end
+
+        # force a load when calling this method
+        def internal_object
+          @internal_object ||= self.load_scope_with_options(:all, {})
+        end
+        
+        def internal_object=(contents)
+          return @internal_object = contents if contents.all?{|o| o.is_a?(self.klass)}
+          return load(contents)
+        end
+
+        protected
+        def load_scope_with_options(scope, options)
+          scope = self.loaded_hash_key(scope.to_s, options)
+          return [] if self.remote_path.blank?
+          unless self.loaded[scope]
+            self.times_loaded += 1
+            self.loaded[scope] = self.load_from_remote(options)
+          end
+          self.loaded[scope].collect{|item| self.klass.new(item)}
+        end
+
+        def load(contents)
+          @internal_object = [] and return nil if contents.blank?
+          if contents.is_a?(Array) && contents.first.is_a?(Hash) && contents.first[self.class.remote_path_element]
+            settings = contents.slice!(0).with_indifferent_access
+          end
+
+          settings = contents.with_indifferent_access if contents.is_a?(Hash)
+          settings ||= {}.with_indifferent_access
+
+          raise "Invalid response for multi object relationship: #{contents}" unless settings[self.class.remote_path_element] || contents.is_a?(Array)
+          self.remote_path = settings.delete(self.class.remote_path_element)
+
+          settings.each do |key, value|
+            raise "Expected the scope #{key} to point to a hash, to #{value}" unless value.is_a?(Hash)
+            self.instance_eval <<-EOE, __FILE__, __LINE__ + 1
+              def #{key}(opts = {})
+                ApiResource::Associations::RelationScope.new(self, :#{key}, opts)
+              end
+            EOE
+            self.scopes[key.to_s] = value
+          end
+
+          # Create the internal object
+          @internal_object = contents.is_a?(Array) ? contents.collect{|item| self.klass.new(item)} : nil
+        end
+      end
+    
+  end
+  
+end

data/lib/api_resource/associations/related_object_hash.rb

@@ -0,0 +1,12 @@
+module ApiResource
+  module Associations 
+    # RelatedObjectHash, re-defines dup to be recursive
+    class RelatedObjectHash < HashWithIndifferentAccess
+      def dup
+        Marshal.load(Marshal.dump(self))
+      end
+      # use this behavior for clone too
+      alias_method :clone, :dup
+    end
+  end
+end

data/lib/api_resource/associations/relation_scope.rb

@@ -0,0 +1,30 @@
+require 'api_resource/associations/scope'
+
+module ApiResource
+  
+  module Associations
+    
+    class RelationScope < Scope
+
+      def reload
+        remove_instance_variable(:@internal_object) if instance_variable_defined?(:@internal_object)
+        self.klass.reload(self.current_scope, self.scopes[self.current_scope])
+        self
+      end
+
+      # Use this method to access the internal data, this guarantees that loading only occurs once per object
+      def internal_object
+        @internal_object ||= self.klass.send(:load_scope_with_options, self.current_scope, self.to_hash)
+      end
+      
+      # 
+      # class factory
+      def self.class_factory(hsh)
+        ApiResource::Associations::RelationScope
+      end
+
+    end
+    
+  end
+  
+end

data/lib/api_resource/associations/resource_scope.rb

@@ -0,0 +1,34 @@
+require 'api_resource/associations/scope'
+
+module ApiResource
+  
+  module Associations
+    
+    class ResourceScope < Scope
+      
+      include Enumerable
+
+      def internal_object
+        @internal_object ||= self.klass.send(:find, :all, :params => self.to_hash)
+      end
+      
+      alias_method :all, :internal_object
+      
+      def each(*args, &block)
+        self.internal_object.each(*args, &block)
+      end
+      
+      # get the relevant 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
+      end
+    end
+  end
+end

data/lib/api_resource/associations/scope.rb

@@ -0,0 +1,107 @@
+module ApiResource
+  
+  module Associations
+    
+    class Scope
+
+      attr_accessor :klass, :current_scope, :internal_object
+
+      attr_reader :scopes
+
+      def initialize(klass, current_scope, opts = {})
+        # Holds onto the association proxy this RelationScope is bound to
+        @klass = klass
+        @parent = opts.delete(:parent)
+        # splits on _and_ and sorts to get a consistent scope key order
+        @current_scope = (self.parent_scope + Array.wrap(current_scope.to_s)).sort
+        # define methods for the scopes of the object
+
+        klass.scopes.each do |key, val|
+          self.instance_eval <<-EOE, __FILE__, __LINE__ + 1
+            # This class always has at least one scope, adding a new one should clone this object
+            def #{key}(*args)
+              obj = self.clone
+              # Call reload to make it go back to the webserver the next time it loads
+              obj.reload
+              return obj.enhance_current_scope(:#{key}, *args)
+            end
+          EOE
+          self.scopes[key.to_s] = val
+        end
+        # Use the method current scope because it gives a string
+        # 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
+
+      # 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"
+      end
+
+      def scopes
+        @scopes ||= {}.with_indifferent_access
+      end
+
+      def scope?(scp)
+        self.scopes.key?(scp.to_s)
+      end
+
+      def current_scope
+        ActiveSupport::StringInquirer.new(@current_scope.join("_and_").concat("_scope"))
+      end
+
+      def to_hash
+        self.parent_hash.merge(self.scopes[self.current_scope])
+      end
+      
+      # gets the current hash and calls to_query on it
+      def to_query
+        self.to_hash.to_query
+      end
+
+      def method_missing(method, *args, &block)
+        self.internal_object.send(method, *args, &block)
+      end
+
+      def reload
+        remove_instance_variable(:@internal_object) if instance_variable_defined?(:@internal_object)
+        self
+      end
+
+      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?
+
+      protected
+        # scope from the parent
+        def parent_scope
+          ret = @parent ? Array.wrap(@parent.current_scope).collect{|el| el.gsub(/_scope$/,'')} : []
+          ret.collect{|el| el.split(/_and_/)}.flatten
+        end
+        # querystring hash from parent
+        def parent_hash
+          @parent ? @parent.to_hash : {}
+        end
+        def enhance_current_scope(scp, *args)
+          opts = args.extract_options!
+          check_scope(scp)         
+          self.class.class_factory(self.scopes[scp]).new(self.klass, scp, *args, opts.merge(:parent => self))
+        end
+        # make sure we have a valid scope
+        def check_scope(scp)
+          raise ArgumentError, "Unknown scope #{scp}" unless self.scope?(scp.to_s)
+        end
+    end
+    
+  end
+  
+end

data/lib/api_resource/associations/single_object_proxy.rb

@@ -0,0 +1,81 @@
+require 'api_resource/associations/association_proxy'
+
+module ApiResource
+  
+  module Associations
+    
+    class SingleObjectProxy < AssociationProxy
+
+      def serializable_hash(options = {})
+        return if self.internal_object.nil?
+        self.internal_object.serializable_hash(options)
+      end
+      
+      def internal_object=(contents)
+        return @internal_object = contents if contents.is_a?(self.klass)
+        return @internal_object = contents if contents.respond_to?(:internal_object) && contents.internal_object.is_a?(self.klass)
+        return load(contents)
+      end
+
+      def blank?
+        return @internal_object.blank?
+      end
+
+      def present?
+	      return @internal_object.present?
+      end
+
+      protected
+      def load_scope_with_options(scope, options)
+        scope = self.loaded_hash_key(scope.to_s, options)
+        # If the service uri is blank you can't load
+        return nil if self.remote_path.blank?
+        unless self.loaded[scope]
+          self.times_loaded += 1
+          self.loaded[scope] = self.load_from_remote(options)
+        end
+        self.klass.new(self.loaded[scope])
+      end
+
+      def load(contents)
+        # If we get something nil this should just behave like nil
+        return if contents.nil?
+        # if we get an array with a length of one, make it a hash
+        if contents.is_a?(self.class)
+          contents = contents.internal_object.serializable_hash
+        elsif contents.is_a?(Array) && contents.length == 1
+          contents = contents.first
+        end
+        raise "Expected an attributes hash got #{contents}" unless contents.is_a?(Hash)
+        contents = contents.with_indifferent_access
+        # If we don't have a 'service_uri' just assume that these are all attributes and make an object
+        return @internal_object = self.klass.new(contents) unless contents[self.class.remote_path_element]
+        # allow for symbols vs strings with these elements
+        self.remote_path = contents.delete(self.class.remote_path_element)
+        # There's only one hash here so it's hard to distinguish attributes from scopes, the key scopes_only says everything
+        # in this hash is a scope
+        no_attrs = (contents.delete(:scopes_only) || false)
+        attrs = {}
+        contents.each do |key, val|
+          # if this key is an attribute add it to attrs, warn if we've set scopes_only
+          if self.klass.attribute_names.include?(key.to_sym) && !no_attrs
+            attrs[key] = val
+          else
+            warn("#{key} is an attribute of #{self.klass}, beware of name collisions") if no_attrs && self.klass.attribute_names.include?(key)
+            raise "Expected the scope #{key} to have a hash for a value, got #{val}" unless val.is_a?(Hash)
+            self.instance_eval <<-EOE, __FILE__, __LINE__ + 1
+              def #{key}(opts = {})
+                ApiResource::Associations::RelationScope.new(self, :#{key}, opts)
+              end
+            EOE
+            self.scopes[key.to_s] = val
+          end
+        end
+        @internal_object = attrs.present? ? self.klass.new(attrs) : nil
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/api_resource/attributes.rb

@@ -0,0 +1,162 @@
+module ApiResource
+
+  module Attributes
+  
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Dirty
+    
+    included do
+      
+      alias_method_chain :save, :dirty_tracking
+      
+      class_inheritable_accessor :attribute_names, :public_attribute_names, :protected_attribute_names
+      
+      attr_reader :attributes
+      
+      self.attribute_names = []
+      self.public_attribute_names = []
+      self.protected_attribute_names = []
+      
+      define_method(:attributes) do
+        return @attributes if @attributes
+        # Otherwise make the attributes hash of all the attributes
+        @attributes = HashWithIndifferentAccess.new
+        self.class.attribute_names.each do |attr|
+          @attributes[attr] = self.send("#{attr}")
+        end
+        @attributes
+      end
+      
+    end
+    
+    module ClassMethods
+      
+      def define_attributes(*args)
+        # This is provided by ActiveModel::AttributeMethods, it should define the basic methods
+        # but we need to override all the setters so we do dirty tracking
+        define_attribute_methods args
+        args.each do |arg|
+          self.attribute_names << arg.to_sym
+          self.public_attribute_names << arg.to_sym
+          
+          # Override the setter for dirty tracking
+          self.class_eval <<-EOE, __FILE__, __LINE__ + 1
+            def #{arg}
+              self.attributes[:#{arg}]
+            end
+          
+            def #{arg}=(val)
+              #{arg}_will_change! unless self.#{arg} == val
+              self.attributes[:#{arg}] = val
+            end
+            
+            def #{arg}?
+              self.attributes[:#{arg}].present?
+            end
+          EOE
+        end
+        self.attribute_names.uniq!
+        self.public_attribute_names.uniq!
+      end
+      
+      def define_protected_attributes(*args)
+        define_attribute_methods args
+        args.each do |arg|
+          self.attribute_names << arg.to_sym
+          self.protected_attribute_names << arg.to_sym
+          
+          # These attributes cannot be set, throw an error if you try
+          self.class_eval <<-EOE, __FILE__, __LINE__ + 1
+
+            def #{arg}
+              self.attributes[:#{arg}]
+            end
+          
+            def #{arg}=(val)
+              raise "#{arg} is a protected attribute and cannot be set"
+            end
+            
+            def #{arg}?
+              self.attributes[:#{arg}].present?
+            end
+          EOE
+        end
+        self.attribute_names.uniq!
+        self.protected_attribute_names.uniq!
+      end
+      
+      def attribute?(name)
+        self.attribute_names.include?(name.to_sym)
+      end
+      
+      def protected_attribute?(name)
+        self.protected_attribute_names.include?(name.to_sym)
+      end
+      
+      def clear_attributes
+        self.attribute_names.clear
+        self.public_attribute_names.clear
+        self.protected_attribute_names.clear
+      end
+    end
+    
+    module InstanceMethods
+      
+      # set new attributes
+      def attributes=(new_attrs)
+        new_attrs.each_pair do |k,v|
+          self.send("#{k}=",v) unless k.to_sym == :id
+        end
+        new_attrs
+      end
+      
+      def save_with_dirty_tracking(*args)
+        if save_without_dirty_tracking(*args)
+          @previously_changed = self.changes
+          @changed_attributes.clear
+          return true
+        else
+          return false
+        end
+      end
+      
+      def set_attributes_as_current(*attrs)
+        @changed_attributes.clear and return if attrs.blank?
+        attrs.each do |attr|
+          @changed_attributes.delete(attr.to_s)
+        end
+      end
+      
+      def reset_attribute_changes(*attrs)
+        attrs = self.class.public_attribute_names if attrs.blank?
+        attrs.each do |attr|
+          self.send("reset_#{attr}!")
+        end
+        
+        set_attributes_as_current(*attrs)
+      end
+      
+      def attribute?(name)
+        self.class.attribute?(name)
+      end
+      
+      def protected_attribute?(name)
+        self.class.protected_attribute?(name)
+      end
+      
+      def respond_to?(sym)
+        if sym =~ /\?$/
+          return true if self.attribute?($`)
+        elsif sym =~ /=$/
+          return true if self.class.public_attribute_names.include?($`)
+        else
+          return true if self.attribute?(sym.to_sym)
+        end
+        super
+      end
+    end
+    
+  end
+  
+end