grapi 0.2.0 → 0.3.0

data/README.textile

@@ -1,13 +1,14 @@
 h2. Grapi : Ruby client to access the unofficial Google Reader API
 
-h3. Client Dependencies
+h3. Install
 
-* "Curb":http://github.com/taf2/curb (gem install curb)
+<pre>
+gem install grapi
+</pre>
 
-h3. ReadingList Parser
+h3. Client Dependencies
 
-* "Nokogiri":http://github.com/tenderlove/nokogiri (gem install nokogiri)
-* "Loofah":http://github.com/flavorjones/loofah (gem install loofah)
+* "Curb":http://github.com/taf2/curb (gem install curb)
 
 h3. Synopsis
 
@@ -18,20 +19,27 @@ require "grapi"
 reader = Grapi::Reader.new
 reader.login USERNAME, PASSWORD
 
-require "grapi/parser"
-list= Grapi::Parser::ReadingList.parse reader.reading_list
+puts reader.reading_list
 
 </pre>
 
 h3. API methods
 
+Public API:
+
 * initialize(verbose= false)
 * login(USERNAME, PASSWORD)
-* reading_list(continuation=nil, dump_data= false)
+* reading_list(:continuation => nil, :dump_data => false, :output => "atom/json")
 * subscribe(feed_url, label=test)
 * unsubscribe(feed_url)
 * mark_as_read(entry_google_id)
 
+Protected API:
+
+* get(url)
+* post(url, params={})
+* post_with_token(url, params={})
+
 h3. License: see "MIT-LICENSE":http://github.com/aurelian/grapi/blob/master/MIT-LICENSE
 
 h3. For: contact - ideas - patches please use github infrastructure

data/Rakefile

@@ -11,9 +11,6 @@ begin
     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

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/grapi.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grapi}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aurelian Oancea"]
@@ -21,11 +21,9 @@ Gem::Specification.new do |s|
      "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"
@@ -46,17 +44,11 @@ Gem::Specification.new do |s|
 
     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/grapi/reader.rb

@@ -4,32 +4,19 @@ module Grapi
 
   class Reader
 
+    VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "VERSION"))).strip
+
     def initialize(verbose= false)
       @client = ::Curl::Easy.new do | easy |
         easy.headers= {
-          "User-Agent"      => "Grapi::Reader /0.2 +gzip",
+          "User-Agent"      => "Grapi::Reader /#{Grapi::Reader::VERSION} +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
+      @token= nil
     end
 
     def login(username, password)
@@ -57,18 +44,42 @@ module Grapi
       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}"
+    # options:
+    #   :continuation (default: nil) -> continuation string
+    #   :dump_data (default: false) -> whether to write the response to a file in /tmp or not
+    #   :output (default: atom) -> desired output (atom|json)
+    def reading_list(options={})
+      options= {:continuation => nil, :output => "atom", :dump_data => false}.update(options)
+      if options[:output] == "atom"
+        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=#{options[:continuation]}"
+      else
+        get "http://www.google.com/reader/api/0/stream/contents/user/-/state/com.google/reading-list?output=#{options[:output]}&xt=user/-/state/com.google/read&ck=#{Time.now.to_i*1000}&n=1000&c=#{options[:continuation]}"
+      end
       response= @client.body_str.uncompress
-      File.open("/tmp/#{Time.now.to_i}-reading_list.atom", "w"){|f|f<<response} if dump_data
+      File.open("/tmp/#{Time.now.to_i}-reading_list.#{options[:output]}", "w"){|f|f<<response} if options[:dump_data]
       response
     end
 
-    private
+    protected
+      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
+
+    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
+        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
@@ -76,7 +87,7 @@ module Grapi
 
       def request_token
         get "http://www.google.com/reader/api/0/token"
-        @token = @client.body_str.uncompress
+        @token= @client.body_str.uncompress
       end
 
       def make_request(url)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grapi
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Aurelian Oancea
@@ -22,26 +22,6 @@ dependencies:
       - !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: []
@@ -56,11 +36,9 @@ files:
 - 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

data/example.rb

@@ -1,34 +0,0 @@
-$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/lib/grapi/parser.rb

@@ -1,55 +0,0 @@
-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
-