active_remote 2.1.0.beta2 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eea2bfe1e14ec6f0915d7c9bfda568a1a1974a8
-  data.tar.gz: 184a79d8077a63773de1e3d2c9e8b9238382d6bc
+  metadata.gz: 9db0dc04521916e66ca566f9ece9b5f0cc8e803e
+  data.tar.gz: aea18e2d9200b988918570898a95fb0a47ed15aa
 SHA512:
-  metadata.gz: 02647968d80f3be1942b2dde24f9594003fda337403cda22e3054d5ec385c735b80dffb5afd6e3ae129ca22e71abb74ea17bc4c6a55780250657ed7f1e891e63
-  data.tar.gz: 98d5289e8ed50bc6cd0fc5e2d8394bb043f806985ea1718bda9854a88e6ff1c962f27dd6aa6e9bc274196e7a705e1b8989701357fbf87d7da4fdedd0f330cd3a
+  metadata.gz: bead40af9673772592780b3a7b62252815fcd0805e2988a5d7d4b6f9d2a3eb32975e3fd2b50f1937096d32c1c053ae5ff8567959861f5c87aeac01cdd27b0b57
+  data.tar.gz: 56d7903986b4bbb33a3c703a833441d44dd76210a560bb48c9e12d72ac9fff3da23276ba3958752d4b8a8b30507f0c44185c4a57fa289c3fbf89dc20698ce330

data/lib/active_remote/bulk.rb

@@ -32,8 +32,13 @@ module ActiveRemote
       #   Tag.create_all(Generic::Remote::Tags.new(:records => [ Generic::Remote::Tag.new(:name => 'foo') ])
       #
       def create_all(*records)
-        response = rpc.execute(:create_all, parse_records(records))
-        serialize_records(response.records) if response.respond_to?(:records)
+        response = rpc.execute(:create_all, _parse_records(records))
+
+        if response.respond_to?(:records)
+          serialize_records(response.records)
+        else
+          warn "DEPRECATED responses to bulk methods must respond to :records. In Active Remote 3.0, bulk responses that don't respond to :records will raise an exception"
+        end
       end
 
       # Delete multiple records at the same time. Returns a collection of active
@@ -58,8 +63,13 @@ module ActiveRemote
       #   Tag.delete_all(Generic::Remote::Tags.new(:records => [ Generic::Remote::Tag.new(:guid => 'foo') ])
       #
       def delete_all(*records)
-        response = rpc.execute(:delete_all, parse_records(records))
-        serialize_records(response.records) if response.respond_to?(:records)
+        response = rpc.execute(:delete_all, _parse_records(records))
+
+        if response.respond_to?(:records)
+          serialize_records(response.records)
+        else
+          warn "DEPRECATED responses to bulk methods must respond to :records. In Active Remote 3.0, bulk responses that don't respond to :records will raise an exception"
+        end
       end
 
       # Destroy multiple records at the same time. Returns a collection of active
@@ -84,8 +94,13 @@ module ActiveRemote
       #   Tag.destroy_all(Generic::Remote::Tags.new(:records => [ Generic::Remote::Tag.new(:guid => 'foo') ])
       #
       def destroy_all(*records)
-        response = rpc.execute(:destroy_all, parse_records(records))
-        serialize_records(response.records) if response.respond_to?(:records)
+        response = rpc.execute(:destroy_all, _parse_records(records))
+
+        if response.respond_to?(:records)
+          serialize_records(response.records)
+        else
+          warn "DEPRECATED responses to bulk methods must respond to :records. In Active Remote 3.0, bulk responses that don't respond to :records will raise an exception"
+        end
       end
 
       # Parse given records to get them ready to be built into a request.
@@ -96,18 +111,9 @@ module ActiveRemote
       # Returns +{ :records => records }+.
       #
       def parse_records(*records)
-        records.flatten!
+        warn "DEPRECATED Model.parse_records is deprecated. It will be removed in Active Remove 3.0"
 
-        if records.first.respond_to?(:attributes)
-          records.collect!(&:attributes)
-        else
-          records.collect!(&:to_hash)
-        end
-
-        return records.first if records.first && records.first.has_key?(:records)
-
-        # If we made it this far, build a bulk-formatted hash.
-        return { :records => records }
+        _parse_records(*records)
       end
 
       # Update multiple records at the same time. Returns a collection of active
@@ -132,8 +138,30 @@ module ActiveRemote
       #   Tag.update_all(Generic::Remote::Tags.new(:records => [ Generic::Remote::Tag.new(:guid => 'foo', :name => 'baz') ])
       #
       def update_all(*records)
-        response = rpc.execute(:update_all, parse_records(records))
-        serialize_records(response.records) if response.respond_to?(:records)
+        response = rpc.execute(:update_all, _parse_records(records))
+
+        if response.respond_to?(:records)
+          serialize_records(response.records)
+        else
+          warn "DEPRECATED responses to bulk methods must respond to :records. In Active Remote 3.0, bulk responses that don't respond to :records will raise an exception"
+        end
+      end
+
+      private
+
+      def _parse_records(*records)
+        records.flatten!
+
+        if records.first.respond_to?(:attributes)
+          records.collect!(&:attributes)
+        else
+          records.collect!(&:to_hash)
+        end
+
+        return records.first if records.first && records.first.has_key?(:records)
+
+        # If we made it this far, build a bulk-formatted hash.
+        return { :records => records }
       end
     end
   end

data/lib/active_remote/persistence.rb

@@ -78,8 +78,7 @@ module ActiveRemote
       raise ReadOnlyRemoteRecord if readonly?
       response = rpc.execute(:delete, scope_key_hash)
 
-      # TODO: add errors here so success? actually does something...
-      # add_errors(response.errors)
+      add_errors(response.errors)
 
       return success? ? freeze : false
     end
@@ -102,10 +101,9 @@ module ActiveRemote
     #
     def destroy
       raise ReadOnlyRemoteRecord if readonly?
-      response = execute(:destroy, scope_key_hash)
+      response = rpc.execute(:destroy, scope_key_hash)
 
-      # TODO: add errors here so success? actually does something...
-      # add_errors(response.errors)
+      add_errors(response.errors)
 
       return success? ? freeze : false
     end

data/lib/active_remote/rpc.rb

@@ -9,8 +9,6 @@ module ActiveRemote
       include Embedded
     end
 
-    # TODO: Deprecate this pattern of executing RPC calls
-    #
     module Embedded
       extend ActiveSupport::Concern
 
@@ -19,11 +17,10 @@ module ActiveRemote
       end
 
       module ClassMethods
-        # Return a protobuf request object for the given rpc request.
-        #
-        # TODO: Add deprecation warning
-        #
+        # :noapi:
         def request(rpc_method, request_args)
+          warn "DEPRECATED Model.request is deprecated and will be removed in Active Remote 3.0. This is handled by the Protobuf RPC adpater now"
+
           return request_args unless request_args.is_a?(Hash)
 
           message_class = request_type(rpc_method)
@@ -31,20 +28,18 @@ module ActiveRemote
           message_class.new(fields)
         end
 
-        # Return the class applicable to the request for the given rpc method.
-        #
-        # TODO: Add deprecation warning
-        #
+        # :noapi:
         def request_type(rpc_method)
+          warn "DEPRECATED Model.request_type is deprecated and will be removed in Active Remote 3.0. This is handled by the Protobuf RPC adpater now"
+
           service_class.rpcs[rpc_method].request_type
         end
       end
 
-      # Invoke an RPC call to the service for the given rpc method.
-      #
-      # TODO: Add deprecation warning
-      #
+      # :noapi:
       def execute(rpc_method, request_args)
+        warn "DEPRECATED Model#execute is deprecated and will be removed in Active Remote 3.0. Use Model#rpc.execute instead"
+
         @last_request = request(rpc_method, request_args)
 
         _service_class.client.__send__(rpc_method, @last_request) do |c|
@@ -63,22 +58,19 @@ module ActiveRemote
         @last_response
       end
 
-
-      # Execute an RPC call to the remote service and return the raw response.
-      #
-      # TODO: Add deprecation warning
-      #
+      # :noapi:
       def remote_call(rpc_method, request_args)
+        warn "DEPRECATED Model#remote_call is deprecated and will be removed in Active Remote 3.0. Use Model#rpc.execute instead"
+
         rpc.execute(rpc_method, request_args)
       end
 
       private
 
-      # Return a protobuf request object for the given rpc call.
-      #
-      # TODO: Add deprecation warning
-      #
+      # :noapi:
       def request(rpc_method, attributes)
+        warn "DEPRECATED Model#request is deprecated and will be removed in Active Remote 3.0. This is handled by the Protobuf RPC adpater now"
+
         self.class.request(rpc_method, attributes)
       end
     end

data/lib/active_remote/search.rb

@@ -14,6 +14,13 @@ module ActiveRemote
 
     module ClassMethods
 
+      # :noapi:
+      def _active_remote_search_args(args)
+        warn "DEPRECATED Model._active_remote_search_args is depracted and will be remoted in Active Remote 3.0."
+
+        validate_search_args!(args)
+      end
+
       # Tries to load the first record; if it fails, an exception is raised.
       #
       # ====Examples
@@ -89,7 +96,7 @@ module ActiveRemote
       #   Tag.search(Generic::Remote::TagRequest.new(:name => 'foo'))
       #
       def search(args)
-        args = _active_remote_search_args(args)
+        args = validate_search_args!(args)
 
         response = rpc.execute(:search, args)
 
@@ -99,13 +106,15 @@ module ActiveRemote
         end
       end
 
-      # :noapi:
-      def _active_remote_search_args(args)
+      # Validates the given args to ensure they are compatible
+      # Search args must be a hash or respond to to_hash
+      #
+      def validate_search_args!(args)
         unless args.is_a?(Hash)
           if args.respond_to?(:to_hash)
             args = args.to_hash
           else
-            raise "Invalid parameter: #{args}. First parameter must respond to :to_hash."
+            raise "Invalid parameter: #{args}. Search args must respond to :to_hash."
           end
         end
 
@@ -113,11 +122,10 @@ module ActiveRemote
       end
     end
 
-    # Search for the given resource. Auto-paginates (i.e. continues searching
-    # for records matching the given search args until all records have been
-    # retrieved) if no pagination options are given.
-    #
+    # :noapi:
     def _active_remote_search(args)
+      warn "DEPRECATED Model#_active_remote_search is depracted and will be remoted in Active Remote 3.0."
+
       run_callbacks :search do
         rpc.execute(:search, args)
       end

data/lib/active_remote/serialization.rb

@@ -46,7 +46,7 @@ module ActiveRemote
     # DEPRECATED – Use :add_errors instead
     #
     def add_errors_from_response(response = nil)
-      warn 'DEPRECATED :add_errors_from_response is deprecated and will be removed in Active Remote 3.0. Use :add_errors instead'
+      warn 'DEPRECATED Model#add_errors_from_response is deprecated and will be removed in Active Remote 3.0. Use Model#add_errors instead'
 
       response ||= last_response
 
@@ -56,7 +56,7 @@ module ActiveRemote
     # DEPRECATED – Use the class-level :serialize_errors instead
     #
     def serialize_records(records = nil)
-      warn 'DEPRECATED Calling :serialize_records on an instance is deprecated and will be removed in Active Remote 3.0. Use the class-level :serialize_records instead'
+      warn 'DEPRECATED Calling Model#serialize_records is deprecated and will be removed in Active Remote 3.0. Use Model.serialize_records instead'
 
       records ||= last_response.records if last_response.respond_to?(:records)
       return if records.nil?

data/lib/active_remote/version.rb

@@ -1,3 +1,3 @@
 module ActiveRemote
-  VERSION = "2.1.0.beta2"
+  VERSION = "2.1.0.rc1"
 end

data/spec/lib/active_remote/bulk_spec.rb

@@ -1,79 +1,69 @@
 require 'spec_helper'
 
 describe ActiveRemote::Bulk do
-  let(:records) { double(:records, :to_hash => {}) }
-  let(:serialized_records) { double(:serialized_records) }
-
-  describe ".create_all" do
-    before { Tag.better_stub(:parse_records).and_return(records) }
-
-    it "creates remote records" do
-      Tag.rpc.better_receive(:execute).with(:create_all, records)
-      Tag.create_all(records)
-    end
-  end
-
-  describe ".delete_all" do
-    before { Tag.better_stub(:parse_records).and_return(records) }
+  shared_examples_for "a bulk method" do |bulk_method|
+    let(:records) { [ Hash.new ] }
+    let(:response) { double(:response, :records => []) }
 
-    it "deletes remote records" do
-      Tag.rpc.better_receive(:execute).with(:delete_all, records)
-      Tag.delete_all(records)
-    end
-  end
+    before { Tag.rpc.better_stub(:execute).and_return(response) }
 
-  describe ".destroy_all" do
-    before { Tag.better_stub(:parse_records).and_return(records) }
+    context "given an empty array" do
+      let(:parsed_records) { { :records => records } }
+      let(:records) { [] }
 
-    it "destroys remote records" do
-      Tag.rpc.better_receive(:execute).with(:destroy_all, records)
-      Tag.destroy_all(records)
+      it "calls #{bulk_method} with parsed records" do
+        Tag.rpc.better_receive(:execute).with(bulk_method, parsed_records)
+        Tag.__send__(bulk_method, records)
+      end
     end
-  end
 
-  describe ".parse_records" do
-    let(:records) { [ Hash.new ] }
-    let(:empty_records) { [] }
-    let(:attribute_record) {
-      record = double(Hash)
-      record.stub(:attributes) { {} }
-      record
-    }
+    context "given an array of record hashes" do
+      let(:hash_record){ double(:record, :to_hash => {}) }
+      let(:parsed_records) { { :records => records.map(&:to_hash) } }
+      let(:records) { [ hash_record ] }
 
-    it "returns an empty array when given empty records" do
-      parsed_records = { :records => [] }
-      Tag.parse_records(empty_records).should eq(parsed_records)
+      it "calls #{bulk_method} with parsed records" do
+        Tag.rpc.better_receive(:execute).with(bulk_method, parsed_records)
+        Tag.__send__(bulk_method, records)
+      end
     end
 
-    it "preps records to be built into a bulk request" do
-      parsed_records = { :records => records }
-      Tag.parse_records(records).should eq parsed_records
-    end
+    context "given an array of remote records" do
+      let(:parsed_records) { { :records => records.map(&:attributes) } }
+      let(:records) { [ remote_record ] }
+      let(:remote_record) { double(:remote, :attributes => {}) }
 
-    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
+      it "calls #{bulk_method} with parsed records" do
+        Tag.rpc.better_receive(:execute).with(bulk_method, parsed_records)
+        Tag.__send__(bulk_method, records)
+      end
     end
 
-    context "when given a bulk message" do
-      let(:records) { [ tag.to_hash ] }
+    context "given a bulk message" do
+      let(:parsed_records) { { :records => records.map(&:to_hash) } }
       let(:tag) { Generic::Remote::Tag.new }
       let(:tags) { Generic::Remote::Tags.new(:records => [ tag ]) }
 
-      it "preps records to be built into a bulk request" do
-        parsed_records = { :records => records }
-        Tag.parse_records(tags).should eq parsed_records
+      it "calls #{bulk_method} with parsed records" do
+        Tag.rpc.better_receive(:execute).with(bulk_method, parsed_records)
+        Tag.__send__(bulk_method, tags)
       end
     end
   end
 
-  describe ".update_all" do
-    before { Tag.stub(:parse_records).and_return(records) }
+  describe ".create_all" do
+    it_behaves_like "a bulk method", :create_all
+  end
 
-    it "updates remote records" do
-      Tag.rpc.better_receive(:execute).with(:update_all, records)
-      Tag.update_all(records)
-    end
+  describe ".delete_all" do
+    it_behaves_like "a bulk method", :delete_all
+  end
+
+  describe ".destroy_all" do
+    it_behaves_like "a bulk method", :destroy_all
+  end
+
+  describe ".update_all" do
+    it_behaves_like "a bulk method", :update_all
   end
 end

data/spec/lib/active_remote/persistence_spec.rb

@@ -57,16 +57,21 @@ describe ActiveRemote::Persistence do
       end
     end
 
-    # TODO: This spec passes, but the implementation does not actually work.
-    # Uncomment it once the implementation is correct.
-    #
-    # context "when the record has errors" do
-    #   before { subject.stub(:has_errors?).and_return(true) }
-    #
-    #   it "returns false" do
-    #     subject.delete.should be_false
-    #   end
-    # end
+    context "when the response has errors" do
+      let(:error) { Generic::Error.new(:field => 'name', :message => 'Boom!') }
+      let(:response) { Generic::Remote::Tag.new(:errors => [ error ]) }
+
+      before { rpc.better_stub(:execute).and_return(response) }
+
+      it "adds the errors to the record" do
+        subject.delete
+        subject.has_errors?.should be_true
+      end
+
+      it "returns false" do
+        subject.delete.should be_false
+      end
+    end
   end
 
   describe "#delete!" do
@@ -75,25 +80,21 @@ describe ActiveRemote::Persistence do
       subject.delete!
     end
 
-    # FIXME: This spec tests that excute raises an execption, not that an
-    # exception is raised when an error is returned (as it should).
-    # Uncomment it once the implementation is correct.
-    #
-    # context "when an error occurs" do
-    #   before { rpc.stub(:execute).and_raise(ActiveRemote::ActiveRemoteError) }
-    #
-    #   it "raises an exception" do
-    #     expect { subject.delete! }.to raise_error(ActiveRemote::ActiveRemoteError)
-    #   end
-    # end
+    context "when an error occurs" do
+      let(:error) { Generic::Error.new(:field => 'name', :message => 'Boom!') }
+      let(:response) { Generic::Remote::Tag.new(:errors => [ error ]) }
+
+      before { rpc.better_stub(:execute).and_return(response) }
+
+      it "raises an exception" do
+        expect { subject.delete! }.to raise_error(ActiveRemote::ActiveRemoteError)
+      end
+    end
   end
 
   describe "#destroy" do
-    before { subject.stub(:execute) }
-    after { subject.unstub(:execute) }
-
     it "destroys a remote record" do
-      subject.should_receive(:execute).with(:destroy, subject.scope_key_hash)
+      rpc.should_receive(:execute).with(:destroy, subject.scope_key_hash)
       subject.destroy
     end
 
@@ -104,35 +105,39 @@ describe ActiveRemote::Persistence do
       end
     end
 
-    # TODO: This spec passes, but the implementation does not actually work.
-    # Uncomment it once the implementation is correct.
-    #
-    # context "when the record has errors" do
-    #   before { subject.stub(:has_errors?).and_return(true) }
-    #
-    #   it "returns false" do
-    #     subject.destroy.should be_false
-    #   end
-    # end
+    context "when the response has errors" do
+      let(:error) { Generic::Error.new(:field => 'name', :message => 'Boom!') }
+      let(:response) { Generic::Remote::Tag.new(:errors => [ error ]) }
+
+      before { rpc.better_stub(:execute).and_return(response) }
+
+      it "adds the errors to the record" do
+        subject.destroy
+        subject.has_errors?.should be_true
+      end
+
+      it "returns false" do
+        subject.destroy.should be_false
+      end
+    end
   end
 
   describe "#destroy!" do
     it "destroys a remote record" do
-      subject.should_receive(:execute).with(:destroy, subject.attributes.slice("guid"))
+      rpc.should_receive(:execute).with(:destroy, subject.scope_key_hash)
       subject.destroy!
     end
 
-    # FIXME: This spec tests that excute raises an execption, not that an
-    # exception is raised when an error is returned (as it should).
-    # Uncomment it once the implementation is correct.
-    #
-    # context "when an error occurs" do
-    #   before { subject.stub(:execute).and_raise(ActiveRemote::ActiveRemoteError) }
-    #
-    #   it "raises an exception" do
-    #     expect { subject.destroy! }.to raise_error(ActiveRemote::ActiveRemoteError)
-    #   end
-    # end
+    context "when an error occurs" do
+      let(:error) { Generic::Error.new(:field => 'name', :message => 'Boom!') }
+      let(:response) { Generic::Remote::Tag.new(:errors => [ error ]) }
+
+      before { rpc.better_stub(:execute).and_return(response) }
+
+      it "raises an exception" do
+        expect { subject.destroy! }.to raise_error(ActiveRemote::ActiveRemoteError)
+      end
+    end
   end
 
   describe "#readonly?" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta2
+  version: 2.1.0.rc1
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr