streamforce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c34310d1629ebc82065f442b4e4ef30eb91fef7f28aa42b01afbc062b6fd3a1e
+  data.tar.gz: 53ae2b66be382330501458097c322c88a70826400af18808ae5f1b062966b6dd
+SHA512:
+  metadata.gz: 4fb0fd547750fb0c26cc027407227bec6091e5a640431bbd26b31eac34866914aaa8fe9b2f0a99551b598aea6ae0f11de0f2ff54e85986fc2cd96e20c3e7a1af
+  data.tar.gz: 55b68bf69239eba0af1ceabfd225184c2ef8e838154273086614acbad4c685645f37bbb8ed6a60da04033f8cc965191a053a719a864815746ad06bfb868b30a3

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-12
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andrei Maxim
+
+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,9 @@
+# Streamforce
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andreimaxim/streamforce.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/streamforce/client.rb

@@ -0,0 +1,79 @@
+class Streamforce::Client
+  class << self
+    def host
+      ENV["SALESFORCE_HOST"]
+    end
+
+    def client_id
+      ENV["SALESFORCE_CLIENT_ID"]
+    end
+
+    def client_secret
+      ENV["SALESFORCE_CLIENT_SECRET"]
+    end
+
+    def username
+      ENV["SALESFORCE_USERNAME"]
+    end
+
+    def password
+      ENV["SALESFORCE_PASSWORD"]
+    end
+
+    def security_token
+      ENV["SALESFORCE_SECURITY_TOKEN"]
+    end
+
+    def version
+      ENV.fetch("SALESFORCE_API_VERSION", "61.0")
+    end
+
+    def authentication_url
+      URI.parse("https://#{host}/services/oauth2/token")
+    end
+
+    def authentication_params
+      {
+        grant_type: "password",
+        client_id: client_id,
+        client_secret: client_secret,
+        username: username,
+        password: "#{password}#{security_token}"
+      }
+    end
+  end
+
+  def set_authentication_credentials!
+    response = Net::HTTP.post_form(Streamforce::Client.authentication_url, Streamforce::Client.authentication_params)
+    credentials = JSON.parse(response.body)
+
+    @access_token = credentials["access_token"]
+    @instance_url = "#{credentials["instance_url"]}/cometd/#{Streamforce::Client.version}"
+  end
+
+  def subscribe(channels = [], &blk)
+    channels = Array(channels)
+
+    set_authentication_credentials!
+
+    EM.run { subscribe_to_channels(faye, channels, &blk) }
+  end
+
+  def faye
+    @faye ||= Faye::Client.new(@instance_url).tap do |client|
+      client.set_header "Authorization", "OAuth #{@access_token}"
+
+      client.add_extension Streamforce::Extension::Replay.new
+      client.add_extension Streamforce::Extension::SubscriptionTracking.new
+      client.add_extension Streamforce::Extension::Logging.new
+    end
+  end
+
+  def subscribe_to_channels(client, channels, &blk)
+    return if channels.empty?
+
+    client
+      .subscribe(channels.shift, &blk)
+      .callback { subscribe_to_channels(client, channels, &blk)}
+  end
+end

data/lib/streamforce/extension/logging.rb

@@ -0,0 +1,18 @@
+class Streamforce::Extension::Logging
+  def initialize(log_level = Logger::DEBUG)
+    @logger = Logger.new($stdout)
+    @logger.level = log_level
+  end
+
+  def incoming(message, callback)
+    @logger.debug "Receving message: #{message.inspect}"
+
+    callback.call(message)
+  end
+
+  def outgoing(message, callback)
+    @logger.debug "Sending message: #{message.inspect}"
+
+    callback.call(message)
+  end
+end

data/lib/streamforce/extension/replay.rb

@@ -0,0 +1,14 @@
+class Streamforce::Extension::Replay
+  def initialize(log_level = Logger::INFO)
+    @logger = Logger.new($stdout)
+    @logger.level = log_level
+  end
+
+  def incoming(message, callback)
+    callback.call(message)
+  end
+
+  def outgoing(message, callback)
+    callback.call(message)
+  end
+end

data/lib/streamforce/extension/subscription_tracking.rb

@@ -0,0 +1,58 @@
+class Streamforce::Extension::SubscriptionTracking
+  def initialize(log_level = Logger::DEBUG)
+    @logger = Logger.new($stdout)
+    @logger.level = log_level
+
+    @subscriptions = []
+  end
+
+  def incoming(message, callback)
+    if subscription?(message)
+      log_subscription_status(message)
+    else
+      log_subscription_payload(message)
+    end
+
+    callback.call(message)
+  end
+
+  def outgoing(message, callback)
+    @logger.debug "Requested subscription for #{message["subscription"]}" if subscription?(message)
+
+    callback.call(message)
+  end
+
+  def log_subscription_status(message)
+    subscription = message["subscription"]
+
+    if message["successful"]
+      @subscriptions << subscription
+
+      @logger.info "Subscription for #{subscription} was successful"
+    else
+      @logger.warn "Subscription for #{subscription} failed: #{message["error"]}"
+    end
+  end
+
+  def log_subscription_payload(message)
+    channel = message["channel"]
+    payload = message["data"].to_json
+
+    type = case channel.split("/")[1]
+           when "topic"
+             "PushTopic"
+           when "event"
+             "PlatformEvent"
+           else
+             "Unknown"
+           end
+
+    name = channel.split("/")[2]
+
+    @logger.info "[#{type}][#{name}]: #{payload}" if @subscriptions.include?(channel)
+  end
+
+  def subscription?(message)
+    message["channel"] == "/meta/subscribe"
+  end
+end

data/lib/streamforce/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Streamforce
+  VERSION = "0.0.1"
+end

data/lib/streamforce.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "streamforce/version"
+
+require "uri"
+require "net/http"
+require "logger"
+require "json"
+require "base64"
+
+require "faye"
+require "relaxed_cookiejar"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Streamforce
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: streamforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Maxim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: relaxed_cookiejar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andrei@andreimaxim.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/streamforce.rb
+- lib/streamforce/client.rb
+- lib/streamforce/extension/logging.rb
+- lib/streamforce/extension/replay.rb
+- lib/streamforce/extension/subscription_tracking.rb
+- lib/streamforce/version.rb
+homepage: https://github.com/andreimaxim/streamforce
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreimaxim/streamforce
+  source_code_uri: https://github.com/andreimaxim/streamforce
+  changelog_uri: https://github.com/andreimaxim/streamforce/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: Small wrapper over the Salesforce Streaming API
+test_files: []