salesforce_streamer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5279cbf060a7998dda26f5b8243f4f7f45a235df437b6e5b43dded0a0db770
-  data.tar.gz: fe42569934ea906d2a90426367233918558abf2848be187263af5556ab56ae3e
+  metadata.gz: 0b2b0f558cddea62f7daa6836378714c462efee9041651c018a3c03ba12f9e37
+  data.tar.gz: 0b78a376cc983420c7d0306db33ad81c91d29817048893f975b9647d748ccc75
 SHA512:
-  metadata.gz: d3f90343488c893ef58bf82ef39105acaef83283476228d7263f524ca87855dd781212cb8b107786def223c32bfea43d9f299a15bca50e95698c3b733350ad9a
-  data.tar.gz: 68467636cccd05ffdd5acc046b32f8f8d5dff0a14b9a72f7bcb18ac102b7664d4bb69538b5613200964f3186b596f345c1c7de83bbf1191a36df811bd825d589
+  metadata.gz: 9a94f0948ab22945f7609e8164330fb273eb32c3366e259fb40ea9b8dd0b39d7b7634972df36af6c4e2e57ce5cf43ee48d9e9ec6c6f46f61354c58144ee68c98
+  data.tar.gz: 4759ab638d353562eeda92be76d660314d7ea37b2bc7f2e2290cf1502f58282e63e8672bb15eeffd093600ae87fb9e63911e67cbfdd47a196697369c75a88983

data/.gitignore

@@ -1,5 +1,4 @@
 /.bundle/
-/.byebug_history
 /.yardoc
 /_yardoc/
 /coverage/
@@ -10,4 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
-.env
+
+# Cached rubocop config files
+.rubocop-http*
+vidar.yml

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require:
+  - rubocop-performance
+
+inherit_from:
+  - https://raw.githubusercontent.com/RenoFi/rubocop/master/ruby.yml
+
+AllCops:
+  TargetRubyVersion: 2.6

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -3,6 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6
   - 2.5
-before_install: gem install bundler -v 2.0.1
+  - 2.6
+before_install: gem install bundler -v 2.0.2
+script:
+  - bundle exec rake

data/Gemfile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in salesforce_streamer.gemspec

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (0.3.0)
+    salesforce_streamer (0.4.0)
       faye (= 0.8.9)
-      restforce (~> 3.1.0)
+      restforce (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
     byebug (11.0.1)
-    codecov (0.1.14)
+    codecov (0.1.16)
       json
       simplecov
       url
@@ -27,7 +28,7 @@ GEM
     em-socksify (0.3.2)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.2.7)
-    faraday (0.17.0)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
@@ -43,34 +44,52 @@ GEM
       websocket-driver (>= 0.5.1)
     hashie (3.6.0)
     http_parser.rb (0.6.0)
+    jaro_winkler (1.5.4)
     json (2.2.0)
+    jwt (2.2.1)
     multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
     public_suffix (4.0.1)
     rack (2.0.7)
-    rake (10.5.0)
-    restforce (3.1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    restforce (4.2.0)
       faraday (>= 0.9.0, <= 1.0)
       faraday_middleware (>= 0.8.8, <= 1.0)
       hashie (>= 1.2.0, < 4.0)
       json (>= 1.7.5)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+      jwt (>= 1.5.6)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    simplecov (0.17.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    unicode-display_width (1.6.0)
     url (0.3.2)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
@@ -81,11 +100,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  byebug (~> 11.0.1)
-  codecov (~> 0.1.14)
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  byebug
+  codecov
+  rake
+  rspec
+  rubocop
+  rubocop-performance
   salesforce_streamer!
 
 BUNDLED WITH

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/bin/console

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
-
 require 'bundler/setup'
 require 'salesforce_streamer'
 

data/exe/streamer

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
-
 require 'salesforce_streamer'
 require 'salesforce_streamer/cli'
 

data/lib/core_extensions/cookiejar/cookie_validation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # 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

data/lib/salesforce_streamer/cli.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class CLI
     def initialize(argv)
@@ -21,8 +19,7 @@ module SalesforceStreamer
           @config.config_file = arg
         end
 
-        o.on '-e', '--environment ENVIRONMENT',
-             'The environment to run the app on (default development)' do |arg|
+        o.on '-e', '--environment ENVIRONMENT', 'The environment to run the app on (default development)' do |arg|
           @config.environment = arg
         end
 

data/lib/salesforce_streamer/configuration.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   # Manages server configuration.
   class Configuration
@@ -16,7 +14,7 @@ module SalesforceStreamer
     def initialize
       @environment = ENV['RACK_ENV'] || :development
       @logger = Logger.new(IO::NULL)
-      @exception_adapter = proc { |exc| raise exc }
+      @exception_adapter = proc { |exc| fail(exc) }
       @persistence_adapter = RedisReplay.new
       @manage_topics = false
       @config_file = './config/streamer.yml'

data/lib/salesforce_streamer/errors.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class MissingCLIFlagError < StandardError
     def initialize(flag)

data/lib/salesforce_streamer/launcher.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   # SalesforceStreamer::Launcher is the entry point for starting the Restforce
   # Streaming API server. It is responsible for upserting each PushTopic and
@@ -27,10 +25,10 @@ module SalesforceStreamer
     end
 
     def require_application
-      if Configuration.instance.require_path
-        Log.debug 'Loading the require path'
-        require Configuration.instance.require_path
-      end
+      return unless Configuration.instance.require_path
+
+      Log.debug 'Loading the require path'
+      require Configuration.instance.require_path
     end
 
     def initialize_push_topics

data/lib/salesforce_streamer/message_receiver.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class MessageReceiver
     class << self

data/lib/salesforce_streamer/push_topic.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
 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
+      :handler, :handler_constant, :api_version
 
     def initialize(data:)
       @handler           = data['handler']
@@ -19,8 +17,8 @@ module SalesforceStreamer
     end
 
     def replay
-      @replay ||= (ReplayPersistence.retrieve(name) || @static_replay).tap do |replayId|
-        Log.info "PushTopic name=#{name} starting at replayId=#{replayId}"
+      @replay ||= (ReplayPersistence.retrieve(name) || @static_replay).tap do |replay_id|
+        Log.info "PushTopic name=#{name} starting at replayId=#{replay_id}"
       end
     end
 
@@ -33,7 +31,7 @@ module SalesforceStreamer
     private
 
     def validate!
-      raise(PushTopicNameTooLongError, @name) if @name.size > 25
+      fail(PushTopicNameTooLongError, @name) if @name.size > 25
 
       @handler_constant = Object.const_get(@handler)
       true
@@ -43,7 +41,7 @@ module SalesforceStreamer
     end
 
     def strip_spaces(str)
-      raise(NilQueryError, @name) unless str
+      fail(NilQueryError, @name) unless str
 
       str.gsub(/\s+/, ' ')
     end

data/lib/salesforce_streamer/redis_replay.rb

@@ -1,10 +1,8 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class RedisReplay
     class << self
       def redis_connection
-        @redis_connection ||= Configuration.instance.redis_connection || raise(RedisConnectionError)
+        @redis_connection ||= Configuration.instance.redis_connection || fail(RedisConnectionError)
       end
 
       attr_writer :redis_connection
@@ -27,7 +25,7 @@ module SalesforceStreamer
       key = namespaced_key(key)
       value = Integer(value)
       connection { |c| c.setex key, SECONDS_TO_EXPIRE, value }
-    rescue StandardError, TypeError => e
+    rescue StandardError => e
       Configuration.instance.exception_adapter.call e
       nil
     end
@@ -49,7 +47,7 @@ module SalesforceStreamer
       NAMESPACE + key.to_s
     end
 
-    NAMESPACE = 'SalesforceStreamer:'
+    NAMESPACE = 'SalesforceStreamer:'.freeze
     SECONDS_TO_EXPIRE = 24 * 60 * 60 # 24 hours
     START = 0
     STOP = 0

data/lib/salesforce_streamer/replay_persistence.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   # Store values for a given key in a sorted sequence
   # Retrieves the highest value given a key

data/lib/salesforce_streamer/salesforce_client.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class SalesforceClient
     def initialize(client: Restforce.new)
@@ -24,17 +22,17 @@ module SalesforceStreamer
 
     # Returns true or raises an exception if the upsert fails
     def upsert_push_topic(push_topic)
-      @client.upsert!('PushTopic', :Id,
-                      'Id' => push_topic.id,
-                      'Name' => push_topic.name,
-                      'ApiVersion' => push_topic.api_version,
-                      'Description' => push_topic.description,
-                      'NotifyForFields' => push_topic.notify_for_fields,
-                      'Query' => push_topic.query)
+      @client.upsert!(
+        'PushTopic', :Id,
+        'Id' => push_topic.id,
+        'Name' => push_topic.name,
+        'ApiVersion' => push_topic.api_version,
+        'Description' => push_topic.description,
+        'NotifyForFields' => push_topic.notify_for_fields,
+        'Query' => push_topic.query
+      )
     end
 
-    private
-
     QUERY = <<~SOQL.chomp.freeze
       SELECT Id, Name, ApiVersion, Description, NotifyForFields, Query, isActive
       FROM PushTopic

data/lib/salesforce_streamer/server.rb

@@ -1,16 +1,12 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class Server
     attr_writer :push_topics
 
     def initialize(push_topics: [])
       @push_topics = push_topics
-      @client = Restforce.new
     end
 
     def run
-      @client.authenticate!
       Log.info 'Starting Server'
       catch_signals
       start_em
@@ -27,10 +23,14 @@ module SalesforceStreamer
       end
     end
 
+    def client
+      Restforce.new.tap(&:authenticate!)
+    end
+
     def start_em
       EM.run do
         @push_topics.map do |topic|
-          @client.subscribe topic.name, replay: topic.replay.to_i do |msg|
+          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
           end

data/lib/salesforce_streamer/topic_manager.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
   class TopicManager
     attr_reader :push_topics

data/lib/salesforce_streamer/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SalesforceStreamer
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'.freeze
 end

data/lib/salesforce_streamer.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'faye'
 require 'logger'
 require 'optparse'

data/salesforce_streamer.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'salesforce_streamer/version'
@@ -10,24 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Scott Serok']
   spec.email         = ['scott@renofi.com']
 
-  spec.summary       = 'A wrapper around the Restforce Streaming API.'
-  spec.description   = 'A wrapper around the Restforce Streaming API.'
+  spec.summary       = 'A wrapper around the Restforce Streaming API with a built-in PushTopic manager.'
   spec.homepage      = 'https://github.com/renofi/salesforce_streamer'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = spec.homepage
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
@@ -35,11 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 11.0.1'
-  spec.add_development_dependency 'codecov', '~> 0.1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_dependency 'faye', '0.8.9'
-  spec.add_dependency 'restforce', '~> 3.1.0'
+  spec.add_dependency 'restforce', '~> 4.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'
 end

metadata

@@ -1,114 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Scott Serok
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: restforce
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '4.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 11.0.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 11.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.14
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.14
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faye
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.9
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: restforce
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
-description: A wrapper around the Restforce Streaming API.
+        version: '0'
+description: 
 email:
 - scott@renofi.com
 executables:
@@ -118,6 +132,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -150,7 +166,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renofi/salesforce_streamer
   source_code_uri: https://github.com/renofi/salesforce_streamer
-  changelog_uri: https://github.com/renofi/salesforce_streamer
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -169,5 +184,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: A wrapper around the Restforce Streaming API.
+summary: A wrapper around the Restforce Streaming API with a built-in PushTopic manager.
 test_files: []