Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tisba/faraday-follow-redirects
Faraday middleware to follow redirects
https://github.com/tisba/faraday-follow-redirects
faraday http-client ruby ruby-gem
Last synced: 1 day ago
JSON representation
Faraday middleware to follow redirects
- Host: GitHub
- URL: https://github.com/tisba/faraday-follow-redirects
- Owner: tisba
- License: mit
- Created: 2022-02-24T08:24:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T21:29:54.000Z (20 days ago)
- Last Synced: 2024-12-13T23:07:39.026Z (8 days ago)
- Topics: faraday, http-client, ruby, ruby-gem
- Language: Ruby
- Homepage:
- Size: 85.9 KB
- Stars: 18
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-faraday - follow_redirects - follow HTTP 30X redirects (Middleware)
README
# Faraday Follow Redirects
[](https://github.com/tisba/faraday-follow-redirects/actions?query=branch%3Amain)
[](https://rubygems.org/gems/faraday-follow_redirects)
[](LICENSE.md)
[Faraday](https://github.com/lostisland/faraday) middleware to follow HTTP redirects transparently.
> [!IMPORTANT]
> This is a Faraday 2.x compatible extraction of the deprecated [`FaradayMiddleware::FollowRedirects` (v1.2.0)](https://github.com/lostisland/faraday_middleware/blob/v1.2.0/lib/faraday_middleware/response/follow_redirects.rb). This gem will also work with Faraday 1.x on a best-effort basis. **Faraday 1.x support is considered deprecated, please update to Faraday 2.x as soon as possible!**
>
> We only support non-EOL versions of Ruby. See [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/) for the list of non-EOL Rubies.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'faraday-follow_redirects'
```
And then execute:
```shell
bundle install
```
Or install it yourself as:
```shell
gem install faraday-follow_redirects
```
## Usage
```ruby
require 'faraday/follow_redirects'
Faraday.new(url: url) do |faraday|
faraday.response :follow_redirects # use Faraday::FollowRedirects::Middleware
faraday.adapter Faraday.default_adapter
end
```
## Upgrading from Faraday 1.x
If you still use Faraday 1.x, and have uninstalled the `faraday_middleware` gem, all you have to change is:
```diff
- conn.use FaradayMiddleware::FollowRedirects
+ conn.use Faraday::FollowRedirects::Middleware
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `bin/test` to run the tests.
To install this gem onto your local machine, run `rake build`.
To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
The `.ruby-version` file defines the default version to be used for development.
### Appraisal for testing multiple versions of dependencies
We use [appraisal](https://github.com/thoughtbot/appraisal) to test against both faraday 1.x and 2.x, and `./bin/test` will run tests against both. To run tests against just one you could:
```shell
bundle exec appraisal faraday_1 rspec
bundle exec appraisal faraday_2 rspec
```
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/tisba/faraday-follow-redirects).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).