salesforce_streamer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b38b1183300426662be05b97122259977fe6b492201845fe167dcc6d3c112aa2
+  data.tar.gz: 375d1d6c83fefdd0acd19df20c8fce763056b28894f73f175b9f3a164dbbbe61
+SHA512:
+  metadata.gz: 23b0bb31b46d75b186907acaeba9931cb9bde5ccfd9e2ea7c92e30fa9b4a26fe238ace2eb1a841fbc0801cd376a37261e53c192e395fbb3ddd163739115e08c4
+  data.tar.gz: 992b2c38a77a92729d370a78c90c35d629f88341994be75b219c1aba65258502c8ef3c60aae573786946c5d270bbdcbdb1c7e405b8f36d18232ded3242403f54

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.byebug_history
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+  - 2.5
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at scott@renofi.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in salesforce_streamer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    salesforce_streamer (0.1.0)
+      faye (~> 0.8.9)
+      restforce (~> 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (11.0.1)
+    codecov (0.1.14)
+      json
+      simplecov
+      url
+    cookiejar (0.3.3)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    em-http-request (1.1.5)
+      addressable (>= 2.3.4)
+      cookiejar (!= 0.3.1)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.2)
+      eventmachine (>= 1.0.0.beta.4)
+    eventmachine (1.2.7)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    faye (0.8.11)
+      cookiejar (>= 0.3.0)
+      em-http-request (>= 0.3.0)
+      eventmachine (>= 0.12.0)
+      faye-websocket (>= 0.4.0)
+      rack (>= 1.0.0)
+      yajl-ruby (>= 1.0.0)
+    faye-websocket (0.10.9)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    hashie (3.6.0)
+    http_parser.rb (0.6.0)
+    json (2.2.0)
+    multipart-post (2.1.1)
+    public_suffix (3.1.1)
+    rack (2.0.7)
+    rake (10.5.0)
+    restforce (3.1.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    url (0.3.2)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    yajl-ruby (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0.1)
+  codecov (~> 0.1.14)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  salesforce_streamer!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Scott Serok
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+[![Build Status](https://travis-ci.org/RenoFi/salesforce_streamer.svg?branch=master)](https://travis-ci.org/RenoFi/salesforce_streamer)
+
+[![codecov](https://codecov.io/gh/RenoFi/salesforce_streamer/branch/master/graph/badge.svg)](https://codecov.io/gh/RenoFi/salesforce_streamer)
+
+# SalesforceStreamer
+
+A wrapper around the Restforce Streaming API to receive real time updates from
+your Salesforce instance with a built-in PushTopic manager.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce_streamer'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### 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.
+
+```yaml
+# config/streamer.yml
+---
+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"
+
+development:
+  <<: *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
+`.call(str)`.
+
+```ruby
+# lib/account_change_handler.rb
+class AccountChangeHandler
+  def self.call(message)
+    puts message
+  end
+end
+```
+
+### Prepare The Environment
+
+Set your Restforce ENV variables in order to establish a connection. See the
+Restforce API documentation for more details. Then start the server using the
+command line interface.
+
+### Launch The Streamer
+
+Launch the `streamer` service, pointing it to your push topic configuration YAML
+file and the entry point to your application.
+
+```
+$ bundle exec streamer -C config/streamer.yml -r ./lib/app -x -v INFO
+I, [2019-07-09T15:19:55.862296 #78537]  INFO -- : Launching Streamer Services
+I, [2019-07-09T15:19:55.862351 #78537]  INFO -- : Running Topic Manager
+I, [2019-07-09T15:19:56.860998 #78537]  INFO -- : New PushTopic AllAccounts
+I, [2019-07-09T15:19:56.861079 #78537]  INFO -- : Upsert PushTopic AllAccounts
+I, [2019-07-09T15:19:57.591241 #78537]  INFO -- : Starting Server
+```
+
+For very verbose logs, also use the `--verbose-restforce` flag to activate the
+Restforce client logger - not recommended for production.
+
+You can start up the server without syncing the push topic configuration if you
+know the topics are already configured appropriately. Remove the `-x` flag from
+the CLI to skip the topic management component.
+
+```
+$ bundle exec streamer -C config/streamer.yml -r ./lib/app -v INFO
+I, [2019-07-08T22:16:34.104271 #26973]  INFO -- : Launching Streamer Services
+I, [2019-07-09T15:19:55.862351 #78537]  INFO -- : Running Topic Manager
+I, [2019-07-09T15:19:56.860998 #78537]  INFO -- : New PushTopic AllAccounts
+I, [2019-07-09T15:19:56.861079 #78537]  INFO -- : Upsert PushTopic AllAccounts
+I, [2019-07-09T15:19:56.861109 #78537]  INFO -- : Skipping upsert because manage topics is off
+I, [2019-07-08T22:16:34.794933 #26973]  INFO -- : Starting Server
+```
+
+By default, the CLI will load the YAML based on the `RACK_ENV` environment
+variable, or default to `:development` if not set. You can override this in the
+CLI with the `-e ENV` flag.
+
+```
+$ bundle exec streamer -C config/streamer.yml -r ./lib/app -e production
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/renofi/salesforce_streamer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SalesforceStreamer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/renofi/salesforce_streamer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "salesforce_streamer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/streamer

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'salesforce_streamer'
+require 'salesforce_streamer/cli'
+
+cli = SalesforceStreamer::CLI.new ARGV
+cli.run

data/lib/core_extensions/cookiejar/cookie_validation.rb

@@ -0,0 +1,31 @@
+# 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
+# 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..-1].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
+
+        end
+      end
+    end
+  end
+end
+
+CookieJar::CookieValidation.extend(CoreExtensions::CookieJar::CookieValidation)

data/lib/salesforce_streamer/cli.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  class CLI
+    def initialize(argv)
+      @argv = argv
+      @config = Configuration.new
+      @push_topics_loaded = false
+      setup_options
+      @parser.parse! @argv
+    end
+
+    def run
+      validate!
+      Launcher.new(config: @config).run
+    end
+
+    private
+
+    def validate!
+      raise(MissingCLIFlagError, '--config PATH') unless @push_topics_loaded
+      raise(MissingCLIFlagError, '--require PATH') unless @config.require_path
+    rescue MissingCLIFlagError => e
+      puts e
+      puts @parser
+      exit 1
+    end
+
+    def setup_options
+      @parser = OptionParser.new do |o|
+        o.on "-C", "--config PATH", "Load PATH as a config file" do |arg|
+          @config.load_push_topic_data arg
+          @push_topics_loaded = true
+        end
+
+        o.on "-e", "--environment ENVIRONMENT",
+          "The environment to run the app on (default development)" do |arg|
+          @config.environment = arg
+        end
+
+        o.on "-r", "--require PATH", "Load PATH as the entry point to your application" do |arg|
+          @config.require_path = arg
+        end
+
+        o.on "--verbose-restforce", "Activate the Restforce logger" do
+          @config.restforce_logger!
+        end
+
+        o.on "-v", "--verbose LEVEL", "Set the log level (default no logging)" do |arg|
+          logger = Logger.new(STDOUT)
+          logger.level = arg
+          @config.logger = logger
+        end
+
+        o.on "-V", "--version", "Print the version information" do
+          puts "streamer version #{SalesforceStreamer::VERSION}"
+          exit 0
+        end
+
+        o.on "-x", "--topics", "Activate PushTopic Management (default off)" do
+          @config.manage_topics = true
+        end
+
+        o.banner = "streamer OPTIONS"
+
+        o.on_tail "-h", "--help", "Show help" do
+          puts o
+          exit 0
+        end
+      end
+    end
+  end
+end

data/lib/salesforce_streamer/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  # Manages server configuration.
+  class Configuration
+    attr_accessor :environment, :logger, :require_path
+    attr_reader :push_topic_data
+    attr_writer :manage_topics
+
+    def initialize
+      @environment = ENV['RACK_ENV'] || :development
+      @logger = Logger.new(IO::NULL)
+      @manage_topics = false
+    end
+
+    def manage_topics?
+      @manage_topics
+    end
+
+    def load_push_topic_data(path)
+      data = YAML.safe_load(File.read(path), [], [], true)
+      @push_topic_data = data[environment.to_s]
+    end
+
+    def restforce_logger!
+      Restforce.log = true
+    end
+  end
+end

data/lib/salesforce_streamer/errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  class MissingCLIFlagError < StandardError
+    def initialize(flag)
+      super 'Missing required command line flag: ' + flag.to_s
+    end
+  end
+
+  class NilQueryError < StandardError
+    def initialize(name)
+      super 'Query not defined for ' + name.to_s
+    end
+  end
+
+  class PushTopicHandlerMissingError < StandardError
+    def initialize(message)
+      super "Unable to load constant #{message.to_s}."
+    end
+  end
+
+  class PushTopicNameTooLongError < StandardError
+    def initialize(name)
+      super 'PushTopic name: ' + name.to_s + ' (' + name.size.to_s + '/25)'
+    end
+  end
+end

data/lib/salesforce_streamer/launcher.rb

@@ -0,0 +1,47 @@
+# 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
+  # starting the server.
+  class Launcher
+    def initialize(config:)
+      @config = config
+      @logger = config.logger
+      load_server_configuration
+      @manager = TopicManager.new push_topics: @push_topics, config: @config
+      @server = Server.new push_topics: @push_topics, config: @config
+    end
+
+    # Manages each PushTopic configured and starts the Streaming API listener.
+    def run
+      @logger.info 'Launching Streamer Services'
+      @manager.run
+      @server.push_topics = @manager.push_topics
+      @server.run
+    end
+
+    private
+
+    def load_server_configuration
+      require_application
+      initialize_push_topics
+    end
+
+    def require_application
+      if @config.require_path
+        @logger.debug 'Loading the require path'
+        require @config.require_path
+      end
+    end
+
+    def initialize_push_topics
+      @logger.debug 'Loading and validating PushTopics configuration'
+      @push_topics = []
+      @config.push_topic_data.values.each do |topic_data|
+        @logger.debug topic_data.to_s
+        @push_topics << PushTopic.new(data: topic_data)
+      end
+    end
+  end
+end

data/lib/salesforce_streamer/push_topic.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  # Models the PushTopic object for both Restforce and Streamer
+  class PushTopic
+    attr_accessor :id
+    attr_reader :name, :replay, :description, :notify_for_fields, :query,
+      :handler, :handler_constant, :api_version
+
+    def initialize(data:)
+      @handler           = data['handler']
+      @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
+
+    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}"
+    end
+
+    private
+
+    def validate!
+      raise(PushTopicNameTooLongError, @name) if @name.size > 25
+      @handler_constant = Object.const_get(@handler)
+      true
+    rescue NameError, TypeError => e
+      message = 'handler=' + @handler.to_s + ' exception=' + e.to_s
+      raise(PushTopicHandlerMissingError, message)
+    end
+
+    def strip_spaces(str)
+      raise(NilQueryError, @name) unless str
+      str.gsub(/\s+/, ' ')
+    end
+  end
+end

data/lib/salesforce_streamer/salesforce_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  class SalesforceClient
+    def initialize(client: Restforce.new)
+      @client = client
+    end
+
+    def authenticate!
+      @client.authenticate!
+    end
+
+    def subscribe(*args)
+      @client.subscribe(args) do
+        yield
+      end
+    end
+
+    # Returns nil or an instance of Restforce::SObject
+    def find_push_topic_by_name(name)
+      query = QUERY.dup.gsub(/\s+/, ' ').gsub('{{NAME}}', name)
+      @client.query(query).first
+    end
+
+    # 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
+      )
+    end
+
+    private
+
+    QUERY = <<~SOQL.chomp.freeze
+    SELECT Id, Name, ApiVersion, Description, NotifyForFields, Query, isActive
+    FROM PushTopic
+    WHERE Name = '{{NAME}}'
+    SOQL
+  end
+end

data/lib/salesforce_streamer/server.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  class Server
+    attr_writer :push_topics
+
+    def initialize(config:, push_topics: [])
+      @logger = config.logger
+      @push_topics = push_topics
+      @client = Restforce.new
+    end
+
+    def run
+      @client.authenticate!
+      @logger.info 'Starting Server'
+      catch_signals
+      start_em
+    end
+
+    private
+
+    def catch_signals
+      %w[INT USR1 USR2 TERM TTIN TSTP].each do |sig|
+        trap sig do
+          puts "Caught signal #{sig}. Shutting down..."
+          exit 0
+        end
+      end
+    end
+
+    def start_em
+      EM.run do
+        @push_topics.map do |topic|
+          @client.subscribe topic.name, replay: topic.replay.to_i do |msg|
+            @logger.debug(msg)
+            topic.handler_constant.call(msg)
+            @logger.info("Message processed: channel=#{topic.name} replayId=#{msg.dig('event', 'replayId')}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/salesforce_streamer/topic_manager.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  class TopicManager
+    attr_reader :push_topics
+
+    def initialize(push_topics:, config:)
+      @push_topics = push_topics
+      @config = config
+      @logger = config.logger
+      @client = Restforce.new
+    end
+
+    def run
+      @logger.info 'Running Topic Manager'
+      @push_topics.each do |push_topic|
+        @logger.debug push_topic.to_s
+        if diff?(push_topic)
+          upsert(push_topic)
+        end
+      end
+    end
+
+    private
+
+    def diff?(push_topic)
+      hashie = @client.find_push_topic_by_name(push_topic.name)
+      unless hashie
+        @logger.info "New PushTopic #{push_topic.name}"
+        return true
+      end
+      @logger.debug "Remote PushTopic found with hash=#{hashie.to_h}"
+      push_topic.id = hashie.Id
+      return true unless push_topic.query.eql?(hashie.Query)
+      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)
+      @logger.debug 'No differences detected'
+      false
+    end
+
+    def upsert(push_topic)
+      @logger.info "Upsert PushTopic #{push_topic.name}"
+      if @config.manage_topics?
+        @client.upsert_push_topic(push_topic)
+      else
+        @logger.info 'Skipping upsert because manage topics is off'
+      end
+    end
+  end
+end

data/lib/salesforce_streamer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SalesforceStreamer
+  VERSION = '0.1.0'
+end

data/lib/salesforce_streamer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'faye'
+require 'logger'
+require 'optparse'
+require 'restforce'
+require 'yaml'
+
+require 'salesforce_streamer/configuration'
+require 'salesforce_streamer/errors'
+require 'salesforce_streamer/push_topic'
+require 'salesforce_streamer/topic_manager'
+require 'salesforce_streamer/salesforce_client'
+require 'salesforce_streamer/server'
+require 'salesforce_streamer/version'
+require 'salesforce_streamer/launcher'
+
+require 'core_extensions/cookiejar/cookie_validation'
+
+# SalesforceStreamer wraps the Restforce Streaming API implementation so that
+# your PushTopics are managed in the same place as your server set up.
+#
+# Establishing a connection to your Salesforce instances is performed using the
+# Restforce client and your ENV variables.
+#
+#     export SALESFORCE_HOST="test.salesforce.com"
+#     export SALESFORCE_USERNAME="user@domain.tld"
+#     export SALESFORCE_PASSWORD="password"
+#     export SALESFORCE_SECURITY_TOKEN="security token"
+#     export SALESFORCE_CLIENT_ID="long client id"
+#     export SALESFORCE_CLIENT_SECRET="long client secret"
+#     export SALESFORCE_API_VERSION="41.0"
+#
+# Define each PushTopic and handler inside of a YAML config file and load it
+# upon starting up the server.
+#
+#     bundle exec streamer -C config/streamer.yml
+#
+# Starting up the server takes a few moments before accepting new events. First,
+# the server launches the PushTopic manager to upsert each PushTopic defined in
+# the configuration file provided.  Once each PushTopic is up to date, then the
+# server launches the event manager to listen for and handle messages.
+#
+# Turn on verbose logging for troubleshooting. The -r flag will activate the
+# Restforce logger, so this is not recommended for production. The -v flag
+# activates a Logger to STDOUT with DEBUG level by default. Set the log level
+# with the -v flag.
+#
+#     bundle exec streamer -C config/streamer.yml -r
+#     bundle exec streamer -C config/streamer.yml -v
+#     bundle exec streamer -C config/streamer.yml -v INFO
+#     bundle exec streamer -C config/streamer.yml -r -v
+#     bundle exec streamer -C config/streamer.yml -r -v INFO
+#
+module SalesforceStreamer
+end

data/salesforce_streamer.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "salesforce_streamer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_streamer"
+  spec.version       = SalesforceStreamer::VERSION
+  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.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
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 11.0.1"
+  spec.add_development_dependency "codecov", "~> 0.1.14"
+  spec.add_dependency "restforce", "~> 3.1.0"
+  spec.add_dependency "faye", "~> 0.8.9"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_streamer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Serok
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.14
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  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
+description: A wrapper around the Restforce Streaming API.
+email:
+- scott@renofi.com
+executables:
+- streamer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/streamer
+- lib/core_extensions/cookiejar/cookie_validation.rb
+- lib/salesforce_streamer.rb
+- lib/salesforce_streamer/cli.rb
+- lib/salesforce_streamer/configuration.rb
+- lib/salesforce_streamer/errors.rb
+- lib/salesforce_streamer/launcher.rb
+- lib/salesforce_streamer/push_topic.rb
+- lib/salesforce_streamer/salesforce_client.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
+licenses:
+- MIT
+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:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A wrapper around the Restforce Streaming API.
+test_files: []