schwab_rb 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51cb666266069aab4bab9aec3d7b8d283c122cde01e99dae36976aec36eef51a
-  data.tar.gz: 44d23aad83b0096b1856b882604e298cadb15cc47f2cde51cd37c91bf32a8880
+  metadata.gz: 8d136dcb5cef454ed8cfaca6a8ad90a8ebf25971e283e4098f73dc765d06023c
+  data.tar.gz: 93bfb2468fcc4706b361bd987087256eed9fe84e6ef3486743659acd51e0de61
 SHA512:
-  metadata.gz: d870b1e3f5dc36ae3f463b65d94c3a378ad59f9f4745c06b0cae5040a8e04ec126a384725846bec522dc94bb5bc22f1cba75e9e5a53e58d11f63e6216dd9633a
-  data.tar.gz: 15df306b19a864cfdf158e8e4ae73c8831470375032b253a835b58bfaac5594afa3ae7ad52912f3448a665a16b7ac1b8132b03b5b8a040ca1580ca5510374c61
+  metadata.gz: 3d684f28d255009c90b0fb0abd401f6c452532bdcdbb1ccbc42d6a33c893aef8f6821af278ffbd9f81792e53db7f511ce561c7d29ac80a5f1d682aded578f886
+  data.tar.gz: 2772b8c48ab306c3d821639bc68ac950bdd7b8b56995f13a55a495b4d60fa5b0f87e2114d471622e6ce2069a8d93a3d8837865f346f7545148cf5b129cb1a1d4

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 ## [Unreleased]
 
+## [1.0.5] - 2026-10-19
+
+### Added
+- Sanitized stream subscription logging (`SUBS`, `ADD`, `UNSUBS`) at INFO level with service, command, request ID, and keys.
+- Stream subscription acknowledgement response logging at INFO level with service, command, response code, message, and request ID.
+
+### Security
+- Redacted `Authorization` access tokens in WebSocket outbound debug logging.
+
+## [1.0.4] - 2026-09-21
+
+### Added
+- Dynamic symbol unsubscription (`stream.unsub`) using Schwab `UNSUBS` command to remove symbols as market windows close without disconnecting.
+- `stream.add` method (alias for `on`) for explicitly adding subscriptions to active streams.
+
+### Fixed
+- Treat `nil` socket read in `Base#run_receive_loop` as disconnect error instead of clean exit to prevent silent reconnect spin loops.
+- Outbound WebSocket write synchronization using a Mutex to prevent framing issues when subscriptions change dynamically.
+
+## [1.0.3] - 2026-09-19
+
+### Fixed
+- Prevent `load_token` from deleting database row on expired access token (#33).
+
+## [1.0.2] - 2026-09-18
+
+### Fixed
+- Fix WebSocket framing to resolve stream login bad command formatting (#32).
+
+## [1.0.1] - 2026-09-17
+
+### Fixed
+- Fix stream login authorization header formatting and STDOUT logger routing (#30).
+
 ## [1.0.0] - 2026-09-05
 
 ### Breaking Changes

data/README.md

@@ -164,6 +164,47 @@ price_history = client.get_price_history(
 )
 ```
 
+### Real-Time WebSocket Streaming
+
+Stream Level 1 quotes, Level 2 order books, chart candles, and account activity over a single WebSocket connection:
+
+```ruby
+client = SchwabRb::Auth.init_client_easy(
+  ENV['SCHWAB_API_KEY'],
+  ENV['SCHWAB_APP_SECRET'],
+  ENV['APP_CALLBACK_URL']
+)
+
+stream = SchwabRb::Stream::Client.new(client)
+
+# Subscribe to Level 1 Equities
+stream.on(:level_one_equities, symbols: %w[SPY QQQ], fields: :all) do |event|
+  puts "Equity quote: #{event}"
+end
+
+# Subscribe to Level 1 Futures
+stream.on(:level_one_futures, symbols: ["/ES"], fields: :all) do |event|
+  puts "Futures quote: #{event}"
+end
+
+# Subscribe to Level 2 Order Book
+stream.on(:nyse_book, symbols: ["SPY"], fields: :all) do |event|
+  puts "Order book: #{event}"
+end
+
+# Start async in a background thread
+stream.start_async
+
+# Dynamically add symbols while streaming
+stream.add(:level_one_equities, symbols: ["IWM"])
+
+# Dynamically remove symbols when window closes without dropping stream
+stream.unsub(:level_one_equities, symbols: ["SPY", "QQQ"])
+
+# Stop streaming when finished
+stream.stop
+```
+
 ## Data Objects
 
 The gem includes structured data objects for better handling of API responses. Most API methods support a `return_data_objects` parameter (defaults to `true`) which returns parsed Ruby objects instead of raw JSON responses:

data/lib/schwab_rb/stream/base.rb

@@ -27,13 +27,14 @@ module SchwabRb
         @connect_time = nil
         @backoff_time = INITIAL_BACKOFF
         @should_run = false
+        @write_mutex = Mutex.new
       end
 
       def on(service_symbol, symbols: nil, fields: nil, &block)
         service_name = Services.lookup(service_symbol)
         resolved_fields = fields ? Fields.resolve(service_name, fields) : nil
 
-        handler = { symbols: Array(symbols), fields: resolved_fields, callback: block }
+        handler = { symbols: Array(symbols).map(&:to_s), fields: resolved_fields, callback: block }
         @handlers[service_name] ||= []
         @handlers[service_name] << handler
 
@@ -46,6 +47,37 @@ module SchwabRb
 
         self
       end
+      alias add on
+
+      def unsub(service_symbol, symbols: nil)
+        service_name = Services.lookup(service_symbol)
+        symbols_to_remove = Array(symbols).map(&:to_s)
+        return self if symbols_to_remove.empty?
+
+        if @subscriptions[service_name]
+          @subscriptions[service_name][:symbols] -= symbols_to_remove
+          @subscriptions.delete(service_name) if @subscriptions[service_name][:symbols].empty?
+        end
+
+        if @handlers[service_name]
+          @handlers[service_name].each do |h|
+            h[:symbols] -= symbols_to_remove
+          end
+          @handlers[service_name].reject! { |h| h[:symbols].empty? }
+          @handlers.delete(service_name) if @handlers[service_name].empty?
+        end
+
+        if @connected
+          request = @message_builder.build_request(
+            service_name, Commands::UNSUBS,
+            keys: symbols_to_remove
+          )
+          log_subscription_request(request)
+          send_message(@message_builder.wrap_requests(request))
+        end
+
+        self
+      end
 
       def start
         @should_run = true
@@ -64,7 +96,7 @@ module SchwabRb
 
       def stop
         @should_run = false
-        disconnect
+        @connected = false
       end
 
       def connected?
@@ -145,6 +177,7 @@ module SchwabRb
             keys: sub[:symbols],
             fields: sub[:fields]
           )
+          log_subscription_request(request)
           send_message(@message_builder.wrap_requests(request))
         end
       end
@@ -155,13 +188,14 @@ module SchwabRb
           keys: handler[:symbols],
           fields: handler[:fields]
         )
+        log_subscription_request(request)
         send_message(@message_builder.wrap_requests(request))
       end
 
       def run_receive_loop
         while @connected && @should_run
           message = @connection.read
-          break if message.nil?
+          raise "Connection closed by remote host" if message.nil?
 
           parsed = JSON.parse(message.to_str)
           dispatch_message(parsed)
@@ -182,10 +216,36 @@ module SchwabRb
         return unless parsed.key?("response")
 
         parsed["response"].each do |resp|
-          SchwabRb::Logger.logger.debug("Stream response: #{resp}")
+          log_stream_response(resp)
         end
       end
 
+      def log_subscription_request(request)
+        service = request["service"]
+        command = request["command"]
+        request_id = request["requestid"]
+        keys = request.dig("parameters", "keys")
+        SchwabRb::Logger.logger.info(
+          "Stream subscription request: service=#{service} command=#{command} " \
+          "request_id=#{request_id} keys=#{keys}"
+        )
+      end
+
+      def log_stream_response(resp)
+        service = resp["service"]
+        command = resp["command"]
+        request_id = resp["requestid"]
+        content = resp["content"] || {}
+        code = content["code"]
+        msg = content["msg"]
+
+        SchwabRb::Logger.logger.info(
+          "Stream response: service=#{service} command=#{command} " \
+          "code=#{code} msg=#{msg.inspect} request_id=#{request_id}"
+        )
+        SchwabRb::Logger.logger.debug("Raw stream response: #{resp}")
+      end
+
       def handle_disconnect(error)
         @connected = false
         begin
@@ -221,9 +281,16 @@ module SchwabRb
       end
 
       def send_message(json_string)
-        SchwabRb::Logger.logger.debug("Stream sending: #{json_string}")
-        @connection.write(json_string)
-        @connection.flush
+        @write_mutex.synchronize do
+          return unless @connection
+
+          if SchwabRb::Logger.logger.debug?
+            sanitized = json_string.gsub(/"Authorization"\s*:\s*"[^"]*"/, '"Authorization":"[REDACTED]"')
+            SchwabRb::Logger.logger.debug("Stream sending: #{sanitized}")
+          end
+          @connection.write(json_string)
+          @connection.flush
+        end
       end
 
       def merge_subscription(existing, handler)

data/lib/schwab_rb/stream/client.rb

@@ -15,6 +15,12 @@ module SchwabRb
         @stream.on(service_symbol, symbols: symbols, fields: fields, &block)
         self
       end
+      alias add on
+
+      def unsub(service_symbol, symbols: nil)
+        @stream.unsub(service_symbol, symbols: symbols)
+        self
+      end
 
       def start
         @thread = Thread.new do
@@ -32,6 +38,7 @@ module SchwabRb
 
       def stop
         @stream.stop
+        @thread&.raise(Interrupt)
         @thread&.join(5)
         @thread = nil
       end

data/lib/schwab_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchwabRb
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: schwab_rb
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Joseph Platta
 bindir: exe
 cert_chain: []
-date: 2026-09-07 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async