https://github.com/excon/faraday-excon
Faraday adapter for Excon
https://github.com/excon/faraday-excon
Last synced: about 1 year ago
JSON representation
Faraday adapter for Excon
- Host: GitHub
- URL: https://github.com/excon/faraday-excon
- Owner: excon
- License: mit
- Created: 2021-04-11T13:04:17.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T15:42:45.000Z (about 1 year ago)
- Last Synced: 2025-05-01T07:37:00.608Z (about 1 year ago)
- Language: Ruby
- Size: 63.5 KB
- Stars: 4
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Faraday Excon adapter
This gem is a [Faraday][faraday] adapter for the [Excon][excon] 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 Excon.
## Installation
Add these lines to your application's Gemfile:
```ruby
gem 'faraday-excon'
```
And then execute:
$ bundle install
Or install them yourself as:
$ gem install faraday-excon
## Usage
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :excon
end
```
Passing connection options:
```ruby
conn = Faraday.new(...) do |f|
# Will keep the connection memoized within the adapter, and rely that flag to excon
f.adapter :excon, persistent: true
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](rubygems).
## Contributing
Bug reports and pull requests are welcome on [GitHub][repo].
## License
The gem is available as open source under the terms of the [license][license].
## Code of Conduct
Everyone interacting in the Faraday Excon adapter project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][code-of-conduct].
[faraday]: https://github.com/excon/faraday
[faraday-website]: https://lostisland.github.io/faraday
[excon]: https://github.com/excon/excon
[rubygems]: https://rubygems.org
[repo]: https://github.com/excon/faraday-excon
[license]: https://github.com/excon/faraday-excon/blob/main/LICENSE.md
[code-of-conduct]: https://github.com/excon/faraday-excon/blob/main/CODE_OF_CONDUCT.md