active_remote 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 528f82335b1b30d9baad0fb5f8039e6e7b5773b1
-  data.tar.gz: e85d2753fe773ff549c0c733f7227ec1600240bf
+  metadata.gz: e660e679338d45a8815db30aed43a7f2376d3db3
+  data.tar.gz: bf4afbe98337b384a369df5cb5d4b7ad19d3d009
 SHA512:
-  metadata.gz: f9330f045952e311261eb5b2c974a62587069651cda046b97f8a11e65fe3d4eb899d2a304ec45adf407062c7fc000184e34ada6d75c0995b0c4f06b367d75bdd
-  data.tar.gz: b1b998e8fb3d6ab724546f466b201f890a0a6eb3f60d154d72a5dbdec41ab6e8276e9ff165dabe158f184c9de52beef4efb1ef8a9fc6a0c6508b262f93e3051a
+  metadata.gz: 5bfb0fb12ba5dd76c11fa9bebea904bdad40c74c6be49cf23556589a687bcfd01e51e1ef08ddf41a520bdbc30fab514d05a22e81cdb0b9cb02d7ceba1a427cf0
+  data.tar.gz: 3a95c65136b76bc0b0e99b23a5ad781f898d28075f4516bf38c3121f0717846413a7fe5bc284fd4e309ea0d6326bc8e68f998daf8f7c44ce8f4075b318b65adc

data/lib/active_remote/association.rb

@@ -2,7 +2,7 @@ module ActiveRemote
   module Association
     def self.included(klass)
       klass.class_eval do
-        extend ActiveRemote::Association::ClassMethods
+        extend ::ActiveRemote::Association::ClassMethods
       end
     end
 

data/lib/active_remote/base.rb

@@ -3,6 +3,7 @@ require 'active_remote/attributes'
 require 'active_remote/bulk'
 require 'active_remote/dirty'
 require 'active_remote/dsl'
+require 'active_remote/integration'
 require 'active_remote/persistence'
 require 'active_remote/publication'
 require 'active_remote/rpc'
@@ -19,6 +20,7 @@ module ActiveRemote
     include ::ActiveRemote::Attributes
     include ::ActiveRemote::Bulk
     include ::ActiveRemote::DSL
+    include ::ActiveRemote::Integration
     include ::ActiveRemote::Persistence
     include ::ActiveRemote::Publication
     include ::ActiveRemote::RPC

data/lib/active_remote/bulk.rb

@@ -4,8 +4,8 @@ module ActiveRemote
   module Bulk
     def self.included(klass)
       klass.class_eval do
-        extend ActiveRemote::Bulk::ClassMethods
-        include ActiveRemote::Persistence
+        extend ::ActiveRemote::Bulk::ClassMethods
+        include ::ActiveRemote::Persistence
       end
     end
 

data/lib/active_remote/dsl.rb

@@ -4,8 +4,8 @@ module ActiveRemote
   module DSL
     def self.included(klass)
       klass.class_eval do
-        extend ActiveRemote::DSL::ClassMethods
-        include ActiveRemote::DSL::InstanceMethods
+        extend ::ActiveRemote::DSL::ClassMethods
+        include ::ActiveRemote::DSL::InstanceMethods
       end
     end
 

data/lib/active_remote/integration.rb

@@ -0,0 +1,52 @@
+module ActiveRemote
+  module Integration
+    def self.included(klass)
+      klass.class_eval do
+        unless singleton_methods.include?(:cache_timestamp_format)
+          ##
+          # :singleton-method:
+          # Indicates the format used to generate the timestamp format in the cache key.
+          # This is +:number+, by default.
+          #
+          def self.cache_timestamp_format
+            :number
+          end
+
+        end
+      end
+    end
+
+    ##
+    # Returns a String, which can be used for constructing an URL to this
+    # object. The default implementation returns this record's guid as a String,
+    # or nil if this record's unsaved.
+    #
+    #   user = User.search(:name => 'Phusion')
+    #   user.to_param  # => "GUID-1"
+    #
+    def to_param
+      self[:guid] && self[:guid].to_s
+    end
+
+    ##
+    # Returns a cache key that can be used to identify this record.
+    #
+    # ==== 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)
+    #
+    def cache_key
+      case
+      when new_record? then
+        "#{self.class.name.underscore}/new"
+      when timestamp = self[:updated_at] then
+        timestamp = timestamp.utc.to_s(self.class.cache_timestamp_format)
+        "#{self.class.name.underscore}/#{self.to_param}-#{timestamp}"
+      else
+        "#{self.class.name.underscore}/#{self.to_param}"
+      end
+    end
+  end
+end

data/lib/active_remote/persistence.rb

@@ -4,9 +4,9 @@ module ActiveRemote
   module Persistence
     def self.included(klass)
       klass.class_eval do
-        extend ActiveRemote::Persistence::ClassMethods
-        include ActiveRemote::Persistence::InstanceMethods
-        include ActiveRemote::RPC
+        extend ::ActiveRemote::Persistence::ClassMethods
+        include ::ActiveRemote::Persistence::InstanceMethods
+        include ::ActiveRemote::RPC
 
         # Allow users to create callbacks around a `save` call.
         #

data/lib/active_remote/version.rb

@@ -1,3 +1,3 @@
 module ActiveRemote
-  VERSION = "1.5.9"
+  VERSION = "1.6.0"
 end

data/spec/lib/active_remote/integration_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe ::ActiveRemote::Integration do
+  let(:guid) { "GUID-derp" }
+  subject { Tag.new(:guid => guid) }
+
+  context "#to_param" do
+    # API
+    specify { subject.should respond_to(:to_param) }
+
+    it "returns the guid if the guid is present (by default)" do
+      subject.to_param.should eq(guid)
+    end
+  end
+
+  context "#cache_key" do
+    # API
+    specify { subject.should respond_to(:cache_key) }
+
+    it "sets 'new' as the identifier when the record has not been persisted" do
+      subject.should_receive(:new_record?).and_return(true)
+      subject.cache_key.should match(/tag\/new/)
+    end
+
+    it "sets the cache_key to the class/guid as a default" do
+      subject.should_receive(:new_record?).and_return(false)
+      subject.cache_key.should eq("tag/#{guid}")
+    end
+
+    it "adds the 'updated_at' attribute to the cache_key if updated_at is present" do
+      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
+    end
+  end
+end

data/spec/lib/active_remote/search_spec.rb

@@ -76,7 +76,7 @@ describe ActiveRemote::Search do
 
   describe "#reload" do
     let(:args) { { :guid => 'foo' } }
-    let(:attributes) { HashWithIndifferentAccess.new(:guid => 'foo', :name => 'bar') }
+    let(:attributes) { HashWithIndifferentAccess.new(:guid => 'foo', :name => 'bar', :updated_at => nil) }
 
     subject { Tag.new(args) }
 

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe ActiveRemote::Serializers::JSON do
   describe "#as_json" do
-    let(:attributes) { { :guid => 'foo', :name => 'bar' } }
+    let(:attributes) { { :guid => 'foo', :name => 'bar', :updated_at => nil } }
     let(:serializable_attributes) { { "tag" => attributes.stringify_keys } }
 
     subject { Tag.new(attributes) }

data/spec/support/models/tag.rb

@@ -8,5 +8,6 @@ class Tag < ::ActiveRemote::Base
 
   attribute :guid
   attribute :name
+  attribute :updated_at
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -146,6 +146,7 @@ files:
 - 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/rpc.rb
@@ -164,6 +165,7 @@ files:
 - 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
@@ -220,6 +222,7 @@ test_files:
 - 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