restforce 2.5.4 → 4.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/batch_api.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'restforce/concerns/verbs'
+
+module Restforce
+  module Concerns
+    module BatchAPI
+      extend Restforce::Concerns::Verbs
+
+      define_verbs :post
+
+      def batch(halt_on_error: false)
+        subrequests = Subrequests.new(options)
+        yield(subrequests)
+        subrequests.requests.each_slice(25).map do |requests|
+          properties = {
+            batchRequests: requests,
+            haltOnError: halt_on_error
+          }
+          response = api_post('composite/batch', properties.to_json)
+          body = response.body
+          results = body['results']
+          if halt_on_error && body['hasErrors']
+            last_error_index = results.rindex { |result| result['statusCode'] != 412 }
+            last_error = results[last_error_index]
+            raise BatchAPIError, last_error['result'][0]['errorCode']
+          end
+          results.map(&:compact)
+        end.flatten
+      end
+
+      def batch!(&block)
+        batch(halt_on_error: true, &block)
+      end
+
+      class Subrequests
+        def initialize(options)
+          @options = options
+          @requests = []
+        end
+        attr_reader :options, :requests
+
+        def create(sobject, attrs)
+          requests << { method: 'POST', url: batch_api_path(sobject), richInput: attrs }
+        end
+
+        def update(sobject, attrs)
+          id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.casecmp?('id') }, nil)
+          raise ArgumentError, 'Id field missing from attrs.' unless id
+
+          attrs_without_id = attrs.reject { |k, v| k.to_s.casecmp?('id') }
+          requests << {
+            method: 'PATCH',
+            url: batch_api_path("#{sobject}/#{id}"),
+            richInput: attrs_without_id
+          }
+        end
+
+        def destroy(sobject, id)
+          requests << { method: 'DELETE', url: batch_api_path("#{sobject}/#{id}") }
+        end
+
+        def upsert(sobject, ext_field, attrs)
+          raise ArgumentError, 'External id field missing.' unless ext_field
+
+          ext_id = attrs.fetch(attrs.keys.find { |k, v|
+            k.to_s.casecmp?(ext_field.to_s)
+          }, nil)
+          raise ArgumentError, 'External id missing from attrs.' unless ext_id
+
+          attrs_without_ext_id = attrs.reject { |k, v| k.to_s.casecmp?(ext_field) }
+          requests << {
+            method: 'PATCH',
+            url: batch_api_path("#{sobject}/#{ext_field}/#{ext_id}"),
+            richInput: attrs_without_ext_id
+          }
+        end
+
+        private
+
+        def batch_api_path(path)
+          "v#{options[:api_version]}/sobjects/#{path}"
+        end
+      end
+    end
+  end
+end

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,8 +1,11 @@
+# frozen_string_literal: true
+
 module Restforce
   module Concerns
     module Canvas
       def decode_signed_request(signed_request)
         raise 'client_secret not set.' unless options[:client_secret]
+
         SignedRequest.decode(signed_request, options[:client_secret])
       end
     end

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,14 +28,13 @@ module Restforce
         PicklistValues.new(describe(sobject)['fields'], field, options)
       end
 
-      private
-
       class PicklistValues < Array
         def initialize(fields, field, options = {})
           @fields = fields
           @field = field
           @valid_for = options.delete(:valid_for)
           raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
+
           replace(picklist_values)
         end
 
@@ -60,7 +61,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
@@ -80,9 +83,9 @@ module Restforce
         # See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_des
         # 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
+          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack1('m').
+                      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
@@ -7,7 +9,8 @@ module Restforce
       # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def subscribe(channels, &block)
+      def subscribe(channels, options = {}, &block)
+        Array(channels).each { |channel| replay_handlers[channel] = options[:replay] }
         faye.subscribe Array(channels).map { |channel| "/topic/#{channel}" }, &block
       end
 
@@ -30,6 +33,62 @@ module Restforce
           client.bind 'transport:up' do
             Restforce.log "[COMETD UP]"
           end
+
+          client.add_extension ReplayExtension.new(replay_handlers)
+        end
+      end
+
+      def replay_handlers
+        @_replay_handlers ||= {}
+      end
+
+      class ReplayExtension
+        def initialize(replay_handlers)
+          @replay_handlers = replay_handlers
+        end
+
+        def incoming(message, callback)
+          callback.call(message).tap do
+            channel = message.fetch('channel').gsub('/topic/', '')
+            replay_id = message.fetch('data', {}).fetch('event', {})['replayId']
+
+            handler = @replay_handlers[channel]
+            if !replay_id.nil? && !handler.nil? && handler.respond_to?(:[]=)
+              # remember the last replay_id for this channel
+              handler[channel] = replay_id
+            end
+          end
+        end
+
+        def outgoing(message, callback)
+          # Leave non-subscribe messages alone
+          return callback.call(message) unless message['channel'] == '/meta/subscribe'
+
+          channel = message['subscription'].gsub('/topic/', '')
+
+          # Set the replay value for the channel
+          message['ext'] ||= {}
+          message['ext']['replay'] = {
+            "/topic/#{channel}" => replay_id(channel)
+          }
+
+          # Carry on and send the message to the server
+          callback.call message
+        end
+
+        private
+
+        def replay_id(channel)
+          handler = @replay_handlers[channel]
+          if handler.is_a?(Integer)
+            handler # treat it as a scalar
+          elsif handler.respond_to?(:[])
+            # Ask for the latest replayId for this channel
+            handler[channel]
+          else
+            # Just pass it along
+            handler
+          end
         end
       end
     end

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
@@ -32,6 +34,7 @@ module Restforce
 
     def log(message)
       return unless Restforce.log?
+
       configuration.logger.send(configuration.log_level, message)
     end
   end
@@ -60,7 +63,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.
@@ -15,6 +17,7 @@ module Restforce
 
     def ensure_body
       return true if self.Body?
+
       raise 'You need to query the Body for the record first.'
     end
   end

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