salesforce_streamer 2.1.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a92bbc0eaffa8152b8cdcc6b8eb35248a8fe1e996bc73410dc1ed4043acde08
-  data.tar.gz: '0787479213ab7bc07c07a6cc5d8c9034f5593aee613a28529e25dd51e8c3d9c2'
+  metadata.gz: ee0a8f25e58071aab321354f7a419407d70f764c50c84999406dc20d798df147
+  data.tar.gz: 3ba160a1abe2748d2bd54191a36a84de8839f4f590654ef71250fdb59172fe42
 SHA512:
-  metadata.gz: 95e9b7ba4133fe7c7840e413677cff3121b6d4c94c9f1037b4fd91fe1a111dd6a1ac350075b987d68cd1fbcb72b733fbed3bd087353b6a075789a8fd15c014cb
-  data.tar.gz: 573892b3222c3240fb8d171b32f03f446bae3a0ff2184aa7bbbdf71f940ecc961cd84a634dda824a9ecb42acb13446e44b8d0d8f4f4dacb4cae0f1c555658cf0
+  metadata.gz: 04e3729da95d7ab24d3d4ca76f37323fdaecf5dcdcd825d8dbae03fa183126fa5b919f9eb6602e3cf2815700ae1b7479638c850c2628acfe9e9932111c3933bf
+  data.tar.gz: af5151cc9d9d38af500085077328afa77a6d63c6786039e29b32942ebafa76074ee67c005bc3aa38d70cefc1bf79c471838c25e62660fc9445fc7b1ddfb3a451

data/.bundler-version

@@ -0,0 +1 @@
+2.2.22

data/.dependabot/config.yml

@@ -3,9 +3,14 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "monthly"
+    update_schedule: "daily"
     commit_message:
       prefix: "[dependabot]"
     allowed_updates:
       - match:
-          update_type: "all"
+          dependency_type: "all"
+          update_type: "security"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "security:patch"

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

@@ -1,7 +1,7 @@
-# automatically approve PRs submitted by Dependabot
+# automatically approve PRs submitted by Dependabot or Renofidev
 # 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
+name: Auto approve dependency upgrades PRs
 
 on:
   pull_request
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
       with:
         github-token: "${{ secrets.GITHUB_TOKEN }}"

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

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.12.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/.travis.yml

@@ -3,8 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6
   - 2.7
+  - 3.0
 before_install: gem install bundler
 script:
   - bundle exec rake spec

data/Gemfile.lock

@@ -1,25 +1,26 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (2.1.1)
+    salesforce_streamer (2.5.0)
+      cookiejar (~> 0.3.0)
       dry-initializer (~> 3.0)
+      eventmachine (~> 1.2)
       faye (~> 1.4)
-      restforce (>= 4.2, < 6.0)
+      restforce (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
-    codecov (0.2.9)
-      json
-      simplecov
+    codecov (0.5.2)
+      simplecov (>= 0.15, < 0.22)
     cookiejar (0.3.3)
     diff-lcs (1.4.4)
-    docile (1.3.2)
-    dry-initializer (3.0.3)
+    docile (1.4.0)
+    dry-initializer (3.0.4)
     em-http-request (1.1.7)
       addressable (>= 2.3.4)
       cookiejar (!= 0.3.1)
@@ -29,8 +30,23 @@ GEM
     em-socksify (0.3.2)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.2.7)
-    faraday (1.0.1)
+    faraday (1.5.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    faraday-patron (1.0.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     faye (1.4.0)
@@ -41,69 +57,74 @@ GEM
       multi_json (>= 1.0.0)
       rack (>= 1.0.0)
       websocket-driver (>= 0.5.1)
-    faye-websocket (0.11.0)
+    faye-websocket (0.11.1)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     hashie (4.1.0)
-    http_parser.rb (0.6.0)
-    json (2.3.1)
-    jwt (2.2.2)
+    http_parser.rb (0.7.0)
+    jwt (2.2.3)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    restforce (5.0.1)
+    rake (13.0.4)
+    regexp_parser (2.1.1)
+    restforce (5.0.6)
       faraday (>= 0.9.0, <= 2.0)
       faraday_middleware (>= 0.8.8, <= 2.0)
       hashie (>= 1.2.0, < 5.0)
       jwt (>= 1.5.6)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.90.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
-    ruby-progressbar (1.10.1)
-    simplecov (0.19.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   byebug
@@ -111,9 +132,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
   salesforce_streamer!
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -91,6 +91,7 @@ SalesforceStreamer.configure do |config|
   config.exception_adapter = proc { |e| puts e }
   config.replay_adapter = MyReplayAdapter
   config.use_middleware AfterMessageReceived
+  config.use_faye_extension ErrorLoggingExtension.new
   config.manage_topics = true
 end
 ```
@@ -173,6 +174,32 @@ end
 
 This adapter will be used directly by `Restforce::ReplayExtension`.
 
+### Use Faye Extension
+
+The `config.use_faye_extension` should be given an object that responds to
+`.incoming(message, callback)` or `.outgoing(message, callback)` or both. Find
+out more about extensions from
+[Faye](https://github.com/faye/faye/blob/master/spec/ruby/server/extensions_spec.rb)
+specs.
+
+Any configured extensions are added to the Faye client used by the Restforce
+client when starting up the server. If the extension responds to `.server=` then
+the instance of `SalesforceStreamer::Server` is assigned. This may be convenient
+to restart the server subscriptions if an error requires a reset.
+
+```ruby
+class MyRestartFayeExtension
+  attr_accessor :server
+
+  def incoming(message, callback)
+    callback.call(message).tap |message|
+      server.restart if message['error'] == 'tragic'
+    end
+  end
+end
+
+SalesforceStreamer.config.use_faye_extension MyRestartFayeExtension.new
+```
 ## 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/lib/core_extensions/cookiejar/cookie_validation.rb

@@ -1,27 +1,69 @@
+require 'cookiejar/cookie_validation'
+
 # Original source code at
 # https://github.com/dwaite/cookiejar/blob/master/lib/cookiejar/cookie_validation.rb
-# Re-opening the CookieValidation module to rewrite the domains_match method to
-# skip the validation of domains. Open issue at
-# https://github.com/restforce/restforce/issues/120
-module CoreExtensions
-  module CookieJar
-    module CookieValidation
-      def self.extended(base)
-        base.class_eval do
-          def self.domains_match(tested_domain, base_domain)
-            return true if tested_domain[-15..].eql?('.salesforce.com')
+module CookieJar
+  module CookieValidation
+    # Re-opening the CookieValidation module to rewrite the domains_match method to
+    # skip the validation of domains. Open issue at
+    # https://github.com/restforce/restforce/issues/120
+    def self.domains_match(tested_domain, base_domain)
+      return true if tested_domain[-15..].eql?('.salesforce.com')
+
+      # original implementation
+      base = effective_host base_domain
+      search_domains = compute_search_domains_for_host base
+      search_domains.find do |domain|
+        domain == tested_domain
+      end
+    end
 
-            # original implementation
-            base = effective_host base_domain
-            search_domains = compute_search_domains_for_host base
-            search_domains.find do |domain|
-              domain == tested_domain
+    # Implements https://github.com/dwaite/cookiejar/commit/adb79c0a14c2b347c5289e79379a1acfe34bf388
+    # which is not part of the cookiejar gem yet and is required to prevent
+    # Unknown cookie parameter 'samesite' (CookieJar::InvalidCookieError)
+    def self.parse_set_cookie(set_cookie_value)
+      args = {}
+      params = set_cookie_value.split(/;\s*/)
+
+      first = true
+      params.each do |param|
+        result = PARAM1.match param
+        unless result
+          fail InvalidCookieError,
+            "Invalid cookie parameter in cookie '#{set_cookie_value}'"
+        end
+        key = result[1].downcase.to_sym
+        keyvalue = result[2]
+        if first
+          args[:name] = result[1]
+          args[:value] = keyvalue
+          first = false
+        else
+          case key
+          when :expires
+            begin
+              args[:expires_at] = Time.parse keyvalue
+            rescue ArgumentError
+              raise unless $ERROR_INFO.message == 'time out of range'
+              args[:expires_at] = Time.at(0x7FFFFFFF)
             end
+          when :'max-age'
+            args[:max_age] = keyvalue.to_i
+          when :domain, :path
+            args[key] = keyvalue
+          when :secure
+            args[:secure] = true
+          when :httponly
+            args[:http_only] = true
+          when :samesite
+            args[:samesite] = keyvalue.downcase
+          else
+            fail InvalidCookieError, "Unknown cookie parameter '#{key}'"
           end
         end
       end
+      args[:version] = 0
+      args
     end
   end
 end
-
-CookieJar::CookieValidation.extend(CoreExtensions::CookieJar::CookieValidation)

data/lib/salesforce_streamer/configuration.rb

@@ -3,7 +3,7 @@ module SalesforceStreamer
   class Configuration
     attr_accessor :environment, :logger, :require_path, :config_file,
       :manage_topics, :exception_adapter, :replay_adapter
-    attr_reader :middleware
+    attr_reader :middleware, :faye_extensions
 
     class << self
       attr_writer :instance
@@ -26,6 +26,7 @@ module SalesforceStreamer
       @config_file = './config/streamer.yml'
       @require_path = './config/environment'
       @middleware = []
+      @faye_extensions = [ReplayIdErrorExtension.new]
     end
 
     def manage_topics?
@@ -37,6 +38,11 @@ module SalesforceStreamer
       @middleware << [klass, args, block]
     end
 
+    # adds a Faye extension
+    def use_faye_extension(extension)
+      @faye_extensions << extension
+    end
+
     # returns a ready to use chain of middleware
     def middleware_runner(last_handler)
       @middleware.reduce(last_handler) do |next_handler, current_handler|

data/lib/salesforce_streamer/launcher.rb

@@ -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(topic_data.transform_keys(&:to_sym))
+        @push_topics << PushTopic.new(**topic_data.transform_keys(&:to_sym))
       end
     end
   end

data/lib/salesforce_streamer/push_topic.rb

@@ -4,11 +4,11 @@ module SalesforceStreamer
     extend Dry::Initializer
 
     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 :query, ->(v) { v.gsub(/\s+/, ' ') }
+    option :handler, ->(v) { prepare_handler_proc(Object.const_get(v)) }
+    option :replay, ->(v) { v.to_i }, default: -> { -1 }
+    option :api_version, proc(&:to_s), default: -> { '49.0' }
+    option :notify_for_fields, default: -> { 'Referenced' }
     option :id, optional: true
     option :description, optional: true
 

data/lib/salesforce_streamer/replay_id_error_extension.rb

@@ -1,6 +1,6 @@
 module SalesforceStreamer
   class ReplayIdErrorExtension
-    REPLAY_ERROR_REGEX = /^400::The replayId /.freeze
+    REPLAY_ERROR_REGEX = /^400::The replayId /
 
     def incoming(message, callback)
       if message['error']&.match?(REPLAY_ERROR_REGEX)

data/lib/salesforce_streamer/server.rb

@@ -1,15 +1,23 @@
 module SalesforceStreamer
   class Server
     attr_writer :push_topics
+    attr_reader :client
 
     def initialize(push_topics: [])
       @push_topics = push_topics
     end
 
     def run
-      Log.info 'Starting Server'
+      Log.info 'Starting server'
       catch_signals
-      start_em
+      reset_client
+      EM.run { subscribe }
+    end
+
+    def restart
+      Log.info 'Restarting server'
+      reset_client
+      EM.next_tick { subscribe }
     end
 
     private
@@ -23,21 +31,21 @@ module SalesforceStreamer
       end
     end
 
-    def client
-      return @client if @client
+    def reset_client
       @client = Restforce.new
-      @client.authenticate!
-      @client.faye.add_extension ReplayIdErrorExtension.new
-      @client
+      client.authenticate!
+      Configuration.instance.faye_extensions.each do |extension|
+        Log.debug %(adding Faye extension #{extension})
+        extension.server = self if extension.respond_to?(:server=)
+        client.faye.add_extension extension
+      end
     end
 
-    def start_em
-      EM.run do
-        @push_topics.map do |topic|
-          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
-          end
+    def subscribe
+      @push_topics.each do |topic|
+        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
         end
       end
     end

data/lib/salesforce_streamer/version.rb

@@ -1,3 +1,3 @@
 module SalesforceStreamer
-  VERSION = '2.1.1'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/salesforce_streamer.gemspec

@@ -25,15 +25,19 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
+  spec.add_dependency 'cookiejar', '~> 0.3.0'
   spec.add_dependency 'dry-initializer', '~> 3.0'
   spec.add_dependency 'faye', '~> 1.4'
-  spec.add_dependency 'restforce', '>= 4.2', '< 6.0'
+  spec.add_dependency 'restforce', '~> 5.0'
+  # # When you have issues installing eventmachine on osx and ruby 3, try:
+  # gem install eventmachine -- --with-openssl-dir=/usr/local/opt/openssl@1.1
+  spec.add_dependency 'eventmachine', '~> 1.2'
 
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Scott Serok
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cookiejar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
@@ -43,22 +57,30 @@ dependencies:
   name: restforce
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,12 +188,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-version"
 - ".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"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -218,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A wrapper around the Restforce Streaming API with a built-in PushTopic manager.