1
0
Fork 0
mirror of https://github.com/jnunemaker/httparty synced 2023-03-27 23:23:07 -04:00
🎉 Makes http fun again!
Find a file
Nikita Misharin 290aa62c33
[WIP] Fix encoding of streamed chunk (#644)
* Fix encoding of streamed chunk

* Explicitly add pry

* Remove global variables
2019-02-11 17:49:30 +04:00
bin Handle json parsing errors and fall back to inspect for CLI 2017-04-21 10:09:43 -04:00
docs Prettify indentation of code snippet examples in docs/README 2017-06-20 16:25:22 +08:00
examples stream_body fragment include http_response feature (#588) 2019-01-23 09:02:55 +03:00
features Adds editorconfig 2018-10-09 11:16:46 +05:30
lib [WIP] Fix encoding of streamed chunk (#644) 2019-02-11 17:49:30 +04:00
script Added script/release. 2013-10-10 11:34:05 -04:00
spec [WIP] Fix encoding of streamed chunk (#644) 2019-02-11 17:49:30 +04:00
website Adds editorconfig 2018-10-09 11:16:46 +05:30
.editorconfig Adds editorconfig 2018-10-09 11:16:46 +05:30
.gitignore added lock and unlock http support 2018-05-02 22:27:02 +02:00
.rubocop.yml Adds rubocop configuration 2015-04-24 07:23:24 +02:00
.rubocop_todo.yml Adds rubocop configuration 2015-04-24 07:23:24 +02:00
.simplecov add code coverage 2014-11-28 18:06:18 +03:00
.travis.yml Specify bundler version to fix CI for rubies < 2.3 (#640) 2019-01-23 09:39:08 +03:00
Changelog.md Bump version to 0.16.4 2019-02-01 01:01:39 +04:00
CONTRIBUTING.md Create CONTRIBUTING.md 2015-05-30 07:52:30 -04:00
cucumber.yml Progress format for cucumber. 2012-04-16 00:21:27 -04:00
Gemfile [WIP] Fix encoding of streamed chunk (#644) 2019-02-11 17:49:30 +04:00
Guardfile Mitigates Style/TraillingComma 2015-04-18 01:29:25 +02:00
httparty.gemspec Determine content_type for multipart payload 2018-10-20 19:49:14 +03:00
MIT-LICENSE Removing .txt from files (it has always annoyed me). Boo Windows! 2008-12-05 17:11:58 -05:00
Rakefile Bump RSpec from 1.3 to 3.1 2014-12-06 16:10:24 -08:00
README.md Use new link for yardoc 2018-08-15 11:02:04 +08:00

httparty

Makes http fun again! Ain't no party like a httparty, because a httparty don't stop.

Install

gem install httparty

Requirements

  • Ruby 2.0.0 or higher
  • multi_xml
  • You like to party!

Examples

# 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 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

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.