api_resource 0.6.18 → 0.6.19

data/lib/api_resource/serializer.rb

@@ -0,0 +1,264 @@
+module ApiResource
+
+  #
+  # Handles serialization for a given instance of ApiResource::Base with
+  # a set of options
+  #
+  # @author [dlangevin]
+  #
+  class Serializer
+
+    # @!attribute [r] options
+    #   @return [HashWithIndifferentAccess]
+    attr_reader :options
+
+    # @!attribute [r] record
+    #   @return [ApiResource::Base]
+    attr_reader :record
+
+    #
+    # Constructor
+    #
+    # @param  record [ApiResource::Base] Record to serialize
+    # @param  options = {} [Hash] Options supplied
+    #
+    # @option options [Array<Symbol,String>] except (Array<>) Attributes to
+    # explicitly exclude
+    # @option options [Array<Symbol,String] include_associations (Array<>)
+    # Associations to explicitly include
+    # @option options [Array<Symbol,String] include_extras (Array<>)
+    # Attributes to explicitly include
+    # @option options [Boolean] include_id (false) Whether or not to include
+    # the primary key
+    # @option options [Boolean] include_nil_attributes (false) Whether or not
+    # to include attributes that are blank/nil in the serialized hash
+    #
+    def initialize(record, options = {})
+      @record = record
+      @options = options.with_indifferent_access
+    end
+
+    #
+    # Return our serialized object as a Hash
+    #
+    # @return [HashWithIndifferentAccess]
+    def to_hash
+      ret = HashWithIndifferentAccess.new
+      ret.merge!(self.attributes_for_hash)
+      ret.merge!(self.associations_for_hash)
+      ret.merge!(self.add_on_data_for_hash)
+      ret.merge!(self.association_foreign_keys_for_hash)
+      ret
+    end
+
+
+    protected
+
+    #
+    # Data that is implicitly or explicitly added by options
+    #
+    # @return [Hash] Data to add on
+    def add_on_data_for_hash
+      {}.tap do |ret|
+        # explicit inclusion of the record's id (used in nested updates)
+        if self.options[:include_id] && !self.record.new_record?
+          ret[:id] = self.record.id
+        end
+      end
+    end
+
+    #
+    # Attribute data to include in the hash - this checks whether or not
+    # to include a given attribute with {#include_attribute?}
+    #
+    # @return [Hash] Data from attributes
+    def attributes_for_hash
+      self.record.attributes.inject({}) do |accum, (key,val)|
+        if self.include_attribute?(key, val)
+          accum.merge(key => val)
+        else
+          accum
+        end
+      end
+    end
+
+    #
+    # Data that is included due to foreign keys.
+    #
+    # @example
+    #   tr = TestResource.new
+    #   tr.belongs_to_object = BelongsToObject.find(10)
+    #   Serializer.new(tr).to_hash #=> {:belongs_to_object_id => 10}
+    #
+    # @return [Hash] Data from foreign keys
+    def association_foreign_keys_for_hash
+      {}.tap do |ret|
+        self.record.association_names.each do |name|
+          # this is the method name
+          # E.g. :belongs_to_object => :belongs_to_object_id
+          method_name = self.record.class.association_foreign_key_field(name)
+          # make sure we have changes
+          next if self.record.changes[method_name].blank?
+          # make sure we aren't in a prefix method
+          next if self.is_prefix_field?(method_name)
+          # add the changed value
+          ret[method_name] = self.record.send(method_name)
+        end
+      end
+    end
+
+    #
+    # Nested association data for the hash.  This checks whether or not
+    # to include a given association with {#include_association?}
+    #
+    # @return [Hash] Data from associations
+    def associations_for_hash
+      self.record.association_names.inject({}) do |accum, assoc_name|
+        if self.include_association?(assoc_name)
+          # get the association
+          assoc = self.record.send(assoc_name)
+          options = self.options.merge(include_id: true)
+          accum.merge(assoc_name => assoc.serializable_hash(options))
+        else
+          accum
+        end
+      end
+    end
+
+    #
+    # List of all association names that are in our changes set
+    #
+    # @return [Array<Symbol>]
+    def changed_associations
+      @changed_associations ||= begin
+        self.record.changes.keys.symbolize_array.select{ |k|
+          self.record.association?(k)
+        }
+      end
+    end
+
+    #
+    # Helper method to check if a blank value should be included
+    # in the response
+    #
+    # @param  key [String, Symbol] Attribute name
+    # @param  val [Mixed] Value to include
+    #
+    # @return [Boolean] Whether or not to include this key/value pair
+    def check_blank_value(key, val)
+      # if we explicitly want nil attributes
+      return true if self.options[:include_nil_attributes]
+      # or if the attribute has changed to nil
+      return true if self.record.changes[key].present?
+      # make sure our value isn't blank
+      return val.present?
+    end
+
+    #
+    # List of explicitly excluded attributes
+    #
+    # @return [type] [description]
+    def excluded_keys
+      @excluded_keys ||= begin
+        ret = self.options[:except] || []
+        ret.map(&:to_sym)
+      end
+    end
+
+    #
+    # Should we include this association in our hash?
+    #
+    # @param  association [Symbol] Association name to check
+    #
+    # @return [Boolean] Whether or not to include it
+    def include_association?(association)
+      # if we have explicitly requested this association we include it
+      return true if self.included_associations.include?(association)
+      return true if self.changed_associations.include?(association)
+      # explicitly excluded
+      return false if self.excluded_keys.include?(association)
+      return false
+    end
+
+    #
+    # Should we include this attribute?
+    #
+    # @param  attribute [String, Symbol] Field name
+    # @param  val [Mixed] Field value
+    #
+    # @return [Boolean] Whether or not to include it
+    def include_attribute?(attribute, val)
+      attribute = attribute.to_sym
+      # explicitly included
+      return true if self.included_attributes.include?(attribute)
+      # explicitly excluded
+      return false if self.excluded_keys.include?(attribute)
+      # make sure it's public
+      return false unless self.public_attributes.include?(attribute)
+      # make sure it's not already accounted for in the URL
+      if self.is_prefix_field?(attribute)
+        return false
+      end
+      # check to make sure the value is something we want to send
+      return false unless self.check_blank_value(attribute, val)
+
+      # default to true
+      true
+    end
+
+    #
+    # Associations explicitly included by the caller
+    #
+    # @return [Array<Symbol>]
+    def included_associations
+      @included_associations ||= begin
+        self.options[:include_associations] ||= []
+        self.options[:include_associations].collect(&:to_sym)
+      end
+    end
+
+    #
+    # Attributes explicitly included by the caller
+    #
+    # @return [Array<Symbol>]
+    def included_attributes
+      @included_attributes ||= begin
+        ret = self.options[:include_extras] || []
+        ret.map(&:to_sym)
+      end
+    end
+
+    #
+    # Whether or not a given attribute is accounted for in the
+    # prefix for this class
+    #
+    # @param  attribute [Symbol] Attribute to check
+    #
+    # @example
+    #   class TestResource
+    #     prefix '/belongs_to_objects/:id/test_resources'
+    #   end
+    #
+    #   tr = TestResource.new(:belongs_to_object_id => 10)
+    #   Serializer.new(tr).to_hash #=> {}
+    #
+    #   tr.save #=> makes a call to /belongs_to_objects/10/test_resources
+    #
+    # @return [Boolean]
+    def is_prefix_field?(attribute)
+      self.record.prefix_attribute_names.include?(attribute.to_sym)
+    end
+
+    #
+    # List of public attributes for the record
+    #
+    # @return [Array<Sumbol>]
+    def public_attributes
+      @public_attributes ||= begin
+        self.record.attributes.keys.symbolize_array.reject{ |k|
+          self.record.protected_attribute?(k)
+        }
+      end
+    end
+  end
+end

data/lib/api_resource/typecast.rb

@@ -5,6 +5,7 @@ require 'api_resource/typecasters/integer_typecaster'
 require 'api_resource/typecasters/string_typecaster'
 require 'api_resource/typecasters/time_typecaster'
 require 'api_resource/typecasters/array_typecaster'
+require 'api_resource/typecasters/unknown_typecaster'
 
 # Apparently need to require the active_support class_attribute
 require 'active_support/core_ext/class/attribute'
@@ -12,6 +13,15 @@ require 'active_support/core_ext/class/attribute'
 
 module ApiResource
 
+  #
+  # Error raised when unable to find a typecaster for a given
+  # attribute
+  #
+  # @author [ejlangev]
+  #
+  class TypecasterNotFound < NoMethodError
+  end
+
   module Typecast
 
     extend ActiveSupport::Concern
@@ -64,9 +74,11 @@ module ApiResource
 
       def default_typecasters
         @default_typecasters ||= {
+          :array => ArrayTypecaster,
           :boolean => BooleanTypecaster,
           :bool => BooleanTypecaster,
           :date => DateTypecaster,
+          :datetime => TimeTypecaster,
           :decimal => FloatTypecaster,
           :float => FloatTypecaster,
           :integer => IntegerTypecaster,
@@ -74,8 +86,7 @@ module ApiResource
           :string => StringTypecaster,
           :text => StringTypecaster,
           :time => TimeTypecaster,
-          :datetime => TimeTypecaster,
-          :array => ArrayTypecaster,
+          :unknown => UnknownTypecaster
         }
       end
 

data/lib/api_resource/typecasters/unknown_typecaster.rb

@@ -0,0 +1,33 @@
+module ApiResource
+
+  module Typecast
+
+    # The unknown typecaster which does not modify the value of
+    # the attribute in either direction.  Keeps the interface consistent
+    # for unspecified typecasters
+    #
+    # @author [ejlangev]
+    #
+    module UnknownTypecaster
+
+      #
+      # Just returns what was passed in
+      # @param  value [Object] The value to typecast
+      #
+      # @return [Object] An unmodified value
+      def self.from_api(value)
+        return value
+      end
+
+      #
+      # Just returns what was passed in
+      # @param  value [Object] The value to typecast
+      #
+      # @return [Object] An unmodified value
+      def self.to_api(value)
+        return value
+      end
+
+    end
+  end
+end

data/lib/api_resource/version.rb

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

data/spec/lib/associations/has_many_remote_object_proxy_spec.rb

@@ -2,15 +2,15 @@ require 'spec_helper'
 
 module ApiResource
   module Associations
-    
+
     describe HasManyRemoteObjectProxy do
 
-      before(:all) do
+      before(:each) do
         TestResource.reload_resource_definition
       end
 
       context "#<<" do
-        
+
         it "implements the shift operator" do
           tr = TestResource.new
           tr.has_many_objects << HasManyObject.new

data/spec/lib/associations_spec.rb

@@ -10,7 +10,7 @@ describe "Associations" do
 
   let(:ap) do
     res = Associations::SingleObjectProxy.new(
-      "TestResource", 
+      "TestResource",
       HasManyObject.new
     )
     res.internal_object = {
@@ -130,7 +130,7 @@ describe "Associations" do
 
       it "should be able to override into the root namespace by prefixing with ::" do
         TestMod::InnerMod::InnerClass.belongs_to :test_resource, :class_name => "::TestResource"
-        TestMod::InnerMod::InnerClass.association_class_name(:test_resource).should eql("::TestResource")        
+        TestMod::InnerMod::InnerClass.association_class_name(:test_resource).should eql("::TestResource")
       end
 
     end
@@ -170,7 +170,7 @@ describe "Associations" do
       TestResource.scope :test_scope, {:item => "test"}
       TestResource.scope?(:test_scope).should be_true
       TestResource.scope_attributes(:test_scope).should eql({"item" => "test"})
-    end 
+    end
 
     it "should not propagate scopes from one class to another" do
 
@@ -239,7 +239,7 @@ describe "Associations" do
 
     it "should be able to extract a service uri from the contents hash" do
       ap = Associations::SingleObjectProxy.new(
-        "TestResource", 
+        "TestResource",
         HasManyObject.new
       )
       ap.internal_object = {
@@ -248,12 +248,12 @@ describe "Associations" do
       ap.remote_path.should eql("/path")
     end
 
-    it "should be able to recognize the attributes of an object 
+    it "should be able to recognize the attributes of an object
       and not make them scopes" do
-      
+
       TestResource.define_attributes :test
       ap = Associations::SingleObjectProxy.new(
-        "TestResource", 
+        "TestResource",
         HasManyObject.new
       )
 
@@ -329,7 +329,7 @@ describe "Associations" do
 
         it "should be able to recognize settings from a hash" do
           ap = Associations::MultiObjectProxy.new(
-            "TestResource", 
+            "TestResource",
             BelongsToObject
           )
           ap.internal_object = {:service_uri => "/route"}
@@ -338,7 +338,7 @@ describe "Associations" do
 
         it "should be able to recognize settings from a hash as a string" do
           ap = Associations::MultiObjectProxy.new(
-            "TestResource", 
+            "TestResource",
             BelongsToObject
           )
           ap.internal_object = {"service_uri" => "/route"}
@@ -348,22 +348,13 @@ describe "Associations" do
         it "should recognize settings with differing 'service_uri' names" do
           Associations::MultiObjectProxy.remote_path_element = :the_element
           ap = Associations::MultiObjectProxy.new(
-            "TestResource", 
+            "TestResource",
             BelongsToObject
           )
           ap.internal_object = {:the_element => "/route"}
           ap.remote_path.should eql("/route")
         end
 
-        it "should include the foreign_key_id when saving" do
-          tr = TestResource.new.tap do |tr|
-            tr.stubs(:id => 123)
-          end
-          tr.has_many_object_ids = [4]
-          hsh = tr.serializable_hash
-          hsh[:has_many_object_ids].should eql([4])
-        end
-
         it "should handle loading attributes from the remote" do
           tr = TestResource.instantiate_record({:has_many_object_ids => [3]})
           tr.has_many_object_ids.should eql([3])
@@ -379,51 +370,6 @@ describe "Associations" do
 
     end
 
-    describe "Selecting scopes" do
-
-      before(:all) do
-        ScopeResource.class_eval do
-          scope :no_arg, {}
-          scope :one_arg, {:id => :req}
-          scope :one_array_arg, {:ids => :req}
-          scope :two_args, {:page => :req, :per_page => :req}
-          scope :opt_args, {:arg1 => :opt}
-          scope :var_args, {:ids => :rest}
-          scope :mix_args, {:id => :req, :vararg => :rest}
-        end
-      end
-
-      it "should be able to query scopes on the current model" do
-        ScopeResource.no_arg.to_query.should eql(
-          "no_arg=true"
-        )
-        ScopeResource.one_arg(5).to_query.should eql(
-          "one_arg[id]=5"
-        )
-        ScopeResource.one_array_arg([3, 5]).to_query.should eql(
-          "one_array_arg[ids][]=3&one_array_arg[ids][]=5"
-        )
-        ScopeResource.two_args(1, 20).to_query.should eql(
-          "two_args[page]=1&two_args[per_page]=20"
-        )
-        $DEB = true
-        ScopeResource.opt_args.to_query.should eql(
-          "opt_args=true"
-        )
-        ScopeResource.opt_args(3).to_query.should eql(
-          "opt_args[arg1]=3"
-        )
-        ScopeResource.var_args(1, 2).to_query.should eql(
-          "var_args[ids][]=1&var_args[ids][]=2"
-        )
-        args = ["a", {:opt1 => 1}, {:opt2 => 2}]
-        ScopeResource.mix_args(*args).to_query.should eql(
-          "mix_args[id]=a&mix_args[vararg][][opt1]=1&mix_args[vararg][][opt2]=2"
-        )
-      end
-    end
-
-
   end
 
   describe "Loading and Caching loaded data" do
@@ -452,7 +398,7 @@ describe "Associations" do
 
       it "should proxy unknown methods to the object loading if it hasn't already" do
         ap = Associations::SingleObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           HasManyObject.new
         )
         ap.internal_object = {
@@ -465,7 +411,7 @@ describe "Associations" do
 
       it "should load scopes with caching" do
         ap = Associations::SingleObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           HasManyObject.new
         )
         ap.internal_object = {
@@ -481,7 +427,7 @@ describe "Associations" do
 
       it "should check that ttl matches the expiration parameter" do
        ap = Associations::SingleObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           HasManyObject.new
         )
        ap.internal_object = {
@@ -492,7 +438,7 @@ describe "Associations" do
 
       it "should cache scopes when caching enabled" do
         ap = Associations::SingleObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           HasManyObject.new
         )
         ap.internal_object = {
@@ -503,7 +449,7 @@ describe "Associations" do
 
       it "should be able to clear it's loading cache" do
         ap = Associations::SingleObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           HasManyObject.new
         )
         ap.internal_object = {
@@ -523,7 +469,7 @@ describe "Associations" do
 
     it "should be able to reload a single-object association" do
       ap = Associations::SingleObjectProxy.new(
-        "TestResource", 
+        "TestResource",
         HasManyObject.new
       )
       ap.internal_object = {
@@ -543,9 +489,9 @@ describe "Associations" do
     end
 
     it "should be able to reload a multi-object association" do
-      
+
       ap = Associations::MultiObjectProxy.new(
-        "TestResource", 
+        "TestResource",
         BelongsToObject.new
       )
       ap.internal_object = {
@@ -568,7 +514,7 @@ describe "Associations" do
 
       it "should be able to load 'all'" do
         ap = Associations::MultiObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           BelongsToObject.new
         )
         ap.internal_object = {
@@ -581,7 +527,7 @@ describe "Associations" do
 
       it "should be able to load a scope" do
         ap = Associations::MultiObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           BelongsToObject.new
         )
         ap.internal_object = {
@@ -595,7 +541,7 @@ describe "Associations" do
 
       it "should be able to load a chain of scopes" do
         ap = Associations::MultiObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           BelongsToObject.new
         )
         ap.internal_object = {
@@ -610,7 +556,7 @@ describe "Associations" do
       it "should be able to clear it's loading cache" do
 
         ap = Associations::MultiObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           BelongsToObject.new
         )
         ap.internal_object = {
@@ -628,7 +574,7 @@ describe "Associations" do
 
       it "should be enumerable" do
         ap = Associations::MultiObjectProxy.new(
-          "TestResource", 
+          "TestResource",
           BelongsToObject.new
         )
         ap.internal_object = {
@@ -698,11 +644,11 @@ describe "Associations" do
           TestResource.reload_class_attributes
         end
 
-        it "should assign associations to the correct 
+        it "should assign associations to the correct
           type on initialization" do
-          
+
           tr = TestResource.new(
-            :has_one_object => {:color => "Blue"}, 
+            :has_one_object => {:color => "Blue"},
             :belongs_to_object => {:zip => "11201"},
             :has_many_objects => [{:name => "Dan"}]
           )
@@ -728,14 +674,14 @@ describe "Associations" do
         it "should assign associations to the correct type when setting attributes directly" do
           tr = TestResource.new()
           tr.has_one_object = {:name => "Dan"}
-          tr.belongs_to_object = {:name => "Dan"} 
+          tr.belongs_to_object = {:name => "Dan"}
 
           tr.has_one_object.internal_object.should be_instance_of HasOneObject
           tr.belongs_to_object.internal_object.should be_instance_of BelongsToObject
         end
 
         it "should be able to reload a single-object association" do
-          
+
           tr = TestResource.new()
           tr.has_one_object = {:color => "Blue"}
 
@@ -766,7 +712,7 @@ describe "Associations" do
         end
 
         it "should be able to reload a multi-object association" do
-          
+
           # do this to load the resource definition
           TestResource.reload_resource_definition
           HasManyObject.reload_resource_definition
@@ -778,7 +724,7 @@ describe "Associations" do
           tr.has_many_objects.should be_blank
         end
 
-        it "should be able to override service_uri for a 
+        it "should be able to override service_uri for a
           multi-object association" do
 
           tr = TestResource.new
@@ -788,7 +734,7 @@ describe "Associations" do
 
         end
 
-        it "should be able to override service_uri for a multi-object 
+        it "should be able to override service_uri for a multi-object
           association when loaded with instantiate_record" do
 
           tr = TestResource.instantiate_record(
@@ -804,17 +750,25 @@ describe "Associations" do
         before(:all) do
           require 'active_record'
           db_path = File.expand_path(File.dirname(__FILE__) + "/../tmp/api_resource_test_db.sqlite")
-          ActiveRecord::Base.establish_connection({"adapter" => "sqlite3", "database" => db_path})
-          ActiveRecord::Base.connection.create_table(:test_ars, :force => true) do |t|
-            t.integer(:test_resource_id)
-          end
+          # ActiveRecord::Base.establish_connection({"adapter" => "sqlite3", "database" => db_path})
+          # ActiveRecord::Base.connection.create_table(:test_ars, :force => true) do |t|
+          #   t.integer(:test_resource_id)
+          # end
           ApiResource::Associations.activate_active_record
           TestAR = Class.new(ActiveRecord::Base)
-          TestAR.class_eval do 
+          TestAR.class_eval do
             belongs_to_remote :my_favorite_thing, :class_name => "TestClassYay"
           end
           HasManyObject.reload_resource_definition
         end
+
+        before(:each) do
+          TestAR.stubs(:columns).returns([])
+          TestAR.stubs(:connection).returns(
+            :schema_cache => stub(:table_exists => true)
+          )
+        end
+
         it "should define remote association types for AR" do
           [:has_many_remote, :belongs_to_remote, :has_one_remote].each do |assoc|
             ActiveRecord::Base.singleton_methods.should include assoc
@@ -835,7 +789,7 @@ describe "Associations" do
           end
         end
         context "Belongs To" do
-          before(:all) do
+          before(:all) do 
             TestAR.class_eval do
               belongs_to_remote :test_resource
             end
@@ -852,11 +806,12 @@ describe "Associations" do
           before(:all) do
             TestAR.class_eval do
               has_one_remote :test_resource
-              has_one_remote :other_test_resource, 
+              has_one_remote :other_test_resource,
                 :class_name => "TestResource"
             end
           end
           it "should attempt to load a single remote object for a has_one relationship" do
+
             tar = TestAR.new
             tar.stubs(:id).returns(1)
             TestResource.connection.expects(:get)
@@ -907,8 +862,8 @@ describe "Associations" do
           end
         end
         context "Has Many Through" do
-          before(:all) do       
-            TestAR.class_eval do 
+          before(:all) do
+            TestAR.class_eval do
               self.extend ApiResource::Associations::HasManyThroughRemoteObjectProxy
               has_many :test_throughs
               has_many_through_remote(:belongs_to_objects, :through => :test_throughs)