restforce 3.0.1 → 4.2.0

data/lib/restforce.rb

@@ -3,6 +3,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
+require 'jwt'
 
 require 'restforce/version'
 require 'restforce/config'
@@ -29,6 +30,7 @@ module Restforce
     autoload :Verbs,          'restforce/concerns/verbs'
     autoload :Base,           'restforce/concerns/base'
     autoload :API,            'restforce/concerns/api'
+    autoload :BatchAPI,       'restforce/concerns/batch_api'
   end
 
   module Data
@@ -44,6 +46,25 @@ module Restforce
   AuthenticationError = Class.new(Error)
   UnauthorizedError   = Class.new(Error)
   APIVersionError     = Class.new(Error)
+  BatchAPIError       = Class.new(Error)
+
+  # Inherit from Faraday::Error::ResourceNotFound for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::Error::ResourceNotFound
+  # can continue to do so.
+  NotFoundError       = Class.new(Faraday::Error::ResourceNotFound)
+
+  # Inherit from Faraday::Error::ClientError for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::Error::ClientError
+  # can continue to do so.
+  ResponseError       = Class.new(Faraday::Error::ClientError)
+  MatchesMultipleError= Class.new(ResponseError)
+  EntityTooLargeError = Class.new(ResponseError)
+
+  module ErrorCode
+    def self.const_missing(constant_name)
+      const_set constant_name, Class.new(ResponseError)
+    end
+  end
 
   class << self
     # Alias for Restforce::Data::Client.new
@@ -74,7 +95,7 @@ module Restforce
       self
     end
   end
-  Object.send :include, Restforce::CoreExtensions unless Object.respond_to? :tap
+  Object.include Restforce::CoreExtensions unless Object.respond_to? :tap
 end
 
 if ENV['PROXY_URI']

data/lib/restforce/abstract_client.rb

@@ -7,5 +7,6 @@ module Restforce
     include Restforce::Concerns::Authentication
     include Restforce::Concerns::Caching
     include Restforce::Concerns::API
+    include Restforce::Concerns::BatchAPI
   end
 end

data/lib/restforce/attachment.rb

@@ -17,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/concerns/api.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'uri'
 require 'restforce/concerns/verbs'
 
@@ -320,6 +321,7 @@ module Restforce
       def update!(sobject, attrs)
         id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.casecmp('id').zero? }, nil)
         raise ArgumentError, 'ID field missing from provided attributes' unless id
+
         attrs_without_id = attrs.reject { |k, v| k.to_s.casecmp("id").zero? }
         api_patch "sobjects/#{sobject}/#{CGI.escape(id)}", attrs_without_id
         true
@@ -377,7 +379,8 @@ module Restforce
               api_post "sobjects/#{sobject}/#{field}", attrs
             end
           else
-            api_patch "sobjects/#{sobject}/#{field}/#{CGI.escape(external_id)}", attrs
+            api_patch "sobjects/#{sobject}/#{field}/" \
+              "#{ERB::Util.url_encode(external_id)}", attrs
           end
 
         response.body.respond_to?(:fetch) ? response.body.fetch('id', true) : true
@@ -414,7 +417,7 @@ module Restforce
       # Returns true of the sobject was successfully deleted.
       # Raises an exception if an error is returned from Salesforce.
       def destroy!(sobject, id)
-        api_delete "sobjects/#{sobject}/#{CGI.escape(id)}"
+        api_delete "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
         true
       end
 
@@ -428,9 +431,9 @@ module Restforce
       # Returns the Restforce::SObject sobject record.
       def find(sobject, id, field = nil)
         url = if field
-                "sobjects/#{sobject}/#{field}/#{CGI.escape(id)}"
+                "sobjects/#{sobject}/#{field}/#{ERB::Util.url_encode(id)}"
               else
-                "sobjects/#{sobject}/#{CGI.escape(id)}"
+                "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
               end
         api_get(url).body
       end
@@ -446,9 +449,9 @@ module Restforce
       #
       def select(sobject, id, select, field = nil)
         path = if field
-                 "sobjects/#{sobject}/#{field}/#{CGI.escape(id)}"
+                 "sobjects/#{sobject}/#{field}/#{ERB::Util.url_encode(id)}"
                else
-                 "sobjects/#{sobject}/#{CGI.escape(id)}"
+                 "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
                end
 
         path = "#{path}?fields=#{select.join(',')}" if select&.any?

data/lib/restforce/concerns/authentication.rb

@@ -19,6 +19,8 @@ module Restforce
           Restforce::Middleware::Authentication::Password
         elsif oauth_refresh?
           Restforce::Middleware::Authentication::Token
+        elsif jwt?
+          Restforce::Middleware::Authentication::JWTBearer
         end
       end
 
@@ -38,6 +40,14 @@ module Restforce
           options[:client_id] &&
           options[:client_secret]
       end
+
+      # Internal: Returns true if jwt bearer token flow should be used for
+      # authentication.
+      def jwt?
+        options[:jwt_key] &&
+          options[:username] &&
+          options[:client_id]
+      end
     end
   end
 end

data/lib/restforce/concerns/base.rb

@@ -28,6 +28,8 @@ module Restforce
       #                                   password and oauth authentication
       #        :client_secret           - The oauth client secret to use.
       #
+      #        :jwt_key                 - The private key for JWT authentication
+      #
       #        :host                    - The String hostname to use during
       #                                   authentication requests
       #                                   (default: 'login.salesforce.com').

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/canvas.rb

@@ -5,6 +5,7 @@ module Restforce
     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/picklists.rb

@@ -34,6 +34,7 @@ module Restforce
           @field = field
           @valid_for = options.delete(:valid_for)
           raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
+
           replace(picklist_values)
         end
 
@@ -82,7 +83,7 @@ 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.
+          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack1('m').
                       unpack('C*')
           (valid_for[index >> 3] & (0x80 >> index % 8)).positive?
         end

data/lib/restforce/concerns/streaming.rb

@@ -5,12 +5,28 @@ module Restforce
     module Streaming
       # Public: Subscribe to a PushTopic
       #
-      # channels - The name of the PushTopic channel(s) to subscribe to.
+      # topics   - The name of the PushTopic channel(s) to subscribe to.
       # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def subscribe(channels, &block)
-        faye.subscribe Array(channels).map { |channel| "/topic/#{channel}" }, &block
+      def legacy_subscribe(topics, options = {}, &block)
+        topics = Array(topics).map { |channel| "/topic/#{channel}" }
+        subscription(topics, options, &block)
+      end
+      alias subscribe legacy_subscribe
+
+      # Public: Subscribe to one or more Streaming API channels
+      #
+      # channels - The name of the Streaming API (cometD) channel(s) to subscribe to.
+      # block    - A block to run when a new message is received.
+      #
+      # Returns a Faye::Subscription
+      def subscription(channels, options = {}, &block)
+        one_or_more_channels = Array(channels)
+        one_or_more_channels.each do |channel|
+          replay_handlers[channel] = options[:replay]
+        end
+        faye.subscribe(one_or_more_channels, &block)
       end
 
       # Public: Faye client to use for subscribing to PushTopics
@@ -32,6 +48,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')
+            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']
+
+          # Set the replay value for the channel
+          message['ext'] ||= {}
+          message['ext']['replay'] = {
+            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/config.rb

@@ -34,6 +34,7 @@ module Restforce
 
     def log(message)
       return unless Restforce.log?
+
       configuration.logger.send(configuration.log_level, message)
     end
   end
@@ -107,6 +108,9 @@ module Restforce
     # The OAuth client secret
     option :client_secret, default: lambda { ENV['SALESFORCE_CLIENT_SECRET'] }
 
+    # The private key for JWT authentication
+    option :jwt_key
+
     # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
     option :host, default: lambda { ENV['SALESFORCE_HOST'] || 'login.salesforce.com' }

data/lib/restforce/document.rb

@@ -17,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/middleware/authentication.rb

@@ -6,8 +6,9 @@ module Restforce
   # will attempt to either reauthenticate (username and password) or refresh
   # the oauth access token (if a refresh token is present).
   class Middleware::Authentication < Restforce::Middleware
-    autoload :Password, 'restforce/middleware/authentication/password'
-    autoload :Token,    'restforce/middleware/authentication/token'
+    autoload :Password,  'restforce/middleware/authentication/password'
+    autoload :Token,     'restforce/middleware/authentication/token'
+    autoload :JWTBearer, 'restforce/middleware/authentication/jwt_bearer'
 
     # Rescue from 401's, authenticate then raise the error again so the client
     # can reissue the request.

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Restforce
+  class Middleware
+    class Authentication
+      class JWTBearer < Restforce::Middleware::Authentication
+        def params
+          {
+            grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+            assertion: jwt_bearer_token
+          }
+        end
+
+        private
+
+        def jwt_bearer_token
+          JWT.encode claim_set, private_key, 'RS256'
+        end
+
+        def claim_set
+          {
+            iss: @options[:client_id],
+            sub: @options[:username],
+            aud: @options[:host],
+            iat: Time.now.utc.to_i,
+            exp: Time.now.utc.to_i + 180
+          }
+        end
+
+        def private_key
+          OpenSSL::PKey::RSA.new(@options[:jwt_key])
+        end
+      end
+    end
+  end
+end

data/lib/restforce/middleware/multipart.rb

@@ -49,6 +49,7 @@ 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)