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
70
71
72
73
74
75
76
77
78
79
|
# httparty
[](https://github.com/jnunemaker/httparty/actions/workflows/ci.yml)
Makes http fun again! Ain't no party like a httparty, because a httparty don't stop.
## Install
```
gem install httparty
```
## Requirements
- Ruby 2.7.0 or higher
- You like to party!
## Examples
```ruby
# Use the class methods to get down to business quickly
response = HTTParty.get('http://api.stackexchange.com/2.2/questions?site=stackoverflow')
puts response.body, response.code, response.message, response.headers.inspect
# Or wrap things up in your own class
class StackExchange
include HTTParty
base_uri 'api.stackexchange.com'
def initialize(service, page)
@options = { query: { site: service, page: page } }
end
def questions
self.class.get("/2.2/questions", @options)
end
def users
self.class.get("/2.2/users", @options)
end
end
stack_exchange = StackExchange.new("stackoverflow", 1)
puts stack_exchange.questions
puts stack_exchange.users
```
See the [examples directory](http://github.com/jnunemaker/httparty/tree/main/examples) for even more goodies.
## Command Line Interface
httparty also includes the executable `httparty` which can be
used to query web services and examine the resulting output. By default
it will output the response as a pretty-printed Ruby object (useful for
grokking the structure of output). This can also be overridden to output
formatted XML or JSON. Execute `httparty --help` for all the
options. Below is an example of how easy it is.
```
httparty "https://api.stackexchange.com/2.2/questions?site=stackoverflow"
```
## Help and Docs
- [Docs](https://github.com/jnunemaker/httparty/tree/main/docs)
- https://github.com/jnunemaker/httparty/discussions
- https://www.rubydoc.info/github/jnunemaker/httparty
## Contributing
- Fork the project.
- Run `bundle`
- Run `bundle exec rake`
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Run `bundle exec rake` (No, REALLY :))
- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.
|
