blob: c6acf03cf6d51e7fc24eae15a1d1084ee2699062 (
plain)
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
68
69
|
# Net::Hippie
Net::Hippie is a light weight wrapper around `net/http` that defaults to
sending JSON messages.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'net-hippie'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install net-hippie
## Usage
```ruby
require 'net/hippie'
Net::Hippie.logger = Rails.logger
client = Net::Hippie::Client.new(headers: {
'Accept' => 'application/vnd.haveibeenpwned.v2+json'
})
response = client.get(URI.parse('https://haveibeenpwned.com/api/breaches'))
puts JSON.parse(response.body)
```
Net::Hippie also supports TLS with client authentication.
```ruby
client = Net::Hippie::Client.new(
certificate: ENV['CLIENT_CERTFICIATE'],
key: ENV['CLIENT_KEY']
)
```
If your private key is encrypted you may include a passphrase to decrypt it.
```ruby
client = Net::Hippie::Client.new(
certificate: ENV['CLIENT_CERTFICIATE'],
key: ENV['CLIENT_KEY'],
passphrase: ENV['CLIENT_KEY_PASSPHRASE']
)
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mokhan/net-hippie.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
