mirror of
https://github.com/samsonjs/instapaper.git
synced 2026-04-03 10:25:50 +00:00
137 lines
2.9 KiB
Markdown
137 lines
2.9 KiB
Markdown
# Instapaper [][travis] [][gemnasium]
|
|
|
|
[travis]: http://travis-ci.org/stve/instapaper
|
|
[gemnasium]: https://gemnasium.com/stve/instapaper
|
|
|
|
|
|
Instapaper is a ruby wrapper for interacting with [Instapaper's Full Developer API](http://www.instapaper.com/api/full). Note that access to the Full API is restricted to Instapaper subscribers only.
|
|
|
|
## Installation
|
|
|
|
gem install instapaper
|
|
|
|
## Usage
|
|
|
|
Instapaper offers full support for all methods exposed through the Full API. Note that Instapaper does not support the request-token/authorize workflow. To obtain an access token, use the `access_token` method.
|
|
|
|
## Configuration
|
|
|
|
```ruby
|
|
client = Instapaper::Client.new do |client|
|
|
client.consumer_key = YOUR_CONSUMER_KEY
|
|
client.consumer_secret = YOUR_CONSUMER_SECRET
|
|
client.access_token = YOUR_OAUTH_TOKEN
|
|
client.access_token_secret = YOUR_OAUTH_TOKEN_SECRET
|
|
end
|
|
```
|
|
|
|
## Authentication
|
|
|
|
To obtain an access token via xAuth:
|
|
|
|
```ruby
|
|
client.token(username, password)
|
|
```
|
|
|
|
You can also verify credentials once you have received tokens:
|
|
|
|
```ruby
|
|
client.verify_credentials
|
|
```
|
|
|
|
## Bookmark Operations
|
|
|
|
Retrieve a list of bookmarks:
|
|
|
|
```ruby
|
|
clientclient.bookmarks
|
|
```
|
|
|
|
Add a new bookmark:
|
|
|
|
```ruby
|
|
client.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description')
|
|
```
|
|
|
|
Remove a bookmark:
|
|
|
|
```ruby
|
|
client.delete_bookmark(bookmark_id)
|
|
```
|
|
|
|
Update read progress:
|
|
|
|
```ruby
|
|
client.update_read_progress(bookmark_id, 0.5)
|
|
```
|
|
|
|
Star/Un-star a bookmark:
|
|
|
|
```ruby
|
|
client.star_bookmark(bookmark_id)
|
|
client.unstar_bookmark(bookmark_id)
|
|
```
|
|
|
|
Archive/Un-archive a bookmark:
|
|
|
|
```ruby
|
|
client.archive_bookmark(bookmark_id)
|
|
client.unarchive_bookmark(bookmark_id)
|
|
```
|
|
|
|
Move a bookmark to a folder:
|
|
|
|
```ruby
|
|
client.move_bookmark(bookmark_id, folder_id)
|
|
```
|
|
|
|
Obtain the text of a bookmark:
|
|
|
|
```ruby
|
|
client.get_text(bookmark_id)
|
|
```
|
|
|
|
## Folder Operations
|
|
|
|
|
|
To obtain the list of folders:
|
|
|
|
```ruby
|
|
client.folders
|
|
```
|
|
|
|
You can add by passing a name:
|
|
|
|
```ruby
|
|
client.add_folder('eventmachine')
|
|
```
|
|
|
|
And remove folders by referencing a folder by it's id.
|
|
|
|
```ruby
|
|
client.delete_folder(folder_id)
|
|
```
|
|
|
|
Lastly, the folders can be reordered:
|
|
|
|
```ruby
|
|
client.set_order(['folder_id1:2','folder_id2:1'])
|
|
```
|
|
|
|
## Documentation
|
|
|
|
[http://rdoc.info/gems/instapaper](http://rdoc.info/gems/instapaper)
|
|
|
|
## Contributing
|
|
|
|
* 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) 2015 Steve Agalloco. See [LICENSE](https://github.com/stve/instapaper/blob/master/LICENSE.md) for details.
|