Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bumi/httparty_sober

HTTParties sober. - APICache for httparty
https://github.com/bumi/httparty_sober

Last synced: 4 days ago
JSON representation

HTTParties sober. - APICache for httparty

Awesome Lists containing this project

README

        

= httparty_sober

makes you not get drunken when httpartying.

== Description

httparty_sober integrates mloughran's APICache into HTTParty. This allows you to easily cache your HTTP requests.
Have a look at the APICache readme for the cache details:

http://github.com/mloughran/api_cache

== Usage Example:

class CacheParty
include HTTParty
include HTTParty::Sober

# setup APICache.
# the cache method accepts a :store parameter and default APICache options (like :valid, :timeout,...)
# you can also use the bang method cache! which overwrites the default HTTParty#get method and forces caching.
cache :store => Moneta::Memcache.new(:server => "localhost")
end

CacheParty.get_with_caching "/foo"
# get_with_caching acts like HTTParty's #get but caches the result

== Note on Patches/Pull Requests

* 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 I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2009 Michael Bumann. See LICENSE for details.