Sha256: a87bf6c25f8163fa5247fc39a043f526db41f562d47de6d86bdb0571dca3c2c0

Contents?: true

Size: 1.98 KB

Versions: 13

Compression:

Stored size: 1.98 KB

Contents

# httparty

Makes http fun again!

## Install

```
gem install httparty
```

## Requirements

* Ruby 1.9.3 or higher
* multi_xml
* You like to party!

## Examples

```ruby
# Use the class methods to get down to business quickly
response = HTTParty.get('https://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/master/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

* https://groups.google.com/forum/#!forum/httparty-gem
* http://rdoc.info/projects/jnunemaker/httparty

## Contributing

* Fork the project.
* 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.
* 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.

Version data entries

13 entries across 12 versions & 4 rubygems

Version Path
alloy_sdk-0.1.0 vendor/bundle/ruby/2.6.0/gems/httparty-0.13.1/README.md
alloy_sdk-0.1.0 vendor/bundle/ruby/3.0.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.9 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.8 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.7 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
asana2flowdock-1.0.0 vendor/bundle/ruby/1.9.1/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.6 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.5 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.4 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.3 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.2 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
allegro_api_client-0.0.1 gems/ruby/2.1.0/gems/httparty-0.13.1/README.md
httparty-0.13.1 README.md