Skip to content

lostisland/faraday-httpclient

Repository files navigation

Faraday HTTPClient adapter

This gem is a Faraday adapter for the HTTPClient library. Faraday is an HTTP client library that provides a common interface over many adapters. Every adapter is defined into its own gem. This gem defines the adapter for HTTPClient.

Installation

Add these lines to your application's Gemfile:

gem 'faraday-httpclient', '~> 2.0'

And then execute:

$ bundle install

Or install them yourself as:

$ gem install faraday-httpclient -v '~> 2.0'

Usage

require 'faraday/httpclient'

conn = Faraday.new(...) do |f|
  f.adapter :httpclient do |client|
    # yields HTTPClient
    client.keep_alive_timeout = 20
    client.ssl_config.timeout = 25
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

The gem is available as open source under the terms of the license.

Code of Conduct

Everyone interacting in the Faraday HTTPClient adapter project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.