rufus-google 0.0.1

data/README.txt

@@ -0,0 +1,98 @@
+
+= rufus-google
+
+rufus-google should probably be named "rufus-gcal" for now, as only google calendar stuff is implemented.
+
+This gem leverages 'atom-tools' to play with Google Data APIs.
+
+The only authentication mechanism implemented for now is "ClientLogin".
+
+(There is a one way synchronization tool for ical to gcal at
+
+  http://github.com/jmettraux/rufus-google/tree/master/tools/itog.rb
+
+work in progress...)
+
+
+== getting it
+
+  sudo gem install rufus-google
+
+or at
+
+http://rubyforge.org/frs/?group_id=4812
+
+
+== usage
+
+Using Google Calendar :
+
+    require 'rubygems'
+    require 'rufus/gcal'
+
+    calendars = Rufus::Google::Calendar.get_calendars(
+      :account => ENV['GUSER'], :password => ENV['GPASS'])
+
+    #calendars.values.each { |c| p [ c.name, c.href ] }
+
+    cal = calendars['gwork']
+
+    event_id = cal.post_quick!('Tennis with John November 13 3pm-4:30pm')
+
+    cal.events(:q => 'tennis').each do |e|
+      puts
+      puts e.to_s
+    end
+
+    cal.delete!(event_id)
+
+    puts "#{cal.events(:q => 'tennis').size} tennis events"
+
+
+Other Google APIs will be covered later, if the need arise.
+
+
+== dependencies
+
+the 'rufus-verbs' and the 'atom-tools' gems.
+
+
+== mailing list
+
+On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
+
+    http://groups.google.com/group/rufus-ruby
+
+
+== issue tracker
+
+http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
+
+
+== irc
+
+irc.freenode.net #ruote
+
+
+== source
+
+http://github.com/jmettraux/rufus-google
+
+  git clone git://github.com/jmettraux/rufus-google.git
+
+
+== author
+
+John Mettraux, jmettraux@gmail.com 
+http://jmettraux.wordpress.com
+
+
+== the rest of Rufus
+
+http://rufus.rubyforge.org
+
+
+== license
+
+MIT
+

data/lib/rufus-google.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/gcal'
+

data/lib/rufus/ahttp.rb

@@ -0,0 +1,64 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@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.
+#
+# (MIT license)
+#++
+#
+
+#
+# John Mettraux
+#
+# Made in Japan
+#
+# Tue Nov 11 22:18:23 JST 2008
+#
+
+require 'atom/http'
+
+module Rufus
+module Google
+
+  class Http <  Atom::HTTP
+
+    def initialize (auth_token)
+
+      @auth_token = auth_token
+
+      super(nil)
+      #super({})
+
+      @allow_all_redirects = true
+    end
+
+    def http_request (
+      url_s, method, body=nil, headers={}, www_a=nil, redir_limit=5)
+
+      headers['Authorization'] = "GoogleLogin auth=#{@auth_token}"
+      headers['GData-Version'] = GDATA_VERSION
+
+      super(url_s, method, body, headers, www_a, redir_limit)
+    end
+  end
+
+end
+end
+

data/lib/rufus/gcal.rb

@@ -0,0 +1,208 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@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.
+#
+# (MIT license)
+#++
+#
+
+#
+# John Mettraux
+#
+# "Made in Japan" as opposed to "Swiss Made"
+#
+# Wed Nov 12 09:14:09 JST 2008
+#
+
+require 'rexml/element'
+require 'rufus/google'
+
+
+module Rufus
+module Google
+
+  class Calendar
+
+    include CollectionMixin
+
+    #
+    # Returns all the events in the calendar.
+    #
+    # The query hash can be used to 'query' those events. It currently
+    # accepts :q, :start_min and :start_max as keys.
+    #
+    def events (query={})
+
+      q = query.inject([]) { |a, (k, v)|
+        a << "#{k.to_s.gsub(/\_/, '-')}=#{v}"
+      }.join("&")
+
+      q = "?#{q}" if q.length > 0
+
+      feed = Rufus::Google.feed_for("#{href}#{q}", @token)
+      feed.update!
+
+      feed.entries.collect { |e| Event.new(e) }
+    end
+
+    #
+    # Posts (creates) a QuickAdd event
+    # in this calendar.
+    #
+    # http://code.google.com/apis/calendar/developers_guide_protocol.html#CreatingQuickAdd
+    #
+    def post_quick! (event_text)
+
+      post!(Event.create_quick(event_text))
+    end
+
+    #
+    # Returns a hash calendar_name => calendar
+    #
+    # an example :
+    #
+    #   calendars = Rufus::Google::Calendar.get_calendars(
+    #     :account => ENV['GUSER'], :password => env['GPASS'])
+    #   calendars.values.each { |c| p [ c.name, c.href ] }
+    #
+    def self.get_calendars (options)
+
+      options[:service] = :cl
+
+      feed = Rufus::Google.feed_for(
+        'https://www.google.com/calendar/feeds/default', options)
+
+      feed.update! # fetch the data over the net
+
+      feed.entries.inject({}) { |h, e|
+        c = Calendar.new(options[:auth], e)
+        h[c.name] = c
+        h
+      }
+    end
+  end
+
+  #
+  # A google calendar event.
+  #
+  class Event
+
+    include EntryMixin
+
+    def start_time
+      evalue('when', 'startTime', :time => true)
+    end
+
+    def end_time
+      evalue('when', 'endTime', :time => true)
+    end
+
+    def where
+      evalue('where', 'valueString')
+    end
+
+    # TODO : add method for recurrence
+
+    def to_s
+      {
+        :id => @entry.id,
+        :etag => etag,
+        :title => @entry.title.to_s,
+        :start_time => start_time,
+        :end_time => end_time,
+        :where => where,
+        :author => "#{author.name} #{author.email}"
+      }.inspect
+    end
+
+    def self.create (opts)
+
+      e = Atom::Entry.new
+      e.title = opts[:title]
+      e.updated!
+
+      if c = opts[:content]
+        e.content = c
+        e.content['type'] = opts[:type] || 'text'
+      end
+
+      if st = opts[:start_time]
+
+        st = st.is_a?(DateTime) ? st : DateTime.parse(st)
+        st = st.to_s
+        st = st[0, 10] if opts[:all_day]
+
+        w = REXML::Element.new('gd:when')
+        w.add_attribute('startTime', st)
+
+        if et = opts[:end_time]
+
+          et = et.is_a?(DateTime) ? et : DateTime.parse(et)
+          et = et.to_s
+          et = et[0, 10] if opts[:all_day]
+
+          w.add_attribute('endTime', et)
+        end
+
+        e.extensions << w
+      end
+
+      if rc = opts[:recurrence]
+
+        r = REXML::Element.new('gd:recurrence')
+        r.text = rc
+
+        e.extensions << r
+      end
+
+      e.extensions.attributes['xmlns:gd'] =
+        'http://schemas.google.com/g/2005'
+      e.extensions.attributes['xmlns:gCal'] =
+        'http://schemas.google.com/gCal/2005'
+
+      #p e.to_xml.to_s
+
+      Event.new(e)
+    end
+
+    #
+    # Creates a QuickAdd event.
+    #
+    # http://code.google.com/apis/calendar/developers_guide_protocol.html#CreatingQuickAdd
+    #
+    def self.create_quick (text)
+
+      e = create(
+        :title => 'nada',
+        :type => 'html',
+        :content => text)
+
+      qa = REXML::Element.new('gCal:quickadd')
+      qa.add_attribute('value', 'true')
+      e.entry.extensions << qa
+
+      e
+    end
+  end
+
+end
+end
+

data/lib/rufus/google.rb

@@ -0,0 +1,228 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@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.
+#
+# (MIT license)
+#++
+#
+
+#
+# John Mettraux
+#
+# Made in Japan
+#
+# Tue Nov 11 15:21:44 JST 2008
+#
+
+require 'cgi'
+require 'uri'
+require 'time'
+require 'rufus/verbs'
+require 'atom/feed'
+#require 'atom/service'
+require 'atom/collection'
+require 'rufus/ahttp'
+
+module Rufus
+module Google
+
+  GDATA_VERSION = '2'
+
+  #
+  # Gets an auth token via the Google ClientLogin facility
+  #
+  def self.get_auth_tokens (options)
+
+    account = options[:account]
+    account_type = options[:account_type] || 'GOOGLE'
+    password = options[:password]
+    service = options[:service] || :cl
+    source = options[:source] || "rufus.rubyforge.org-rufus_google-#{VERSION}"
+
+    account = "#{account}@gmail.com" unless account.index('@')
+
+    password = CGI.escape(password)
+
+    data = ''
+    data << "accountType=#{account_type}&"
+    data << "Email=#{account}&"
+    data << "Passwd=#{password}&"
+    data << "service=#{service}&"
+    data << "source=#{source}"
+
+    headers = { 'Content-type' => 'application/x-www-form-urlencoded' }
+    headers['GData-Version'] = GDATA_VERSION
+
+    r = Rufus::Verbs.post(
+      'https://www.google.com/accounts/ClientLogin',
+      :headers => headers,
+      :data => data)
+
+    code = r.code.to_i
+
+    raise r.body if code == 403
+    raise "not a 200 OK reply : #{code} : #{r.body}" unless code == 200
+
+    tokens = r.body.split.inject({}) { |h, l|
+      md = l.match(/^(.*)=(.*$)/)
+      h[md[1].downcase.to_sym] = md[2]
+      h
+    }
+
+    options.merge!(tokens)
+
+    tokens
+  end
+
+  #
+  # Returns the auth token for a google account.
+  #
+  def self.get_auth_token (options)
+
+    return options if options.is_a?(String)
+
+    options[:auth] || get_auth_tokens(options)[:auth]
+  end
+
+  #
+  # A small method for getting an atom-tools Feed instance.
+  # The options hash is a get_auth_token() hash.
+  #
+  def self.feed_for (feed_uri, options)
+
+    token = get_auth_token(options)
+
+    Atom::Feed.new(feed_uri, Rufus::Google::Http.new(token))
+  end
+
+  module CollectionMixin
+
+    attr_reader :name, :href
+
+    def initialize (auth_token, entry)
+
+      @token = auth_token
+      @name = entry.title.to_s
+      @href = entry.links.find { |l| l.rel == 'alternate' }.href
+    end
+
+    #
+    # Posts (creates) an object
+    #
+    # Returns the URI of the created resource.
+    #
+    def post! (o)
+
+      r = collection.post!(o.entry)
+
+      raise "posting object of class #{o.class} failed : #{r.body}" \
+        unless r.code.to_i == 201
+
+      r['Location']
+    end
+
+    #
+    # Removes an object from the collection
+    #
+    def delete! (entry)
+
+      uri = entry.entry.edit_url
+
+      #r = collection.delete!(nil, uri)
+      r = collection.http.delete(uri, nil, { 'If-Match' => entry.etag })
+
+      raise "failed to delete entry (#{r.code}): #{r.body}" \
+        unless r.code.to_i == 200
+
+      r
+    end
+
+    protected
+
+      #
+      # returns the Atom::Collection instance
+      #
+      def collection
+
+        return @collection if @collection
+
+        @collection = Atom::Collection.new(
+          href, Rufus::Google::Http.new(@token))
+      end
+  end
+
+  #
+  # A mixin for entry based objects (like cal events for example)
+  #
+  module EntryMixin
+
+    attr_reader :entry
+
+    #
+    # Creates a google calendar event based on the info found in an
+    # atom-tools Entry instance.
+    #
+    def initialize (entry)
+      @entry = entry
+    end
+
+    def title
+      @entry.title.to_s
+    end
+
+    def author
+      @entry.authors.first
+    end
+
+    def authors
+      @entry.authors
+    end
+
+    def etag
+      @entry.extensions.attributes['gd:etag']
+    end
+
+    protected
+
+      #
+      # fetches a value in the extension part of the entry
+      #
+      # :time => true will attempt to parse the value to a Time instance
+      #
+      def evalue (elt_name, att_name, options={})
+
+        v = @entry.extensions.find { |e|
+          e.name == elt_name
+        }
+
+        return nil unless v
+
+        v = v.attribute(att_name)
+
+        v = Time.parse(v.value) if options[:time] == true
+
+        v
+      end
+  end
+
+end
+end
+

data/lib/rufus/gversion.rb

@@ -0,0 +1,42 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@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.
+#
+# (MIT license)
+#++
+#
+
+#
+# John Mettraux
+#
+# Made in Japan
+#
+# Wed Nov 12 20:08:24 JST 2008
+#
+
+module Rufus
+module Google
+
+  VERSION = '0.0.1'
+
+end
+end
+

data/test/t0.rb

@@ -0,0 +1,31 @@
+
+require 'rubygems'
+require 'rufus/gcal'
+
+calendars = Rufus::Google::Calendar.get_calendars(
+  :account => ENV['GUSER'], :password => ENV['GPASS'])
+
+#calendars.values.each { |c| p [ c.name, c.href ] }
+
+cal = calendars['gtest']
+
+#id = cal.post_quick!('Tennis with John November 13 3pm-4:30pm')
+#t = Time.now
+#id = cal.post!(Rufus::Google::Event.create(
+#  :title => 'drink Tequila at the Tennis club',
+#  :start_time => t,
+#  :end_time => t + 3600))
+
+#cal.events(:q => 'tennis').each do |e|
+cal.events().each do |e|
+  puts
+  puts e.to_s
+  #puts e.entry.to_s.gsub(/</, "\n<")
+  #puts e.entry.inspect
+  #p e.entry.extensions.attributes
+  #cal.delete!(e)
+end
+#cal.delete!(id)
+
+#puts "#{cal.events(:q => 'tennis').size} tennis events"
+

data/test/t_0_cal.rb

@@ -0,0 +1,39 @@
+
+#
+# Testing rufus-google
+#
+# Wed Nov 12 20:59:36 JST 2008
+#
+
+require 'test/unit'
+require 'rubygems'
+require 'rufus/gcal'
+
+class Test0Cal < Test::Unit::TestCase
+
+  def test_0
+
+    calendars = Rufus::Google::Calendar.get_calendars(
+      :account => ENV['GUSER'], :password => ENV['GPASS'])
+
+    cal = calendars['gtest']
+
+    #cal.events(:q => 'zorglub').each { |e| puts e.entry.to_s }
+    #cal.events(:q => 'zorglub').each { |e| puts e.to_s }
+    #return
+    cal.events(:q => 'zorglub').each { |e| cal.delete!(e) }
+
+    event_id = cal.post_quick!('Tennis with Zorglub November 13 3pm-4:30pm')
+
+    evts = cal.events(:q => 'zorglub')
+
+    assert_equal 1, evts.size
+    assert_equal 'Tennis with Zorglub', evts.first.title
+
+    cal.delete!(evts.first)
+
+    assert_equal [], cal.events(:q => 'zorglub')
+  end
+
+end
+

data/test/test.rb

@@ -0,0 +1,3 @@
+
+require 't_0_cal.rb'
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: rufus-google
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-03 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-verbs
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: atom-tools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: john at gmail dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/rufus
+- lib/rufus/ahttp.rb
+- lib/rufus/gcal.rb
+- lib/rufus/google.rb
+- lib/rufus/gversion.rb
+- lib/rufus-google.rb
+- test/t0.rb
+- test/t_0_cal.rb
+- test/test.rb
+- README.txt
+has_rdoc: true
+homepage: http://rufus.rubyforge.org/rufus-google
+post_install_message: 
+rdoc_options: []
+
+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: 
+- rufus-verbs
+- atom-tools
+rubyforge_project: rufus
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: snippets of Ruby code for accessing Google stuff
+test_files: 
+- test/test.rb