salesforce_streamer 1.2.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b143e33e82a48eab99336814e577ea28f3587ff001215d0f113cde9ba4cd4af9
-  data.tar.gz: 0e14143ff38b5cea8aaf98ff1232d50c9240e9867cee9e7a9e8931b11b519875
+  metadata.gz: b7aa51a1aab875d18d027a1686a598d795d30126cea6fc81f08e705911bdc92c
+  data.tar.gz: ce9f47fdc1f3c277347c684fc533e92e56e93779c3115a0894f8834c1196b795
 SHA512:
-  metadata.gz: d8ddac32a872d67fc643e5b917e3f9a6226cb36baea76a256ebba6c74f29414a8f66d403cee40f440fd8876da17af8fcc72c169e2a4e234679dd1b071a59a537
-  data.tar.gz: ee20957061503d2301a4044429dd86966b6c57f3b9277ce00d5c6a471c7501cb266a1be7afb71ff66f0f7d2c69d98d6a5d9032fdd39d052214cdeafb27c8ce42
+  metadata.gz: 6d7183472e280c49188c8f0a386ddf24e47ee99cd827b0e1b9bb3c22184136ef81694364020a4c6676f728317af530e5959908fe79d871ba065d43f29b0c5f97
+  data.tar.gz: 329f63f5ced7e03256761765e70a3d13107779fa895e249e69e07e98d148ed1142b0f23c9e8cc86d38faae92087af59080524cef60a70ba51619ab4ec9cdd36b

data/.dependabot/config.yml

@@ -9,10 +9,3 @@ update_configs:
     allowed_updates:
       - match:
           update_type: "all"
-    automerged_updates:
-      - match:
-          dependency_type: "development"
-          update_type: "all"
-      - match:
-          dependency_type: "production"
-          update_type: "all"

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to track an issue that has been identified
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Mutation/Query**
+
+**URL and HTTP method (for non-GQL):**
+
+**Sentry or Logs URL:**
+
+**User/authentication details**
+Impacted user name or service account
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,22 @@
+---
+name: New story
+about: Add a new story for implementation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the solution**
+A clear and concise description of what you want to happen.
+When will this feature be done?
+
+**Describe the users**
+Who are we building this feature for?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+Link to any applicable documents describing the feature.
+
+**Designs**
+Link to any applicable designs on Invision.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+<!--- Describe your changes in detail -->
+
+## Related issue(s)
+<!--- GH issue number -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+
+## Screenshots (if appropriate):
+<!--- Please add any screenshots of the feature. -->
+
+## Related PRs
+<!--- Please add links to any related PRs (backend, component packages, etc). -->

data/.github/workflows/auto-approve.yml

@@ -0,0 +1,16 @@
+# automatically approve PRs submitted by Dependabot
+# this will allow Dependabot to automatically merge dependency update PRs where CI passes
+# from: https://github.com/hmarr/auto-approve-action
+name: Auto approve Dependabot PRs
+
+on:
+  pull_request
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hmarr/auto-approve-action@v2.0.0
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/CHANGELOG.md

@@ -0,0 +1,99 @@
+# Changelog
+
+Sorted so that the most recent change logs are near the top. Only significant
+changes are logged in the change log.
+
+## 2020-08-17 Scott Serok [scott@renofi.com](mailto:scott@renofi.com)
+
+v2.1 changes the expected interface of `Configuration#replay_adapter`.
+
+Normally this breaking change would require a major version bump, but since the
+functionality today is quiet broken we can call this a major bug fix.
+
+The `config.replay_adapter` should be an object that has an interface like Hash.
+It must respond to `[]` and `[]=`. By default the adapter is an empty hash.  If
+you want your push topic replayId to persist between restarts, then you should
+implement a class with an appropriate interface.
+
+```ruby
+class MyReplayAdapter
+  def [](channel)
+    MyPersistence.get(channel)
+  end
+
+  def []=(channel, replay_id)
+    MyPersistence.set(channel, replay_id)
+  end
+end
+```
+
+This change was sparked by a misunderstanding of the
+`Restforce::Concerns::Streaming::ReplayExtension` replay handlers.
+SalesforceStreamer can eliminate some complexity and fix a bug by delegating the
+responsibility of maintaining the current replayId to that ReplayExtension. The
+object will be used on each request/response cycle to record and read the latest
+replayId as long as the object assigned to `config.replay_adapter` responds to
+`[]` and `[]=`.
+
+## 2020-08-04 Scott Serok [scott@renofi.com](mailto:scott@renofi.com)
+
+v2.0 is released as a major simplification of this library. There are 2
+significant differences from a user's perspective.
+
+1. The YAML configuration requires minor edits to be compatible in v2.0.
+2. The built-in Redis persistance of the replayId field has been removed. You
+   should add a custom middleware and configure the new replay_adapter option.
+
+### PushTopic configuration changes
+
+After upgrading to v2, the YAML configuration should be modified. Shift the
+nested "salesforce" block to the left and remove the "salesforce" key.
+
+Before v2:
+
+    name: "TopicName"
+    handler: "MyConstant"
+    salesforce:
+      query: "SELECT Id FROM Lead"
+
+As of v2:
+
+    name: "TopicName"
+    handler: "MyConstant"
+    query: "SELECT Id FROM Lead"
+
+### Redis Persistance removed
+
+The original intention of this library is to manage PushTopic definitions
+and run an event machine that subscribes to the Salesforce Streaming API based
+on those PushTopics.
+
+The addition of managing the Replay ID adds unecessary complexity that can be
+incorporated through customization, and so it's been removed. You might use a
+recent commit of v1 of this library for reference how to implement Redis as the
+persistence layer.
+
+To record the replayId on every message we can add a piece of middleware
+
+    class RecordReplayIdMiddleware
+      def initialize(handler)
+        @handler = handler
+      end
+
+      def call(message)
+        @handler.call(message)
+        replay_id = message['event']['replayId']
+        topic_name = message['topic']
+        MyStore.record_replay_id(replay_id, topic_name)
+      end
+    end
+    SalesforceStreamer.config.use_middleware RecordReplayIdMiddleware
+
+To retrieve the replayId before subscribing to a PushTopic,
+configure an adapter that returns an integer.
+
+    SalesforceStreamer.config.replay_adapter = proc { |topic|
+      (MyStore.fetch_replay_id(topic.name) || -1).to_i
+    }
+
+This will be used to set the replayId value when subscribing to the PushTopic.

data/Gemfile.lock

@@ -1,25 +1,28 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (1.2.1)
-      faye (= 0.8.9)
-      restforce (~> 4.2)
+    salesforce_streamer (2.1.0)
+      dry-initializer (~> 3.0)
+      faye (~> 1.4)
+      restforce (>= 4.2, < 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.1)
     byebug (11.1.3)
-    codecov (0.1.16)
+    codecov (0.2.3)
+      colorize
       json
       simplecov
-      url
+    colorize (0.8.1)
     cookiejar (0.3.3)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    em-http-request (1.1.5)
+    dry-initializer (3.0.3)
+    em-http-request (1.1.6)
       addressable (>= 2.3.4)
       cookiejar (!= 0.3.1)
       em-socksify (>= 0.3)
@@ -28,38 +31,39 @@ GEM
     em-socksify (0.3.2)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.2.7)
-    faraday (1.0.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
-    faye (0.8.9)
+    faye (1.4.0)
       cookiejar (>= 0.3.0)
-      em-http-request (>= 0.3.0)
+      em-http-request (>= 1.1.6)
       eventmachine (>= 0.12.0)
-      faye-websocket (>= 0.4.0)
+      faye-websocket (>= 0.11.0)
+      multi_json (>= 1.0.0)
       rack (>= 1.0.0)
-      yajl-ruby (>= 1.0.0)
-    faye-websocket (0.10.9)
+      websocket-driver (>= 0.5.1)
+    faye-websocket (0.11.0)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     hashie (4.1.0)
     http_parser.rb (0.6.0)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     jwt (2.2.1)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     public_suffix (4.0.5)
-    rack (2.2.2)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    restforce (4.2.2)
-      faraday (>= 0.9.0, <= 1.0)
-      faraday_middleware (>= 0.8.8, <= 1.0)
+    regexp_parser (1.7.1)
+    restforce (5.0.1)
+      faraday (>= 0.9.0, <= 2.0)
+      faraday_middleware (>= 0.8.8, <= 2.0)
       hashie (>= 1.2.0, < 5.0)
-      json (>= 1.7.5)
       jwt (>= 1.5.6)
     rexml (3.2.4)
     rspec (3.9.0)
@@ -75,29 +79,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
     unicode-display_width (1.7.0)
-    url (0.3.2)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    yajl-ruby (1.4.1)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -20,33 +20,11 @@ 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
-for each subscription must have a nested `salesforce:` key. These settings will
-be synced to your Salesforce instance when the `-x` flag is set on the command
-line. For more information about the `replay:` and `notify_fields_for` options
-please see the Salesforce Streaming API reference documentation.
+Create a YAML file to configure your PushTopic subscriptions. When streamer
+starts up it will check for any differences between Salesforce PushTopics and
+this yaml and update any differences when `config.manage_topics = true`.
 
 ```yaml
 # config/streamer.yml
@@ -55,12 +33,11 @@ base: &DEFAULT
   accounts:
     handler: "AccountChangeHandler"
     replay: -1
-    salesforce:
-      name: "AllAccounts"
-      api_version: "41.0"
-      description: "Sync Accounts"
-      notify_for_fields: "Referenced"
-      query: "Select Id, Name From Account"
+    name: "AllAccounts"
+    api_version: "49.0"
+    description: "Sync Accounts"
+    notify_for_fields: "Referenced"
+    query: "Select Id, Name From Account"
 
 development:
   <<: *DEFAULT
@@ -72,14 +49,6 @@ production:
   <<: *DEFAULT
 ```
 
-It's important to note that the way push topics are managed is by the Salesforce
-name attribute.  This should uniquely identify each push topic.  It is not
-recommended to change the name of your push topic definitions; otherwise, the
-push topic manager will not find a push topic in Salesforce resulting in the
-creation of a brand new push topic. If the push topic manager identifies a
-difference in any of the other Salesforce attributes, then it will update the
-push topic in Salesforce before starting the streaming server.
-
 ### Define Message Handlers
 
 Define your handlers somewhere in your project. They must respond to either
@@ -89,14 +58,17 @@ Define your handlers somewhere in your project. They must respond to either
 # lib/account_change_handler.rb
 # Handle account changes inline
 class AccountChangeHandler
-  def self.call(message)
-    puts message
+  class << self
+    def call(message)
+      puts message
+    end
   end
 end
 
 # Handle account changes asynchronously
 class AccountChangeHandler
   include Sidekiq::Worker
+
   def perform(message)
     puts message
   end
@@ -114,13 +86,13 @@ Configure the `SalesforceStreamer` module.
 ```ruby
 # config/initializers/salesforce_streamer.rb
 
-require 'redis'
-require 'connection_pool'
-
-SalesforceStreamer.config.redis_connection = ConnectionPool.new(size: 5, timeout: 5) { Redis.new }
-SalesforceStreamer.config.logger = Logger.new(STDERR, level: 'INFO')
-SalesforceStreamer.config.exception_adapter = proc { |e| puts e }
-SalesforceStreamer.config.manage_topics = true
+SalesforceStreamer.configure do |config|
+  config.logger = Logger.new(STDERR, level: 'INFO')
+  config.exception_adapter = proc { |e| puts e }
+  config.replay_adapter = MyReplayAdapter
+  config.use_middleware AfterMessageReceived
+  config.manage_topics = true
+end
 ```
 
 ### Launch The Streamer
@@ -159,6 +131,48 @@ By default, the executable will load the YAML based on the `RACK_ENV` environmen
 variable, or default to `:development` if not set. You can override this by
 setting the `config.environment = :integration`
 
+### Message Handling 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
+```
+
+### ReplayAdapter
+
+The `config.replay_adapter` should be an object that has an interface like Hash.
+It must respond to `[]` and `[]=`. By default the adapter is an empty hash.  If
+you want your push topic replayId to persist between restarts, then you should
+implement a class with an appropriate interface.
+
+```ruby
+class MyReplayAdapter
+  def [](channel)
+    Persistence.get(channel)
+  end
+
+  def []=(channel, replay_id)
+    Persistence.set(channel, replay_id)
+  end
+end
+```
+
+This adapter will be used directly by `Restforce::ReplayExtension`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop:auto_correct spec]
+task default: %i[spec rubocop:auto_correct]

data/lib/core_extensions/cookiejar/cookie_validation.rb

@@ -9,7 +9,7 @@ module CoreExtensions
       def self.extended(base)
         base.class_eval do
           def self.domains_match(tested_domain, base_domain)
-            return true if tested_domain[-15..-1].eql?('.salesforce.com')
+            return true if tested_domain[-15..].eql?('.salesforce.com')
 
             # original implementation
             base = effective_host base_domain

data/lib/salesforce_streamer.rb

@@ -4,16 +4,15 @@ require 'optparse'
 require 'restforce'
 require 'yaml'
 require 'forwardable'
+require 'dry-initializer'
 
 require 'salesforce_streamer/configuration'
 require 'salesforce_streamer/errors'
 require 'salesforce_streamer/replay_id_error_extension'
 require 'salesforce_streamer/log'
 require 'salesforce_streamer/push_topic'
-require 'salesforce_streamer/topic_manager'
+require 'salesforce_streamer/salesforce_topic_manager'
 require 'salesforce_streamer/salesforce_client'
-require 'salesforce_streamer/replay_persistence'
-require 'salesforce_streamer/redis_replay'
 require 'salesforce_streamer/server'
 require 'salesforce_streamer/version'
 require 'salesforce_streamer/launcher'
@@ -60,9 +59,7 @@ module SalesforceStreamer
     Configuration.instance
   end
 
-  class RedisConnectionError < StandardError
-    def initialize
-      super 'SalesforceStreamer.config.redis_connection not set'
-    end
+  def self.configure
+    yield Configuration.instance
   end
 end

data/lib/salesforce_streamer/cli.rb

@@ -32,7 +32,7 @@ module SalesforceStreamer
         end
 
         o.on '-v', '--verbose LEVEL', 'Set the log level (default no logging)' do |arg|
-          @config.logger = Logger.new(STDERR, level: arg)
+          @config.logger = Logger.new($stderr, level: arg)
         end
 
         o.on '-V', '--version', 'Print the version information' do

data/lib/salesforce_streamer/configuration.rb

@@ -1,22 +1,27 @@
 module SalesforceStreamer
   # Manages server configuration.
   class Configuration
-    attr_accessor :environment, :logger, :require_path, :config_file, :manage_topics,
-      :server, :exception_adapter, :persistence_adapter, :redis_connection, :middleware
+    attr_accessor :environment, :logger, :require_path, :config_file,
+      :manage_topics, :exception_adapter, :replay_adapter
+    attr_reader :middleware
 
     class << self
       attr_writer :instance
-    end
 
-    def self.instance
-      @instance ||= new
+      def configure
+        yield instance
+      end
+
+      def instance
+        @instance ||= new
+      end
     end
 
     def initialize
       @environment = ENV['RACK_ENV'] || :development
       @logger = Logger.new(IO::NULL)
       @exception_adapter = proc { |exc| fail(exc) }
-      @persistence_adapter = RedisReplay.new
+      @replay_adapter = Hash.new { |hash, key| hash[key] = -1 }
       @manage_topics = false
       @config_file = './config/streamer.yml'
       @require_path = './config/environment'
@@ -27,12 +32,17 @@ module SalesforceStreamer
       @manage_topics
     end
 
+    # adds a setup proc to the middleware array
     def use_middleware(klass, *args, &block)
-      middleware << proc { |app| klass.new(app, *args, &block) }
+      @middleware << [klass, args, block]
     end
 
-    def middleware_chain_for(app)
-      middleware.reduce(app) { |memo, middleware| middleware.call(memo) }
+    # returns a ready to use chain of middleware
+    def middleware_runner(last_handler)
+      @middleware.reduce(last_handler) do |next_handler, current_handler|
+        klass, args, block = current_handler
+        klass.new(next_handler, *args, &block)
+      end
     end
 
     def push_topic_data

data/lib/salesforce_streamer/errors.rb

@@ -3,13 +3,13 @@ module SalesforceStreamer
 
   class MissingCLIFlagError < StandardError
     def initialize(flag)
-      super 'Missing required command line flag: ' + flag.to_s
+      super "Missing required command line flag: #{flag}"
     end
   end
 
   class NilQueryError < StandardError
     def initialize(name)
-      super 'Query not defined for ' + name.to_s
+      super "Query not defined for #{name}"
     end
   end
 
@@ -21,7 +21,13 @@ module SalesforceStreamer
 
   class PushTopicNameTooLongError < StandardError
     def initialize(name)
-      super 'PushTopic name: ' + name.to_s + ' (' + name.size.to_s + '/25)'
+      super "PushTopic name: #{name} (#{name.size}/25)"
+    end
+  end
+
+  class UnprocessableHandlerError < StandardError
+    def initialize(constant)
+      super "#{constant} does not repond to .call or .perform_async"
     end
   end
 end

data/lib/salesforce_streamer/launcher.rb

@@ -5,14 +5,14 @@ module SalesforceStreamer
   class Launcher
     def initialize
       load_server_configuration
-      @manager = TopicManager.new push_topics: @push_topics
+      @manager = SalesforceTopicManager.new push_topics: @push_topics
       @server = Server.new push_topics: @push_topics
     end
 
     # Manages each PushTopic configured and starts the Streaming API listener.
     def run
       Log.info 'Launching Streamer Services'
-      @manager.run
+      @manager.upsert_topics!
       @server.push_topics = @manager.push_topics
       @server.run
     end
@@ -36,7 +36,7 @@ module SalesforceStreamer
       @push_topics = []
       Configuration.instance.push_topic_data.each_value do |topic_data|
         Log.debug topic_data.to_s
-        @push_topics << PushTopic.new(data: topic_data)
+        @push_topics << PushTopic.new(topic_data.transform_keys(&:to_sym))
       end
     end
   end

data/lib/salesforce_streamer/push_topic.rb

@@ -1,38 +1,29 @@
 module SalesforceStreamer
   # Models the PushTopic object for both Restforce and Streamer
   class PushTopic
-    attr_accessor :id
-    attr_reader :name, :description, :notify_for_fields, :query,
-      :handler, :handler_constant, :api_version
+    extend Dry::Initializer
 
-    def initialize(data:)
-      @handler = data['handler']
-      @static_replay = data.dig('replay')&.to_i || -1
-      @name = data.dig('salesforce', 'name')
-      @api_version = data.dig('salesforce', 'api_version') || '41.0'
-      @description = data.dig('salesforce', 'description') || @name
-      @notify_for_fields = data.dig('salesforce', 'notify_for_fields') || 'Referenced'
-      @query = strip_spaces(data.dig('salesforce', 'query'))
-      validate!
-    end
+    option :name
+    option :query, proc { |str| str.gsub(/\s+/, ' ') }
+    option :handler, proc { |str| prepare_handler_proc Object.const_get(str) }
+    option :replay, proc(&:to_i), default: proc { -1 }
+    option :api_version, proc(&:to_s), default: proc { '49.0' }
+    option :notify_for_fields, default: proc { 'Referenced' }
+    option :id, optional: true
+    option :description, optional: true
 
-    def replay
-      ReplayPersistence.retrieve(name) || @static_replay
-    end
+    attr_writer :id
 
     def handle(message)
       message['topic'] = @name
-      handle_chain.call(message)
-      ReplayPersistence.record @name, message.dig('event', 'replayId')
+      message_middleware.call(message)
     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} " \
-        "description=#{description} api_version=#{api_version} query=#{query}"
+    def attributes
+      self.class.dry_initializer.public_attributes self
     end
 
     private
@@ -40,29 +31,33 @@ module SalesforceStreamer
     def validate!
       fail(PushTopicNameTooLongError, @name) if @name.size > 25
 
-      @handler_constant = Object.const_get(@handler)
+      @handler = Object.const_get(@handler)
       true
     rescue NameError, TypeError => e
-      message = 'handler=' + @handler.to_s + ' exception=' + e.to_s
+      message = "handler=#{@handler} exception=#{e}"
       raise(PushTopicHandlerMissingError, message)
     end
 
-    def handle_chain
-      Configuration.instance.middleware_chain_for(handler_proc)
+    def message_middleware
+      Configuration.instance.middleware_runner(handler)
     end
 
-    def handler_proc
-      if handler_constant.respond_to? :perform_async
-        proc { |message| handler_constant.perform_async message }
-      else
-        handler_constant
-      end
-    end
+    class << self
+      def strip_spaces(str)
+        fail(NilQueryError, @name) unless str
 
-    def strip_spaces(str)
-      fail(NilQueryError, @name) unless str
+        str.gsub(/\s+/, ' ')
+      end
 
-      str.gsub(/\s+/, ' ')
+      def prepare_handler_proc(constant)
+        if constant.respond_to? :call
+          constant
+        elsif constant.respond_to? :perform_async
+          proc { |message| constant.perform_async message }
+        else
+          fail(UnprocessableHandlerError, constant)
+        end
+      end
     end
   end
 end

data/lib/salesforce_streamer/salesforce_client.rb

@@ -8,10 +8,8 @@ module SalesforceStreamer
       @client.authenticate!
     end
 
-    def subscribe(*args)
-      @client.subscribe(args) do
-        yield
-      end
+    def subscribe(*args, &block)
+      @client.subscribe(args, &block)
     end
 
     # Returns nil or an instance of Restforce::SObject

data/lib/salesforce_streamer/{topic_manager.rb → salesforce_topic_manager.rb}

@@ -1,5 +1,5 @@
 module SalesforceStreamer
-  class TopicManager
+  class SalesforceTopicManager
     attr_reader :push_topics
 
     def initialize(push_topics:)
@@ -7,10 +7,11 @@ module SalesforceStreamer
       @client = SalesforceClient.new
     end
 
-    def run
-      Log.info 'Running Topic Manager'
+    def upsert_topics!
+      Log.info 'Starting to upsert PushTopic definitions into Salesforce'
       @push_topics.each do |push_topic|
-        Log.debug push_topic.to_s
+        Log.info push_topic.name
+        Log.debug push_topic.attributes.to_json
         upsert(push_topic) if diff?(push_topic)
       end
     end
@@ -29,12 +30,12 @@ module SalesforceStreamer
       return true unless push_topic.notify_for_fields.eql?(hashie.NotifyForFields)
       return true unless push_topic.api_version.to_s.eql?(hashie.ApiVersion.to_s)
 
-      Log.debug 'No differences detected'
+      Log.info 'No differences detected'
       false
     end
 
     def upsert(push_topic)
-      Log.info "Upsert PushTopic #{push_topic.name}"
+      Log.info "Upserting PushTopic"
       if Configuration.instance.manage_topics?
         @client.upsert_push_topic(push_topic)
       else

data/lib/salesforce_streamer/server.rb

@@ -34,11 +34,9 @@ module SalesforceStreamer
     def start_em
       EM.run do
         @push_topics.map do |topic|
-          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}"
+          client.subscribe topic.name, replay: Configuration.instance.replay_adapter do |message|
+            Log.info "Message #{message.dig('event', 'replayId')} 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.2.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/salesforce_streamer.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['documentation_uri'] = 'https://www.rubydoc.info/gems/salesforce_streamer'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
@@ -24,8 +25,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'faye', '0.8.9'
-  spec.add_dependency 'restforce', '~> 4.2'
+  spec.add_dependency 'dry-initializer', '~> 3.0'
+  spec.add_dependency 'faye', '~> 1.4'
+  spec.add_dependency 'restforce', '>= 4.2', '< 6.0'
 
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'codecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Scott Serok
@@ -9,36 +9,56 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: restforce
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -147,9 +167,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dependabot/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/story.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/auto-approve.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -164,12 +190,10 @@ files:
 - lib/salesforce_streamer/launcher.rb
 - lib/salesforce_streamer/log.rb
 - lib/salesforce_streamer/push_topic.rb
-- lib/salesforce_streamer/redis_replay.rb
 - lib/salesforce_streamer/replay_id_error_extension.rb
-- lib/salesforce_streamer/replay_persistence.rb
 - lib/salesforce_streamer/salesforce_client.rb
+- lib/salesforce_streamer/salesforce_topic_manager.rb
 - lib/salesforce_streamer/server.rb
-- lib/salesforce_streamer/topic_manager.rb
 - lib/salesforce_streamer/version.rb
 - salesforce_streamer.gemspec
 homepage: https://github.com/renofi/salesforce_streamer
@@ -178,6 +202,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renofi/salesforce_streamer
   source_code_uri: https://github.com/renofi/salesforce_streamer
+  documentation_uri: https://www.rubydoc.info/gems/salesforce_streamer
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/salesforce_streamer/redis_replay.rb

@@ -1,55 +0,0 @@
-module SalesforceStreamer
-  class RedisReplay
-    class << self
-      def redis_connection
-        @redis_connection ||= Configuration.instance.redis_connection || fail(RedisConnectionError)
-      end
-
-      attr_writer :redis_connection
-    end
-
-    def connection
-      if RedisReplay.redis_connection.respond_to?(:with)
-        RedisReplay.redis_connection.with do |conn|
-          yield(conn)
-        end
-      else
-        yield RedisReplay.redis_connection
-      end
-    end
-
-    # Saves the value to a key with expiration
-    def record(key, value)
-      return unless key && value
-
-      key = namespaced_key(key)
-      value = Integer(value)
-      connection { |c| c.setex key, SECONDS_TO_EXPIRE, value }
-    rescue StandardError => e
-      Configuration.instance.exception_adapter.call e
-      nil
-    end
-
-    def retrieve(key)
-      return unless key
-
-      key = namespaced_key(key)
-      value = connection { |c| c.get key }
-      Integer(value) if value
-    rescue StandardError => e
-      Configuration.instance.exception_adapter.call e
-      nil
-    end
-
-    private
-
-    def namespaced_key(key)
-      NAMESPACE + key.to_s
-    end
-
-    NAMESPACE = 'SalesforceStreamer:'.freeze
-    SECONDS_TO_EXPIRE = 24 * 60 * 60 # 24 hours
-    START = 0
-    STOP = 0
-  end
-end

data/lib/salesforce_streamer/replay_persistence.rb

@@ -1,18 +0,0 @@
-module SalesforceStreamer
-  # Store values for a given key in a sorted sequence
-  # Retrieves the highest value given a key
-  class ReplayPersistence
-    class << self
-      def record(key, value)
-        Log.debug { "Recording #{key}=#{value}" }
-        Configuration.instance.persistence_adapter&.record key, value
-      end
-
-      def retrieve(key)
-        Configuration.instance.persistence_adapter&.retrieve(key).tap do |v|
-          Log.debug { "Retrieved for #{key} #{v || 'nil'}" }
-        end
-      end
-    end
-  end
-end