Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/29decibel/readit
a simple api client for readability
https://github.com/29decibel/readit
Last synced: about 1 month ago
JSON representation
a simple api client for readability
- Host: GitHub
- URL: https://github.com/29decibel/readit
- Owner: 29decibel
- Created: 2012-01-18T07:57:49.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2016-04-02T20:27:49.000Z (over 8 years ago)
- Last Synced: 2024-10-19T10:39:43.739Z (about 2 months ago)
- Language: Ruby
- Homepage: http://29decibel.github.com/readit
- Size: 246 KB
- Stars: 49
- Watchers: 5
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- my-awesome-github-stars - 29decibel/readit - a simple api client for readability (Ruby)
README
## Simple api client of [Readability](http://readability.com) [](https://travis-ci.org/29decibel/readit) [](https://codeclimate.com/github/29decibel/readit)
### Installation
```ruby
gem install readit
```
or in your rails gemfile
``` ruby
gem 'readit'
# or latest (recommend)
gem 'readit',:git=>'[email protected]:29decibel/readit.git'
```
### Configuration
#### Rails
config/readability.yml
``` ruby
development:
consumer_key: some_key
consumer_secret: some_secret
parser_token: some_parser_token
```
or in your code
``` ruby
Readit::Config.consumer_key = some_key
Readit::Config.consumer_secret = some_value
Readit::Config.parser_token = some_parser_token
```
### API usage
#### Initialize api client
``` ruby
@api = Readit::API.new 'access_token','access_token_secret'
```
#### User info
```ruby
# get user info
@api.me
```
#### Bookmarks
```ruby
# get all bookmarks, result will be a hash array
@api.bookmarks
# get bookmarks along with meta info :
# item_count, item_count_total, num_pages, page
bookmarks,meta = @api.bookmarks(:include_meta => true)
# add bookmark
bookmark_info = @api.bookmark(:url=>'http://some_article_url.html')
# check bookmarked infos
# bookmark_info.bookmark_id
# bookmark_info.article_id
# get bookmark by bookmark_id
@api.bookmarks :bookmark_id => some_bookmark_id
# archive a bookmark
@api.archive some_bookmark_id
# favorite a bookmark
@api.favorite some_bookmark_id
# or you can just call update_bookmark to
# update a bookmark to favorited or archived
@api.update_bookmark bookmark_id,:favorite => 1,:archive => 0
```
#### Tags
```ruby
# get all tags of current user
@api.all_tags # [#, #, #]
# add tags to one bookmark
@api.add_tags bookmark_id, "tag1,tag2,tag3"
# fetch all tags of one bookmark
@api.tags bookmark_id
# remove tag from one bookmark
@api.remove_tag bookmark_id, tag_id
```
#### Get Article
```ruby
# get one artile by article_id
@api.article 'article_id'
```
### Parser
```ruby
# create a parser client
@parser = Readit::Parser.new "some_parser_token"
# parse one url
@parser.parse some_url
# now you will get a object with title, content, etc.
```
## Donation
Buy me a [Kindle book](https://amzn.com/w/27RM84VK3GHRL) :book:
### At last but not least
>Contributions are welcome!