/README.rdoc

http://github.com/jnunemaker/httparty · Unknown · 54 lines · 35 code · 19 blank · 0 comment · 0 complexity · 73923db23475771f1c4db92611060d2a MD5 · raw file

  1. = httparty
  2. Makes http fun again!
  3. == Note on Releases
  4. Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
  5. * rake gemspec
  6. * gem build httparty.gemspec
  7. * gem install the gem that was built
  8. == Note on Patches/Pull Requests
  9. * Fork the project.
  10. * Make your feature addition or bug fix.
  11. * Add tests for it. This is important so I don't break it in a future version unintentionally.
  12. * 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)
  13. * Send me a pull request. Bonus points for topic branches.
  14. == Features:
  15. * Easy get, post requests
  16. * Basic http authentication
  17. * Default request query string parameters (ie: for api keys that are needed on each request)
  18. * Automatic parsing of JSON and XML into ruby hashes based on response content-type
  19. == Examples
  20. See http://github.com/jnunemaker/httparty/tree/master/examples
  21. == Command Line Interface
  22. httparty also includes the executable <tt>httparty</tt> which can be
  23. used to query web services and examine the resulting output. By default
  24. it will output the response as a pretty-printed Ruby object (useful for
  25. grokking the structure of output). This can also be overridden to output
  26. formatted XML or JSON. Execute <tt>httparty --help</tt> for all the
  27. options. Below is an example of how easy it is.
  28. httparty "http://twitter.com/statuses/public_timeline.json"
  29. == Requirements
  30. * multijson and multixml
  31. * You like to party!
  32. == Install
  33. * sudo gem install httparty
  34. == Docs
  35. http://rdoc.info/projects/jnunemaker/httparty