readit 0.0.7 → 0.0.8

data/.travis.yml

@@ -0,0 +1,12 @@
+before_install:
+  - gem install bundler
+branches:
+  only:
+    - 'master'
+rvm:
+  - 1.9.2
+  - 1.9.3
+before_script:
+  - "cp spec/readability.yml.sample spec/readability.yml"
+  - "cp features/readability.yml.sample features/readability.yml"
+script: "bundle exec rspec"

data/Gemfile

@@ -7,11 +7,13 @@ group :development, :test do
   gem 'guard'
   gem 'guard-rspec'
   gem 'cucumber'
+  gem 'vcr','2.0.1'
+  gem 'webmock','~> 1.8.0', :require => false
 
   if RUBY_PLATFORM =~ /darwin/
     # OS X integration
     gem "ruby_gntp"
-    gem "rb-fsevent", "~> 0.4.3.1"
+    gem "rb-fsevent", "~> 0.9.0"
   end
 end
 gem 'oauth'

data/Readme.md

@@ -1,4 +1,4 @@
-## Simple api client of [readability](http://www.readability.com)
+## Simple api client of [Readability](http://readability.com) [![Build Status](https://travis-ci.org/29decibel/readit.png)](https://travis-ci.org/29decibel/readit)  [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/29decibel/readit)
 
 ### Installation
 ```ruby
@@ -34,19 +34,75 @@ Readit::Config.consumer_secret = some_value
 ```
 
 ### API usage
-``` ruby 
+
+#### 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 one artile by article_id
-@api.article 'article_id'
+# get bookmarks along with meta info :
+# item_count, item_count_total, num_pages, page
+bookmarks,meta = @api.bookmarks(:include_meta => true)
+
 # add bookmark
-@api.bookmark :url=>'http://some_article_url.html'
+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 # [#<Hashie::Mash id=39086 text="rails">, #<Hashie::Mash id=39085 text="ruby">, #<Hashie::Mash id=39087 text="tag3">]
+
+# 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
+```
+
+### Parser
+```ruby
+@parser = Readit::Parser.new "some_parser_token"
+@parser.parse some_url
 ```
 
+#### Get Article
+```ruby
+# get one artile by article_id
+@api.article 'article_id'
+
+```
+
+### At last but not least
+>Contributions are welcome!
+

data/features/bookmarks.feature

@@ -38,15 +38,15 @@ Scenario: archive bookmark by id
   When call archive with bookmark_id
   Then got bookmark's archive set to true
 
-Scenario: user can add and delete bookmark
-  Given the readit api client
-  When add bookmark with url http://google.com
-  Then got status ok
-  When fetch the latest bookmark
-  Then got the bookmark with url http://google.com
-  When delete this new added bookmark
-  And fetch the latest bookmark
-  Then the latesed bookmark which url is not http://google.com
+  ## Scenario: user can add and delete bookmark
+  ##   Given the readit api client
+  ##   When add bookmark with url http://google.com
+  ##   Then got status ok
+  ##   When fetch the bookmark info with url http://google.com
+  ##   Then got the bookmark with url http://google.com
+  ##   When delete this new added bookmark
+  ##   And fetch the latest bookmark
+  ##   Then the latesed bookmark which url is not http://google.com
 
 
 

data/features/readability.yml.sample

@@ -0,0 +1,6 @@
+development:
+  consumer_key: consumer_key
+  consumer_secret: consumer_secret
+  # you can get such informations from omniauth-readability
+  oauth_token: oauth_token
+  oauth_token_secret: oauth_token_secret

data/features/step_definitions/api_steps.rb

@@ -19,10 +19,10 @@ Then /^get the api client$/ do
 end
 
 Given /^the readit api client$/ do
-  consumer_info = YAML.load_file(File.join(File.dirname(__FILE__),'../../readability.yml'))["development"]
-  Readit::Config.consumer_key = consumer_info['consumer_key']
-  Readit::Config.consumer_secret = consumer_info['consumer_secret']
-  @client = Readit::API.new "zQuzAzVW4Ark7VZvm2","5VEnMNPr7Q4393wxAYdnTWnpWwn7bHm4"
+  tokens = YAML.load_file(File.join(File.dirname(__FILE__),'../readability.yml'))["development"]
+  Readit::Config.consumer_key = tokens['consumer_key']
+  Readit::Config.consumer_secret = tokens['consumer_secret']
+  @client = Readit::API.new tokens['oauth_token'],tokens['oauth_token_secret']
 end
 
 

data/lib/readit/version.rb

@@ -1,3 +1,3 @@
 module Readit
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/readit.rb

@@ -3,11 +3,14 @@ require 'multi_json'
 require 'oauth'
 require 'uri'
 require 'hashie'
+require 'net/http'
 # plugin railtie hook when using rails
 require 'readit/railtie' if defined?(Rails)
 
 module Readit
 
+  SITE_URL = 'https://www.readability.com/'
+
   class ReaditError < StandardError;end
 
   module Config
@@ -28,6 +31,34 @@ module Readit
       @@consumer_secret = val
     end
 
+    def self.parser_token
+      @@parser_token
+    end
+
+    def self.parser_token=(val)
+      @@parser_token = val
+    end
+
+  end
+
+  class Parser
+    def initialize(parser_token = Readit::Config.parser_token)
+      @parser_token = parser_token
+      raise ReaditError.new('please set parser token before use') unless @parser_token
+    end
+
+    def parse(url)
+      uri = URI.parse("#{SITE_URL}api/content/v1/parser?token=#{@parser_token}&url=#{URI.escape(url)}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      # using https
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      # create request
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+
+      Hashie::Mash.new MultiJson.decode(response.body)
+    end
   end
 
   class API
@@ -47,16 +78,14 @@ module Readit
 
     attr_reader :access_token
 
-    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. 
+    # Retrieve a single Article, including its content.
     # api rest address: /articles/{article_id}
-    # @param article_id the article_id 
+    # @param article_id the article_id
     def article(article_id)
       request(:get,"/articles/#{article_id}")
     end
@@ -83,23 +112,40 @@ module Readit
     # per_page default 20,max 50
     # exclude_accessibility
     # only_deleted
+    # ***** Special args *****
+    # to get bookmarks meta infos
+    # :include_meta => true
+    # item_count=20 item_count_total=633 num_pages=32 page=1
+    # bookmarks,meta = @api.bookmarks(:include_meta => true)
     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?#{URI.escape(params)}").bookmarks
+        result = request(:get,"/bookmarks?#{URI.escape(params)}")
+        args[:include_meta] ? [result.bookmarks,result.meta] : result.bookmarks
       end
     end
 
-    # Add a bookmark. Returns 202 Accepted, meaning that the bookmark has been added but no guarantees are made as 
+    # 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.
     # @param args args to bookmark a url
     # url the address to bookmark
     # favorite 0 or 1
     # archive 0 or 1
+    # Return example
+    # success:
+    # {:status => '202',:bookmark_id => '233444', :article_id => 't323r2'}
+    # conflicts
+    # {:status => '409'}
     def bookmark(args={})
-      request(:post,'/bookmarks',args)
+      raise ReaditError.new('expect at lease a hash argument with key :url') unless args[:url]
+      request(:post,'/bookmarks',args) do |response|
+        Hashie::Mash.new({
+          :status =>response.code,
+          :bookmark_id=> ['202', '409'].include?(response.code) ? response["Location"].match(/bookmarks\/(.*)/)[1] : '',
+          :article_id=> response.code== '202' ? response["X-Article-Location"].match(/articles\/(.*)/)[1] : ''})
+      end
     end
 
     # Update a bookmark. Returns 200 on successful update.
@@ -124,11 +170,11 @@ module Readit
       update_bookmark(bookmark_id,:favorite=>1)
     end
 
-    # Remove a single bookmark from this user's history. 
+    # 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. 
+    # something they have no intention of reading or supporting.
     # In almost all cases, you'll probably want to use archive by POSTing archive=1 to this bookmark.
-    # If you use DELETE and this months bookmarks have not yet been tallied, 
+    # If you use DELETE and this months bookmarks have not yet been tallied,
     # 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.
@@ -149,12 +195,44 @@ module Readit
       request(:get,"/users/_current")
     end
 
-    private 
+    # Retrieve all tags of current user
+    # api rest address :/tags
+    def all_tags
+      request(:get,"/tags")
+    end
+
+    # add tags to one bookmark
+    # api rest address POST :/bookmarks/{bookmark_id}/tags
+    def add_tags(bookmark_id, tags_string)
+      request(:post, "/bookmarks/#{bookmark_id}/tags",{ :tags => tags_string }).tags
+    end
+
+    # Retrieve all tags of one bookmark
+    # api rest address GET :/bookmarks/{bookmark_id}/tags
+    def tags(bookmark_id)
+      request(:get, "/bookmarks/#{bookmark_id}/tags").tags
+    end
+
+    # remove tag info from bookmark
+    # api rest address DELETE /bookmarks/{bookmark_id}/tags/{tag_id}
+    def remove_tag(bookmark_id, tag_id)
+      request(:delete, "/bookmarks/#{bookmark_id}/tags/#{tag_id}")
+    end
+
+    private
     def request(method,url,args={})
       consumer = ::OAuth::Consumer.new(Readit::Config.consumer_key,Readit::Config.consumer_secret,:site=>SITE_URL)
       atoken = ::OAuth::AccessToken.new(consumer, @access_token, @access_token_secret)
       #response = client.send(method,"/api/rest/v1#{url}",args.merge!('oauth_token'=>@access_token,'oauth_token_secret'=>'5VEnMNPr7Q4393wxAYdnTWnpWwn7bHm4','oauth_consumer_key'=>'lidongbin','oauth_consumer_secret'=>'gvjSYqH4PLWQtQG8Ywk7wKZnEgd4xf2C'))
       response = atoken.send(method,"/api/rest/v1#{url}",args)
+      if block_given?
+        yield response
+      else
+        hashie_response(response)
+      end
+    end
+
+    def hashie_response(response)
       if response.body==nil or response.body==''
         Hashie::Mash.new({:status => response.code})
       else

data/spec/cases/api_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 require 'time'
 
-describe "Readit::API" do
+describe "Readit::API",:vcr do
   before do
     # load consumer infos
-    consumer_info = YAML.load_file(File.join(File.dirname(__FILE__),'../../readability.yml'))["development"]
-    Readit::Config.consumer_key = consumer_info['consumer_key']
-    Readit::Config.consumer_secret = consumer_info['consumer_secret']
-    @api = Readit::API.new 'zQuzAzVW4Ark7VZvm2','5VEnMNPr7Q4393wxAYdnTWnpWwn7bHm4'
+    tokens = YAML.load_file(File.join(File.dirname(__FILE__),'../readability.yml'))["development"]
+    Readit::Config.consumer_key = tokens['consumer_key']
+    Readit::Config.consumer_secret = tokens['consumer_secret']
+    @api = Readit::API.new tokens['oauth_token'],tokens['oauth_token_secret']
   end
 
   let :bookmarks do
-    @bms ||= @api.bookmarks
+    @bms = @api.bookmarks
   end
 
   let :bookmark_ids do
@@ -33,6 +33,22 @@ describe "Readit::API" do
     resp.should_not == nil
   end
 
+  it "can get meta infos of bookmarks" do
+    bookmarks,meta = @api.bookmarks(:include_meta => true)
+    bookmarks.count.should > 0
+    meta.item_count.should > 0
+    meta.item_count_total.should > 0
+    meta.num_pages.should > 0
+    meta.page.should > 0
+  end
+
+  it "can get bookmark location when bookmarked a url" do
+    url = 'http://www.jslib.org.cn/njlib_xsyj/201011/t20101130_98154.htm'
+    resp = @api.bookmark :url => url
+    resp.bookmark_id.should_not be_nil
+    resp.article_id.should_not be_nil
+  end
+
   it "should get the article content" do
     article = @api.article 'eg60dxbv'
     #puts article
@@ -64,6 +80,13 @@ describe "Readit::API" do
     bookmark.should be_archive
   end
 
+  it "should raise exception when call bookmark without url provide" do
+    lambda { @api.bookmark }.should raise_error
+  end
+
+  it "should provide the bookmark_id of an already bookmarked url" do
+    @api.bookmark(:url => @api.bookmarks.first.article.url).bookmark_id.should_not be_empty
+  end
 
 end
 

data/spec/cases/parser_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'time'
+
+describe "Readit::Parser",:vcr do
+  before do
+    # load consumer infos
+    tokens = YAML.load_file(File.join(File.dirname(__FILE__),'../readability.yml'))["development"]
+    Readit::Config.parser_token = tokens['parser_token']
+    @parser = Readit::Parser.new tokens['parser_token']
+  end
+
+  it "should return parsed article cotents" do
+    url = "http://statico.github.com/vim.html"
+    article = @parser.parse url
+    article.title.should_not == nil
+    article.content.should_not == nil
+    article.content.length.should > 0
+  end
+end

data/spec/cases/tags_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'time'
+
+describe "Readit::API",:vcr do
+  before do
+    # load consumer infos
+    tokens = YAML.load_file(File.join(File.dirname(__FILE__),'../readability.yml'))["development"]
+    Readit::Config.consumer_key = tokens['consumer_key']
+    Readit::Config.consumer_secret = tokens['consumer_secret']
+    @api = Readit::API.new tokens['oauth_token'],tokens['oauth_token_secret']
+  end
+
+  let :bookmarks do
+    @bms = @api.bookmarks
+  end
+
+  let :bookmark_ids do
+    bookmarks.map{|a| a['id']}
+  end
+
+  it "can fetch all tags information of current user" do
+    tags = @api.all_tags
+    tags.count.should > 0
+  end
+
+  it "can add tags to one bookmark" do
+    bookmark_id = bookmark_ids.first
+    tags = @api.add_tags bookmark_id, "book,movie,music"
+    tags.count.should == 3
+  end
+
+  it "can fetch tags of one bookmark" do
+    bookmark_id = bookmark_ids.first
+    tags = @api.tags bookmark_id
+    tags.count.should == 3
+  end
+
+  it "can remove tag info of one bookmark by tag id" do
+    bookmark_id = bookmark_ids.first
+    tags = @api.tags bookmark_id
+    @api.remove_tag bookmark_id,tags.first.id
+    @api.tags(bookmark_id).count.should == 2
+  end
+
+
+end