Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Faraday Middleware coping with variety of json (patch, hal, etc)

License

Notifications You must be signed in to change notification settings

okitan/faraday_middleware-jsons

Repository files navigation

FaradayMiddleware::Jsons

Build Status

Faraday Middleware coping with variety of json (patch, hal, etc).

Installation

Add this line to your application's Gemfile:

gem 'faraday_middleware-jsons'

And then execute:

$ bundle

Or install it yourself as:

$ gem install faraday_middleware-jsons

Usage

require "faraday_middleware/jsons"

Faraday.new "http://example.com/api" do |conn|
  conn.request :jsons, content_type: /application\/json/, pretty: true
end

Request Middleware

jsons

Serialize as json if Content-Type matched. Defalut allows to searialize many variety of json type such as patch+json, hal+json.

Options:

key description default
:content_type To be compared with Content-Type using === /^application/(.*+)?json/
:pretty To be passed to MultiJson false

Response Middleware

jsons

Parse json if Content-Type matched. Defalut allows to load many variety of json type such as patch+json, hal+json.

Options:

key description default
:content_type To be compared with Content-Type using === /^application/(.*+)?json/
:symbolize_keys To be passed to MultiJson false
:raise_error When parse json failed it raise error. If this is false, body ramains as is false

Contributing

  1. Fork it ( https://github.com/okitan/faraday-middleware-jsons/fork )
  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 a new Pull Request