grapi 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009, 2010 Aurelian Oancea, <oancea [at] gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,44 @@
+h2. Grapi : Ruby client to access the unofficial Google Reader API
+
+h3. Client Dependencies
+
+* "Curb":http://github.com/taf2/curb (gem install curb)
+
+h3. ReadingList Parser
+
+* "Nokogiri":http://github.com/tenderlove/nokogiri (gem install nokogiri)
+* "Loofah":http://github.com/flavorjones/loofah (gem install loofah)
+
+h3. Synopsis
+
+<pre>
+require "rubygems"
+require "grapi"
+
+reader = Grapi::Reader.new
+reader.login USERNAME, PASSWORD
+
+require "grapi/parser"
+list= Grapi::Parser::ReadingList.parse reader.reading_list
+
+</pre>
+
+h3. API methods
+
+* initialize(verbose= false)
+* login(USERNAME, PASSWORD)
+* reading_list(continuation=nil, dump_data= false)
+* subscribe(feed_url, label=test)
+* unsubscribe(feed_url)
+* mark_as_read(entry_google_id)
+
+h3. License: see "MIT-LICENSE":http://github.com/aurelian/grapi/blob/master/MIT-LICENSE
+
+h3. For: contact - ideas - patches please use github infrastructure
+
+h3. Links
+
+* "Friends of the Unofficial Google Reader API":http://groups.google.com/group/fougrapi
+* "pyrfeed":http://code.google.com/p/pyrfeed/wiki/GoogleReaderAPI
+* "Using the Google Reader API – Part 2":http://blog.martindoms.com/2009/10/16/using-the-google-reader-api-part-2/
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grapi"
+    gem.summary = %Q{Ruby client for unofficial Google Reader API}
+    gem.description = %Q{Ruby client for unofficial Google Reader API}
+    gem.email = "oancea@gmail.com"
+    gem.homepage = "http://github.com/aurelian/grapi"
+    gem.authors = ["Aurelian Oancea"]
+    gem.add_dependency("curb", ">=0.6.1.0")
+    gem.add_dependency("nokogiri", ">=1.4.1")
+    gem.add_dependency("loofah", ">=0.4.1")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grapi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/example.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH<< "lib"
+
+require "rubygems"
+require "grapi"
+require "grapi/parser"
+require "yaml"
+
+def print_list(list)
+  puts "~> Got: #{list.gid} updated at: #{list.updated_at}\n\t contains: #{list.entries.size} items. continuation: #{list.continuation}"
+  list.entries.each do | entry |
+    puts "~> #{entry.title}"
+    puts "\tpublished at: #{entry.published_at}"
+    puts "\tcategories: \n\t\t#{entry.categories.map{|k| "label= #{k[:label]} | term= #{k[:term]}"}.join("\n\t\t")}"
+    puts "\tsource: #{entry.source[:title]}"
+    puts "\tauthor: #{entry.author}"
+    puts "\turl: #{entry.link}"
+    puts "\tsummary: #{entry.summary}"
+    puts "======================================================================="
+  end
+end
+
+config= YAML.load_file File.expand_path("~/.gdata.yml")
+
+reader= Grapi::Reader.new(true)
+reader.login config["username"], config["password"]
+
+continuation= nil
+loop do
+  list= Grapi::Parser::ReadingList.parse(reader.reading_list(continuation))
+  print_list list
+  continuation= list.continuation
+  break if continuation.nil?
+end
+

data/grapi.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grapi}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aurelian Oancea"]
+  s.date = %q{2009-12-29}
+  s.description = %q{Ruby client for unofficial Google Reader API}
+  s.email = %q{oancea@gmail.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "example.rb",
+     "grapi.gemspec",
+     "lib/core_ext/string.rb",
+     "lib/grapi.rb",
+     "lib/grapi/parser.rb",
+     "lib/grapi/reader.rb",
+     "test/helper.rb",
+     "test/test_grapi.rb"
+  ]
+  s.homepage = %q{http://github.com/aurelian/grapi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby client for unofficial Google Reader API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_grapi.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<curb>, [">= 0.6.1.0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_runtime_dependency(%q<loofah>, [">= 0.4.1"])
+    else
+      s.add_dependency(%q<curb>, [">= 0.6.1.0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+      s.add_dependency(%q<loofah>, [">= 0.4.1"])
+    end
+  else
+    s.add_dependency(%q<curb>, [">= 0.6.1.0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
+    s.add_dependency(%q<loofah>, [">= 0.4.1"])
+  end
+end
+

data/lib/core_ext/string.rb

@@ -0,0 +1,16 @@
+require 'zlib'
+
+class String
+  def uncompress
+    begin
+      gz = Zlib::GzipReader.new(StringIO.new(self))
+      xml = gz.read
+      gz.close
+    rescue Zlib::GzipFile::Error
+      # Maybe this is not gzipped?
+      xml = self
+    end
+    xml
+  end
+end
+

data/lib/grapi.rb

@@ -0,0 +1,2 @@
+require 'core_ext/string'
+require 'grapi/reader'

data/lib/grapi/parser.rb

@@ -0,0 +1,55 @@
+require "nokogiri"
+require "loofah"
+require "time"
+
+module Grapi
+
+  module Parser
+
+    class Entry
+      attr_accessor :crawled_at, :summary, :gid, :categories, :published_at, :updated_at, :author, :source, :title, :link
+
+      def initialize
+        @categories= []
+        yield self
+      end
+    end
+
+    class ReadingList
+      attr_accessor :entries, :gid, :updated_at, :continuation
+
+      def initialize
+        @entries= []
+        yield self
+      end
+
+      def self.parse(xml)
+        doc= Nokogiri::XML xml
+        Grapi::Parser::ReadingList.new do | list |
+          list.gid          = doc.search("id").first.inner_text
+          list.updated_at   = Time.parse(doc.search("updated").first.inner_text)
+          list.continuation = doc.at_xpath("//gr:continuation").inner_text rescue nil
+          doc.search("entry").each do | entry |
+            list.entries << Grapi::Parser::Entry.new do | e |
+              e.gid          = entry.search("id").first.inner_text
+              e.title        = entry.search("title").first.inner_text
+              e.published_at = Time.parse(entry.search("published").first.inner_text)
+              e.updated_at   = Time.parse(entry.search("updated").first.inner_text)
+              e.link         = entry.search("link").attr("href").value
+              e.crawled_at   = Time.at(entry["crawl-timestamp-msec"].to_i/1000.0).utc
+              e.summary      = Loofah.fragment(entry.search("summary").inner_text).scrub!(:strip).text
+              e.author       = entry.search("author/name").inner_text
+              e.source       = {
+                :id    => entry.search("source/id").inner_text,
+                :title => entry.search("source/title").inner_text,
+                :link  => entry.search("source/link").attr("href").value
+              }
+              entry.search("category").each { | category | e.categories << {:term=>category.attr("term"), :label=>category.attr("label")} }
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/grapi/reader.rb

@@ -0,0 +1,89 @@
+require 'curl'
+
+module Grapi
+
+  class Reader
+
+    def initialize(verbose= false)
+      @client = ::Curl::Easy.new do | easy |
+        easy.headers= {
+          "User-Agent"      => "Grapi::Reader /0.2 +gzip",
+          "Accept-Encoding" => "gzip, deflate",
+          "GData-Version"   => 2
+        }
+        easy.follow_location= true
+        easy.verbose= true if verbose
+      end
+      @token = nil
+    end
+
+    def get(url)
+      make_request(url){|c| c.http_get }
+    end
+
+    def post(url, params)
+      curl_post_params= params.inject([]){|p, e| p << ::Curl::PostField.content(e[0],e[1])}
+      make_request(url){|c| c.http_post(*curl_post_params)}
+    end
+
+    def post_with_token(url, params)
+      request_token if @token.nil?
+      params["T"]= @token
+      post url, params
+    end
+
+    def login(username, password)
+      post "https://www.google.com/accounts/ClientLogin", {
+        "Email" => username,
+        "Passwd" => password,
+        "source" => @client.headers["User-Agent"],
+        "service" => "reader",
+        "accountType" => "HOSTED_OR_GOOGLE"
+      }
+      @client.body_str.uncompress =~ /^SID=(.*)\n/
+      @client.headers['Cookie']= "SID=#{$1}"
+      self
+    end
+
+    def unsubscribe(feed_url)
+      edit_subscription "feed/#{feed_url}", "unsubscribe"
+    end
+
+    def subscribe(feed_url, label= "test")
+      edit_subscription "feed/#{feed_url}", "subscribe", {"a" => "user/-/label/#{label}"}
+    end
+
+    def mark_as_read(entry_id)
+      post_with_token "http://www.google.com/reader/api/0/edit-tag", {"i" => entry_id, "a" => "user/-/state/com.google/read"}
+    end
+
+    def reading_list(continuation= nil, dump_data= false)
+      get "http://www.google.com/reader/atom/user/-/state/com.google/reading-list?xt=user/-/state/com.google/read&ck=#{Time.now.to_i*1000}&n=1000&c=#{continuation}"
+      response= @client.body_str.uncompress
+      File.open("/tmp/#{Time.now.to_i}-reading_list.atom", "w"){|f|f<<response} if dump_data
+      response
+    end
+
+    private
+
+      def edit_subscription(feed_url, action, params={})
+        post_with_token "http://www.google.com/reader/api/0/subscription/edit", { "s" => "feed/#{feed_url}", "ac" => action }.update(params)
+        response = @client.body_str.uncompress
+        unless response == "OK"
+          $stderr<< "WARN: [#{__FILE__}:#{__LINE__}] ~> response is not OK. probably token has expired!\n#{response}\n\n"
+        end
+      end
+
+      def request_token
+        get "http://www.google.com/reader/api/0/token"
+        @token = @client.body_str.uncompress
+      end
+
+      def make_request(url)
+        @client.url= url
+        yield @client
+        @client.perform
+        self
+      end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'grapi'
+
+class Test::Unit::TestCase
+end

data/test/test_grapi.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGrapi < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: grapi
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aurelian Oancea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: loofah
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+    version: 
+description: Ruby client for unofficial Google Reader API
+email: oancea@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- example.rb
+- grapi.gemspec
+- lib/core_ext/string.rb
+- lib/grapi.rb
+- lib/grapi/parser.rb
+- lib/grapi/reader.rb
+- test/helper.rb
+- test/test_grapi.rb
+has_rdoc: true
+homepage: http://github.com/aurelian/grapi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby client for unofficial Google Reader API
+test_files: 
+- test/helper.rb
+- test/test_grapi.rb