Skip to content
A Rails engine for interacting with the Readability API
Ruby JavaScript
Latest commit ecff09f Jul 10, 2011 @plukevdh Merge pull request #3 from doucette/master
Add Support for POST Requests
Failed to load latest commit information.
app/controllers/readability
config tests what? May 7, 2011
lib add POST support Jul 9, 2011
spec/dummy
.gitignore ignore cov. May 7, 2011
Gemfile tests what? May 8, 2011
Gemfile.lock tests what? May 8, 2011
MIT-LICENSE initial engine Apr 19, 2011
README.markdown update readmes. Apr 22, 2011
Rakefile bump version number May 7, 2011
readability.gemspec

README.markdown

Readability

Install

Simply include

gem readability

in your Gemfile. bundle, and then run

rails g readability:install

This will create a readability.yml file in your config dir. All you'll need to configure at that point is to add your consumer key/secret and then add readabilify into controllers you want to use Readability api methods within.

To check if you have access, you can use before_filter or simply check with the readabilified? method:

before_filter :readabilified?

Once you want to make API calls to Readability, use the readability method to make calls. For example:

readabilty :bookmarks, {favorite: true}  # return a listing of all the bookmarks which are favorited.
readabilty :article, params[id]  # return an article

API Docs

I'm working on documenting more of the code and putting together an actual API, but really, it just references the Readability API, found at http://readability.com/publishers/api.

Contribute

This is a pretty basic API, so do your worst:

  • fork
  • fix
  • write tests (yes I know I didn't...)
  • pull request!

License

See MIT-LICENSE.

Something went wrong with that request. Please try again.