feat: async WebSocket streaming client

[karlwaldman]

Summary

Adds a real-time async WebSocket streaming client to the Python SDK, exposing the OilPriceAPI ActionCable stream (/cable, EnergyPricesChannel) — a Professional+ feature no SDK previously surfaced. Available via client.stream on the async client.

Channel / protocol (confirmed from source)

Source of truth: oilpriceapi-api/app/channels/ + oilpriceapi-docs/docs/websocket/.

• Endpoint: wss://api.oilpriceapi.com/cable (mounted at /cable in config/routes.rb)
• Channel: EnergyPricesChannel
• Auth (application_cable/connection.rb#find_verified_user): API token via ?token= query param or Authorization: Token <key> header → resolves ApiKey.active.find_by_token; subscription further requires current_user.can_access_websocket? (Reservoir Mastery / Professional+), else reject.
• Subprotocol (ActionCable JSON): server sends {"type":"welcome"} → client sends {"command":"subscribe","identifier":"{\"channel\":\"EnergyPricesChannel\",\"api_key\":\"...\"}"} → server {"type":"confirm_subscription"} → broadcasts arrive as {"identifier":...,"message":{...}}; {"type":"ping"} keepalives ignored.
• Message shapes (from BroadcastEnergyPricesJob + channel send_initial_prices):
  • welcome — initial snapshot (same shape as price_update; may carry error)
  • price_update — prices.oil.{brent,wti} + prices.natural_gas.{uk,us,eu}, each a normalized price block
  • rig_count_update — rig_count.{code,region,count,source,updated_at}

Streaming API

async with client.stream.prices(commodities=["BRENT_CRUDE_USD"]) as stream:
    async for update in stream:
        if update.type == "price_update":
            print(update.price_update.prices.oil.brent.original_price)
        elif update.type == "rig_count_update":
            print(update.rig_count_update.rig_count.count)

• Async context manager + async iterator yielding typed StreamUpdate (Pydantic), with .price_update / .rig_count_update accessors and .raw passthrough.
• Auto-reconnect with exponential backoff + jitter (configurable auto_reconnect, max_reconnect_attempts, reconnect_base_delay/max_delay); clean server close (ConnectionClosedOK) ends iteration without reconnect.
• Clean teardown: unsubscribe + close on exit.
• New optional [stream] extra (websockets>=11); lazily imported so the base SDK is unaffected. Wired into all and dev.
• Exported from oilpriceapi.__init__: PriceStream, StreamUpdate, PriceUpdate, RigCountUpdate, StreamingNotInstalledError.

Test results (exact CI commands)

• ruff check oilpriceapi/ → All checks passed
• mypy oilpriceapi/ --ignore-missing-imports → Success: no issues found in 39 source files (new modules fully annotated, strict-clean)
• pytest tests/ --ignore=tests/integration --ignore=tests/contract -m 'not slow' --cov=oilpriceapi → 240 passed, 9 skipped, coverage 55.9% (≥ 50%)

13 new unit tests with a fully mocked websocket transport (no network): handshake/subscribe, rejected subscription, message dispatch, control-frame filtering, reconnect-on-drop, give-up after max attempts, auto-reconnect disabled, unsubscribe-on-close, namespace wiring, cable-URL derivation. New module coverage: streaming/client.py 92.6%, streaming/models.py 95.4%.

No version bump / tag.

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

@karlwaldman, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 56 minutes and 16 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 09763fe1-d8e3-48f9-af97-910b5bba4d2a

📥 Commits

Reviewing files that changed from the base of the PR and between fbcd18c and 598c6f8.

📒 Files selected for processing (8)

• README.md
• oilpriceapi/__init__.py
• oilpriceapi/async_client.py
• oilpriceapi/streaming/__init__.py
• oilpriceapi/streaming/client.py
• oilpriceapi/streaming/models.py
• pyproject.toml
• tests/unit/test_streaming.py

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/websocket-streaming

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}