readit 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+readability.yml

data/Gemfile

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+gem 'multi_json'
+
+group :development, :test do
+	gem 'rspec'
+  # Testing infrastructure
+  gem 'guard'
+  gem 'guard-rspec'
+
+  # if RUBY_PLATFORM =~ /darwin/
+  #   # OS X integration
+  #   gem "ruby_gntp"
+  #   gem "rb-fsevent", "~> 0.4.3.1"
+  # end
+end
+gem 'oauth'
+
+
+# Specify your gem's dependencies in readit.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+ 

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,36 @@
+### Simple api client of [readability](http://www.readability.com)
+not ready to use
+### Configuration
+#### Rails
+config/readability.yml
+
+``` ruby
+
+development:
+	consumer_key: some_key
+	consumer_secret: some_secret
+```
+
+#### or in your code
+
+``` ruby
+
+Readit::Config.consumer_key = some_key
+Readit::Config.consumer_secret = some_value
+```
+
+### API use
+``` ruby 
+
+@api = Readit::API.new 'access_token','access_token_secret'
+
+# get user info
+@api.me
+# get all bookmarks
+@api.bookmarks
+# get one artile by article_id
+@api.article 'article_id'
+# add bookmark
+@api.add_bookmark :url=>'http://some_article_url.html'
+```
+

data/lib/readit/railtie.rb

@@ -0,0 +1,11 @@
+module Readit
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      if File.exists?('config/readability.yml')
+        consumer_info = YAML.load_file(File.join(Rails.root.to_s, 'config', 'readability.yml'))[Rails.env || "development"]
+        Readit::Config.consumer_key = consumer_info["consumer_key"]
+        Readit::Config.consumer_secret = consumer_info["consumer_secret"]
+      end
+    end
+  end
+end

data/lib/readit/version.rb

@@ -0,0 +1,3 @@
+module Readit
+  VERSION = "0.0.1"
+end

data/lib/readit.rb

@@ -0,0 +1,131 @@
+require "readit/version"
+require 'multi_json'
+require 'oauth'
+# plugin railtie hook when using rails
+require 'readit/railtie' if defined?(Rails)
+
+module Readit
+
+	class ReaditError < StandardError;end
+
+	module Config
+
+		def self.consumer_key
+			@@consumer_key
+		end
+
+		def self.consumer_key=(val)
+			@@consumer_key = val
+		end
+
+		def self.consumer_secret
+			@@consumer_secret
+		end
+
+		def self.consumer_secret=(val)
+			@@consumer_secret = val
+		end
+
+	end
+
+	class API
+		# Create a new Readit API client
+		def initialize(access_token='',access_token_secret='')
+			@access_token = access_token
+			@access_token_secret = access_token_secret
+			load_config
+		end
+
+		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. 
+		# /articles/{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}
+		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)
+			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={})
+			request(:post,'/bookmarks',args)
+		end
+
+		# Update a bookmark. Returns 200 on successful update.
+		# /bookmarks/{bookmark_id}
+		def update_bookmark(bookmark_id,args={})
+			request(:post,"/bookmarks/#{bookmark_id}",args)
+		end
+
+		def archive(bookmark_id)
+			update_bookmark(bookmark_id,:archive=>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. 
+		# 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, 
+		# 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.
+		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
+		def contributions(args={})
+			request(:get,"/contributions",args)
+		end
+
+		# Retrieve the current user's information.
+		# /users/_current
+		def me
+			request(:get,"/users/_current")
+		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 response.body==nil or response.body==''
+				{:status => response.code}
+			else
+				MultiJson.decode response.body
+			end
+		end
+
+	end
+end

data/readability.yml.sample

@@ -0,0 +1,3 @@
+development:
+	consumer_key: consumer_key
+	consumer_secret: consumer_secret

data/readit.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/readit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["dongbin.li"]
+  gem.email         = ["mike.d.1984@gmail.com"]
+  gem.description   = %q{a simple readability api client}
+  gem.summary       = %q{a simple readability api client}
+  gem.homepage      = "https://github.com/29decibel/readit"
+
+	gem.rubyforge_project = "readit"
+	gem.add_dependency 'multi_json'
+	gem.add_dependency 'oauth'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "readit"
+  gem.require_paths = ["lib"]
+  gem.version       = Readit::VERSION
+end

data/spec/cases/api_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+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
+
+  it "should get user infos" do
+		@api.me.should_not == nil
+  end
+
+	it "should get user's bookmarks" do
+		@api.bookmarks.should_not == nil
+	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
+		puts resp.inspect
+		resp.should_not == nil
+	end
+
+	it "should get the article content" do
+		article = @api.article 'eg60dxbv'
+		#puts article
+		article.should_not == nil
+	end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'Although not required, bundler is recommended for running the tests.'
+end
+
+require 'readit'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: readit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- dongbin.li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2157022360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157022360
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &2157021940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157021940
+description: a simple readability api client
+email:
+- mike.d.1984@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- Readme.md
+- lib/readit.rb
+- lib/readit/railtie.rb
+- lib/readit/version.rb
+- readability.yml.sample
+- readit.gemspec
+- spec/cases/api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/29decibel/readit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: readit
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: a simple readability api client
+test_files:
+- spec/cases/api_spec.rb
+- spec/spec_helper.rb