restforce 4.0.0 → 5.0.0

data/spec/unit/error_code_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::ErrorCode do
+  describe "mapping of error codes to classes" do
+    subject(:error_exception_classes) { described_class::ERROR_EXCEPTION_CLASSES }
+
+    let(:exception_classes) do
+      described_class.constants.
+        map { |constant_name| described_class.const_get(constant_name) }.
+        select { |constant| constant.is_a?(Class) }
+    end
+
+    it "maps all defined exception classes to an error code" do
+      exception_classes.each do |exception_class|
+        expect(error_exception_classes.values).to include(exception_class)
+      end
+    end
+
+    it "maps all error codes to a defined exception class" do
+      error_exception_classes.each_value do |mapped_exception_class|
+        expect(exception_classes).to include(mapped_exception_class)
+      end
+    end
+  end
+
+  describe '.get_exception_class' do
+    context 'when a non-existent error code is looked up' do
+      let(:new_error_code) { 'ANOTHER_NEW_ERROR_CODE' }
+      subject              { described_class.get_exception_class(new_error_code) }
+
+      it { should be Restforce::ResponseError }
+
+      it 'outputs a warning' do
+        expect(Warning).to receive(:warn)
+        subject
+      end
+    end
+
+    context 'when a known error code is looked up' do
+      let(:existing_error_code) { "ALL_OR_NONE_OPERATION_ROLLED_BACK" }
+      let(:existing_error)      { described_class::AllOrNoneOperationRolledBack }
+
+      subject do
+        described_class.get_exception_class(existing_error_code)
+      end
+
+      it { should < Restforce::ResponseError }
+
+      it 'returns existing error' do
+        should be(existing_error)
+      end
+
+      it 'does not output a warning' do
+        expect(Warning).to_not receive(:warn)
+        subject
+      end
+    end
+  end
+end

data/spec/unit/mash_spec.rb

@@ -33,6 +33,11 @@ describe Restforce::Mash do
         let(:input) { { 'attributes' => { 'type' => 'Document' } } }
         it { should eq Restforce::Document }
       end
+
+      context 'when the attributes value is nil' do
+        let(:input) { { 'attributes' => nil } }
+        it { should eq Restforce::SObject }
+      end
     end
 
     context 'else' do

data/spec/unit/middleware/authentication/jwt_bearer_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+describe Restforce::Middleware::Authentication::JWTBearer do
+  let(:jwt_key) { File.read('spec/fixtures/test_private.key') }
+
+  let(:options) do
+    { host: 'login.salesforce.com',
+      client_id: 'client_id',
+      username: 'foo',
+      jwt_key: jwt_key,
+      instance_url: 'https://na1.salesforce.com',
+      adapter: :net_http }
+  end
+
+  it_behaves_like 'authentication middleware' do
+    let(:success_request) do
+      stub_login_request(
+        body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+             "assertion=abc1234567890"
+      ).to_return(status: 200, body: fixture(:auth_success_response))
+    end
+
+    let(:fail_request) do
+      stub_login_request(
+        body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+             "assertion=abc1234567890"
+      ).to_return(status: 400, body: fixture(:refresh_error_response))
+    end
+  end
+
+  context 'allows jwt_key as string' do
+    let(:jwt_key) do
+      File.read('spec/fixtures/test_private.key')
+    end
+
+    let(:options) do
+      { host: 'login.salesforce.com',
+        client_id: 'client_id',
+        username: 'foo',
+        jwt_key: jwt_key,
+        instance_url: 'https://na1.salesforce.com',
+        adapter: :net_http }
+    end
+
+    it_behaves_like 'authentication middleware' do
+      let(:success_request) do
+        stub_login_request(
+          body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+            "assertion=abc1234567890"
+        ).to_return(status: 200, body: fixture(:auth_success_response))
+      end
+
+      let(:fail_request) do
+        stub_login_request(
+          body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+            "assertion=abc1234567890"
+        ).to_return(status: 400, body: fixture(:refresh_error_response))
+      end
+    end
+  end
+end

data/spec/unit/middleware/authentication_spec.rb

@@ -57,10 +57,10 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson,
-                         Faraday::Adapter::NetHttp
+          should include FaradayMiddleware::ParseJson
         }
         its(:handlers) { should_not include Restforce::Middleware::Logger }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with logging enabled' do
@@ -70,8 +70,9 @@ describe Restforce::Middleware::Authentication do
 
         its(:handlers) {
           should include FaradayMiddleware::ParseJson,
-                         Restforce::Middleware::Logger, Faraday::Adapter::NetHttp
+                         Restforce::Middleware::Logger
         }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with specified adapter' do
@@ -80,8 +81,9 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson, Faraday::Adapter::Typhoeus
+          should include FaradayMiddleware::ParseJson
         }
+        its(:adapter) { should eq Faraday::Adapter::Typhoeus }
       end
     end
 
@@ -89,4 +91,25 @@ describe Restforce::Middleware::Authentication do
       connection.ssl[:version].should eq(:TLSv1_2)
     end
   end
+
+  describe '.error_message' do
+    context 'when response.body is present' do
+      let(:response) {
+        Faraday::Response.new(
+          response_body: { 'error' => 'error', 'error_description' => 'description' },
+          status: 401
+        )
+      }
+
+      subject { middleware.error_message(response) }
+      it { should eq "error: description (401)" }
+    end
+
+    context 'when response.body is nil' do
+      let(:response) { Faraday::Response.new(status: 401) }
+
+      subject { middleware.error_message(response) }
+      it { should eq "401" }
+    end
+  end
 end

data/spec/unit/middleware/raise_error_spec.rb

@@ -18,8 +18,8 @@ describe Restforce::Middleware::RaiseError do
                                               'INVALID_FIELD: error_message'
       end
 
-      it 'raises an error that inherits from Faraday::Error::ResourceNotFound' do
-        expect { on_complete }.to raise_error Faraday::Error::ResourceNotFound
+      it 'raises an error that inherits from Faraday::ResourceNotFound' do
+        expect { on_complete }.to raise_error Faraday::ResourceNotFound
       end
     end
 
@@ -31,8 +31,8 @@ describe Restforce::Middleware::RaiseError do
                                               /300: The external ID provided/
       end
 
-      it 'raises an error that inherits from Faraday::Error::ClientError' do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -44,8 +44,8 @@ describe Restforce::Middleware::RaiseError do
                                               'INVALID_FIELD: error_message'
       end
 
-      it 'raises an error that inherits from Faraday::Error::ClientError' do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -66,8 +66,8 @@ describe Restforce::Middleware::RaiseError do
                                               '413: Request Entity Too Large'
       end
 
-      it 'raises an error that inherits from Faraday::Error::ClientError' do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -80,10 +80,19 @@ describe Restforce::Middleware::RaiseError do
                                               "(error code missing): #{body}"
       end
 
-      it 'raises an error that inherits from Faraday::Error::ClientError' do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError,
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError,
                                               "(error code missing): #{body}"
       end
     end
+
+    context 'when error code is not already defined' do
+      let(:body) { { 'errorCode' => 'SOMETHING_UNDEFINED' } }
+      let(:status) { 400 }
+
+      it 'raises a generic Restforce::ResponseError' do
+        expect { on_complete }.to raise_error Restforce::ResponseError
+      end
+    end
   end
 end

data/spec/unit/signed_request_spec.rb

@@ -6,7 +6,7 @@ describe Restforce::SignedRequest do
   let(:client_secret) { 'foo' }
   let(:digest) do
     if RUBY_VERSION < '2.1'
-      OpenSSL::Digest::Digest.new('sha256')
+      OpenSSL::Digest.new('Digest', 'sha256')
     else
       OpenSSL::Digest.new('sha256')
     end

data/spec/unit/sobject_spec.rb

@@ -45,13 +45,10 @@ describe Restforce::SObject do
     destroy: :destroy,
     destroy!: :destroy! }.each do |method, receiver|
     describe ".#{method}" do
-      subject(:send_method) { sobject.send(method) }
+      subject(:send_method) { lambda { sobject.send(method) } }
 
       context 'when an Id was not queried' do
-        it "raises an error" do
-          expect { send_method }.to raise_error ArgumentError,
-                                                /need to query the Id for the record/
-        end
+        it { should raise_error ArgumentError, /need to query the Id for the record/ }
       end
 
       context 'when an Id is present' do

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
-- Eric J. Holmes
 - Tim Rogers
+- Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !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: '2.0'
     - - ">="
       - !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
@@ -40,7 +40,7 @@ dependencies:
         version: 0.8.8
     - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,21 +50,21 @@ dependencies:
         version: 0.8.8
     - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
         version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -84,7 +84,7 @@ dependencies:
         version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
@@ -119,65 +119,66 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.87.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.87.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
-description: A lightweight ruby client for the Salesforce REST API.
+        version: 3.8.3
+description: A lightweight Ruby client for the Salesforce REST API
 email:
+- me@timrogers.co.uk
 - eric@ejholmes.net
-- tim@gocardless.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/unhandled-salesforce-error.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -189,6 +190,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
 - lib/restforce.rb
 - lib/restforce/abstract_client.rb
 - lib/restforce/attachment.rb
@@ -207,9 +209,12 @@ files:
 - lib/restforce/config.rb
 - lib/restforce/data/client.rb
 - lib/restforce/document.rb
+- lib/restforce/error_code.rb
+- lib/restforce/file_part.rb
 - lib/restforce/mash.rb
 - lib/restforce/middleware.rb
 - lib/restforce/middleware/authentication.rb
+- lib/restforce/middleware/authentication/jwt_bearer.rb
 - lib/restforce/middleware/authentication/password.rb
 - lib/restforce/middleware/authentication/token.rb
 - lib/restforce/middleware/authorization.rb
@@ -225,7 +230,6 @@ files:
 - lib/restforce/signed_request.rb
 - lib/restforce/sobject.rb
 - lib/restforce/tooling/client.rb
-- lib/restforce/upload_io.rb
 - lib/restforce/version.rb
 - restforce.gemspec
 - script/bootstrap
@@ -266,6 +270,7 @@ files:
 - spec/fixtures/sobject/upsert_multiple_error_response.json
 - spec/fixtures/sobject/upsert_updated_success_response.json
 - spec/fixtures/sobject/write_error_response.json
+- spec/fixtures/test_private.key
 - spec/integration/abstract_client_spec.rb
 - spec/integration/data/client_spec.rb
 - spec/spec_helper.rb
@@ -290,7 +295,9 @@ files:
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
 - spec/unit/document_spec.rb
+- spec/unit/error_code_spec.rb
 - spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/jwt_bearer_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb
@@ -304,7 +311,7 @@ files:
 - spec/unit/signed_request_spec.rb
 - spec/unit/sobject_spec.rb
 - spec/unit/tooling/client_spec.rb
-homepage: http://restforce.org/
+homepage: https://restforce.github.io/
 licenses:
 - MIT
 metadata:
@@ -318,17 +325,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A lightweight ruby client for the Salesforce REST API.
+summary: A lightweight Ruby client for the Salesforce REST API
 test_files:
 - spec/fixtures/auth_error_response.json
 - spec/fixtures/auth_success_response.json
@@ -364,6 +371,7 @@ test_files:
 - spec/fixtures/sobject/upsert_multiple_error_response.json
 - spec/fixtures/sobject/upsert_updated_success_response.json
 - spec/fixtures/sobject/write_error_response.json
+- spec/fixtures/test_private.key
 - spec/integration/abstract_client_spec.rb
 - spec/integration/data/client_spec.rb
 - spec/spec_helper.rb
@@ -388,7 +396,9 @@ test_files:
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
 - spec/unit/document_spec.rb
+- spec/unit/error_code_spec.rb
 - spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/jwt_bearer_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb