salesforce_streamer 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7aa51a1aab875d18d027a1686a598d795d30126cea6fc81f08e705911bdc92c
-  data.tar.gz: ce9f47fdc1f3c277347c684fc533e92e56e93779c3115a0894f8834c1196b795
+  metadata.gz: 44577fdf473e9b6522ab3020453442e6e0ff9fe9a260405b711f6bc76cabb7db
+  data.tar.gz: 8c2ec55c1e067ba5ea86837c1c778a33e5d90003713cc3758977f5de679f126a
 SHA512:
-  metadata.gz: 6d7183472e280c49188c8f0a386ddf24e47ee99cd827b0e1b9bb3c22184136ef81694364020a4c6676f728317af530e5959908fe79d871ba065d43f29b0c5f97
-  data.tar.gz: 329f63f5ced7e03256761765e70a3d13107779fa895e249e69e07e98d148ed1142b0f23c9e8cc86d38faae92087af59080524cef60a70ba51619ab4ec9cdd36b
+  metadata.gz: d6a0b79d9a2a14e8c666462385e794781037865bae627d1f7bbd018381ed1f3900eb7c726451eb62ca02782b42bee8fdb9c1e3dce9a53c35e7ab724b2607a7f6
+  data.tar.gz: 891d7f0bafc8ca5490e109afd96408239afeee13c3d8e4cbcde571d9799edf61973981c6c63bc954e32c9fec45bdbd4b22659c9cd3b6070362357ccf58bf399c

data/.bundler-version

@@ -0,0 +1 @@
+2.2.16

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/Gemfile.lock

@@ -1,28 +1,26 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (2.1.0)
+    salesforce_streamer (2.4.0)
+      cookiejar (~> 0.3.0)
       dry-initializer (~> 3.0)
       faye (~> 1.4)
-      restforce (>= 4.2, < 6.0)
+      restforce (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
-    codecov (0.2.3)
-      colorize
-      json
-      simplecov
-    colorize (0.8.1)
+    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)
-    em-http-request (1.1.6)
+    docile (1.3.5)
+    dry-initializer (3.0.4)
+    em-http-request (1.1.7)
       addressable (>= 2.3.4)
       cookiejar (!= 0.3.1)
       em-socksify (>= 0.3)
@@ -31,8 +29,15 @@ GEM
     em-socksify (0.3.2)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.2.7)
-    faraday (1.0.1)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     faye (1.4.0)
@@ -48,64 +53,69 @@ GEM
       websocket-driver (>= 0.5.1)
     hashie (4.1.0)
     http_parser.rb (0.6.0)
-    json (2.3.1)
-    jwt (2.2.1)
+    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.3)
+    regexp_parser (2.1.1)
+    restforce (5.0.5)
       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.88.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
       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.1.0, < 1.0)
+      rubocop-ast (>= 1.5.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.42.0)
-      rubocop (>= 0.87.0)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.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)
+      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.3)
       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
@@ -113,9 +123,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
   salesforce_streamer!
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

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/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/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.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/salesforce_streamer.gemspec

@@ -25,15 +25,16 @@ 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'
 
   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,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Scott Serok
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2021-05-09 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,16 @@ 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'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,7 +165,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - scott@renofi.com
 - engineering@renofi.com
@@ -166,12 +174,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"
@@ -203,7 +213,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: A wrapper around the Restforce Streaming API with a built-in PushTopic manager.
 test_files: []