Skip to content

levonmaa/readit

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple api client of readability

Installation

gem install readit

or in your rails gemfile

gem 'readit'
# or latest (recommend)
gem 'readit',:git=>'[email protected]:29decibel/readit.git'

Configuration

Rails

config/readability.yml

development:
  consumer_key: some_key
  consumer_secret: some_secret

or in your code

Readit::Config.consumer_key = some_key
Readit::Config.consumer_secret = some_value

API usage

Initialize api client

@api = Readit::API.new 'access_token','access_token_secret'

User info

# get user info
@api.me

Bookmarks

# 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

Get Article

# get one artile by article_id
@api.article 'article_id'

At last but not least

Contributions are welcome!

About

a simple api client for readability

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%