schwab_rb 0.9.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4383649ebc37badd05174f05c57c97fdaa912d597de0d1f4190fd7db7d696189
-  data.tar.gz: 79faa77068025157b3ab19c4e353ec5b8b032b7938fb189b98487947a9dc48be
+  metadata.gz: a575cc586047d31d897d0ec4ba6d35afa1c2c97938a8dbf3e82b292d3b5d74a2
+  data.tar.gz: 3c859570ce9831b5b30bc2798d9083d2110d7e9be09065b33a312292334d7963
 SHA512:
-  metadata.gz: ab99f855f6a026fc9dc79356f2561ee2a774593f60881022668b23f52caa326adb0d38783ba2d278096e4ba04a815d045be8ba3e41e3f1948ad0d1bfb06e1638
-  data.tar.gz: 5d3d3592a48c94432f695add430c9949fc1da44913ff96398571125d0b57a2d4680d85d549896e5230cdbb88f95f155896a178acdcd391f2e892032c375bb5f3
+  metadata.gz: 3c2a2709207b61685083ff764585ccafe8a722ae798faf4c469fe75617585d65ae89847aa63d4b17bd9315a504a234d212b63226c40acfb2324f4e28199e7fc6
+  data.tar.gz: 85799a5ec440620b5c3756b2d86ac007e10d5c5c08be8fd08dc793232c0fb2ad1f918787a8fede962a797cecd7f4bef3cc222a121c285faed8ac06e364551355

data/.claude/settings.local.json

@@ -1,7 +1,24 @@
 {
   "permissions": {
     "allow": [
-      "Bash(gh pr edit:*)"
+      "Bash(gh pr edit:*)",
+      "WebSearch",
+      "WebFetch(domain:github.com)",
+      "Bash(bundle exec:*)",
+      "Bash(bundle install:*)",
+      "Bash(git checkout:*)",
+      "Bash(git add:*)",
+      "Bash(git rm:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(gh pr:*)",
+      "Bash(git reset:*)",
+      "Bash(find:*)",
+      "Bash(git pull:*)",
+      "Bash(git fetch:*)",
+      "Bash(git merge:*)",
+      "Bash(git stash:*)",
+      "Bash(git cherry-pick:*)"
     ],
     "deny": [],
     "ask": []

data/CHANGELOG.md

@@ -1,16 +1,32 @@
 ## [Unreleased]
 
+## [1.0.0] - 2026-09-05
+
+### Breaking Changes
+- **Token storage**: Tokens are now persisted in SQLite (`~/.schwab_rb/schwab.db`) instead of a JSON file. `init_client_easy` and `init_client_login` no longer accept a `token_path` argument. Use `init_client_from_database` instead of `init_client_token_file`.
+- **Account management**: `AccountHashManager`, `account_names.json`, and `account_hashes.json` are removed. Set `SCHWAB_ACCOUNT_NUMBER` in your environment instead. Account hashes are fetched from the API automatically and cached in SQLite.
+- **Client method signatures**: All account-specific methods (`get_account`, `place_order`, `get_order`, etc.) now use `account_hash:` as a keyword argument instead of a positional argument. The `account_name:` keyword argument is removed.
+
+### Added
+- **WebSocket streaming client**: Real-time market data streaming via `SchwabRb::Stream::Client`
+  - Event-based API: `stream.on(:nyse_book, symbols: ["AAPL"], fields: :all) { |event| ... }`
+  - Supported services: `NYSE_BOOK`, `NASDAQ_BOOK`, `OPTIONS_BOOK`, `LEVELONE_EQUITIES`, `LEVELONE_OPTIONS`, `LEVELONE_FUTURES`, `LEVELONE_FUTURES_OPTIONS`, `LEVELONE_FOREX`, `CHART_EQUITY`, `CHART_FUTURES`, `SCREENER_EQUITY`, `SCREENER_OPTION`, `ACCT_ACTIVITY`
+  - Ruby constant field definitions for all services (e.g. `Fields::Book::BIDS`, `Fields::LevelOneEquity::BID_PRICE`)
+  - Exponential backoff reconnection (2s initial, doubles, 120s cap)
+  - Sync (`Stream::Client`) and async (`Stream::AsyncClient`) wrappers
+- **SQLite storage** (`SchwabRb::Storage::Database`): Single database at `~/.schwab_rb/schwab.db` (configurable via `SCHWAB_DATABASE_PATH`) storing tokens and account hashes
+- **`SCHWAB_ACCOUNT_NUMBER` env var**: Configure your account number once; the gem auto-fetches and caches the account hash on first use
+- **`init_client_from_database`**: New initializer that loads tokens from SQLite (replaces `init_client_token_file`)
+
 ### Fixed
 - CLI `login` no longer reads from `ARGF` at the browser prompt, which prevented `schwab_rb login` from opening the browser when command arguments were present
 - `OptionExpirationChain` now accepts both string-keyed and symbol-keyed hashes, matching `BaseClient#get_option_expiration_chain`
 
-### Added
-- CLI `sample` command for saving single-expiration option chain snapshots as CSV or JSON
-- `--root` option for filtering sampled contracts by option root and using that root in output filenames
-
 ### Changed
 - CLI history downloads now default to `~/.schwab_rb/data/history`
 - CLI option samples now default to `~/.schwab_rb/data/options`
+- CLI `login` success message updated to reflect database storage
+- `PathSupport.expand_path` error message generalized from `"token_path is nil or empty"` to `"path is nil or empty"`
 
 ## [0.6.0] - 2025-12-11
 

data/examples/place_oco_order.rb

@@ -19,9 +19,6 @@ Dotenv.load
 # config.log_level = "DEBUG"
 # end
 
-CURRENT_ACCT = "TRADING_BROKERAGE_ACCOUNT"
-acct_manager = SchwabRb::AccountHashManager.new
-
 client = SchwabRb::Auth.init_client_easy(
   ENV['SCHWAB_API_KEY'],
   ENV['SCHWAB_APP_SECRET'],
@@ -72,6 +69,6 @@ built_order = oco_order.build
 
 binding.pry
 
-# response = client.place_order(built_order, account_name: CURRENT_ACCT)
+# response = client.place_order(built_order)
 
 binding.pry

data/examples/stream_level_one.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Stream Level 1 equity quotes
+#
+# Usage: ruby examples/stream_level_one.rb
+#
+# Requires SCHWAB_API_KEY, SCHWAB_APP_SECRET, and APP_CALLBACK_URL env vars.
+# Token must already exist in the database (run login first).
+
+require "schwab_rb"
+require "dotenv/load"
+
+Fields = SchwabRb::Stream::Fields
+
+client = SchwabRb::Auth.init_client_easy(
+  ENV.fetch("SCHWAB_API_KEY"),
+  ENV.fetch("SCHWAB_APP_SECRET"),
+  ENV.fetch("SCHWAB_APP_CALLBACK_URL")
+)
+
+stream = SchwabRb::Stream::Client.new(client)
+
+stream.on(:level_one_equities,
+  symbols: ["AAPL", "MSFT", "GOOGL", "AMZN"],
+  fields: [
+    Fields::LevelOneEquity::SYMBOL,
+    Fields::LevelOneEquity::BID_PRICE,
+    Fields::LevelOneEquity::ASK_PRICE,
+    Fields::LevelOneEquity::LAST_PRICE,
+    Fields::LevelOneEquity::TOTAL_VOLUME,
+    Fields::LevelOneEquity::NET_CHANGE,
+    Fields::LevelOneEquity::NET_CHANGE_PERCENT
+  ]
+) do |event|
+  event["content"]&.each do |entry|
+    symbol = entry["key"]
+    bid = entry["1"]
+    ask = entry["2"]
+    last = entry["3"]
+    volume = entry["8"]
+    change = entry["18"]
+    change_pct = entry["42"]
+
+    parts = ["#{symbol}:"]
+    parts << "Last=#{last}" if last
+    parts << "Bid=#{bid}" if bid
+    parts << "Ask=#{ask}" if ask
+    parts << "Vol=#{volume}" if volume
+    parts << "Chg=#{change}" if change
+    parts << "Chg%=#{change_pct}" if change_pct
+
+    puts parts.join(" ")
+  end
+end
+
+puts "Starting Level 1 equity stream... Press Ctrl+C to stop."
+
+trap("INT") do
+  puts "\nStopping stream..."
+  stream.stop
+  exit
+end
+
+stream.start

data/examples/stream_order_book.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Stream order book (Level 2) data for NYSE, NASDAQ, and Options
+#
+# Usage: ruby examples/stream_order_book.rb
+#
+# Requires SCHWAB_API_KEY, SCHWAB_APP_SECRET, and APP_CALLBACK_URL env vars.
+# Token must already exist in the database (run login first).
+
+require "schwab_rb"
+require "dotenv/load"
+
+Fields = SchwabRb::Stream::Fields
+
+client = SchwabRb::Auth.init_client_easy(
+  ENV.fetch("SCHWAB_API_KEY"),
+  ENV.fetch("SCHWAB_APP_SECRET"),
+  ENV.fetch("SCHWAB_APP_CALLBACK_URL")
+)
+
+stream = SchwabRb::Stream::Client.new(client)
+
+stream.on(:nyse_book, symbols: ["AAPL", "MSFT"], fields: Fields::Book::ALL) do |event|
+  puts "=== NYSE BOOK ==="
+  event["content"]&.each do |entry|
+    puts "  Symbol: #{entry["key"]}"
+    puts "  Bids: #{entry["2"]&.length || 0} levels"
+    puts "  Asks: #{entry["3"]&.length || 0} levels"
+  end
+end
+
+stream.on(:nasdaq_book, symbols: ["AMD", "NVDA"], fields: Fields::Book::ALL) do |event|
+  puts "=== NASDAQ BOOK ==="
+  event["content"]&.each do |entry|
+    puts "  Symbol: #{entry["key"]}"
+    puts "  Bids: #{entry["2"]&.length || 0} levels"
+    puts "  Asks: #{entry["3"]&.length || 0} levels"
+  end
+end
+
+stream.on(:options_book, symbols: ["AAPL  261218C00200000"], fields: Fields::Book::ALL) do |event|
+  puts "=== OPTIONS BOOK ==="
+  event["content"]&.each do |entry|
+    puts "  Symbol: #{entry["key"]}"
+  end
+end
+
+puts "Starting order book stream... Press Ctrl+C to stop."
+
+trap("INT") do
+  puts "\nStopping stream..."
+  stream.stop
+  exit
+end
+
+stream.start

data/lib/schwab_rb/auth/init_client_easy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "oauth2"
-require_relative "init_client_token_file"
+require_relative "init_client_from_database"
 require_relative "init_client_login"
 require_relative "../path_support"
 
@@ -11,38 +11,39 @@ module SchwabRb
       api_key,
       app_secret,
       callback_url,
-      token_path,
       asyncio: false,
       enforce_enums: false,
       callback_timeout: 300.0,
       interactive: true,
-      requested_browser: nil
+      requested_browser: nil,
+      database: nil
     )
-      token_path = SchwabRb::PathSupport.expand_path(token_path)
+      client = begin
+        SchwabRb::Auth.init_client_from_database(
+          api_key,
+          app_secret,
+          enforce_enums: enforce_enums,
+          database: database
+        )
+      rescue StandardError
+        nil
+      end
 
-      raise OAuth2::Error, "No token found" unless File.exist?(token_path)
+      if client
+        client.refresh! if client.session.expired?
+        return client unless client.session.expired?
+      end
 
-      client = SchwabRb::Auth.init_client_token_file(
-        api_key,
-        app_secret,
-        token_path,
-        enforce_enums: enforce_enums
-      )
-      client.refresh! if client.session.expired?
-      raise OAuth2::Error, "Token expired" if client.session.expired?
-
-      client
-    rescue StandardError
       SchwabRb::Auth.init_client_login(
         api_key,
         app_secret,
         callback_url,
-        token_path,
         asyncio: asyncio,
         enforce_enums: enforce_enums,
         callback_timeout: callback_timeout,
         interactive: interactive,
-        requested_browser: requested_browser
+        requested_browser: requested_browser,
+        database: database
       )
     end
   end

data/lib/schwab_rb/auth/{init_client_token_file.rb → init_client_from_database.rb}

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "oauth2"
-require_relative "../path_support"
 
 module SchwabRb
   module Auth
-    def self.init_client_token_file(api_key, app_secret, token_path, enforce_enums: true)
-      token_path = SchwabRb::PathSupport.expand_path(token_path)
+    def self.init_client_from_database(api_key, app_secret, enforce_enums: true, database: nil)
+      metadata_manager = SchwabRb::Auth::TokenManager.from_database(api_key, database: database)
+      return nil unless metadata_manager
+
+      token = metadata_manager.token
 
       oauth = OAuth2::Client.new(
         api_key,
@@ -15,9 +17,6 @@ module SchwabRb
         token_url: "/v1/oauth/token"
       )
 
-      metadata_manager = SchwabRb::Auth::TokenManager.from_file(token_path)
-      token = metadata_manager.token
-
       session = OAuth2::AccessToken.new(
         oauth,
         token.token,

data/lib/schwab_rb/auth/init_client_login.rb

@@ -65,16 +65,14 @@ module SchwabRb
       api_key,
       app_secret,
       callback_url,
-      token_path,
       asyncio: false,
       enforce_enums: false,
       callback_timeout: 300.0,
       interactive: true,
       input: $stdin,
-      requested_browser: nil
+      requested_browser: nil,
+      database: nil
     )
-      token_path = SchwabRb::PathSupport.expand_path(token_path)
-
       callback_timeout = if !callback_timeout
                            0
       elsif callback_timeout.negative?
@@ -154,7 +152,7 @@ module SchwabRb
           app_secret,
           auth_context,
           received_url,
-          token_path
+          database: database
         )
       ensure
         LoginFlowServer.stop
@@ -213,7 +211,7 @@ module SchwabRb
     end
 
     def self.client_from_received_url(
-      api_key, app_secret, auth_context, received_url, token_path, enforce_enums: true
+      api_key, app_secret, auth_context, received_url, enforce_enums: true, database: nil
     )
       oauth = OAuth2::Client.new(
         api_key,
@@ -230,9 +228,10 @@ module SchwabRb
       metadata_manager = SchwabRb::Auth::TokenManager.from_oauth2_token(
         token,
         Time.now.to_i,
-        token_path: token_path
+        api_key: api_key,
+        database: database
       )
-      metadata_manager.to_file
+      metadata_manager.save
 
       session = OAuth2::AccessToken.new(
         oauth,

data/lib/schwab_rb/auth/token_manager.rb

@@ -9,9 +9,11 @@ module SchwabRb
   module Auth
     class TokenManager
       class << self
-        def from_file(token_path)
-          token_path = SchwabRb::PathSupport.expand_path(token_path)
-          token_data = JSON.parse(File.read(token_path))
+        def from_database(api_key, database: nil)
+          database ||= default_database
+          token_data = database.load_token(api_key)
+          return nil unless token_data
+
           token = SchwabRb::Auth::Token.new(
             token: token_data["token"]["access_token"],
             expires_in: token_data["token"]["expires_in"],
@@ -22,10 +24,10 @@ module SchwabRb
             expires_at: token_data["token"]["expires_at"]
           )
 
-          TokenManager.new(token, token_data["timestamp"], token_path: token_path)
+          TokenManager.new(token, token_data["timestamp"], api_key: api_key, database: database)
         end
 
-        def from_oauth2_token(oauth2_token, timestamp, token_path: SchwabRb::Constants::DEFAULT_TOKEN_PATH)
+        def from_oauth2_token(oauth2_token, timestamp, api_key:, database: nil)
           token = SchwabRb::Auth::Token.new(
             token: oauth2_token.token,
             expires_in: oauth2_token.expires_in,
@@ -36,17 +38,24 @@ module SchwabRb
             expires_at: oauth2_token.expires_at
           )
 
-          TokenManager.new(token, timestamp, token_path: token_path)
+          TokenManager.new(token, timestamp, api_key: api_key, database: database)
+        end
+
+        private
+
+        def default_database
+          SchwabRb::Storage::Database.new
         end
       end
 
-      def initialize(token, timestamp, token_path: SchwabRb::Constants::DEFAULT_TOKEN_PATH)
+      def initialize(token, timestamp, api_key: nil, database: nil)
         @token = token
         @timestamp = timestamp
-        @token_path = SchwabRb::PathSupport.expand_path(token_path)
+        @api_key = api_key
+        @database = database
       end
 
-      attr_reader :token, :timestamp, :token_path
+      attr_reader :token, :timestamp, :api_key, :database
 
       def refresh_token(client)
         new_token = client.session.refresh!
@@ -62,7 +71,7 @@ module SchwabRb
         )
         @timestamp = Time.now.to_i
 
-        to_file
+        save
 
         oauth = OAuth2::Client.new(
           client.api_key,
@@ -79,9 +88,8 @@ module SchwabRb
         )
       end
 
-      def to_file
-        SchwabRb::PathSupport.ensure_parent_directory(token_path)
-        File.write(token_path, to_json)
+      def save
+        effective_database.save_token(api_key, to_h)
       end
 
       def token_age
@@ -103,8 +111,10 @@ module SchwabRb
         }
       end
 
-      def to_json(*_args)
-        to_h.to_json
+      private
+
+      def effective_database
+        @database || self.class.send(:default_database)
       end
     end
   end

data/lib/schwab_rb/cli/app.rb

@@ -83,21 +83,15 @@ module SchwabRb
         raise Error, "Unexpected arguments: #{argv.join(' ')}" if argv.any?
 
         credentials = load_credentials(require_callback_url: true)
-        token_path = resolved_token_path
 
         SchwabRb::Auth.init_client_login(
           credentials.fetch(:api_key),
           credentials.fetch(:app_secret),
-          credentials.fetch(:callback_url),
-          token_path
+          credentials.fetch(:callback_url)
         )
 
-        stdout.puts("Authentication succeeded. Token saved to #{token_path}")
+        stdout.puts("Authentication succeeded. Token saved to database.")
         0
-      rescue JSON::ParserError
-        raise Error,
-              "The token file at #{resolved_token_path} is not valid JSON. " \
-              "Delete it or run `schwab_rb login` to recreate it."
       rescue OAuth2::Error, SchwabRb::Auth::RedirectTimeoutError, SchwabRb::Auth::RedirectServerExitedError => e
         raise Error, "Authentication failed: #{e.message}"
       end
@@ -230,24 +224,23 @@ module SchwabRb
 
       def build_non_interactive_client
         credentials = load_credentials(require_callback_url: false)
-        token_path = resolved_token_path
 
-        client = SchwabRb::Auth.init_client_token_file(
+        client = SchwabRb::Auth.init_client_from_database(
           credentials.fetch(:api_key),
-          credentials.fetch(:app_secret),
-          token_path
+          credentials.fetch(:app_secret)
         )
+
+        raise Error, "No valid API token found. Run `schwab_rb login` to authenticate." unless client
+
         client.refresh!
 
         return client unless client.session.expired?
 
-        raise Error, "No valid API token found at #{token_path}. Run `schwab_rb login` to authenticate."
+        raise Error, "Token expired. Run `schwab_rb login` to authenticate."
       rescue Errno::ENOENT
-        raise Error, "No valid API token found at #{token_path}. Run `schwab_rb login` to authenticate."
-      rescue JSON::ParserError
-        raise Error, "The token file at #{token_path} is not valid JSON. Run `schwab_rb login` to recreate it."
+        raise Error, "No valid API token found. Run `schwab_rb login` to authenticate."
       rescue OAuth2::Error => e
-        raise Error, "Unable to use the token at #{token_path}: #{e.message}. Run `schwab_rb login` to refresh it."
+        raise Error, "Unable to use stored token: #{e.message}. Run `schwab_rb login` to refresh it."
       end
 
       # rubocop:disable Metrics/AbcSize
@@ -280,11 +273,6 @@ module SchwabRb
         raise Error, "The `--expiration-date` option is required." unless options[:expiration_date]
       end
 
-      def resolved_token_path
-        token_path = env["SCHWAB_TOKEN_PATH"] || env["TOKEN_PATH"] || SchwabRb::Constants::DEFAULT_TOKEN_PATH
-        SchwabRb::PathSupport.expand_path(token_path)
-      end
-
       def default_history_dir
         SchwabRb::PathSupport.expand_path(DEFAULT_HISTORY_DIR)
       end
@@ -359,7 +347,7 @@ module SchwabRb
         <<~HELP
           Usage: schwab_rb login
 
-          Authenticates with Schwab in a browser and stores the token at #{resolved_token_path}.
+          Authenticates with Schwab in a browser and stores the token in the database.
           Required environment variables: SCHWAB_API_KEY, SCHWAB_APP_SECRET, SCHWAB_APP_CALLBACK_URL
         HELP
       end