restforce 2.5.2 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe36ce396f2e18efc3f6ca5baa391ba0d3e5ada
-  data.tar.gz: e968e760eb726434e54576836985732221fd9457
+  metadata.gz: 37d2535283740f9a089e2a1fa91dd856b3047180
+  data.tar.gz: 68d9358e56b9c9150ac504549ad0baa031f1fa25
 SHA512:
-  metadata.gz: 3a60bb6adcd71799a5bdbb4b19a41bfefa9aa554db975e3442ee3c90af2db4489a4f699029617dba0f50c5fe2fe2e0ed535160cfb617211cb0054f1cbc0ea165
-  data.tar.gz: 9af84717f844c3497bcc357083e468fcb7fe4c50e070dac0465696bfbea001395335a01d18efdc02c29d1375ccd1af98638f6388ef6cca69d87a98bcca30e53e
+  metadata.gz: 6968dd3d8edd7559f36225b85325f9b2712836b30cde5e26393e676266013a7267f4e4b36e4273610cb33dda9dea95f8ebff862a021fd817e46528c29e34b04d
+  data.tar.gz: d7049225f2af6b649103a7b86b4d4487c0e4af5a4759db4345473d79562e74889384bee64a96c81980a8c9187ceaa6c78843d233413bf5ce291ea7bb714552d0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.5.3 (April 25, 2017)
+
+* Raise an error where a custom external ID field name is supplied to `upsert` and `upsert!`, but it is missing from the provided attributes (@velveret)
+* Use the Restforce client's configured SSL options for authentication requests (@jvdp)
+* Fix bug where `upsert` and `upsert!` mutate the provided attributes, previously fixed in [v1.5.3](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#153-jun-26-2015) (@velveret)
+
+
 ## 2.5.2 (Apr 3, 2017)
 
 * Ensure `Restforce::Middleware::Logger` is the last Faraday middleware to be called so everything is properly logged (including the effects of the `Gzip` and `CustomHeaders` middlewares which were previously running after it) (@jonnymacs)

data/Gemfile

@@ -3,6 +3,7 @@ gemspec
 
 gem 'rake'
 gem 'jruby-openssl', :platforms => :jruby
+gem 'faraday', '~> 0.11.0'
 
 group :development do
   gem 'guard-rspec'

data/Gemfile.travis

@@ -3,5 +3,6 @@ gemspec
 
 gem 'rake'
 gem 'rack', '~> 1.6.4'
+gem 'faraday', '~> 0.11.0'
 gem 'jruby-openssl', :platforms => :jruby
 gem 'public_suffix', '2.0.3'

data/README.md

@@ -25,7 +25,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 2.5.2'
+    gem 'restforce', '~> 2.5.3'
 
 And then execute:
 

data/lib/restforce/concerns/api.rb

@@ -317,7 +317,7 @@ module Restforce
       # Raises an exception if an error is returned from Salesforce.
       def update!(sobject, attrs)
         id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.downcase == 'id' }, nil)
-        raise ArgumentError, 'Id field missing from attrs.' unless id
+        raise ArgumentError, 'ID field missing from provided attributes' unless id
         attrs_without_id = attrs.reject { |k, v| k.to_s.downcase == "id" }
         api_patch "sobjects/#{sobject}/#{id}", attrs_without_id
         true
@@ -361,8 +361,13 @@ module Restforce
       # error returned if the external ID provided matches multiple records (in which
       # case the conflicting IDs can be found by looking at the response on the error)
       def upsert!(sobject, field, attrs)
+        attrs = attrs.dup
         external_id =
           extract_case_insensitive_string_or_symbol_key_from_hash!(attrs, field)
+        if field.to_s != "Id" && (external_id.nil? || external_id.strip.empty?)
+          raise ArgumentError, 'Specified external ID field missing from provided ' \
+                               'attributes'
+        end
 
         response =
           if field.to_s == "Id" && (external_id.nil? || external_id.strip.empty?)

data/lib/restforce/middleware/authentication.rb

@@ -81,7 +81,8 @@ module Restforce
 
     def faraday_options
       { url: "https://#{@options[:host]}",
-        proxy: @options[:proxy_uri] }.reject { |k, v| v.nil? }
+        proxy: @options[:proxy_uri],
+        ssl: @options[:ssl] }
     end
   end
 end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.5.2'.freeze
+  VERSION = '2.5.3'.freeze
 end

data/spec/integration/abstract_client_spec.rb

@@ -133,7 +133,7 @@ shared_examples_for Restforce::AbstractClient do
   describe '.update' do
     context 'with missing Id' do
       subject { lambda { client.update('Account', Name: 'Foobar') } }
-      it { should raise_error ArgumentError, 'Id field missing from attrs.' }
+      it { should raise_error ArgumentError, 'ID field missing from provided attributes' }
     end
 
     context 'with invalid Id' do

data/spec/unit/concerns/api_spec.rb

@@ -282,116 +282,135 @@ describe Restforce::Concerns::API do
     end
   end
 
-  describe '.create!' do
-    let(:sobject)    { 'Whizbang' }
-    let(:attrs)      { Hash.new }
-    subject(:result) { client.create!(sobject, attrs) }
-
-    it 'send an HTTP POST, and returns the id of the record' do
-      response.body.stub(:[]).with('id').and_return('1234')
-      client.should_receive(:api_post).
-        with('sobjects/Whizbang', attrs).
-        and_return(response)
-      expect(result).to eq '1234'
+  context 'methods with attrs' do
+    before do
+      attrs.freeze
     end
-  end
 
-  describe '.update!' do
-    let(:sobject)    { 'Whizbang' }
-    let(:attrs)      { Hash.new }
-    subject(:result) { client.update!(sobject, attrs) }
-
-    context 'when the id field is present' do
-      let(:attrs) { { id: '1234', StageName: "Call Scheduled" } }
+    describe '.create!' do
+      let(:sobject)    { 'Whizbang' }
+      let(:attrs)      { Hash.new }
+      subject(:result) { client.create!(sobject, attrs) }
 
-      it 'sends an HTTP PATCH, and returns true' do
-        client.should_receive(:api_patch).
-          with('sobjects/Whizbang/1234', StageName: "Call Scheduled")
-        expect(result).to be_true
+      it 'send an HTTP POST, and returns the id of the record' do
+        response.body.stub(:[]).with('id').and_return('1234')
+        client.should_receive(:api_post).
+          with('sobjects/Whizbang', attrs).
+          and_return(response)
+        expect(result).to eq '1234'
       end
     end
 
-    context 'when the id field is missing from the attrs' do
-      subject { lambda { result } }
-      it { should raise_error ArgumentError, 'Id field missing from attrs.' }
-    end
-  end
+    describe '.update!' do
+      let(:sobject)    { 'Whizbang' }
+      let(:attrs)      { Hash.new }
+      subject(:result) { client.update!(sobject, attrs) }
 
-  describe '.upsert!' do
-    let(:sobject)    { 'Whizbang' }
-    let(:field)      { :External_ID__c }
-    let(:attrs)      { { 'External_ID__c' => '1234' } }
-    subject(:result) { client.upsert!(sobject, field, attrs) }
-
-    context 'when the record is found and updated' do
-      it 'returns true' do
-        response.body.stub :[]
-        client.should_receive(:api_patch).
-          with('sobjects/Whizbang/External_ID__c/1234', {}).
-          and_return(response)
-        expect(result).to be_true
+      context 'when the id field is present' do
+        let(:attrs) { { id: '1234', StageName: "Call Scheduled" } }
+
+        it 'sends an HTTP PATCH, and returns true' do
+          client.should_receive(:api_patch).
+            with('sobjects/Whizbang/1234', StageName: "Call Scheduled")
+          expect(result).to be_true
+        end
       end
-    end
 
-    context 'when the record is found and created' do
-      it 'returns the id of the record' do
-        response.body.stub(:[]).with('id').and_return('4321')
-        client.should_receive(:api_patch).
-          with('sobjects/Whizbang/External_ID__c/1234', {}).
-          and_return(response)
-        expect(result).to eq '4321'
+      context 'when the id field is missing from the attrs' do
+        it "raises an error" do
+          expect { client.update!(sobject, attrs) }.
+            to raise_error(ArgumentError, 'ID field missing from provided attributes')
+        end
       end
     end
 
-    context 'when using Id as the attribute' do
-      let(:field) { :Id }
-      let(:attrs) { { 'Id' => '4321' } }
+    describe '.upsert!' do
+      let(:sobject)    { 'Whizbang' }
+      let(:field)      { :External_ID__c }
+      let(:attrs)      { { 'External_ID__c' => '1234' } }
+      subject(:result) { client.upsert!(sobject, field, attrs) }
 
-      context 'and the value for Id is provided' do
+      context 'when the record is found and updated' do
+        it 'returns true' do
+          response.body.stub :[]
+          client.should_receive(:api_patch).
+            with('sobjects/Whizbang/External_ID__c/1234', {}).
+            and_return(response)
+          expect(result).to be_true
+        end
+      end
+
+      context 'when the record is found and created' do
         it 'returns the id of the record' do
           response.body.stub(:[]).with('id').and_return('4321')
           client.should_receive(:api_patch).
-            with('sobjects/Whizbang/Id/4321', {}).
+            with('sobjects/Whizbang/External_ID__c/1234', {}).
             and_return(response)
           expect(result).to eq '4321'
         end
       end
 
-      context 'and no value for Id is provided' do
-        let(:attrs) { { 'External_ID__c' => '1234' } }
+      context 'when the external id field is missing from the attrs' do
+        let(:attrs) { Hash.new }
 
-        it 'uses POST to create the record' do
-          response.body.stub(:[]).with('id').and_return('4321')
-          client.should_receive(:options).and_return(api_version: 38.0)
-          client.should_receive(:api_post).
-            with('sobjects/Whizbang/Id', attrs).
-            and_return(response)
-          expect(result).to eq '4321'
+        it 'raises an argument error' do
+          expect { client.upsert!(sobject, field, attrs) }.
+            to raise_error ArgumentError, 'Specified external ID field missing from ' \
+                                          'provided attributes'
+        end
+      end
+
+      context 'when using Id as the attribute' do
+        let(:field) { :Id }
+        let(:attrs) { { 'Id' => '4321' } }
+
+        context 'and the value for Id is provided' do
+          it 'returns the id of the record, and original record still contains id' do
+            response.body.stub(:[]).with('id').and_return('4321')
+            client.should_receive(:api_patch).
+              with('sobjects/Whizbang/Id/4321', {}).
+              and_return(response)
+            expect(result).to eq '4321'
+            expect(attrs).to include('Id' => '4321')
+          end
         end
 
-        it 'guards functionality for unsupported API versions' do
-          client.should_receive(:options).and_return(api_version: 35.0)
-          expect do
-            client.upsert!(sobject, field, attrs)
-          end.to raise_error Restforce::APIVersionError
+        context 'and no value for Id is provided' do
+          let(:attrs) { { 'External_ID__c' => '1234' } }
+
+          it 'uses POST to create the record' do
+            response.body.stub(:[]).with('id').and_return('4321')
+            client.should_receive(:options).and_return(api_version: 38.0)
+            client.should_receive(:api_post).
+              with('sobjects/Whizbang/Id', attrs).
+              and_return(response)
+            expect(result).to eq '4321'
+          end
+
+          it 'guards functionality for unsupported API versions' do
+            client.should_receive(:options).and_return(api_version: 35.0)
+            expect do
+              client.upsert!(sobject, field, attrs)
+            end.to raise_error Restforce::APIVersionError
+          end
         end
       end
     end
-  end
 
-  describe '.upsert! with multi bytes character' do
-    let(:sobject)    { 'Whizbang' }
-    let(:field)      { :External_ID__c }
-    let(:attrs)      { { 'External_ID__c' => "\u{3042}" } }
-    subject(:result) { client.upsert!(sobject, field, attrs) }
-
-    context 'when the record is found and updated' do
-      it 'returns true' do
-        response.body.stub :[]
-        client.should_receive(:api_patch).
-          with('sobjects/Whizbang/External_ID__c/%E3%81%82', {}).
-          and_return(response)
-        expect(result).to be_true
+    describe '.upsert! with multi bytes character' do
+      let(:sobject)    { 'Whizbang' }
+      let(:field)      { :External_ID__c }
+      let(:attrs)      { { 'External_ID__c' => "\u{3042}" } }
+      subject(:result) { client.upsert!(sobject, field, attrs) }
+
+      context 'when the record is found and updated' do
+        it 'returns true' do
+          response.body.stub :[]
+          client.should_receive(:api_patch).
+            with('sobjects/Whizbang/External_ID__c/%E3%81%82', {}).
+            and_return(response)
+          expect(result).to be_true
+        end
       end
     end
   end

data/spec/unit/middleware/authentication_spec.rb

@@ -5,7 +5,8 @@ describe Restforce::Middleware::Authentication do
     { host: 'login.salesforce.com',
       proxy_uri: 'https://not-a-real-site.com',
       authentication_retries: retries,
-      adapter: :net_http }
+      adapter: :net_http,
+      ssl: { version: :TLSv1_2 } }
   end
 
   describe '.authenticate!' do
@@ -81,5 +82,9 @@ describe Restforce::Middleware::Authentication do
         }
       end
     end
+
+    it "should have SSL config set" do
+      connection.ssl[:version].should eq(:TLSv1_2)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.3
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday