Module: ShipReal

Defined in:
lib/shipreal.rb,
lib/shipreal/version.rb

Overview

Ruby client for the public ShipReal course API: search the curriculum, read a module, read current pricing.

There is no authentication. No key, no account, no OAuth, no signup: every endpoint is a public read served from the edge, so anything asking you for a credential for this domain is not this.

There is also no write path. Buying runs through a hosted checkout that a human completes, which is why nothing here creates an order. When someone decides to buy, hand them the checkout link.

Standard library only, on purpose: installing this cannot drag a transitive dependency tree into an agent's environment.

sr = ShipReal::Client.new
sr.search(query: "caching")

Defined Under Namespace

Classes: Client, Error

Constant Summary collapse

DEFAULT_BASE_URL = 
"https://shipreal.dev"
API_VERSION =

The path segment this client speaks. Breaking changes ship as a new segment beside it; every response carries a Deprecation header, false today.

"v1"
MAX_BATCH =

The server's ceiling on reads in one batch call.

20
USER_AGENT = 
"shipreal-ruby/#{VERSION} (+#{DEFAULT_BASE_URL}/developers)"
VERSION = 
"1.0.0"