Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sue445/faraday-mashify
Faraday middleware for wrapping responses into Hashie::Mash
https://github.com/sue445/faraday-mashify
faraday faradaymiddleware
Last synced: about 2 months ago
JSON representation
Faraday middleware for wrapping responses into Hashie::Mash
- Host: GitHub
- URL: https://github.com/sue445/faraday-mashify
- Owner: sue445
- License: mit
- Created: 2022-01-08T12:09:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T16:27:05.000Z (5 months ago)
- Last Synced: 2024-07-08T23:00:06.694Z (2 months ago)
- Topics: faraday, faradaymiddleware
- Language: Ruby
- Homepage: https://sue445.github.io/faraday-mashify
- Size: 52.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-faraday - mashify - parse responses into a [Hashie::Mash](https://github.com/hashie/hashie) (for Faraday 2) (Middleware)
README
# Faraday Mashify
[](https://github.com/sue445/faraday-mashify/actions/workflows/ci.yaml)
[](https://rubygems.org/gems/faraday-mashify)
[](LICENSE.md)
Faraday middleware for wrapping responses into [Hashie::Mash](https://github.com/hashie/hashie#mash).
This very specific middleware has been extracted from the [faraday_middleware](https://github.com/lostisland/faraday_middleware) project.
This is fully compatible with [FaradayMiddleware::Mashify](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/mashify.rb)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'faraday-mashify'
```
And then execute:
```shell
bundle install
```
Or install it yourself as:
```shell
gem install faraday-mashify
```
## Usage
```bash
curl http://www.example.com/api/me
{"name":"sue445"}
```
```ruby
require 'faraday/mashify'
connection =
Faraday.new(url: 'http://www.example.com') do |conn|
conn.response :mashify
conn.response :json
end
response = connection.get('/api/me').body
response[:name]
#=> "sue445"
response['name']
#=> "sue445"
response.name
#=> "sue445"
```
### Customize response class
If you want to customize the response class, pass `mash_class` to `conn.response :mashify`. (default is `Hashie::Mash`)
e.g.
```ruby
class MyHash < Hashie::Mash
end
connection =
Faraday.new(url: 'http://www.example.com') do |conn|
conn.response :mashify, mash_class: MyHash
conn.response :json
end
response = connection.get('/api/me').body
response.class
#=> MyHash
```
## Migrate from faraday_middleware
Please do the following
1. `gem "faraday_middleware"` -> `gem "faraday-mashify"` in `Gemfile`
2. `require "faraday_middleware"` -> `require "faraday/mashify"`
## 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).
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/sue445/faraday-mashify).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).