gcalapi 0.0.4 → 0.1.0

data/lib/googlecalendar/service_auth_sub.rb

@@ -0,0 +1,18 @@
+require "googlecalendar/service_base"
+
+module GoogleCalendar
+  #
+  # this class interacts with Google Calendar and uses AuthSub interface for authentication.
+  #
+  class ServiceAuthSub < ServiceBase
+
+    def initialize(token)
+      @auth = token
+    end 
+
+  private 
+    def add_authorize_header(header)
+      header["Authorization"] = "AuthSub token=#{@auth}"
+    end
+  end # ServiceAuthSub
+end # GoogleCalendar

data/lib/googlecalendar/service_base.rb

@@ -0,0 +1,197 @@
+require "cgi"
+require "uri"
+require "net/http"
+require "net/https"
+require "open-uri"
+require "nkf"
+require "time"
+
+Net::HTTP.version_1_2
+
+module GoogleCalendar
+
+  class AuthenticationFailed < StandardError; end #:nodoc: all
+
+  #
+  # This class interacts with google calendar service.
+  #
+  class ServiceBase
+    # Server name to Authenticate
+    AUTH_SERVER = "www.google.com"
+
+    # proxy server address
+    @@proxy_addr = nil
+    def self.proxy_addr
+      @@proxy_addr
+    end
+
+    def self.proxy_addr=(addr)
+      @@proxy_addr=addr
+    end
+
+    # proxy server port number
+    @@proxy_port = nil
+    def self.proxy_port
+      @@proxy_port
+    end
+
+    def self.proxy_port=(port)
+      @@proxy_port = port
+    end
+
+    # proxy server username
+    @@proxy_user = nil
+    def self.proxy_user
+      @@proxy_user
+    end
+
+    def self.proxy_user=(user)
+      @@proxy_user = user
+    end
+
+    # proxy server password
+    @@proxy_pass = nil
+    def self.proxy_pass
+      @@proxy_pass
+    end
+
+    def self.proxy_pass=(pass)
+      @@proxy_pass = pass
+    end
+
+    attr_accessor :logger
+
+    #
+    # send query for events of a calendar and returns http response object.
+    # available condtions are 
+    # * :q => query string
+    # * :max-results => max contents count. (default: 25)
+    # * :start-index => 1-based index of the first result to be retrieved
+    # * :orderby => the order of retrieved data.
+    # * :published-min => Bounds on the entry publication date(oldest)
+    # * :published-max => Bounds on the entry publication date(newest)
+    # * :updated-min => Bounds on the entry update date(oldest)
+    # * :updated-max => Bounds on the entry update date(newest)
+    # * :author => Entry author
+    # and so on.
+    # For detail, see http://code.google.com/apis/gdata/protocol.html#Queries
+    #             and http://code.google.com/apis/calendar/reference.html#Parameters
+    #
+    def query(cal_url, conditions = nil)
+      logger.info("-- query st --") if logger
+      auth unless @auth
+      uri = URI.parse(cal_url)
+      uri.query = conditions.map do |key, val|
+        "#{key}=#{URI.escape(val.kind_of?(Time) ? val.getutc.iso8601 : val.to_s)}"
+      end.join("&") unless conditions.nil?
+      res = do_get(uri, {})
+      logger.info("-- query en (#{res.message}) --") if logger
+      res
+    end
+  
+    #
+    # delete an event.
+    #
+    def delete(feed)
+      logger.info("-- delete st --") if logger
+      auth unless @auth
+      uri = URI.parse(feed)
+      res = do_post(uri, 
+              {"X-HTTP-Method-Override" => "DELETE"}, 
+               "DELETE " + uri.path)
+      logger.info("-- delete en (#{res.message}) --") if logger
+      res
+    end
+    
+    #
+    # insert an event
+    #
+    def insert(feed, event)
+      logger.info("-- insert st --") if logger
+      auth unless @auth
+      uri = URI.parse(feed)
+      res = do_post(uri, 
+              {"Content-Type" => "application/atom+xml",
+               "Content-Length" => event.length.to_s}, event)
+      logger.info("-- insert en (#{res.message}) --") if logger
+      res
+    end
+  
+    #
+    # update an event.
+    #
+    def update(feed, event)
+      logger.info("-- update st --") if logger
+      auth unless @auth
+      uri = URI.parse(feed)
+      res = do_post(uri, 
+              {"X-HTTP-Method-Override" => "PUT", 
+               "Content-Type" => "application/atom+xml",
+               "Content-Length" => event.length.to_s}, event)
+      logger.info("-- update en (#{res.message}) --") if logger
+      res
+    end
+    
+    private 
+  
+    # authencate
+    def auth
+      raise AuthenticationFailed
+    end
+    
+    def do_post(uri, header, content)
+      logger.debug("POST:" + uri.to_s) if logger
+      res = nil
+      try_http(uri, header, content) do |http,path,head,args|
+        cont = args[0]
+        res = http.post(path, cont, head) 
+      end
+      res
+    end
+    
+    def do_get(uri, header)
+      logger.debug("GET:" + uri.to_s) if logger
+      res = nil
+      try_http(uri, header) do |http,path,head| 
+        res = http.get(path, head) 
+      end
+      res
+    end
+    
+    def try_http(uri, header, *args)
+      res = nil
+      add_authorize_header(header)
+      Net::HTTP.start(uri.host, uri.port, @@proxy_addr, @@proxy_port, @@proxy_user, @@proxy_pass) do |http|
+        header["Cookie"] = @cookie if @cookie
+        res = yield(http, path_with_authorized_query(uri), header, args)
+        logger.debug(res) if logger
+        if res.code == "302"
+          ck = sess = nil
+          ck = res["set-cookie"] if res.key?("set-cookie")
+          uri = URI.parse(res["location"]) if res.key?("location")
+          if uri && uri.query
+            qr = CGI.parse(uri.query)
+            sess = qr["gsessionid"][0] if qr.key?("gsessionid")
+          end
+          if ck && sess
+            logger.debug("cookie: #{ck}, gsessionid:#{sess}") if logger
+            header["Cookie"] = @cookie = ck
+            @session = sess
+            res = yield(http, path_with_authorized_query(uri), header, args)
+            logger.debug(res) if logger
+          else
+            logger.fatal res.body.gsub(/\n/, ' ') if logger
+          end
+        end
+      end
+      res
+    end
+    
+    def path_with_authorized_query(uri)
+      query = CGI.parse(uri.query.nil? ? "" : uri.query)
+      query["gsessionid"] = [@session] if @session
+      qs = query.map do |k,v| "#{CGI.escape(k)}=#{CGI.escape(v[0])}" end.join("&")
+      qs.empty? ? uri.path : "#{uri.path}?#{qs}"
+    end
+  end # class ServiceBase
+end # module

data/test/00_service_test.rb

@@ -1,11 +1,12 @@
 require "base_unit"
 
-class TestService < Test::Unit::TestCase
+class TestService0 < Test::Unit::TestCase
   include GoogleCalendar
   include CalendarTest
 
   def test_invalid_auth
     s = GoogleCalendar::Service.new("invalid@example.com", "invalidpassword")
+    s.logger = @srv.logger
     assert_raise(GoogleCalendar::AuthenticationFailed) do 
       s.calendar_list
     end

data/test/01_calendar_test.rb

@@ -1,6 +1,6 @@
 require "base_unit"
 
-class TestCalendar < Test::Unit::TestCase
+class TestCalendar1 < Test::Unit::TestCase
   include GoogleCalendar
   include CalendarTest
 

data/test/02_event_test.rb

@@ -1,6 +1,6 @@
 require "base_unit"
 
-class TestCalendar < Test::Unit::TestCase
+class TestCalendar2 < Test::Unit::TestCase
   include GoogleCalendar
   include CalendarTest
 
@@ -44,6 +44,33 @@ class TestCalendar < Test::Unit::TestCase
     assert_equal(0, @cal.events.length)
   end
   
+  def test_get_event
+    ev = @cal.create_event
+    ev.title = "title"
+    ev.desc = "desc"
+    ev.st = Time.now
+    ev.en = Time.now + 3600
+    ev.save!
+    
+    #@srv.logger.level = Logger::DEBUG
+    e2 = Event.get(ev.feed, @srv)
+    assert_same_event(ev, e2)
+    
+    e2.desc = "changed"
+    e2.save!
+    assert_equal("changed", e2.desc)
+    
+    e3 = Event.get(ev.feed, @srv)
+    assert_same_event(e2, e3)
+  end
+  
+  def test_get_event_fail
+    #@srv.logger.level = Logger::DEBUG
+    assert_raise(GoogleCalendar::EventGetFailed) do 
+      Event.get(GoogleCalendar::Calendar::DEFAULT_CALENDAR_FEED + "/XXXXXXXXXXXXXXXXXXXXX", @srv)
+    end
+  end
+  
   def setup
     @srv = get_service
     clear_all(@srv, FEED)

data/test/03_authsub_test.rb

@@ -0,0 +1,119 @@
+require "base_unit"
+require "rubygems"
+require "mechanize"
+require "logger"
+require "cgi"
+require "uri"
+require "googlecalendar/service_auth_sub"
+require "googlecalendar/auth_sub_util"
+
+class TestService3 < Test::Unit::TestCase
+  SAMPLE_URL = "http://www.example.com/sample.html"
+  attr_accessor :logger
+  # get one-time token
+  def test_get_onetime_token
+    # login google account
+    agent = WWW::Mechanize.new do |a| a.log = logger end
+    page = agent.get("https://www.google.com/accounts/Login")
+
+    form = page.forms[0]
+    form["Email"] = MAIL
+    form["Passwd"] = PASS
+    page = agent.submit(form)
+
+    # get auth sub request url
+    next_url = SAMPLE_URL
+    use_secure = false
+    use_session = true
+    request_url = GoogleCalendar::AuthSubUtil.build_request_url(
+      next_url, GoogleCalendar::AuthSubUtil::CALENDAR_SCOPE, use_secure, use_session)
+    query = "next=#{CGI.escape(next_url)}&scope=#{CGI.escape(GoogleCalendar::AuthSubUtil::CALENDAR_SCOPE)}&secure=#{use_secure ? "1" : "0"}&session=#{use_session ? "1" : "0"}"
+    logger.debug(request_url)
+    assert_equal(query, URI.parse(request_url).query)
+  
+    # get authsub request
+    page = agent.get(request_url)
+    form = page.forms[0]
+    agent.redirect_ok = false
+    page = agent.submit(form, form.buttons.first)
+
+    #get one time token
+    #
+    #   In the real world, Google shows the link for your website. When the user clicks the link, you can
+    #   get the one time token.
+    #   But in this UNIT TEST, this process is omitted and the token is retrieved directly from google's response.
+    #
+    uri = URI.parse(page.links.first.href)
+    params = CGI.parse(uri.query)
+    expected = params["token"][0]
+    logger.debug " token: #{expected}"
+    one_time_token = GoogleCalendar::AuthSubUtil.get_one_time_token(page.links.first.href)
+    assert_equal(expected, one_time_token)
+    return one_time_token
+  end
+  
+  def test_use_session_token
+    one_time_token = test_get_onetime_token
+    session_token = nil
+    srv = nil
+    begin
+      #get session token
+      session_token = GoogleCalendar::AuthSubUtil.exchange_session_token(one_time_token)
+      assert_not_nil(session_token)
+      logger.debug(session_token)
+      srv = GoogleCalendar::ServiceAuthSub.new(session_token)
+      srv.logger = logger
+      ret = srv.query(FEED, {})
+      logger.debug(ret.body)
+      assert_equal("200", ret.code)
+      
+      #do something
+      yield(session_token, srv) if block_given?
+    ensure
+      #revoke token
+      unless session_token.nil?
+        GoogleCalendar::AuthSubUtil.revoke_session_token(session_token)
+        ret = srv.query(FEED, {})
+        logger.debug(ret)
+        assert_equal("401", ret.code)
+      end
+    end
+  end
+  
+  def test_query_with_session_token
+    test_use_session_token do |token, srv|
+      ret = srv.query(GoogleCalendar::Calendar::DEFAULT_CALENDAR_FEED, {})
+      assert_equal("200", ret.code)
+    end
+  end
+  
+  def test_with_session_token
+    test_use_session_token do |token, srv|
+      cal = GoogleCalendar::Calendar.new(srv)
+      event = cal.create_event
+      event.desc = "desc"
+      event.st = Time.now
+      event.en = Time.now + 3600
+      ret = event.save
+      assert(ret)
+      event.destroy!
+    end
+  end
+  
+  def test_session_info
+    test_use_session_token do |token, session|
+      ret = GoogleCalendar::AuthSubUtil.token_info(token)
+      expected = {"Secure" => "false", 
+                  "Scope" => GoogleCalendar::AuthSubUtil::CALENDAR_SCOPE, 
+                  "Target" => "www.example.com"}
+      expected.each do |k,v|
+        assert(ret.key?(k))
+        assert_equal(v, ret[k]) if ret.key?(k)
+      end
+    end
+  end
+  
+  def setup
+    @logger = Logger.new("authsub.log")
+  end
+end

data/test/base_unit.rb

@@ -3,11 +3,14 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 require "parameters"
 require 'test/unit'
 require "googlecalendar/calendar"
+require "logger"
 
 module CalendarTest
   include GoogleCalendar
   def get_service
     srv = Service.new(MAIL, PASS)
+    srv.logger = Logger.new("testlog.log")
+    srv.logger.level = Logger::INFO
     assert_instance_of(Service, srv)
     srv.send("auth")
     assert_not_nil(srv.instance_eval("@auth"))

metadata

@@ -1,87 +1,130 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.9.0
 specification_version: 1
 name: gcalapi
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2006-12-28
+  version: 0.1.0
+date: 2007-02-18 00:00:00 +09:00
 summary: Google Calendar API
 require_paths: 
-  - lib
+- lib
 email: zoriorz@gmail.com
 homepage: http://gcalapi.rubyforge.net
 rubyforge_project: gcalapi
-description: ''
+description: ""
 autorequire: googlecalendar/calendar
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
-  - zorio
+- zorio
 files: 
-  - lib
-  - html
-  - test
-  - Rakefile
-  - README
-  - example
-  - VERSION
-  - lib/googlecalendar
-  - lib/gcalapi.rb
-  - lib/googlecalendar/calendar.rb
-  - lib/googlecalendar/event.rb
-  - lib/googlecalendar/service.rb
-  - html/files
-  - html/index.html
-  - html/rdoc-style.css
-  - html/fr_method_index.html
-  - html/fr_class_index.html
-  - html/fr_file_index.html
-  - html/created.rid
-  - html/classes
-  - html/files/lib
-  - html/files/README.html
-  - html/files/lib/googlecalendar
-  - html/files/lib/googlecalendar/event_rb.html
-  - html/files/lib/googlecalendar/service_rb.html
-  - html/files/lib/googlecalendar/calendar_rb.html
-  - html/classes/GoogleCalendar.html
-  - html/classes/GoogleCalendar
-  - html/classes/GoogleCalendar/Service.html
-  - html/classes/GoogleCalendar/EventUpdateFailed.html
-  - html/classes/GoogleCalendar/Calendar.html
-  - html/classes/GoogleCalendar/EventInsertFailed.html
-  - html/classes/GoogleCalendar/EventDeleteFailed.html
-  - html/classes/GoogleCalendar/Event.html
-  - html/classes/GoogleCalendar/InvalidCalendarURL.html
-  - html/classes/GoogleCalendar/AuthenticationFailed.html
-  - test/each.sh
-  - test/00_service_test.rb
-  - test/template.parameters.rb
-  - test/all.sh
-  - test/base_unit.rb
-  - test/01_calendar_test.rb
-  - test/02_event_test.rb
-  - example/ol2gcal.rb
-  - example/mail2gcal.rb
+- doc
+- example
+- html
+- lib
+- Rakefile
+- README
+- test
+- VERSION
+- doc/classes
+- doc/files
+- doc/classes/CalendarTest.src
+- doc/classes/GoogleCalendar
+- doc/classes/GoogleCalendar.src
+- doc/classes/Mail.src
+- doc/classes/TestCalendar1.src
+- doc/classes/TestCalendar2.src
+- doc/classes/TestService0.src
+- doc/classes/TestService3.src
+- doc/classes/GoogleCalendar/AuthSubFailed.src
+- doc/classes/GoogleCalendar/AuthSubUtil.src
+- doc/classes/GoogleCalendar/Calendar.src
+- doc/classes/GoogleCalendar/Event.src
+- doc/classes/GoogleCalendar/Service.src
+- doc/classes/GoogleCalendar/ServiceAuthSub.src
+- doc/classes/GoogleCalendar/ServiceBase.src
+- doc/files/example
+- doc/files/lib
+- doc/files/test
+- doc/files/example/ol2gcal_rb.src
+- doc/files/lib/googlecalendar
+- example/mail2gcal.rb
+- example/mixi2gcal.rb
+- example/ol2gcal.rb
+- html/classes
+- html/created.rid
+- html/files
+- html/fr_class_index.html
+- html/fr_file_index.html
+- html/fr_method_index.html
+- html/index.html
+- html/rdoc-style.css
+- html/classes/GoogleCalendar
+- html/classes/GoogleCalendar.html
+- html/classes/GoogleCalendar/AuthenticationFailed.html
+- html/classes/GoogleCalendar/AuthSubFailed.html
+- html/classes/GoogleCalendar/AuthSubUtil.html
+- html/classes/GoogleCalendar/Calendar.html
+- html/classes/GoogleCalendar/Event.html
+- html/classes/GoogleCalendar/EventDeleteFailed.html
+- html/classes/GoogleCalendar/EventGetFailed.html
+- html/classes/GoogleCalendar/EventInsertFailed.html
+- html/classes/GoogleCalendar/EventUpdateFailed.html
+- html/classes/GoogleCalendar/InvalidCalendarURL.html
+- html/classes/GoogleCalendar/Service.html
+- html/classes/GoogleCalendar/ServiceAuthSub.html
+- html/classes/GoogleCalendar/ServiceBase.html
+- html/files/lib
+- html/files/README.html
+- html/files/lib/googlecalendar
+- html/files/lib/googlecalendar/auth_sub_util_rb.html
+- html/files/lib/googlecalendar/calendar_rb.html
+- html/files/lib/googlecalendar/event_rb.html
+- html/files/lib/googlecalendar/service_auth_sub_rb.html
+- html/files/lib/googlecalendar/service_base_rb.html
+- html/files/lib/googlecalendar/service_rb.html
+- lib/gcalapi.rb
+- lib/googlecalendar
+- lib/googlecalendar/auth_sub_util.rb
+- lib/googlecalendar/calendar.rb
+- lib/googlecalendar/event.rb
+- lib/googlecalendar/service.rb
+- lib/googlecalendar/service_auth_sub.rb
+- lib/googlecalendar/service_base.rb
+- test/00_service_test.rb
+- test/01_calendar_test.rb
+- test/02_event_test.rb
+- test/03_authsub_test.rb
+- test/all.sh
+- test/base_unit.rb
+- test/each.sh
+- test/template.parameters.rb
 test_files: 
-  - test/00_service_test.rb
-  - test/01_calendar_test.rb
-  - test/02_event_test.rb
+- test/00_service_test.rb
+- test/01_calendar_test.rb
+- test/02_event_test.rb
+- test/03_authsub_test.rb
 rdoc_options: 
-  - "--line-numbers"
-  - "--inline-source"
+- --line-numbers
+- --inline-source
 extra_rdoc_files: 
-  - README
+- README
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+