salesforce_streamer 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e012e8556497f5507f2623d8894c61461185bd3204188ed5ad0a7aaf452a74de
-  data.tar.gz: 1049dc30fa1244441e763cbd90229fe8788b269ea4b387a3fad22f256cbaea68
+  metadata.gz: 2174b14554d0de8cd9d40a4ed7d85323316a363915a7030dba34f392bfb7cf66
+  data.tar.gz: d841e9dca629409c5c0572267da8246d5f21e301c5c7c85d6f0f44cac32ca664
 SHA512:
-  metadata.gz: ae36d194ebebaa1bd0b85009d84b6689ab1047e8c019617fd1d61dc50d412f6a46e06724948836ec7943516596e39c4cee0a3f0906e9cc53c21dc8010677f47d
-  data.tar.gz: 456bb39dc8fc06b879b6611e6b2abab2b396f988b9daa0e7d191a38823698850267a653909b1471e0c99cdf01a43f00fc49d610cb1978107a8ff5433875cc120
+  metadata.gz: 11f4e6a58005ab86abbe38816e1b511bb2201bd4cdb66bfb90d918e9e7e8123158780b32f937106d39f70d987d9527ef25007aecd104063e647f3119bf601ab3
+  data.tar.gz: 951a5316f531b860f52c0c7198542414209a4384c9361a2e28f10f33ae92406c29def1e79d23f79ea987d04176a896e0186385b4ad1a3db64cf7a330ec9eabf9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (1.1.3)
+    salesforce_streamer (1.2.0)
       faye (= 0.8.9)
       restforce (~> 4.2)
 
@@ -11,7 +11,7 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    byebug (11.1.1)
+    byebug (11.1.3)
     codecov (0.1.16)
       json
       simplecov
@@ -49,9 +49,9 @@ GEM
     jwt (2.2.1)
     multipart-post (2.1.1)
     parallel (1.19.1)
-    parser (2.7.0.5)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.4)
     rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
@@ -66,16 +66,16 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.81.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -85,7 +85,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.38.1)
+    rubocop-rspec (1.39.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     simplecov (0.18.5)

data/README.md

@@ -20,6 +20,26 @@ And then execute:
 
 ## Usage
 
+### Middleware
+
+You can initialize the streamer server with any number of middleware classes.
+When a message is received by a PushTopic subscription, the chain of middleware
+classes are executed before the message handler is called.
+
+```ruby
+# config/initializers/streamer.rb
+class MySimpleMiddleware
+  def initialize(handler)
+    @handler = handler
+  end
+  def call(message)
+    @handler.call(message)
+  end
+end
+
+SalesforceStreamer.config.use_middleware MySimpleMiddleware
+```
+
 ### Configure Push Topics
 
 Create a YAML file to configure your server subscriptions.  The configuration

data/lib/salesforce_streamer/configuration.rb

@@ -1,7 +1,8 @@
 module SalesforceStreamer
   # Manages server configuration.
   class Configuration
-    attr_accessor :environment, :logger, :require_path, :config_file, :manage_topics, :server, :exception_adapter, :persistence_adapter, :redis_connection
+    attr_accessor :environment, :logger, :require_path, :config_file, :manage_topics,
+      :server, :exception_adapter, :persistence_adapter, :redis_connection, :middleware
 
     class << self
       attr_writer :instance
@@ -19,12 +20,21 @@ module SalesforceStreamer
       @manage_topics = false
       @config_file = './config/streamer.yml'
       @require_path = './config/environment'
+      @middleware = []
     end
 
     def manage_topics?
       @manage_topics
     end
 
+    def use_middleware(klass, *args, &block)
+      middleware << proc { |app| klass.new(app, *args, &block) }
+    end
+
+    def middleware_chain_for(app)
+      middleware.reduce(app) { |memo, middleware| middleware.call(memo) }
+    end
+
     def push_topic_data
       return @push_topic_data if @push_topic_data
 

data/lib/salesforce_streamer/push_topic.rb

@@ -20,6 +20,14 @@ module SalesforceStreamer
       ReplayPersistence.retrieve(name) || @static_replay
     end
 
+    def handle(message)
+      handle_chain.call(message)
+      ReplayPersistence.record @name, message.dig('event', 'replayId')
+    rescue StandardError => e
+      Log.error e
+      Configuration.instance.exception_adapter.call e
+    end
+
     def to_s
       "PushTopic id=#{id} name=#{name} handler=#{handler} " \
         "replay=#{replay} notify_for_fields=#{notify_for_fields} " \
@@ -38,6 +46,18 @@ module SalesforceStreamer
       raise(PushTopicHandlerMissingError, message)
     end
 
+    def handle_chain
+      Configuration.instance.middleware_chain_for(handler_proc)
+    end
+
+    def handler_proc
+      if handler_constant.respond_to? :perform_async
+        proc { |message| handler_constant.perform_async message }
+      else
+        handler_constant
+      end
+    end
+
     def strip_spaces(str)
       fail(NilQueryError, @name) unless str
 

data/lib/salesforce_streamer/server.rb

@@ -34,9 +34,11 @@ module SalesforceStreamer
     def start_em
       EM.run do
         @push_topics.map do |topic|
-          client.subscribe topic.name, replay: topic.replay.to_i do |msg|
-            Log.info "Message received from topic #{topic.name}"
-            MessageReceiver.call topic.name, topic.handler_constant, msg
+          client.subscribe topic.name, replay: topic.replay.to_i do |message|
+            replay_id = message.dig('event', 'replayId')
+            Log.info "Message #{replay_id} received from topic #{topic.name}"
+            topic.handle message
+            topic.id = replay_id
           end
         end
       end

data/lib/salesforce_streamer/version.rb

@@ -1,3 +1,3 @@
 module SalesforceStreamer
-  VERSION = '1.1.3'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/salesforce_streamer.rb

@@ -14,7 +14,6 @@ require 'salesforce_streamer/topic_manager'
 require 'salesforce_streamer/salesforce_client'
 require 'salesforce_streamer/replay_persistence'
 require 'salesforce_streamer/redis_replay'
-require 'salesforce_streamer/message_receiver'
 require 'salesforce_streamer/server'
 require 'salesforce_streamer/version'
 require 'salesforce_streamer/launcher'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Scott Serok
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
@@ -163,7 +163,6 @@ files:
 - lib/salesforce_streamer/errors.rb
 - lib/salesforce_streamer/launcher.rb
 - lib/salesforce_streamer/log.rb
-- lib/salesforce_streamer/message_receiver.rb
 - lib/salesforce_streamer/push_topic.rb
 - lib/salesforce_streamer/redis_replay.rb
 - lib/salesforce_streamer/replay_id_error_extension.rb
@@ -194,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A wrapper around the Restforce Streaming API with a built-in PushTopic manager.

data/lib/salesforce_streamer/message_receiver.rb

@@ -1,19 +0,0 @@
-module SalesforceStreamer
-  class MessageReceiver
-    class << self
-      # @param topic [String] The unique Salesforce Topic name
-      # @param handler [Object] An object that responds to .call(message)
-      # @param message [Hash] The event payload
-      def call(topic, handler, message)
-        if handler.respond_to? :perform_async
-          handler.perform_async message
-        else
-          handler.call message
-        end
-        ReplayPersistence.record topic, message.dig('event', 'replayId')
-      rescue StandardError => e
-        Configuration.instance.exception_adapter.call e
-      end
-    end
-  end
-end