Instapaper is a ruby wrapper for interacting with Instapaper's Full Developer API. Note that access to the Full API is restricted to Instapaper subscribers only.
gem install instapaper
Instapaper offers full support for all methods exposed through the Full API. Note that Instapaer does not support the request-token/authorize workflow. To obtain an access token, use the
. do |config| config.consumer_key = YOUR_CONSUMER_KEY config.consumer_secret = YOUR_CONSUMER_SECRET config.oauth_token = YOUR_OAUTH_TOKEN config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET end
To obtain an access token via xAuth:
You can also verify credentials once you have received tokens:
Retrieve a list of bookmarks:
Add a new bookmark:
.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description')
Remove a bookmark:
Update read progress:
Star/Un-star a bookmark:
Archive/Un-archive a bookmark:
Move a bookmark to a folder:
Obtain the text of a bookmark:
To obtain the list of folders:
You can add by passing a name:
And remove folders by referencing a folder by it's id.
Lastly, the folders can be reordered:
Users without an Instapaper Subscription may only invoke the following calls:
.access_token .verify_credentials .add_bookmark .folders
- 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 (c) 2011 Steve Agalloco. See LICENSE for details.