api_adaptor
Advanced tools
A basic adaptor to send HTTP requests and parse the responses. Intended to bootstrap the quick writing of Adaptors for specific APIs, without having to write the same old JSON request and processing time and time again.
Install the gem and add to the application's Gemfile by executing:
bundle add api_adaptor
If bundler is not being used to manage dependencies, install the gem by executing:
gem install api_adaptor
Full API documentation is available at https://huwd.github.io/api_adaptor/
Generate documentation locally:
bundle exec yard # Generate docs to doc/
bundle exec yard server # Preview at http://localhost:8808
Publishing is handled by GitHub Actions when you push a version tag.
rubygems/release-gemapi_adaptor is configured on RubyGems.org with this repository/workflow as a trusted publisher.ApiAdaptor::VERSION in lib/api_adaptor/version.rb.vX.Y.Z (must match ApiAdaptor::VERSION) and push the tag:git tag v0.1.1
git push origin v0.1.1
Use the ApiAdaptor as a base class for your API wrapper, for example:
class MyApi < ApiAdaptor::Base; end
Use your new class to create a client that can make HTTP requests to JSON APIs for:
client = MyApi.new
client.get_json("http://some.endpoint/json")
client.post_json("http://some.endpoint/json", { "foo": "bar" })
client.put_json("http://some.endpoint/json", { "foo": "bar" })
client.patch_json("http://some.endpoint/json", { "foo": "bar" })
client.delete_json("http://some.endpoint/json", { "foo": "bar" })
You can also get a raw response from the API
client.get_raw("http://some.endpoint/json")
Some APIs return a 3xx response (commonly 307/308) with a Location header that points to the “real” URL.
ApiAdaptor::JsonClient follows these redirects in a controlled way so callers consistently receive a final JSON response.
GET/HEAD when the status is 301, 302, 303, 307, or 308.max_redirects defaults to 3.POST, PUT, PATCH, DELETE) do not follow redirects by default.You can configure redirect behaviour by passing options into your ApiAdaptor::Base subclass (they are forwarded to ApiAdaptor::JsonClient):
client = MyApi.new(
"https://example.com",
max_redirects: 3,
allow_cross_origin_redirects: true,
forward_auth_on_cross_origin_redirects: false,
follow_non_get_redirects: false
)
client.get_json("https://example.com/some/endpoint.json")
Or, if you are using ApiAdaptor::JsonClient directly:
client = ApiAdaptor::JsonClient.new(
bearer_token: "SOME_BEARER_TOKEN",
max_redirects: 3,
allow_cross_origin_redirects: true,
forward_auth_on_cross_origin_redirects: false
)
client.get_json("https://example.com/some/endpoint.json")
Following redirects across origins can accidentally leak credentials (for example Authorization bearer tokens) to an unexpected host.
To reduce risk:
Authorization is stripped and basic auth is not applied.allow_cross_origin_redirects: false.forward_auth_on_cross_origin_redirects: true if you fully trust the redirect target.Redirects for non-GET requests are risky because they may cause a request to be replayed (and potentially create duplicate side effects). For that reason, redirect-following is disabled for non-GET requests by default.
If you do want to follow 307/308 for non-GET requests, you can opt in:
client = MyApi.new(
"https://example.com",
follow_non_get_redirects: true
)
client.post_json("https://example.com/some/endpoint.json", { "a" => 1 })
You can rescue these redirect-specific exceptions:
ApiAdaptor::TooManyRedirects (exceeded max_redirects)ApiAdaptor::RedirectLocationMissing (a redirect response without a usable Location)Example:
begin
client.get_json("https://example.com/some/endpoint.json")
rescue ApiAdaptor::TooManyRedirects, ApiAdaptor::RedirectLocationMissing => e
# handle / log / retry / surface a friendly message
raise e
end
An example of how to use this repository to bootstrap an API can be found in the WikiData REST adaptor it was built for.
A REST API module can be created with:
module MyApiAdaptor
# Wikidata REST API class
class RestApi < ApiAdaptor::Base
def get_foo(foo_id)
get_json("#{endpoint}/foo/#{CGI.escape(foo_id)}")
end
end
end
and can be wrapped in a top level module:
module MyApiAdaptor
class Error < StandardError; end
def self.rest_endpoint
ENV["MYAPI_REST_ENDPOINT"] || "https://example.com"
end
def self.rest_api
MyApiAdaptor::RestApi.new(rest_endpoint)
end
end
The intended convention is to have test helpers ship alongside the actual Adaptor code. See WikiData examples here. This allows other applications that integrate the API Adaptor to easily mock out calls and receive representative data back.
User Agent is populated with a default string. See .env.example.
For instance if you provide:
APP_NAME=test_app
APP_VERSION=1.0.0
APP_CONTACT=contact@example.com
User agent would read
test_app/1.0.0 (contact@example.com)
After checking out the repo, run bundle install to install dependencies.
bundle exec rspec # Run tests only
bundle exec rubocop # Run linter only
bundle exec rake # Run tests, linter, and build docs
SimpleCov tracks test coverage. View the report at coverage/index.html after running tests.
Current coverage: 92.3% line, 81.65% branch
Generate YARD documentation:
bundle exec yard # Generate docs to doc/
bundle exec yard server # Preview at http://localhost:8808
bundle exec yard stats # View documentation coverage
By default, only GET/HEAD requests follow redirects. For POST/PUT/PATCH/DELETE:
client = MyApi.new("https://example.com", follow_non_get_redirects: true)
Default timeout is 4 seconds. Configure longer timeouts:
client = MyApi.new("https://example.com", timeout: 10)
By default, auth headers are stripped on cross-origin redirects. To allow (use with caution):
client = MyApi.new(
"https://example.com",
forward_auth_on_cross_origin_redirects: true # Security risk!
)
Or disable cross-origin redirects entirely:
client = MyApi.new("https://example.com", allow_cross_origin_redirects: false)
Bug reports and pull requests are welcome on GitHub at https://github.com/huwd/api_adaptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the ApiAdaptor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
FAQs
Unknown package
We found that api_adaptor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
A brand-squatted TanStack npm package used postinstall scripts to steal .env files and exfiltrate developer secrets to an attacker-controlled endpoint.
Research
Compromised SAP CAP npm packages download and execute unverified binaries, creating urgent supply chain risk for affected developers and CI/CD environments.
Company News
Socket has acquired Secure Annex to expand extension security across browsers, IDEs, and AI tools.