File: README.md

package info (click to toggle)
ruby-faraday-middleware-multi-json 0.0.6-2
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 112 kB
  • ctags: 10
  • sloc: ruby: 70; makefile: 3
file content (67 lines) | stat: -rw-r--r-- 1,360 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# FaradayMiddleware::MultiJson

Simple Faraday middleware that uses MultiJson to unobtrusively encode JSON requests and parse JSON responses.

## Installation

Add this line to your application's Gemfile:

    gem 'faraday_middleware-multi_json'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install faraday_middleware-multi_json

## Usage

The same as FaradayMiddleware::ParseJson:

```ruby
require 'faraday_middleware/multi_json'

connection = Faraday.new do |conn|
  conn.request :multi_json
  conn.response :multi_json
  conn.adapter  Faraday.default_adapter
end

connection.get('http://example.com/example.json')

resp = connection.post 'http://example.com/example.json' do |req|
  req.body = {:hello => 'world'}
end
```

### Passing parser options

```ruby
conn.response :multi_json, symbolize_keys: true
```

### Upgrading to 0.0.5+

The class name for the middleware changed, so if you had this before:

```ruby
connection = Faraday.new do |conn|
  conn.use FaradayMiddleware::MultiJson
end
```
Change to:
```ruby
connection = Faraday.new do |conn|
  conn.response :multi_json
end
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request