active_remote 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b484c875f2b7f6e8dd9b3ba72d802c80ebd923c
-  data.tar.gz: 29194830e6f79902050b17ce78c7494b56cfce85
+  metadata.gz: a53038e5bd4f39ffbba6356eaeeb8de9c55ee2aa
+  data.tar.gz: 694f516e1adb22e5fd3ed9c68395b6081a54d389
 SHA512:
-  metadata.gz: 0664c1c11685b5260104c8f0eefc96bda16195b69e0aa8de185a4540f854a8ea1b273e1ea8b5e18fbd5b24951c84078ed88e03f86eb0aacf1686cf44395cf1d7
-  data.tar.gz: 1169cb3e752f32648903e8e8d3d1c97e3264230b73bfabc7a4870200f58ad3d9aa385df0193edaac9795894221ebcedff63bb3df2ac26b60f901a6a91c22b824
+  metadata.gz: 179ff3825b682860f3600cf90735a783c49f175f764ed56779d859b230da021961f7124faac2561fbc029d0ee9924f37c00532b2190a11d4495f1e5525c25fd9
+  data.tar.gz: 1f3d111e0cc746926899f9aba30f2c82e32caeb4eddca8250debdcf1830c877588d4e0c29cc3a36352e253c98562d21ea5ee34de1ed8aa8831ebbef34116f8f8

data/.gitignore

@@ -3,6 +3,7 @@
 .DS_Store
 .bundle
 .config
+.ruby-*
 .rvmrc
 .yardoc
 .idea

data/active_remote.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   # Dependencies
   #
   s.add_dependency "active_attr"
+  s.add_dependency "activesupport"
   s.add_dependency "protobuf", ">= 2.0"
 
   ##

data/lib/active_remote.rb

@@ -1,15 +1,29 @@
 require 'active_attr'
 require 'active_model'
+require 'protobuf'
+
 require 'active_support/core_ext/array'
 require 'active_support/core_ext/hash'
 require 'active_support/inflector'
 require 'active_support/json'
 
-require 'core_ext/date_time'
-require 'core_ext/date'
-require 'core_ext/integer'
+require 'active_remote/core_ext/date_time'
+require 'active_remote/core_ext/date'
+require 'active_remote/core_ext/integer'
 
 require 'active_remote/base'
+require 'active_remote/config'
 require 'active_remote/errors'
 
 require 'active_remote/version'
+
+module ActiveRemote
+  def self.config
+    @config ||= ::ActiveRemote::Config.new
+  end
+
+  # Initialize the config
+  config
+end
+
+require 'active_remote/railtie' if defined?(Rails)

data/lib/active_remote/attributes.rb

@@ -6,7 +6,7 @@ module ActiveRemote
       name = name.to_s
 
       if respond_to? name
-        @attributes[name]
+        attribute(name)
       else
         raise ::ActiveAttr::UnknownAttributeError, "unknown attribute: #{name}"
       end
@@ -19,7 +19,7 @@ module ActiveRemote
       name = name.to_s
 
       if respond_to? "#{name}="
-        @attributes[name] = typecast_attribute(_attribute_typecaster(name), value)
+        __send__("attribute=", name, value)
       else
         raise ::ActiveAttr::UnknownAttributeError, "unknown attribute: #{name}"
       end

data/lib/active_remote/base.rb

@@ -1,6 +1,7 @@
 require 'active_remote/association'
 require 'active_remote/attributes'
 require 'active_remote/bulk'
+require 'active_remote/config'
 require 'active_remote/dirty'
 require 'active_remote/dsl'
 require 'active_remote/integration'

data/lib/active_remote/bulk.rb

@@ -104,7 +104,12 @@ module ActiveRemote
       #
       def parse_records(*records)
         records.flatten!
-        records.collect!(&:to_hash)
+        
+        if records.first.respond_to?(:attributes)
+          records.collect!(&:attributes)
+        else
+          records.collect!(&:to_hash)
+        end
 
         return records.first if records.first.has_key?(:records)
 

data/lib/active_remote/config.rb

@@ -0,0 +1,23 @@
+require 'active_support/ordered_options'
+
+module ActiveRemote
+  class Config < ::ActiveSupport::OrderedOptions
+
+    def initialize(options = {})
+      super
+
+      self.default_cache_key_updated_at = false
+      self.include_root_in_json = true
+    end
+
+    def default_cache_key_updated_at?
+      self[:default_cache_key_updated_at]
+    end
+
+    def include_root_in_json=(true_or_false)
+      self[:include_root_in_json] = !!true_or_false
+      ::ActiveRemote::Base.include_root_in_json = self[:include_root_in_json]
+    end
+
+  end
+end

data/lib/active_remote/dsl.rb

@@ -46,7 +46,7 @@ module ActiveRemote
         @publishable_attributes
       end
 
-      # Set the RPC service class directly. By default, ActiveRemove determines
+      # Set the RPC service class directly. By default, ActiveRemote determines
       # the RPC service by constantizing the namespace and service name.
       #
       # ====Examples

data/lib/active_remote/integration.rb

@@ -34,14 +34,14 @@ module ActiveRemote
     # ==== Examples
     #
     #   Product.new.cache_key     # => "products/new"
-    #   Product.search(:guid => "derp-5").cache_key # => "products/derp-5" (updated_at not available)
-    #   Person.search(:guid => "derp-5").cache_key  # => "people/derp-5-20071224150000" (updated_at available)
+    #   Person.search(:guid => "derp-5").cache_key  # => "people/derp-5-20071224150000" (include updated_at)
+    #   Product.search(:guid => "derp-5").cache_key # => "products/derp-5"
     #
     def cache_key
       case
       when new_record? then
         "#{self.class.name.underscore}/new"
-      when timestamp = self[:updated_at] then
+      when ::ActiveRemote.config.default_cache_key_updated_at? && (timestamp = self[:updated_at]) then
         timestamp = timestamp.utc.to_s(self.class.cache_timestamp_format)
         "#{self.class.name.underscore}/#{self.to_param}-#{timestamp}"
       else

data/lib/active_remote/persistence.rb

@@ -10,7 +10,7 @@ module ActiveRemote
 
         # Allow users to create callbacks around a `save` call.
         #
-        define_model_callbacks :save
+        define_model_callbacks :save, :create, :update
 
         # Before a save occurs, ensure that we
         # clear out the errors list.
@@ -75,7 +75,7 @@ module ActiveRemote
       #
       def delete
         raise ReadOnlyRemoteRecord if readonly?
-        execute(:delete, @attributes.slice("guid"))
+        execute(:delete, "guid" => read_attribute("guid"))
 
         return success? ? freeze : false
       end
@@ -98,7 +98,7 @@ module ActiveRemote
       #
       def destroy
         raise ReadOnlyRemoteRecord if readonly?
-        execute(:destroy, @attributes.slice("guid"))
+        execute(:destroy, "guid" => read_attribute("guid"))
 
         return success? ? freeze : false
       end
@@ -197,16 +197,18 @@ module ActiveRemote
       # errors from the response.
       #
       def create
-        # Use the getter here so we get the type casting.
-        new_attributes = attributes
-        new_attributes.delete("guid")
+        run_callbacks :create do
+          # Use the getter here so we get the type casting.
+          new_attributes = attributes
+          new_attributes.delete("guid")
 
-        execute(:create, new_attributes)
+          execute(:create, new_attributes)
 
-        assign_attributes(last_response.to_hash)
-        add_errors_from_response
+          assign_attributes(last_response.to_hash)
+          add_errors_from_response
 
-        success?
+          success?
+        end
       end
 
       # Deterines whether the record should be created or updated. New records
@@ -223,17 +225,19 @@ module ActiveRemote
       # (plus :guid) will be updated. Defaults to all attributes.
       #
       def update(attribute_names = @attributes.keys)
-        # Use the getter here so we get the type casting.
-        updated_attributes = attributes
-        updated_attributes.slice!(*attribute_names)
-        updated_attributes.merge!("guid" => self[:guid])
+        run_callbacks :update do
+          # Use the getter here so we get the type casting.
+          updated_attributes = attributes
+          updated_attributes.slice!(*attribute_names)
+          updated_attributes.merge!("guid" => self[:guid])
 
-        execute(:update, updated_attributes)
+          execute(:update, updated_attributes)
 
-        assign_attributes(last_response.to_hash)
-        add_errors_from_response
+          assign_attributes(last_response.to_hash)
+          add_errors_from_response
 
-        success?
+          success?
+        end
       end
     end
   end

data/lib/active_remote/publication.rb

@@ -6,7 +6,7 @@ module ActiveRemote
       keys = _publishable_attributes_or_attribute_keys
 
       attributes_hash = keys.inject({}) do |publishable_hash, key|
-        value = respond_to?(key) ? __send__(key) : @attributes[key]
+        value = respond_to?(key) ? __send__(key) : read_attribute(key)
 
         publishable_hash[key] = case
                                 when value.respond_to?(:map) then

data/lib/active_remote/railtie.rb

@@ -0,0 +1,5 @@
+module ActiveRemote
+  class Railtie < ::Rails::Railtie
+    config.active_remote = ::ActiveRemote.config
+  end
+end

data/lib/active_remote/serializers/protobuf.rb

@@ -1,5 +1,3 @@
-require 'protobuf_extensions/base_field'
-
 module ActiveRemote
   module Serializers
     module Protobuf

data/lib/active_remote/version.rb

@@ -1,3 +1,3 @@
 module ActiveRemote
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

data/spec/lib/active_remote/bulk_spec.rb

@@ -42,12 +42,24 @@ describe ActiveRemote::Bulk do
 
   describe ".parse_records" do
     let(:records) { [ Hash.new ] }
+    let(:attribute_record) {
+      record = double(Hash)
+      record.stub(:attributes) { {} }
+      record
+    }
+    let(:records) { [ Hash.new ] }
 
     it "preps records to be built into a bulk request" do
       parsed_records = { :records => records }
       Tag.parse_records(records).should eq parsed_records
     end
 
+    it "preps records to be built into a bulk request (prioritizing :attributes over :to_hash)" do
+      attribute_record.should_receive(:attributes)
+      parsed_records = { :records => [ {} ] }
+      Tag.parse_records([ attribute_record ]).should eq parsed_records
+    end
+
     context "when given a bulk message" do
       let(:records) { [ tag.to_hash ] }
       let(:tag) { Generic::Remote::Tag.new }
@@ -71,4 +83,4 @@ describe ActiveRemote::Bulk do
       Tag.update_all(records)
     end
   end
-end
+end

data/spec/lib/active_remote/integration_spec.rb

@@ -28,10 +28,16 @@ describe ::ActiveRemote::Integration do
     end
 
     it "adds the 'updated_at' attribute to the cache_key if updated_at is present" do
+      ::ActiveRemote.config.default_cache_key_updated_at = true
       twenty_o_one_one = subject[:updated_at] = DateTime.new(2001, 01, 01)
       subject.should_receive(:new_record?).and_return(false)
       subject.cache_key.should eq("tag/#{guid}-#{twenty_o_one_one.to_s(:number)}")
       subject[:updated_at] = nil
+      ::ActiveRemote.config.default_cache_key_updated_at = false
+    end
+
+    it "defaults the cache updated_at to false" do
+      ::ActiveRemote.config.default_cache_key_updated_at?.should be_false
     end
   end
 end

data/spec/lib/active_remote/persistence_spec.rb

@@ -9,6 +9,12 @@ describe ActiveRemote::Persistence do
     before { Tag.any_instance.stub(:execute) }
     after { Tag.any_instance.unstub(:execute) }
 
+    it "runs create callbacks" do
+      Tag.any_instance.should_receive(:after_create_callback)
+      Tag.create(:name => 'foo')
+    end
+
+
     it "initializes and saves a new record" do
       Tag.any_instance.should_receive(:save)
       Tag.create(:name => 'foo')
@@ -170,7 +176,7 @@ describe ActiveRemote::Persistence do
     before { subject.stub(:execute) }
     after { subject.unstub(:execute) }
 
-    it "runs callbacks" do
+    it "runs save callbacks" do
       subject.should_receive(:run_callbacks).with(:save)
       subject.save
     end
@@ -257,6 +263,15 @@ describe ActiveRemote::Persistence do
   describe "#update_attributes" do
     let(:attributes) { HashWithIndifferentAccess.new(:name => 'bar') }
 
+    before { Tag.any_instance.stub(:execute) }
+    after { Tag.any_instance.unstub(:execute) }
+
+    it "runs update callbacks" do
+      tag = Tag.new({:guid => "123"})
+      tag.should_receive(:after_update_callback)
+      tag.update_attributes({})
+    end
+
     before { subject.stub(:save) }
     after { subject.unstub(:save) }
 

data/spec/lib/active_remote/serializers/json_spec.rb

@@ -7,32 +7,71 @@ describe ActiveRemote::Serializers::JSON do
 
     subject { Tag.new(attributes) }
 
-    context "when options are nil" do
-      it "substitutes an empty hash" do
-        subject.as_json(nil).should eq serializable_attributes
+    context "with roots in json" do
+      context "when options are nil" do
+        it "substitutes an empty hash" do
+          subject.as_json(nil).should eq serializable_attributes
+        end
       end
-    end
 
-    it "accepts standard JSON options" do
-      subject.as_json(:root => false).should eq attributes.stringify_keys
-    end
+      it "accepts standard JSON options" do
+        subject.as_json(:root => false).should eq attributes.stringify_keys
+      end
 
-    context "with publishable attributes defined" do
-      let(:expected_json) { { :tag => attributes.slice(:name) }.to_json }
+      context "with publishable attributes defined" do
+        let(:expected_json) { { :tag => attributes.slice(:name) }.to_json }
 
-      before { Tag.attr_publishable :name }
-      after { reset_publishable_attributes(Tag) }
+        before { Tag.attr_publishable :name }
+        after { reset_publishable_attributes(Tag) }
 
-      it "serializes to JSON with only the publishable attributes" do
-        subject.to_json.should eq expected_json
+        it "serializes to JSON with only the publishable attributes" do
+          subject.to_json.should eq expected_json
+        end
+      end
+
+      context "without publishable attributes defined" do
+        let(:expected_json) { { :tag => attributes }.to_json }
+
+        it "serializes to JSON" do
+          subject.to_json.should eq expected_json
+        end
       end
     end
 
-    context "without publishable attributes defined" do
-      let(:expected_json) { { :tag => attributes }.to_json }
+    context "without roots in json" do
+      let(:serializable_attributes) { attributes.stringify_keys }
+
+      before(:each) do
+        ::ActiveRemote.config.include_root_in_json = false
+      end
+
+      after(:each) do
+        ::ActiveRemote.config.include_root_in_json = true
+      end
+
+      context "when options are nil" do
+        it "substitutes an empty hash" do
+          subject.as_json(nil).should eq serializable_attributes
+        end
+      end
+
+      context "with publishable attributes defined" do
+        let(:expected_json) { attributes.slice(:name).to_json }
+
+        before { Tag.attr_publishable :name }
+        after { reset_publishable_attributes(Tag) }
+
+        it "serializes to JSON with only the publishable attributes" do
+          subject.to_json.should eq expected_json
+        end
+      end
+
+      context "without publishable attributes defined" do
+        let(:expected_json) { attributes.to_json }
 
-      it "serializes to JSON" do
-        subject.to_json.should eq expected_json
+        it "serializes to JSON" do
+          subject.to_json.should eq expected_json
+        end
       end
     end
   end

data/spec/support/models/tag.rb

@@ -10,4 +10,12 @@ class Tag < ::ActiveRemote::Base
   attribute :name
   attribute :updated_at
 
+  after_update :after_update_callback
+  after_create :after_create_callback
+
+  def after_create_callback
+  end
+
+  def after_update_callback
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -143,22 +157,23 @@ files:
 - lib/active_remote/attributes.rb
 - lib/active_remote/base.rb
 - lib/active_remote/bulk.rb
+- lib/active_remote/config.rb
+- lib/active_remote/core_ext/date.rb
+- lib/active_remote/core_ext/date_time.rb
+- lib/active_remote/core_ext/integer.rb
 - lib/active_remote/dirty.rb
 - lib/active_remote/dsl.rb
 - lib/active_remote/errors.rb
 - lib/active_remote/integration.rb
 - lib/active_remote/persistence.rb
 - lib/active_remote/publication.rb
+- lib/active_remote/railtie.rb
 - lib/active_remote/rpc.rb
 - lib/active_remote/search.rb
 - lib/active_remote/serialization.rb
 - lib/active_remote/serializers/json.rb
 - lib/active_remote/serializers/protobuf.rb
 - lib/active_remote/version.rb
-- lib/core_ext/date.rb
-- lib/core_ext/date_time.rb
-- lib/core_ext/integer.rb
-- lib/protobuf_extensions/base_field.rb
 - spec/core_ext/date_time_spec.rb
 - spec/lib/active_remote/association_spec.rb
 - spec/lib/active_remote/base_spec.rb
@@ -211,41 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Active Record for your platform
-test_files:
-- spec/core_ext/date_time_spec.rb
-- spec/lib/active_remote/association_spec.rb
-- spec/lib/active_remote/base_spec.rb
-- spec/lib/active_remote/bulk_spec.rb
-- spec/lib/active_remote/dirty_spec.rb
-- spec/lib/active_remote/dsl_spec.rb
-- spec/lib/active_remote/integration_spec.rb
-- spec/lib/active_remote/persistence_spec.rb
-- spec/lib/active_remote/publication_spec.rb
-- spec/lib/active_remote/rpc_spec.rb
-- spec/lib/active_remote/search_spec.rb
-- spec/lib/active_remote/serialization_spec.rb
-- spec/lib/active_remote/serializers/json_spec.rb
-- spec/lib/active_remote/serializers/protobuf_spec.rb
-- spec/spec_helper.rb
-- spec/support/definitions/author.proto
-- spec/support/definitions/post.proto
-- spec/support/definitions/support/protobuf/category.proto
-- spec/support/definitions/support/protobuf/error.proto
-- spec/support/definitions/tag.proto
-- spec/support/helpers.rb
-- spec/support/models.rb
-- spec/support/models/author.rb
-- spec/support/models/category.rb
-- spec/support/models/message_with_options.rb
-- spec/support/models/post.rb
-- spec/support/models/tag.rb
-- spec/support/protobuf.rb
-- spec/support/protobuf/author.pb.rb
-- spec/support/protobuf/category.pb.rb
-- spec/support/protobuf/error.pb.rb
-- spec/support/protobuf/post.pb.rb
-- spec/support/protobuf/tag.pb.rb
+test_files: []

data/lib/protobuf_extensions/base_field.rb

@@ -1,18 +0,0 @@
-require 'protobuf'
-
-# A couple of helper fields.
-# Might make sense to create a patch for Protobuf.
-#
-Protobuf::Field::BaseField.class_eval do
-  unless respond_to?(:enum?)
-    def enum?
-      kind_of?(Protobuf::Field::EnumField)
-    end
-  end
-
-  unless respond_to?(:message?)
-    def message?
-      kind_of?(Protobuf::Field::MessageField)
-    end
-  end
-end