Bloglines4R 0.1.0

data/README.txt

@@ -0,0 +1,50 @@
+= Bloglines4R -- Bloglines API for Ruby
+
+This is Bloglines4R, a little library to access Bloglines Web Services
+at http://rpc.bloglines.com from the Ruby programming language.
+
+Author:: Giulio Piancastelli <giulio.piancastelli@gmail.com>
+Requires:: Ruby 1.8 or later
+License:: Bloglines4R is Copyright (c) 2004 by Giulio Piancastelli
+          Bloglines4R is released under the terms of the GNU General
+          Public License version 2 or later. See the license.txt file
+          included in the distribution for further details.
+
+== Quick Start
+
+Bloglines4R comes in RubyGems flavor and as tgz and zip archives
+also. Automatic installation of the library is supported through
+RubyGems only.
+
+After installing Bloglines4R through RubyGems you should be able to
+run a little example as the following:
+  begin
+    require 'rubygems'
+    require_gem 'Bloglines4R'
+  rescue LoadError
+    require 'bloglines'
+  end
+  bloglines = Bloglines::WebServices.new(:user => 'user@example.com')
+  puts bloglines.update
+where you need to substituite the email address you registered to
+Bloglines with for <tt>user@example.com</tt>.
+
+== Unit Tests
+
+Bloglines4R comes with a little suite of unit tests. If you want to
+run it, you have to modify the script <tt>test/bloglines_test.rb</tt>
+substituting your account's email address, password, and user_id for
+the appropriate parameters in BloglinesTest#setup method.
+
+Please note that if you run tests from within the RubyGems
+installation process, they will entirely fail. This does not mean the
+library won't work: run the example, and try the tests after modifying
+them as required. If and only if those do not work, you can report a
+problem within Bloglines4R.
+
+== Known issues
+
+- RSS documents are returned as REXML documents, but this will change in Ruby 1.8.2
+  when a RSS parser will be officially included in the distribution.
+- Also OPML documents are returned as REXML documents: would it be better to build
+  an hash from elements in the subscriptions document?

data/lib/bloglines.rb

@@ -0,0 +1,105 @@
+# Bloglines4R
+# Access the Bloglines Web Services at http://rpc.bloglines.com Web Services from Ruby.
+# Copyright (c) 2004 Giulio Piancastelli.
+# Released under the terms of the GNU General Public License version 2 or later.
+
+module Bloglines
+
+require 'base64'
+require 'net/http'
+require 'rexml/document'
+
+HOSTNAME = 'rpc.bloglines.com'
+
+class BloglinesException < Exception; end
+
+class WebServices
+
+  # Initialize Bloglines web services.
+  # This method takes as parameters:
+  #   :user is the email address used for a Bloglines account.
+  #   :password is the Bloglines account password. It is an optional argument,
+  #             because not every method in the Bloglines API request it.
+  #   :proxy_host is the host for a proxy to access the internet. It is an
+  #               optional parameter.
+  #   :proxy_port is the port where the proxy host is listening for incoming
+  #               connections. It is an optional parameter.
+  #   :proxy_user specify the proxy username to work with authorization
+  #               enabled proxies.
+  #   :proxy_pass specify the proxy password to work with authorization
+  #               enabled proxies.
+  def initialize params
+    @user = params.delete :user
+    @password = params.delete :password
+    if ENV['http_proxy'] =~ /http:\/\/(.*):(\d*)/
+      @proxy = {:proxy_host => $1, :proxy_port => $2}.merge params
+    else
+      @proxy = params
+    end
+  end
+
+  # Retrieve an unread count for a given Bloglines account.
+  # See http://www.bloglines.com/services/api/notifier for details.
+  def update version=1
+    response = Net::HTTP::Proxy(@proxy[:proxy_addr], @proxy[:proxy_port],
+                                @proxy[:proxy_user], @proxy[:proxy_pass]).start(HOSTNAME) { |http|
+      http.get "/update?user=#{@user}&ver=#{version}"
+    }
+    raise BloglinesException.new unless response.code == '200'
+    raise BloglinesException.new('Unexpected response pattern') unless response.body =~ /\|(\-{0,1}[0-9]+)\|([^|]*)\|/
+    raise BloglinesException.new('User does not exist') if $1 == '-1'
+    
+    $stderr.puts "Please upgrade to a new notifier at #{$2}" unless $2.empty?
+    
+    $1.to_i
+  end
+  
+  # Retrieve subscription information in OPML format for a given Bloglines account.
+  # See http://www.bloglines.com/services/api/listsubs for details.
+  def listsubs
+    response = Net::HTTP::Proxy(@proxy[:proxy_addr], @proxy[:proxy_port],
+                                @proxy[:proxy_user], @proxy[:proxy_pass]).start(HOSTNAME) { |http|
+      headers = {'Authorization' => "Basic #{encode64(@user + ':' + @password)}"}
+      http.get "/listsubs", headers    
+    }
+
+    raise BloglinesException.new("Incorrect email address or password") if response.code == '401'
+
+    REXML::Document.new response.body
+  end
+
+  # Retrieve unread blog entries for a given subscription, optionally marking them as read. If a
+  # date in seconds since Epoch is specified, all items since the passed UTC time are downloaded.
+  # See: http://www.bloglines.com/services/api/getitems for details.
+  def getitems subscription_id, mark_as_read=0, date=nil
+    query = "s=#{subscription_id}&n=#{mark_as_read}"
+    query += "&d=#{date}" unless date.nil?
+    response = Net::HTTP::Proxy(@proxy[:proxy_addr], @proxy[:proxy_port],
+                                @proxy[:proxy_user], @proxy[:proxy_pass]).start(HOSTNAME) { |http|
+      headers = {'Authorization' => "Basic #{encode64(@user + ':' + @password)}"}
+      http.get "/getitems?#{query}", headers
+    }
+
+    case response.code
+      when '401' then raise BloglinesException.new("Incorrect email address or password")
+      when '403' then raise BloglinesException.new("Invalid or missing subscription ID")
+      when '410' then raise BloglinesException.new("Subscription has been deleted")
+    end
+
+    REXML::Document.new response.body
+  end
+
+  # Retrieve public subscription information in OPML format for a given Bloglines account.
+  # See http://www.bloglines.com/public/user_id, and click on Export Subscription at the
+  # bottom of the left frame for details.
+  def export user_id
+    response = Net::HTTP::Proxy(@proxy[:proxy_addr], @proxy[:proxy_port],
+                                @proxy[:proxy_user], @proxy[:proxy_pass]).start(HOSTNAME) { |http|
+      http.get "/export?id=#{user_id}"
+    }
+    REXML::Document.new response.body
+  end
+
+end
+
+end

data/test/bloglines_test.rb

@@ -0,0 +1,40 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bloglines'
+require 'test/unit'
+
+module Bloglines
+
+  class BloglinesTest < Test::Unit::TestCase
+    def setup
+      @user = 'user@example.com'
+      @password = 'mypassword'
+      @user_id = 'myuserid'
+    end
+    def test_update
+      bloglines = Bloglines::WebServices.new(:user => @user)
+      n = bloglines.update
+      assert n >= 0
+    end
+    def test_listsubs
+      bloglines = Bloglines::WebServices.new(:user => @user, :password => @password)
+      opml = bloglines.listsubs
+      outlines = opml.elements["//body/outline"]
+      assert outlines.size > 0
+    end
+    def test_getitems
+      sub_id = '1920365' # Scripting News
+      bloglines = Bloglines::WebServices.new(:user => @user, :password => @password)
+      rss = bloglines.getitems sub_id
+      channel_title = rss.elements["//channel/title"]
+      assert_equal 'Scripting News', channel_title[0].to_s
+    end
+    def test_export
+      bloglines = Bloglines::WebServices.new({}) # no need for any parameter
+      subscriptions = bloglines.export @user_id
+      outlines = subscriptions.elements["//body/outline"]
+      assert outlines.size > 0
+    end
+  end
+
+end

metadata

@@ -0,0 +1,40 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.3
+specification_version: 1
+name: Bloglines4R
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-01-16
+summary: A library to access the Bloglines API from Ruby
+require_paths: 
+  - lib
+email: giulio.piancastelli@gmail.com
+homepage: http://bloglines.rubyforge.org/
+rubyforge_project: 
+description: 
+autorequire: bloglines
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Giulio Piancastelli
+files: 
+  - lib/bloglines.rb
+  - README.txt
+test_files: 
+  - test/bloglines_test.rb
+rdoc_options: []
+extra_rdoc_files: 
+  - README.txt
+executables: []
+extensions: []
+requirements: []
+dependencies: []