restforce 2.5.4 → 4.0.0

data/lib/restforce/middleware/authentication/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Authentication middleware used if username and password flow is used
   class Middleware::Authentication::Password < Restforce::Middleware::Authentication

data/lib/restforce/middleware/authentication/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Authentication middleware used if oauth_token and refresh_token are set
   class Middleware::Authentication::Token < Restforce::Middleware::Authentication

data/lib/restforce/middleware/authorization.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Restforce
   # Piece of middleware that simply injects the OAuth token into the request
   # headers.
   class Middleware::Authorization < Restforce::Middleware
-    AUTH_HEADER = 'Authorization'.freeze
+    AUTH_HEADER = 'Authorization'
 
     def call(env)
       env[:request_headers][AUTH_HEADER] = %(OAuth #{token})

data/lib/restforce/middleware/caching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class Middleware::Caching < FaradayMiddleware::Caching
     def call(env)
@@ -6,7 +8,7 @@ module Restforce
     end
 
     def expire(key)
-      cache.delete(key) if cache
+      cache&.delete(key)
     end
 
     # We don't want to cache requests for different clients, so append the

data/lib/restforce/middleware/custom_headers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Middleware that allows you to specify custom request headers
   # when initializing Restforce client

data/lib/restforce/middleware/gzip.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'zlib'
 
 module Restforce
   # Middleware to uncompress GZIP compressed responses from Salesforce.
   class Middleware::Gzip < Restforce::Middleware
-    ACCEPT_ENCODING_HEADER  = 'Accept-Encoding'.freeze
-    CONTENT_ENCODING_HEADER = 'Content-Encoding'.freeze
-    ENCODING                = 'gzip'.freeze
+    ACCEPT_ENCODING_HEADER  = 'Accept-Encoding'
+    CONTENT_ENCODING_HEADER = 'Content-Encoding'
+    ENCODING                = 'gzip'
 
     def call(env)
       env[:request_headers][ACCEPT_ENCODING_HEADER] = ENCODING if @options[:compress]

data/lib/restforce/middleware/instance_url.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
 module Restforce
   # Middleware which asserts that the instance_url is always set
   class Middleware::InstanceURL < Restforce::Middleware
     def call(env)
       # If the connection url_prefix isn't set, we must not be authenticated.
-      raise Restforce::UnauthorizedError,
-            'Connection prefix not set' unless url_prefix_set?
+      unless url_prefix_set?
+        raise Restforce::UnauthorizedError,
+              'Connection prefix not set'
+      end
 
       @app.call(env)
     end
 
     def url_prefix_set?
-      !!(connection.url_prefix && connection.url_prefix.host)
+      !!(connection.url_prefix&.host)
     end
   end
 end

data/lib/restforce/middleware/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Restforce

data/lib/restforce/middleware/mashify.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Middleware the converts sobject records from JSON into Restforce::SObject objects
   # and collections of records into Restforce::Collection objects.

data/lib/restforce/middleware/multipart.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Restforce
   class Middleware::Multipart < Faraday::Request::UrlEncoded
-    self.mime_type = 'multipart/form-data'.freeze
-    DEFAULT_BOUNDARY  = "--boundary_string".freeze
-    JSON_CONTENT_TYPE = { "Content-Type" => "application/json" }
+    self.mime_type = 'multipart/form-data'
+    DEFAULT_BOUNDARY  = "--boundary_string"
+    JSON_CONTENT_TYPE = { "Content-Type" => "application/json" }.freeze
 
     def call(env)
       match_content_type(env) do |params|
@@ -46,9 +48,11 @@ module Restforce
 
       # Files
       params.each do |k, v|
+        next unless v.respond_to? :content_type
+
         parts << Faraday::Parts::Part.new(boundary,
                                           k.to_s,
-                                          v) if v.respond_to? :content_type
+                                          v)
       end
 
       parts << Faraday::Parts::EpiloguePart.new(boundary)

data/lib/restforce/middleware/raise_error.rb

@@ -1,26 +1,35 @@
+# frozen_string_literal: true
+
 module Restforce
   class Middleware::RaiseError < Faraday::Response::Middleware
     def on_complete(env)
       @env = env
       case env[:status]
       when 300
-        raise Faraday::Error::ClientError.new("300: The external ID provided matches " \
-                                              "more than one record",
-                                              response_values)
+        raise Restforce::MatchesMultipleError.new(
+          "300: The external ID provided matches more than one record",
+          response_values
+        )
       when 401
         raise Restforce::UnauthorizedError, message
       when 404
-        raise Faraday::Error::ResourceNotFound, message
+        raise Restforce::NotFoundError, message
       when 413
-        raise Faraday::Error::ClientError.new("413: Request Entity Too Large",
-                                              response_values)
+        raise Restforce::EntityTooLargeError.new(
+          "413: Request Entity Too Large",
+          response_values
+        )
       when 400...600
-        raise Faraday::Error::ClientError.new(message, response_values)
+        klass = exception_class_for_error_code(body['errorCode'])
+        raise klass.new(message, response_values)
       end
     end
 
     def message
-      "#{body['errorCode']}: #{body['message']}"
+      message = "#{body['errorCode']}: #{body['message']}"
+      message << "\nRESPONSE: #{JSON.dump(@env[:body])}"
+    rescue StandardError
+      message # if JSON.dump fails, return message without extra detail
     end
 
     def body
@@ -41,5 +50,14 @@ module Restforce
         body: @env[:body]
       }
     end
+
+    ERROR_CODE_MATCHER = /\A[A-Z_]+\z/.freeze
+
+    def exception_class_for_error_code(error_code)
+      return Restforce::ResponseError unless ERROR_CODE_MATCHER.match?(error_code)
+
+      constant_name = error_code.split('_').map(&:capitalize).join.to_sym
+      Restforce::ErrorCode.const_get(constant_name)
+    end
   end
 end

data/lib/restforce/patches/parts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Faraday
   module Parts
     module Part

data/lib/restforce/signed_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'base64'
 require 'json'
@@ -25,6 +27,7 @@ module Restforce
     # Returns nil if the signed request is invalid.
     def decode
       return nil if signature != hmac
+
       JSON.parse(Base64.decode64(payload))
     end
 

data/lib/restforce/sobject.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class SObject < Restforce::Mash
     def sobject_type
@@ -61,6 +63,7 @@ module Restforce
 
     def ensure_id
       return true if self.Id?
+
       raise ArgumentError, 'You need to query the Id for the record first.'
     end
   end

data/lib/restforce/tooling/client.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Restforce
   module Tooling
     class Client < AbstractClient
       private
 
-        def api_path(path)
-          super("tooling/#{path}")
-        end
+      def api_path(path)
+        super("tooling/#{path}")
+      end
     end
   end
 end

data/lib/restforce/upload_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday/upload_io'
 
 module Restforce

data/lib/restforce/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
-  VERSION = '2.5.4'.freeze
+  VERSION = '4.0.0'
 end

data/restforce.gemspec

@@ -1,33 +1,40 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/restforce/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/restforce/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Eric J. Holmes", "Tim Rogers"]
   gem.email         = ["eric@ejholmes.net", "tim@gocardless.com"]
-  gem.description   = %q{A lightweight ruby client for the Salesforce REST API.}
-  gem.summary       = %q{A lightweight ruby client for the Salesforce REST API.}
+  gem.description   = 'A lightweight ruby client for the Salesforce REST API.'
+  gem.summary       = 'A lightweight ruby client for the Salesforce REST API.'
   gem.homepage      = "http://restforce.org/"
   gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "restforce"
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
 
-  gem.required_ruby_version = '>= 2.0'
+  gem.metadata = {
+    'source_code_uri' => 'https://github.com/restforce/restforce',
+    'changelog_uri'   => 'https://github.com/restforce/restforce/blob/master/CHANGELOG.md'
+  }
+
+  gem.required_ruby_version = '>= 2.4'
 
-  gem.add_dependency 'faraday', ['>= 0.9.0', '<= 1.0']
+  gem.add_dependency 'faraday', '<= 1.0', '>= 0.9.0'
   gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 1.0']
 
   gem.add_dependency 'json', '>= 1.7.5'
 
   gem.add_dependency 'hashie', ['>= 1.2.0', '< 4.0']
 
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
-  gem.add_development_dependency 'webmock', '~> 1.13.0'
-  gem.add_development_dependency 'simplecov', '~> 0.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.31.0'
   gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
+  gem.add_development_dependency 'rubocop', '~> 0.75.0'
+  gem.add_development_dependency 'simplecov', '~> 0.17.1'
+  gem.add_development_dependency 'webmock', '~> 3.7.6'
 end

data/spec/fixtures/sobject/sobject_describe_success_response.json

@@ -767,7 +767,48 @@
       "label" : "three",
       "defaultValue" : false,
       "validFor" : null
-    } ],
+    }, {
+      "value" : "control_four",
+      "active" : true,
+      "label" : "control_four",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_five",
+      "active" : true,
+      "label" : "control_five",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_six",
+      "active" : true,
+      "label" : "control_six",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_seven",
+      "active" : true,
+      "label" : "control_seven",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_eight",
+      "active" : true,
+      "label" : "control_eight",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_nine",
+      "active" : true,
+      "label" : "control_nine",
+      "defaultValue" : false,
+      "validFor" : null
+    }, {
+      "value" : "control_ten",
+      "active" : true,
+      "label" : "control_ten",
+      "defaultValue" : false,
+      "validFor" : null}],
     "referenceTo" : [ ],
     "relationshipName" : null,
     "relationshipOrder" : null,
@@ -883,6 +924,12 @@
 	      "label" : "nine",
 	      "defaultValue" : false,
 	      "validFor" : "QAAA"
+	    }, {
+          "value" : "ten",
+	      "active" : true,
+	      "label" : "nine",
+	      "defaultValue" : false,
+	      "validFor" : "AEAA"
 	    } ],
 	    "referenceTo" : [ ],
 	    "relationshipName" : null,

data/spec/integration/abstract_client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_examples_for Restforce::AbstractClient do
@@ -35,7 +37,7 @@ shared_examples_for Restforce::AbstractClient do
   end
 
   describe '.get_updated' do
-    let(:start_date) { Time.new(2015, 8, 17, 0, 0, 0, "+02:00")  }
+    let(:start_date) { Time.new(2015, 8, 17, 0, 0, 0, "+02:00") }
     let(:end_date) { Time.new(2016, 8, 19, 0, 0, 0, "+02:00") }
     end_string = '2016-08-18T22:00:00Z'
     start_string = '2015-08-16T22:00:00Z'
@@ -46,7 +48,7 @@ shared_examples_for Restforce::AbstractClient do
   end
 
   describe '.get_deleted' do
-    let(:start_date) { Time.new(2015, 8, 17, 0, 0, 0, "+02:00")  }
+    let(:start_date) { Time.new(2015, 8, 17, 0, 0, 0, "+02:00") }
     let(:end_date) { Time.new(2016, 8, 19, 0, 0, 0, "+02:00") }
     end_string = '2016-08-18T22:00:00Z'
     start_string = '2015-08-16T22:00:00Z'
@@ -94,7 +96,7 @@ shared_examples_for Restforce::AbstractClient do
       subject do
         client.create('Account', Name: 'Foobar',
                                  Blob: Restforce::UploadIO.new(
-                                   File.expand_path('../../fixtures/blob.jpg', __FILE__),
+                                   File.expand_path('../fixtures/blob.jpg', __dir__),
                                    'image/jpeg'
                                  ))
       end
@@ -168,7 +170,8 @@ shared_examples_for Restforce::AbstractClient do
     context 'when updated' do
       requests 'sobjects/Account/External__c/foobar',
                method: :patch,
-               with_body: "{\"Name\":\"Foobar\"}"
+               with_body: "{\"Name\":\"Foobar\"}",
+               fixture: "sobject/upsert_updated_success_response"
 
       context 'with symbol external Id key' do
         subject do
@@ -206,6 +209,24 @@ shared_examples_for Restforce::AbstractClient do
         end
       end
     end
+
+    context 'when created with a space in the id' do
+      requests 'sobjects/Account/External__c/foo%20bar',
+               method: :patch,
+               with_body: "{\"Name\":\"Foobar\"}",
+               fixture: 'sobject/upsert_created_success_response'
+
+      [:External__c, 'External__c', :external__c, 'external__c'].each do |key|
+        context "with #{key.inspect} as the external id" do
+          subject do
+            client.upsert!('Account', 'External__c', key => 'foo bar',
+                                                     :Name => 'Foobar')
+          end
+
+          it { should eq 'foo' }
+        end
+      end
+    end
   end
 
   describe '.destroy!' do
@@ -226,6 +247,13 @@ shared_examples_for Restforce::AbstractClient do
 
       it { should be_true }
     end
+
+    context 'with a space in the id' do
+      subject(:destroy!) { client.destroy!('Account', '001D000000 INjVe') }
+      requests 'sobjects/Account/001D000000%20INjVe', method: :delete
+
+      it { should be_true }
+    end
   end
 
   describe '.destroy' do
@@ -263,6 +291,14 @@ shared_examples_for Restforce::AbstractClient do
       subject { client.find('Account', '1234', 'External_Field__c') }
       it { should be_a Hash }
     end
+
+    context 'with a space in an external id' do
+      requests 'sobjects/Account/External_Field__c/12%2034',
+               fixture: 'sobject/sobject_find_success_response'
+
+      subject { client.find('Account', '12 34', 'External_Field__c') }
+      it { should be_a Hash }
+    end
   end
 
   describe '.select' do
@@ -281,6 +317,14 @@ shared_examples_for Restforce::AbstractClient do
         subject { client.select('Account', '1234', ['External_Field__c']) }
         it { should be_a Hash }
       end
+
+      context 'with a space in the id' do
+        requests 'sobjects/Account/12%2034',
+                 fixture: 'sobject/sobject_select_success_response'
+
+        subject { client.select('Account', '12 34', nil, nil) }
+        it { should be_a Hash }
+      end
     end
 
     context 'when an external id is specified' do
@@ -379,11 +423,11 @@ shared_examples_for Restforce::AbstractClient do
 
     before do
       @query = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object').
-        with(headers: { 'Authorization' => "OAuth #{oauth_token}" }).
-        to_return(status: 401,
+               with(headers: { 'Authorization' => "OAuth #{oauth_token}" }).
+               to_return(status: 401,
                   body: fixture('expired_session_response'),
                   headers: { 'Content-Type' => 'application/json' }).then.
-        to_return(status: 200,
+               to_return(status: 200,
                   body: fixture('sobject/query_success_response'),
                   headers: { 'Content-Type' => 'application/json' })