restforce 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e798ab8d32c43d1ae3b424d3e48d7e75cac1450
-  data.tar.gz: 5f79e271ed9e74ad7657dc954d1dccb04f4adb0c
+  metadata.gz: 6a2edec8fbe80bbf028b896e38efbe598ce91ba9
+  data.tar.gz: 567b7ede645cc03d358320ac85898efd106f9415
 SHA512:
-  metadata.gz: 5f5758308c6f4ba3be1171f4228772c36700f62726136b6dc2789b4dcce9cf1bbf469e2eeafe6b0e71737525cc00929eec4f7d25ca9ff6bc79b4f9e0fa26b3d2
-  data.tar.gz: b2e7a13436430a980f558e65a05be0176765f15dbbcece508813e25c5d50baf114d7915cc0955bd4533962f0bed05e47617892d4e91b62a0a3e3e05b14b4d227
+  metadata.gz: 902362f2c9cc5c24d70c945873f3afc182b1225925cb7d2dd8d5419a1b5ba02d4fc3f1f833813981118620c33994a843bf3c244e4dc42546c85fb85d79896861
+  data.tar.gz: 42a7923a9ae9e2e8c9d2928b746fe2832b5f40ed0a81882aed777cf8cd0e8fee91fc76f8e42f1e7e9212b1d9a280c5d3411535409b5a81e431b8b219e65bc982

data/.travis.yml

@@ -4,10 +4,13 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.1
-  - ruby-2.4.0-preview2
+  - ruby-2.4.0
 gemfile:
   - Gemfile.travis
 script:
   - bundle exec rubocop
   - bundle exec rspec spec
 sudo: false
+before_install:
+  - gem update --system
+  - gem update bundler

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.5.1 (Mar 16, 2017)
+
+* Allow setting custom headers, [required by parts of the Salesforce API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm), by specifiying a `:request_headers` option when instantiating the client (@moskeyombus)
+* Add support for `upsert`ing using an ID (see the [Salesforce docs](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_upsert.htm) for more details) (@ecbypi)
+* Relax `faraday` dependency to allow upgrading to Faraday 1.0 (@tinogomes, @alexluke)
+
 ## 2.5.0 (Dec 7, 2016)
 
 * __Deprecate support for Ruby 1.9__, since [official support was dropped nearly two years ago](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/), and it's causing problems with keeping our dependencies up to date

data/README.md

@@ -25,7 +25,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 2.5.0'
+    gem 'restforce', '~> 2.5.1'
 
 And then execute:
 
@@ -194,6 +194,23 @@ to do some custom error handling. The bang methods will raise exceptions, while
 non-bang methods will return false in the event that an exception is raised. This
 works similarly to ActiveRecord.
 
+
+### Custom Headers
+
+Salesforce allows the addition of
+[custom headers](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm)
+in REST API requests to trigger specific logic. In order to pass any custom headers along with API requests,
+you can specify a hash of `:request_headers`  upon client initialization. The example below demonstrates how
+to include the `sforce-auto-assign` header in all client HTTP requests:
+
+```ruby
+client = Restforce.new(oauth_token: 'access_token',
+                       instance_url: 'instance url',
+                       api_version: '38.0',
+                       request_headers: { 'sforce-auto-assign' => 'FALSE' })
+
+```
+
 * * *
 
 ### query

data/lib/restforce/concerns/api.rb

@@ -361,12 +361,17 @@ 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)
-        external_id = attrs.
-          fetch(attrs.keys.find { |k, v| k.to_s.downcase == field.to_s.downcase }, nil)
-        attrs_without_field = attrs.
-          reject { |k, v| k.to_s.downcase == field.to_s.downcase }
-        response = api_patch "sobjects/#{sobject}/#{field}/#{URI.encode(external_id)}",
-                             attrs_without_field
+        external_id =
+          extract_case_insensitive_string_or_symbol_key_from_hash!(attrs, field)
+
+        response =
+          if field.to_s == "Id" && (external_id.nil? || external_id.strip.empty?)
+            version_guard(37.0) do
+              api_post "sobjects/#{sobject}/#{field}", attrs
+            end
+          else
+            api_patch "sobjects/#{sobject}/#{field}/#{URI.encode(external_id)}", attrs
+          end
 
         (response.body && response.body['id']) ? response.body['id'] : true
       end
@@ -484,6 +489,14 @@ module Restforce
         end
       end
 
+      def extract_case_insensitive_string_or_symbol_key_from_hash!(hash, key)
+        value = hash.delete(key.to_sym)
+        value ||= hash.delete(key.to_s)
+        value ||= hash.delete(key.to_s.downcase)
+        value ||= hash.delete(key.to_s.downcase.to_sym)
+        value
+      end
+
       # Internal: Errors that should be rescued from in non-bang methods
       def exceptions
         [Faraday::Error::ClientError]

data/lib/restforce/concerns/base.rb

@@ -50,6 +50,10 @@ module Restforce
       #
       #        :authentication_callback - A Proc that is called with the response body
       #                                   after a successful authentication.
+      #
+      #        :request_headers         - A hash containing custom headers that will be
+      #                                   appended to each request
+
       def initialize(opts = {})
         raise ArgumentError, 'Please specify a hash of options' unless opts.is_a?(Hash)
 

data/lib/restforce/concerns/connection.rb

@@ -52,6 +52,8 @@ module Restforce
                            options if Restforce.log?
           # Compress/Decompress the request/response
           builder.use      Restforce::Middleware::Gzip, self, options
+          # Inject custom headers into requests
+          builder.use      Restforce::Middleware::CustomHeaders, self, options
 
           builder.adapter  adapter
         end

data/lib/restforce/middleware.rb

@@ -11,6 +11,7 @@ module Restforce
     autoload :Caching,        'restforce/middleware/caching'
     autoload :Logger,         'restforce/middleware/logger'
     autoload :Gzip,           'restforce/middleware/gzip'
+    autoload :CustomHeaders,  'restforce/middleware/custom_headers'
 
     def initialize(app, client, options)
       @app = app

data/lib/restforce/middleware/custom_headers.rb

@@ -0,0 +1,12 @@
+module Restforce
+  # Middleware that allows you to specify custom request headers
+  # when initializing Restforce client
+  class Middleware::CustomHeaders < Restforce::Middleware
+    def call(env)
+      headers = @options[:request_headers]
+      env[:request_headers].merge!(headers) if headers.is_a?(Hash)
+
+      @app.call(env)
+    end
+  end
+end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.5.0'
+  VERSION = '2.5.1'
 end

data/restforce.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.0'
 
-  gem.add_dependency 'faraday', '~> 0.9.0'
-  gem.add_dependency 'faraday_middleware', '>= 0.8.8'
+  gem.add_dependency 'faraday', ['>= 0.9.0', '<= 1.0']
+  gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 1.0']
 
   gem.add_dependency 'json', '>= 1.7.5'
 

data/spec/support/client_integration.rb

@@ -25,7 +25,8 @@ module ClientIntegrationExampleGroup
           security_token: security_token,
           client_id: client_id,
           client_secret: client_secret,
-          cache: cache
+          cache: cache,
+          request_headers: { 'x-test-header' => 'Test Header' }
         }
       end
 

data/spec/unit/concerns/api_spec.rb

@@ -342,6 +342,41 @@ describe Restforce::Concerns::API do
         expect(result).to eq '4321'
       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' 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'
+        end
+      end
+
+      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
 
   describe '.upsert! with multi bytes character' do

data/spec/unit/middleware/custom_headers_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::CustomHeaders do
+  describe '.call' do
+    subject { lambda { middleware.call(env) } }
+
+    context 'when :request_headers are a Hash' do
+      let(:options) { { request_headers: { 'x-test-header' => 'Test Value' } } }
+
+      it { should change { env[:request_headers]['x-test-header'] }.to eq 'Test Value' }
+    end
+
+    context 'when :request_headers are not a Hash' do
+      let(:options) { { request_headers: 'bad header' } }
+
+      it { should_not change { env[:request_headers] } }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -32,6 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -39,6 +48,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +200,7 @@ files:
 - lib/restforce/middleware/authentication/token.rb
 - lib/restforce/middleware/authorization.rb
 - lib/restforce/middleware/caching.rb
+- lib/restforce/middleware/custom_headers.rb
 - lib/restforce/middleware/gzip.rb
 - lib/restforce/middleware/instance_url.rb
 - lib/restforce/middleware/logger.rb
@@ -267,6 +280,7 @@ files:
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb
 - spec/unit/middleware/authorization_spec.rb
+- spec/unit/middleware/custom_headers_spec.rb
 - spec/unit/middleware/gzip_spec.rb
 - spec/unit/middleware/instance_url_spec.rb
 - spec/unit/middleware/logger_spec.rb
@@ -295,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST API.
@@ -362,6 +376,7 @@ test_files:
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb
 - spec/unit/middleware/authorization_spec.rb
+- spec/unit/middleware/custom_headers_spec.rb
 - spec/unit/middleware/gzip_spec.rb
 - spec/unit/middleware/instance_url_spec.rb
 - spec/unit/middleware/logger_spec.rb
@@ -370,3 +385,4 @@ test_files:
 - spec/unit/signed_request_spec.rb
 - spec/unit/sobject_spec.rb
 - spec/unit/tooling/client_spec.rb
+has_rdoc: