restforce 3.0.1 → 5.1.1

data/lib/restforce/concerns/picklists.rb

@@ -34,7 +34,8 @@ module Restforce
           @field = field
           @valid_for = options.delete(:valid_for)
           raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
-          replace(picklist_values)
+
+          super(picklist_values)
         end
 
         private
@@ -82,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.
+          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack1('m').
                       unpack('C*')
-          (valid_for[index >> 3] & (0x80 >> index % 8)).positive?
+          (valid_for[index >> 3] & (0x80 >> (index % 8))).positive?
         end
       end
     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,60 @@ 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.respond_to?(:[]) && !handler.is_a?(Integer)
+            # 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' }
@@ -147,11 +151,14 @@ module Restforce
     option :request_headers
 
     # Set a logger for when Restforce.log is set to true, defaulting to STDOUT
-    option :logger, default: ::Logger.new(STDOUT)
+    option :logger, default: ::Logger.new($stdout)
 
     # Set a log level for logging when Restforce.log is set to true, defaulting to :debug
     option :log_level, default: :debug
 
+    # Set use_cache to false to opt in to caching with client.with_caching
+    option :use_cache, default: true
+
     def options
       self.class.options
     end

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