streamforce 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d03ff265d884babb70b8db70637c9814a5819834ed83109b2b26537cb5c992b
-  data.tar.gz: b7b87b62347f92e9a27139536655ee95339e8a3b22bf2c1980db1eca00fa66e9
+  metadata.gz: 39b60e818f6a705ee63949e7ff6a48858565917a737691cb6a94c109e37f7342
+  data.tar.gz: ca563677771ec54e9fbef2a3ddf4de157d59d3e879ad9f7ad8841269da02bed3
 SHA512:
-  metadata.gz: c4dc737d70d28c061ee3c89379b97274983c14008184acbe7c99139b59c3ed79b3ef79893ba3d486d3f142172d30461260237d171bdb7a230c6f92471769a605
-  data.tar.gz: 6a3bbd281947060861c34e5cceab6814cfad52a80e964c80ef4da4956a3c40287e1315ef05419c69b31e60ac2bd20b394336e85a087c8fd41e22691543f6f7d7
+  metadata.gz: 1491f1d6772bf34b393879dfdec8b18b6310e28fcfcafe6f8136994b9c7667c09e07221a8dd52f032e9d746771802f80b87356534b65f33b2ba1a33290520f9a
+  data.tar.gz: fde46e8c412e01be566741d5474216ea55ea3e77f83cf29f19a3cd417017d646c64f9140cf153bd727a88997e9698fc7f54decf906cf0581b586e6c21c77e226

data/README.md

@@ -1,45 +1,22 @@
 # Streamforce
 
-In most cases, processing events received from the Salesforce Streaming API can be
+In most cases, consuming events received from the Salesforce Streaming API can be
 broken down into three very specific steps:
 
-1. Connecting to the Salesforce API and listening for messaging
+1. Connecting to the Salesforce API and listening for messages
 2. Ingesting received messages into some sort of internal event bus (e.g. RabbitMQ,
    Kafka, Redis, etc)
 3. Processing the stored messages
 
-Streamforce aims to handle #1 and simplify the work done for #2.
-
-[Restforce](https://github.com/restforce/restforce) provides a simple API to connect
-to the Streaming API and consume messages:
-
-```ruby
-# Restforce uses faye as the underlying implementation for CometD.
-require 'faye'
-
-# Initialize a client with your username/password/oauth token/etc.
-client = Restforce.new(username: 'foo',
-                       password: 'bar',
-                       security_token: 'security token',
-                       client_id: 'client_id',
-                       client_secret: 'client_secret')
-
-EM.run do
-  # Subscribe to the PushTopic.
-  client.subscription '/topic/AllAccounts' do |message|
-    puts message.inspect
-  end
-end
-```
-
-However, the above code is usable in a production environment because:
+Streamforce aims to be an abstraction for the first step, by implementing some of the
+common tasks that need to be performed by any well-behaved client:
 
 * The interactions with the Streaming API need to be logged using the correct severity
   (e.g. handshakes should use `Logger::DEBUG` while subscription errors should use
   `Logger::ERROR` for better visibility)
 * Replay IDs need to be stored using a persistent storage like Redis and not in-memory
 
-Streamforce comes with all the batteries included.
+As an alternative, checkout [Restforce](https://github.com/restforce/restforce).
 
 ## Usage
 

data/lib/streamforce/extension/logging.rb

@@ -5,36 +5,36 @@ class Streamforce::Extension::Logging
 
   def incoming(payload, callback)
     message = Streamforce::Message.new(payload)
-    log_incoming_message(message)
+
+    case message.channel
+    when "/meta/handshake"
+      log_incoming_handshake(message)
+    when "/meta/connect"
+      log_incoming_connect(message)
+    when "/meta/subscribe"
+      log_incoming_subscribe(message)
+    else
+      @logger.debug "[#{message.channel}] #{message.data}"
+    end
 
     callback.call(payload)
   end
 
   def outgoing(payload, callback)
     message = Streamforce::Message.new(payload)
-    log_outgoing_message(message)
-
-    callback.call(payload)
-  end
-
-  def log_incoming_message(message)
-    if message.channel_type == "meta"
-      public_send("log_incoming_#{message.channel_name}", message)
-    else
-      @logger.debug "[#{message.channel_name}] #{message.data}"
-    end
-  end
 
-  def log_outgoing_message(message)
-    if message.channel_type == "meta"
-      public_send("log_outgoing_#{message.channel_name}", message)
+    case message.channel
+    when "/meta/handshake"
+      @logger.debug "[Client] Handshake requested..."
+    when "/meta/connect"
+      debug message, "Sending connection request"
+    when "/meta/subscribe"
+      log_outgoing_subscribe(message)
     else
-      @logger.debug "[#{message.channel_name}] #{message.data}"
+      @logger.debug "[#{message.channel}] #{message.data}"
     end
-  end
 
-  def log_outgoing_handshake(message)
-    @logger.debug "[Client] Handshake requested..."
+    callback.call(payload)
   end
 
   def log_incoming_handshake(message)
@@ -45,10 +45,6 @@ class Streamforce::Extension::Logging
     end
   end
 
-  def log_outgoing_connect(message)
-    debug message, "Sending connection request"
-  end
-
   def log_incoming_connect(message)
     if message.success?
       debug message, "Connection successful!"
@@ -60,9 +56,9 @@ class Streamforce::Extension::Logging
   def log_outgoing_subscribe(message)
     replay_id = message.replay_id
 
-    replay_info = if replay_id == -1
+    replay_info = if message.no_replay?
       "for all new messages"
-    elsif replay_id == -2
+    elsif message.replay_available_messages?
       "and requesting all stored messages"
     else
       "and requesting all messages newer than ##{replay_id}"

data/lib/streamforce/message.rb

@@ -3,8 +3,8 @@ class Streamforce::Message
     @payload = payload
   end
 
-  def success?
-    @payload["successful"]
+  def client_id
+    @payload["clientId"]
   end
 
   def id
@@ -19,10 +19,6 @@ class Streamforce::Message
     @payload["channel"]
   end
 
-  def client_id
-    @payload["clientId"]
-  end
-
   def channel_type
     channel.split("/")[1]
   end
@@ -31,6 +27,10 @@ class Streamforce::Message
     channel.split("/")[2]
   end
 
+  def success?
+    @payload["successful"]
+  end
+
   def data
     @payload["data"]
   end
@@ -43,6 +43,18 @@ class Streamforce::Message
     channel == "/meta/subscribe"
   end
 
+  def replay_from_message?
+    replay_id && replay_id != -1 && replay_id != -2
+  end
+
+  def replay_available_messages?
+    replay_id == -2
+  end
+
+  def no_replay?
+    replay_id.nil? || replay_id == -1
+  end
+
   def error_message
     @payload["error"]
   end

data/lib/streamforce/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamforce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrei Maxim
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - andrei@andreimaxim.ro
 executables: []
@@ -133,7 +133,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.9
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Small wrapper over the Salesforce Streaming API
 test_files: []