restforce 2.5.4 → 3.0.0

data/lib/restforce/concerns/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Authentication

data/lib/restforce/concerns/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Base

data/lib/restforce/concerns/caching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Caching
@@ -6,9 +8,9 @@ module Restforce
       # block - A query/describe/etc.
       #
       # Returns the result of the block
-      def without_caching(&block)
+      def without_caching
         options[:use_cache] = false
-        block.call
+        yield
       ensure
         options.delete(:use_cache)
       end

data/lib/restforce/concerns/canvas.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Canvas

data/lib/restforce/concerns/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Connection
@@ -13,7 +15,7 @@ module Restforce
       def middleware
         connection.builder
       end
-      alias_method :builder, :middleware
+      alias builder middleware
 
       private
 
@@ -22,40 +24,44 @@ module Restforce
         @connection ||= Faraday.new(options[:instance_url],
                                     connection_options) do |builder|
           # Parses JSON into Hashie::Mash structures.
-          unless (options[:mashify] == false)
-            builder.use    Restforce::Middleware::Mashify, self, options
+          unless options[:mashify] == false
+            builder.use Restforce::Middleware::Mashify, self, options
           end
 
           # Handles multipart file uploads for blobs.
-          builder.use      Restforce::Middleware::Multipart
+          builder.use Restforce::Middleware::Multipart
           # Converts the request into JSON.
-          builder.request  :json
+          builder.request :json
           # Handles reauthentication for 403 responses.
           if authentication_middleware
-            builder.use    authentication_middleware, self, options
+            builder.use authentication_middleware, self, options
           end
           # Sets the oauth token in the headers.
-          builder.use      Restforce::Middleware::Authorization, self, options
+          builder.use Restforce::Middleware::Authorization, self, options
           # Ensures the instance url is set.
-          builder.use      Restforce::Middleware::InstanceURL, self, options
+          builder.use Restforce::Middleware::InstanceURL, self, options
           # Caches GET requests.
-          builder.use      Restforce::Middleware::Caching, cache, options if cache
+          builder.use Restforce::Middleware::Caching, cache, options if cache
           # Follows 30x redirects.
-          builder.use      FaradayMiddleware::FollowRedirects
+          builder.use FaradayMiddleware::FollowRedirects
           # Raises errors for 40x responses.
-          builder.use      Restforce::Middleware::RaiseError
+          builder.use Restforce::Middleware::RaiseError
           # Parses returned JSON response into a hash.
           builder.response :json, content_type: /\bjson$/
           # Compress/Decompress the request/response
-          builder.use      Restforce::Middleware::Gzip, self, options
+          unless adapter == :httpclient
+            builder.use Restforce::Middleware::Gzip, self, options
+          end
           # Inject custom headers into requests
-          builder.use      Restforce::Middleware::CustomHeaders, self, options
+          builder.use Restforce::Middleware::CustomHeaders, self, options
           # Log request/responses
-          builder.use      Restforce::Middleware::Logger,
-                           Restforce.configuration.logger,
-                           options if Restforce.log?
+          if Restforce.log?
+            builder.use Restforce::Middleware::Logger,
+                        Restforce.configuration.logger,
+                        options
+          end
 
-          builder.adapter  adapter
+          builder.adapter adapter
         end
       end
 
@@ -67,10 +73,10 @@ module Restforce
       def connection_options
         { request: {
             timeout: options[:timeout],
-            open_timeout: options[:timeout] },
+            open_timeout: options[:timeout]
+},
           proxy: options[:proxy_uri],
-          ssl: options[:ssl]
-        }
+          ssl: options[:ssl] }
       end
 
       # Internal: Returns true if the middlware stack includes the

data/lib/restforce/concerns/picklists.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Picklists
@@ -26,8 +28,6 @@ module Restforce
         PicklistValues.new(describe(sobject)['fields'], field, options)
       end
 
-      private
-
       class PicklistValues < Array
         def initialize(fields, field, options = {})
           @fields = fields
@@ -60,7 +60,9 @@ module Restforce
 
         def controlling_picklist
           @_controlling_picklist ||= controlling_field['picklistValues'].
-            find { |picklist_entry| picklist_entry['value'] == @valid_for }
+                                     find do |picklist_entry|
+                                       picklist_entry['value'] == @valid_for
+                                     end
         end
 
         def index
@@ -81,8 +83,8 @@ module Restforce
         # cribesobjects_describesobjectresult.htm
         def valid?(picklist_entry)
           valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack('m').first.
-            unpack('q*')
-          (valid_for[index >> 3] & (0x80 >> index % 8)) != 0
+                      unpack('C*')
+          (valid_for[index >> 3] & (0x80 >> index % 8)).positive?
         end
       end
     end

data/lib/restforce/concerns/streaming.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Streaming

data/lib/restforce/concerns/verbs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Verbs
@@ -34,7 +36,7 @@ module Restforce
           begin
             connection.send(verb, *args, &block)
           rescue Restforce::UnauthorizedError
-            if retries > 0
+            if retries.positive?
               retries -= 1
               connection.url_prefix = options[:instance_url]
               retry

data/lib/restforce/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module Restforce
@@ -60,7 +62,7 @@ module Restforce
       private
 
       attr_reader :default
-      alias_method :default_provided?, :default
+      alias default_provided? default
 
       def write_attribute
         configuration.send :attr_accessor, name

data/lib/restforce/data/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Data
     class Client < AbstractClient

data/lib/restforce/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class Document < Restforce::SObject
     # Public: Returns the body of the document.

data/lib/restforce/mash.rb

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

data/lib/restforce/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Base class that all middleware can extend. Provides some convenient helper
   # functions.

data/lib/restforce/middleware/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   # Faraday middleware that allows for on the fly authentication of requests.
   # When a request fails (a status of 401 is returned), the middleware
@@ -31,9 +33,7 @@ module Restforce
       @options[:instance_url] = response.body['instance_url']
       @options[:oauth_token]  = response.body['access_token']
 
-      if @options[:authentication_callback]
-        @options[:authentication_callback].call(response.body)
-      end
+      @options[:authentication_callback]&.call(response.body)
 
       response.body
     end
@@ -50,9 +50,11 @@ module Restforce
         builder.use Restforce::Middleware::Mashify, nil, @options
         builder.response :json
 
-        builder.use Restforce::Middleware::Logger,
-                    Restforce.configuration.logger,
-                    @options if Restforce.log?
+        if Restforce.log?
+          builder.use Restforce::Middleware::Logger,
+                      Restforce.configuration.logger,
+                      @options
+        end
 
         builder.adapter @options[:adapter]
       end

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,10 @@ 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class Middleware::RaiseError < Faraday::Response::Middleware
     def on_complete(env)

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'

data/lib/restforce/sobject.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class SObject < Restforce::Mash
     def sobject_type

data/lib/restforce/tooling/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   module Tooling
     class Client < AbstractClient

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 = '3.0.0'
 end

data/restforce.gemspec

@@ -1,24 +1,30 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require File.expand_path('../lib/restforce/version', __FILE__)
 
 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.3'
 
-  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'
@@ -26,8 +32,9 @@ Gem::Specification.new do |gem|
   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 'webmock', '~> 3.4.0'
+  gem.add_development_dependency 'simplecov', '~> 0.15.0'
+  gem.add_development_dependency 'rubocop', '~> 0.50.0'
+  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
   gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
 end