readit 0.0.2 → 0.0.3

data/Gemfile

@@ -7,11 +7,11 @@ group :development, :test do
   gem 'guard'
   gem 'guard-rspec'
 
-  # if RUBY_PLATFORM =~ /darwin/
-  #   # OS X integration
-  #   gem "ruby_gntp"
-  #   gem "rb-fsevent", "~> 0.4.3.1"
-  # end
+  if RUBY_PLATFORM =~ /darwin/
+    # OS X integration
+    gem "ruby_gntp"
+    gem "rb-fsevent", "~> 0.4.3.1"
+  end
 end
 gem 'oauth'
 

data/Readme.md

@@ -11,6 +11,8 @@ or in your rails gemfile
 ``` ruby
 
 gem 'readit'
+# or latest (recommend)
+gem 'readit',:git=>'git@github.com:29decibel/readit.git'
 ```
 
 ### Configuration
@@ -39,11 +41,13 @@ Readit::Config.consumer_secret = some_value
 
 # get user info
 @api.me
-# get all bookmarks
+# get all bookmarks, result will be a hash array
 @api.bookmarks
 # get one artile by article_id
 @api.article 'article_id'
 # add bookmark
-@api.add_bookmark :url=>'http://some_article_url.html'
+@api.bookmark :url=>'http://some_article_url.html'
+# get bookmark by bookmark_id
+@api.bookmarks :bookmark_id => some_bookmark_id
 ```
 

data/lib/readit/version.rb

@@ -1,3 +1,3 @@
 module Readit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/readit.rb

@@ -29,11 +29,18 @@ module Readit
 	end
 
 	class API
-		# Create a new Readit API client
+		# initializer if creating a new Readit API client
+		# @param access_token access_token of user
+		# @param access_token_secret access_token_secret of user
 		def initialize(access_token='',access_token_secret='')
+			if access_token == '' or access_token_secret == ''
+				raise ReaditError.new('have to provide access_token and access_token_secret')
+			end
+			if Readit::Config.consumer_key=='' or Readit::Config.consumer_secret==''
+				raise ReaditError.new('please set Readit::Config.consumer_key or Readit::Config.consumer_secret first')
+			end
 			@access_token = access_token
 			@access_token_secret = access_token_secret
-			load_config
 		end
 
 		attr_reader :access_token
@@ -41,54 +48,80 @@ module Readit
 		SITE_URL = 'https://www.readability.com/'
 
 		# Retrieve the base API URI - information about subresources.
-		# /
 		def resource_info
 			request(:get,'/')
 		end
 
 		# Retrieve a single Article, including its content. 
-		# /articles/{article_id}
+		# api rest address: /articles/{article_id}
+		# @param article_id the article_id 
 		def article(article_id)
 			request(:get,"/articles/#{article_id}")
 		end
 
 		# Retrieve the bookmarks collection. Automatically filtered to the current user.
-		# bookmark_id support
-		#
-		# /bookmarks?archive&favorite&domain&added_since&added_until&opened_since&opened_until&
-		# archived_since&archived_until&favorited_since&favorited_until&updated_since&updated_until&
-		# order&page&per_page&exclude_accessibility&only_deleted
-		#
-		# /bookmarks/{bookmark_id}
+		# api rest address : /bookmarks? or /bookmarks/{bookmark_id}
+		# @args support
+		# bookmark_id (at most return one record)
+		# archive
+		# favorite
+		# domain
+		# added_since
+		# added_until
+		# opened_since
+		# opened_until
+		# archived_since
+		# archived_until
+		# favorited_since
+		# favorited_until
+		# updated_since
+		# updated_until
+		# order
+		# page
+		# per_page
+		# exclude_accessibility
+		# only_deleted
 		def bookmarks(args={})
 			if args[:bookmark_id] and args[:bookmark_id]!=''
 				request(:get,"/bookmarks/#{args[:bookmark_id]}")
 			else
 				params = args.map{|k,v| "#{k}=#{v}"}.join('&')
-				request(:get,'/bookmarks',args)
+				request(:get,'/bookmarks',args)['bookmarks']
 			end
 		end
 
 		# Add a bookmark. Returns 202 Accepted, meaning that the bookmark has been added but no guarantees are made as 
 		# to whether the article proper has yet been parsed.
-		#
-		# /bookmarks?archive&favorite&domain&added_since&added_until&opened_since&opened_until&
-		# archived_since&archived_until&favorited_since&favorited_until&updated_since&updated_until&
-		# order&page&per_page&exclude_accessibility&only_deleted
-		def add_bookmark(args={})
+		# @param args args to bookmark a url
+		# url the address to bookmark
+		# favorite 0 or 1
+		# archive 0 or 1
+		def bookmark(args={})
 			request(:post,'/bookmarks',args)
 		end
 
 		# Update a bookmark. Returns 200 on successful update.
-		# /bookmarks/{bookmark_id}
+		# api rest address : /bookmarks/{bookmark_id}
+		# @param bookmark_id bookmark to update
+		# @param args args to update the bookmark
+		# favorite 0 or 1
+		# archive 0 or 1
 		def update_bookmark(bookmark_id,args={})
 			request(:post,"/bookmarks/#{bookmark_id}",args)
 		end
 
+		# archive a bookmark by id
+		# @param bookmark_id bookmark to archive
 		def archive(bookmark_id)
 			update_bookmark(bookmark_id,:archive=>1)
 		end
 
+		# favorite a bookmark by id
+		# @param bookmark_id bookmark_id to favorite
+		def favorite(bookmark_id)
+			update_bookmark(bookmark_id,:favorite=>1)
+		end
+
 		# Remove a single bookmark from this user's history. 
 		# NOTE: THIS IS PROBABLY NOT WHAT YOU WANT. This is particularly for the case where a user accidentally bookmarks
 		# something they have no intention of reading or supporting. 
@@ -97,19 +130,19 @@ module Readit
 		# the site associated with this bookmark will not receive any contributions for this bookmark.
 		# Use archive! It's better.
 		# Returns a 204 on successful remove.
+		# @param bookmark_id bookmark to delete
 		def delete_bookmark(bookmark_id)
 			request(:delete,"/bookmarks/#{bookmark_id}")
 		end
 
 		# Retrieve the contributions collection, which is a set of payments by a user to a specific domain. Automatically filtered to the current user.
-		#
-		# /contributions?since&until&domain&page&per_page
+		# api rest address : /contributions?since&until&domain&page&per_page
 		def contributions(args={})
 			request(:get,"/contributions",args)
 		end
 
 		# Retrieve the current user's information.
-		# /users/_current
+		# api rest address :/users/_current
 		def me
 			request(:get,"/users/_current")
 		end

data/spec/cases/api_spec.rb

@@ -4,24 +4,31 @@ describe "Readit::API" do
 	before do
 		# load consumer infos
     consumer_info = YAML.load_file(File.join(File.dirname(__FILE__),'../readability.yml'))["development"]
-		puts consumer_info
 		Readit::Config.consumer_key = consumer_info['consumer_key']
 		Readit::Config.consumer_secret = consumer_info['consumer_secret']
 		@api = Readit::API.new 'zQuzAzVW4Ark7VZvm2','5VEnMNPr7Q4393wxAYdnTWnpWwn7bHm4'
 	end
 
+	let :bookmarks do
+		@bms ||= @api.bookmarks
+	end
+
+	let :bookmark_ids do
+		bookmarks.map{|a| a['id']}
+	end
+
   it "should get user infos" do
 		@api.me.should_not == nil
   end
 
 	it "should get user's bookmarks" do
-		@api.bookmarks.should_not == nil
+		bookmarks.should_not == nil
+		bookmarks.count.should > 0
 	end
 
 	it "should add bookmark" do
-		url = 'http://www.mihuwa.com/article/5073/'
-		url = 'http://leewindy.blogbus.com/logs/188360549.html'
-		resp = @api.add_bookmark :url=>url
+		url = 'http://www.tripadvisor.com/Restaurant_Review-g297701-d1182615-Reviews-Cafe_Lotus-Ubud_Bali.html'
+		resp = @api.bookmark :url=>url
 		puts resp.inspect
 		resp.should_not == nil
 	end
@@ -32,5 +39,26 @@ describe "Readit::API" do
 		article.should_not == nil
 	end
 
+	it "should get the bookmark info by bookmark id" do
+		bookmark = @api.bookmarks :bookmark_id=>bookmark_ids.first
+		bookmark.should_not == nil
+		puts bookmark
+	end
+
+	it "should update bookmark to favarite" do
+		bm_id = bookmark_ids.first
+		@api.favorite bm_id
+		bookmark = @api.bookmarks :bookmark_id=>bm_id
+		bookmark['favorite'].should == true
+	end
+
+	it "should update bookmark to archive" do
+		bm_id = bookmark_ids.first
+		@api.archive bm_id
+		bookmark = @api.bookmarks :bookmark_id=>bm_id
+		bookmark['archive'].should == true
+	end
+
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-23 00:00:00.000000000Z
+date: 2012-01-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2156654960 !ruby/object:Gem::Requirement
+  requirement: &2162303000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156654960
+  version_requirements: *2162303000
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &2156654540 !ruby/object:Gem::Requirement
+  requirement: &2162302580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156654540
+  version_requirements: *2162302580
 description: a simple readability api client
 email:
 - mike.d.1984@gmail.com
@@ -79,3 +79,4 @@ summary: a simple readability api client
 test_files:
 - spec/cases/api_spec.rb
 - spec/spec_helper.rb
+has_rdoc: