Skip to content

socketry/async-http-faraday

Repository files navigation

Async::HTTP::Faraday

Provides an adaptor for Faraday to perform async HTTP requests. If you are designing a new library, you should probably just use Async::HTTP::Client directly.

Development Status

Installation

Add this line to your application's Gemfile:

gem 'async-http-faraday'

And then execute:

$ bundle

Or install it yourself as:

$ gem install async-http-faraday

Usage

Here is how you set faraday to use Async::HTTP:

require 'async/http/faraday'

# Make it the global default:
Faraday.default_adapter = :async_http

# Per connection:
connection = Faraday.new(...) do |builder|
	builder.adapter :async_http
end

Here is how you make a request:

Async do
	response = connection.get("/index")
end

Default

To make this the default adaptor:

require 'async/http/faraday/default'

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.