active_remote 5.0.0.pre → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20c9373eff2820fdfaeb4eefd815a1d4cfb752e9fd388e8fd0e2d4ef2c0c5f7f
-  data.tar.gz: 5f66d51af2723950bad69d3870fc83685e253f5fcfd894d6ae19dd6a78c27516
+  metadata.gz: 24ecc4009b9bb7ab623c2f80961e2e15263a249ac412be97c39f86cde123fdaa
+  data.tar.gz: ac0215aad0dce875952b9e2583e8c3fe8ce114d33de15978a7393482e7fa65dc
 SHA512:
-  metadata.gz: 07d671953169e1eefc9db8b26d2de3af40a39302e1423fdd7beeb212df913c46db1017aeb2dbc2d02c21cf72f0ae35639732d6af86694f0ecd7be894ae03db04
-  data.tar.gz: 98ee4213dcd636baab1def67ba1848469ff8592aff9334b720348830e4fd797f65e2935450fe399fafdc84261a64f2a07197323d38b743c616d4b70475f7890f
+  metadata.gz: c8cd4c36b5dc8840206dc32bbe4ccc3e591f631691e156d1ebcf537877442bf5be00c70506f8d2e890f2340f34b805e6cde7e1f80103c07bd1fcc4799b1829d7
+  data.tar.gz: ff8a9f380a3eba79fcd0cb41e4856e02c20ede68044bab07fe80b3996f88962e49e95f6db59308e4cdd7ff51468ff0b280f36307c21fdd5bf5f0cdd8c4bc393e

data/.travis.yml

@@ -1,5 +1,5 @@
 ---
 language: ruby
 rvm:
-  - 2.2
+  - 2.3
   - jruby

data/active_remote.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "active_remote/version"
 
 Gem::Specification.new do |s|

data/lib/active_remote/attribute_definition.rb

@@ -28,6 +28,7 @@ module ActiveRemote
     def <=>(other)
       return nil unless other.instance_of? self.class
       return nil if name == other.name && options != other.options
+
       self.name.to_s <=> other.name.to_s
     end
 
@@ -57,6 +58,7 @@ module ActiveRemote
     # @since 0.2.0
     def initialize(name, type = :value, **options)
       raise TypeError, "can't convert #{name.class} into Symbol" unless name.respond_to? :to_sym
+
       @name = name.to_sym
       @type = ::ActiveModel::Type.lookup(type)
       @options = options

data/lib/active_remote/attributes.rb

@@ -14,6 +14,7 @@ module ActiveRemote
     #
     def ==(other)
       return false unless other.instance_of?(self.class)
+
       attributes == other.attributes
     end
 

data/lib/active_remote/dirty.rb

@@ -29,6 +29,14 @@ module ActiveRemote
       end
     end
 
+    # Override #remote to provide dirty tracking.
+    #
+    def remote(*)
+      super.tap do
+        clear_changes_information
+      end
+    end
+
     # Override #save to store changes as previous changes then clear them.
     #
     def save(*)

data/lib/active_remote/dsl.rb

@@ -41,11 +41,11 @@ module ActiveRemote
 
       def endpoints(endpoints_hash = nil)
         @endpoints ||= {
-          :create  => :create,
-          :delete  => :delete,
+          :create => :create,
+          :delete => :delete,
           :destroy => :destroy,
-          :search  => :search,
-          :update  => :update
+          :search => :search,
+          :update => :update
         }
         @endpoints.merge!(endpoints_hash) if endpoints_hash.present?
         @endpoints

data/lib/active_remote/integration.rb

@@ -24,7 +24,7 @@ module ActiveRemote
     #   user.to_param  # => "GUID-1"
     #
     def to_param
-      self[:guid] && self[:guid].to_s
+      self[:guid]&.to_s
     end
 
     ##

data/lib/active_remote/persistence.rb

@@ -76,6 +76,7 @@ module ActiveRemote
     #
     def delete
       raise ReadOnlyRemoteRecord if readonly?
+
       response = remote_call(:delete, scope_key_hash)
 
       add_errors(response.errors) if response.respond_to?(:errors)
@@ -101,6 +102,7 @@ module ActiveRemote
     #
     def destroy
       raise ReadOnlyRemoteRecord if readonly?
+
       response = remote_call(:destroy, scope_key_hash)
 
       add_errors(response.errors) if response.respond_to?(:errors)
@@ -156,6 +158,19 @@ module ActiveRemote
       self.class.readonly? || @readonly
     end
 
+    # Executes a remote call on the current object and serializes it's attributes and
+    # errors from the response.
+    #
+    # Defaults request args to the scope key hash (e.g., { guid: 'ABC-123' }) when none are given.
+    # Returns false if the response contained errors; otherwise, returns true.
+    #
+    def remote(endpoint, request_args = scope_key_hash)
+      response = remote_call(endpoint, request_args)
+      assign_attributes_from_rpc(response)
+
+      success?
+    end
+
     # Saves the remote record.
     #
     # If it is a new record, it will be created through the service, otherwise
@@ -203,6 +218,7 @@ module ActiveRemote
     # attribute is marked as readonly.
     def update_attribute(name, value)
       raise ReadOnlyRemoteRecord if readonly?
+
       name = name.to_s
       send("#{name}=", value)
       save(:validate => false)
@@ -235,13 +251,7 @@ module ActiveRemote
     #
     def remote_create
       run_callbacks :create do
-        # Use the getter here so we get the type casting.
-        new_attributes = attributes
-
-        response = remote_call(:create, new_attributes)
-
-        instantiate(response.to_hash)
-        add_errors(response.errors) if response.respond_to?(:errors)
+        remote(:create, attributes)
 
         @new_record = has_errors?
         success?
@@ -254,6 +264,7 @@ module ActiveRemote
     #
     def create_or_update(*args)
       raise ReadOnlyRemoteRecord if readonly?
+
       new_record? ? remote_create : remote_update(*args)
     end
 
@@ -268,12 +279,7 @@ module ActiveRemote
         updated_attributes.slice!(*attribute_names)
         updated_attributes.merge!(scope_key_hash)
 
-        response = remote_call(:update, updated_attributes)
-
-        instantiate(response.to_hash)
-        add_errors(response.errors) if response.respond_to?(:errors)
-
-        success?
+        remote(:update, updated_attributes)
       end
     end
   end

data/lib/active_remote/query_attributes.rb

@@ -28,11 +28,7 @@ module ActiveRemote
       when true        then true
       when false, nil  then false
       else
-        if value.respond_to?(:zero?)
-          !value.zero?
-        else
-          value.present?
-        end
+        value.present?
       end
     end
 

data/lib/active_remote/rpc.rb

@@ -52,6 +52,12 @@ module ActiveRemote
       end
     end
 
+    def assign_attributes_from_rpc(response)
+      new_attributes = self.class.build_from_rpc(response.to_hash)
+      @attributes.update(new_attributes)
+      add_errors(response.errors) if response.respond_to?(:errors)
+    end
+
     def remote_call(rpc_method, request_args)
       self.class.remote_call(rpc_method, request_args)
     end

data/lib/active_remote/version.rb

@@ -1,3 +1,3 @@
 module ActiveRemote
-  VERSION = "5.0.0.pre"
+  VERSION = "5.0.0.rc1"
 end

data/spec/lib/active_remote/dirty_spec.rb

@@ -54,6 +54,15 @@ describe ActiveRemote::Dirty do
     its(:changes) { should be_empty }
   end
 
+  describe "#remote" do
+    let(:post) { Post.new(:name => "foo") }
+
+    it "clears changes information" do
+      allow(post).to receive(:remote_call).and_return(::Generic::Remote::Post.new(:name => "foo"))
+      expect { post.remote(:reload) }.to change { post.changed? }.to(false)
+    end
+  end
+
   describe "#save" do
     let!(:changes) { subject.changes }
 

data/spec/lib/active_remote/persistence_spec.rb

@@ -140,15 +140,6 @@ describe ::ActiveRemote::Persistence do
     end
   end
 
-  describe "#readonly?" do
-    context "when the record is created through instantiate with options[:readonly]" do
-      subject { Tag.instantiate({ :guid => "foo" }, :readonly => true) }
-
-      its(:new_record?) { should be_falsey }
-      its(:readonly?) { should be_truthy }
-    end
-  end
-
   describe "#has_errors?" do
     context "when errors are not present" do
       before { subject.errors.clear }
@@ -197,6 +188,70 @@ describe ::ActiveRemote::Persistence do
     end
   end
 
+  describe "#readonly?" do
+    context "when the record is created through instantiate with options[:readonly]" do
+      subject { Tag.instantiate({ :guid => "foo" }, :readonly => true) }
+
+      its(:new_record?) { should be_falsey }
+      its(:readonly?) { should be_truthy }
+    end
+  end
+
+  describe "#remote" do
+    let(:response) { ::Generic::Remote::Tag.new(:guid => tag.guid, :name => "bar") }
+    let(:rpc) { ::ActiveRemote::RPCAdapters::ProtobufAdapter.new(::Tag.service_class, ::Tag.endpoints) }
+    let(:tag) { ::Tag.new(:guid => SecureRandom.uuid) }
+
+    subject { tag }
+
+    before do
+      allow(::Tag).to receive(:rpc).and_return(rpc)
+      allow(rpc).to receive(:execute).and_return(response)
+    end
+
+    it "calls the given RPC method with default args" do
+      expect(::Tag.rpc).to receive(:execute).with(:remote_method, tag.scope_key_hash)
+      tag.remote(:remote_method)
+    end
+
+    it "updates the attributes from the response" do
+      expect { tag.remote(:remote_method) }.to change { tag.name }.to(response.name)
+    end
+
+    it "returns true" do
+      expect(tag.remote(:remote_method)).to be(true)
+    end
+
+    context "when request args are given" do
+      it "calls the given RPC method with default args" do
+        attributes = { :guid => tag.guid, :name => "foo" }
+        expect(::Tag.rpc).to receive(:execute).with(:remote_method, attributes)
+        tag.remote(:remote_method, attributes)
+      end
+    end
+
+    context "when response does not respond to errors" do
+      it "returns true" do
+        allow(rpc).to receive(:execute).and_return(double(:response, :to_hash => ::Hash.new))
+        expect(tag.remote(:remote_method)).to be(true)
+      end
+    end
+
+    context "when errors are returned" do
+      let(:response) {
+        ::Generic::Remote::Tag.new(:guid => tag.guid, :name => "bar", :errors => [{ :field => "name", :message => "message" }])
+      }
+
+      it "adds errors from the response" do
+        expect { tag.remote(:remote_method) }.to change { tag.has_errors? }.to(true)
+      end
+
+      it "returns false" do
+        expect(tag.remote(:remote_method)).to be(false)
+      end
+    end
+  end
+
   describe "#save" do
     it "runs save callbacks" do
       allow(subject).to receive(:run_callbacks).with(:validation).and_return(true)
@@ -313,12 +368,12 @@ describe ::ActiveRemote::Persistence do
 
     it "runs update callbacks" do
       expect(tag).to receive(:after_update_callback)
-      tag.update_attributes({})
+      tag.update({})
     end
 
     it "updates a remote record" do
       expect(rpc).to receive(:execute).with(:update, tag.scope_key_hash)
-      tag.update_attributes({})
+      tag.update({})
     end
 
     before { allow(subject).to receive(:save) }
@@ -326,12 +381,12 @@ describe ::ActiveRemote::Persistence do
 
     it "assigns new attributes" do
       expect(subject).to receive(:assign_attributes).with(attributes)
-      subject.update_attributes(attributes)
+      subject.update(attributes)
     end
 
     it "saves the record" do
       expect(subject).to receive(:save)
-      subject.update_attributes(attributes)
+      subject.update(attributes)
     end
   end
 
@@ -343,12 +398,12 @@ describe ::ActiveRemote::Persistence do
 
     it "assigns new attributes" do
       expect(subject).to receive(:assign_attributes).with(attributes)
-      subject.update_attributes!(attributes)
+      subject.update!(attributes)
     end
 
     it "saves! the record" do
       expect(subject).to receive(:save!)
-      subject.update_attributes!(attributes)
+      subject.update!(attributes)
     end
   end
 end

data/spec/lib/active_remote/query_attribute_spec.rb

@@ -38,9 +38,10 @@ describe ::ActiveRemote::QueryAttributes do
       expect(subject.name?).to eq true
     end
 
-    it "is false when the attribute is 0" do
+    # This behavior varies from ActiveRecord, so we test it explicitly
+    it "is true when the attribute is 0" do
       subject.name = 0
-      expect(subject.name?).to eq false
+      expect(subject.name?).to eq true
     end
 
     it "is true when the attribute is 1" do

data/spec/lib/active_remote/rpc_spec.rb

@@ -50,4 +50,35 @@ describe ::ActiveRemote::RPC do
       expect(::Tag.remote_call(:remote_method, args)).to eq response
     end
   end
+
+  describe "#assign_attributes_from_rpc" do
+    let(:response) { ::Generic::Remote::Tag.new(:guid => tag.guid, :name => "bar") }
+    let(:tag) { ::Tag.new(:guid => SecureRandom.uuid) }
+
+    it "updates the attributes from the response" do
+      expect { tag.assign_attributes_from_rpc(response) }.to change { tag.name }.to(response.name)
+    end
+
+    context "when response does not respond to errors" do
+      let(:response) { double(:response, :to_hash => ::Hash.new) }
+
+      it "does not add errors from the response" do
+        expect { tag.assign_attributes_from_rpc(response) }.to_not change { tag.has_errors? }
+      end
+    end
+
+    context "when errors are returned" do
+      let(:response) {
+        ::Generic::Remote::Tag.new(
+          :guid => tag.guid,
+          :name => "bar",
+          :errors => [{ :field => "name", :message => "message" }]
+        )
+      }
+
+      it "adds errors from the response" do
+        expect { tag.assign_attributes_from_rpc(response) }.to change { tag.has_errors? }.to(true)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_remote
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre
+  version: 5.0.0.rc1
 platform: ruby
 authors:
 - Adam Hutchison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel