gdata-jruby-client 0.7.0

data/lib/gdata/java/version.properties

@@ -0,0 +1,46 @@
+# Define version number for GData client and property extension jars.
+# Specification version
+client.spec.version=1.0
+media.spec.version=1.0
+appsforyourdomain.spec.version=1.0
+analytics.spec.version=2.0
+base.spec.version=1.0
+blogger.spec.version=2.0
+books.spec.version=1.0
+calendar.spec.version=2.0
+codesearch.spec.version=2.0
+contacts.spec.version=3.0
+docs.spec.version=3.0
+finance.spec.version=2.0
+health.spec.version=2.0
+maps.spec.version=2.0
+photos.spec.version=2.0
+projecthosting.spec.version=2.0
+sidewiki.spec.version=2.0
+sites.spec.version=2.0
+spreadsheet.spec.version=3.0
+youtube.spec.version=2.0
+webmastertools.spec.version=2.0
+
+# Implementation version
+client.impl.version=1.39.1
+media.impl.version=1.0.2
+appsforyourdomain.impl.version=1.1.3
+analytics.impl.version=2.0.0
+base.impl.version=1.2.0
+blogger.impl.version=2.0.0
+books.impl.version=1.0.0
+calendar.impl.version=2.0.2
+codesearch.impl.version=2.0.0
+contacts.impl.version=3.0.0
+docs.impl.version=3.0.0
+finance.impl.version=2.0.0
+health.impl.version=2.0.1
+maps.impl.version=2.0.1
+photos.impl.version=2.0.0
+projecthosting.impl.version=2.0.0
+sidewiki.impl.version=2.0.1
+sites.impl.version=2.0.0
+spreadsheet.impl.version=3.0.1
+youtube.impl.version=2.1.1
+webmastertools.impl.version=2.0.0

data/lib/gdata_jruby_client.rb

@@ -0,0 +1,22 @@
+DEFAULT_APPLICATION_NAME = "Presdo-GDataJRubyClient-0.1"
+
+module GData end
+
+require 'java'
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/contacts_service'
+require File.dirname(__FILE__) + '/time_ext'
+require File.dirname(__FILE__) + '/string_ext'
+require File.dirname(__FILE__) + '/google_helpers'
+require File.dirname(__FILE__) + '/base_entry'
+require File.dirname(__FILE__) + '/text_content'
+require File.dirname(__FILE__) + '/query'
+require File.dirname(__FILE__) + '/when'
+require File.dirname(__FILE__) + '/email'
+require File.dirname(__FILE__) + '/im'
+require File.dirname(__FILE__) + '/extended_property'
+require File.dirname(__FILE__) + '/recurrence'
+require File.dirname(__FILE__) + '/calendar_event_entry'
+require File.dirname(__FILE__) + '/google_oauth_parameters'
+require File.dirname(__FILE__) + '/google_service'
+require File.dirname(__FILE__) + '/calendar_service'

data/lib/google_helpers.rb

@@ -0,0 +1,14 @@
+module GoogleHelpers
+  include_class 'java.net.URL'
+  
+  def url_for(url_or_string)
+    (url_or_string.kind_of? String) ? URL.new(url_or_string) : url_or_string
+  end
+  
+  def update_attributes(attributes)
+    attributes.each do |k, v|
+      self.send("#{k}=".to_sym, (v.kind_of? Time)? v.to_joda_time : v)
+    end
+  end
+  
+end

data/lib/google_oauth_parameters.rb

@@ -0,0 +1,13 @@
+module GData
+  include_package 'com.google.gdata.client.authn.oauth'
+end
+
+class Java::ComGoogleGdataClientAuthnOauth::GoogleOAuthParameters
+  def attributes=(credentials = {})    
+    self.oauth_consumer_key = credentials[:consumer_key] if credentials[:consumer_key]
+    self.oauth_consumer_secret = credentials[:consumer_secret] if credentials[:consumer_secret]
+    self.oauth_token = credentials[:token] if credentials[:token]
+    self.oauth_token_secret = credentials[:token_secret] if credentials[:token_secret]
+    self
+  end
+end

data/lib/google_service.rb

@@ -0,0 +1,58 @@
+class Java::ComGoogleGdataClient::GoogleService
+  include GoogleHelpers
+  
+  def oauth_credentials=(credientials, signer=GData::OAuthHmacSha1Signer.new)
+    self.set_oauth_credentials(credientials, signer)
+  end
+  
+  def auth_sub_token=(token, private_key=nil)
+    self.set_auth_sub_token(token, private_key)
+  end
+  
+  def find_feed(options={})
+    raise "URL or query is required" unless options[:url] or options[:query]
+    raise "Feed Class is required" unless options[:class]
+    options[:url] = url_for(options[:url]) if options[:url]
+    
+    if options[:etag] or options[:modified_since]
+      get_feed(options[:url] || options[:query], 
+        options[:class].java_class, 
+        options[:etag] || options[:modified_since])
+    else
+      get_feed(options[:url] || options[:query], 
+        options[:class].java_class)
+    end
+  end
+  
+  def find_entry(options={})
+    raise "URL or query is required" unless options[:url] or option[:query]
+    raise "Entry Class is required" unless options[:class]
+    options[:url] = url_for(options[:url]) if options[:url]
+    
+    if options[:etag] or options[:modified_since]
+      get_entry(options[:url] || options[:query], 
+        options[:class].java_class, 
+        options[:etag] || options[:modified_since])
+    else
+      get_entry(options[:url] || options[:query], 
+        options[:class].java_class)
+    end
+  end
+  
+  def create_entry(options={})
+    raise "Feed URL is required" unless options[:url]
+    raise "Entry is required" unless options[:entry]
+    options[:url] = url_for(options[:url]) if options[:url]
+    
+    insert(options[:url], options[:entry])
+  end
+  
+  def create_batch(options={})
+    raise "Feed URL is required" unless options[:url]
+    raise "Feed is required" unless options[:feed]
+    options[:url] = url_for(options[:url]) if options[:url]
+    
+    batch(options[:url], options[:feed])
+  end
+  
+end

data/lib/im.rb

@@ -0,0 +1,16 @@
+class Java::ComGoogleGdataDataExtensions::Im
+  include GoogleHelpers
+  
+  alias_method :orig_initialize, :initialize
+  
+  def initialize(options=nil)
+    if options.is_a? Hash
+      orig_initialize()
+      update_attributes(options)
+    elsif options.nil?
+      orig_initialize()
+    else
+      orig_initialize
+    end
+  end
+end

data/lib/query.rb

@@ -0,0 +1,12 @@
+class Java::ComGoogleGdataClient::Query
+  include GoogleHelpers
+  
+  def initialize(options)
+    if options.is_a? Hash
+      super url_for(options.delete(:url))
+      update_attributes(options)
+    else
+      super url_for(options)
+    end
+  end
+end

data/lib/recurrence.rb

@@ -0,0 +1,14 @@
+class Java::ComGoogleGdataDataExtensions::Recurrence
+  include GoogleHelpers
+  
+  alias_method :orig_initialize, :initialize
+  
+  def initialize(value=nil)
+    if value.nil?
+      orig_initialize
+    else
+      orig_initialize
+      self.value = value 
+    end
+  end
+end

data/lib/string_ext.rb

@@ -0,0 +1,10 @@
+class String
+  include_class 'com.google.gdata.data.PlainTextConstruct'
+  
+  def to_plain_text
+    PlainTextConstruct.new(self)
+  end
+  
+  alias_method :to_gdata, :to_plain_text
+  
+end

data/lib/text_content.rb

@@ -0,0 +1,5 @@
+class Java::ComGoogleGdataData::Content
+  def method_missing(method_name, *args)
+    self.content.send(method_name, *args)
+  end
+end

data/lib/time_ext.rb

@@ -0,0 +1,49 @@
+require 'parsedate'
+
+class Time
+  include_class('com.google.gdata.data.DateTime') {|package,name| "G#{name}" }
+  
+  def to_joda_time
+    GDateTime.parseDateTime(self.iso8601)
+  end
+  
+  alias_method :to_gdata, :to_joda_time
+  alias_method :to_date_time, :to_joda_time
+  
+  class << self
+    def from_joda_time(gdatetime)
+      if defined? parse
+        self.parse(gdatetime.to_s)
+      else
+        res = ParseDate.parsedate(gdatetime.to_s)
+        Time.local(*res)
+      end
+    end
+    
+    alias_method :from_gdata, :from_joda_time
+    alias_method :from_date_time, :from_joda_time
+  end  
+  
+  unless defined? iso8601
+    # The following are copied from Rails. If you are using Rails, everything
+    # is already defined in ActiveSupport
+    def iso8601(fraction_digits = 0)
+      fraction = if fraction_digits > 0
+        ".%i" % self.usec.to_s[0, fraction_digits]
+      end
+      "#{self.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
+   end
+   
+    def formatted_offset(colon = true, alternate_utc_string = nil)
+      utc? && alternate_utc_string || to_utc_offset_s(utc_offset, colon)
+    end
+    
+    def to_utc_offset_s(utc_offset, colon=true)
+      seconds = utc_offset
+      sign = (seconds < 0 ? -1 : 1)
+      hours = seconds.abs / 3600
+      minutes = (seconds.abs % 3600) / 60
+      "%+03d%s%02d" % [ hours * sign, colon ? ":" : "", minutes ]
+    end
+  end
+end

data/lib/when.rb

@@ -0,0 +1,16 @@
+class Java::ComGoogleGdataDataExtensions::When
+  include GoogleHelpers
+  
+  alias_method :orig_initialize, :initialize
+  
+  def initialize(options=nil)
+    if options.is_a? Hash
+      orig_initialize()
+      update_attributes(options)
+    elsif options.nil?
+      orig_initialize()
+    else
+      orig_initialize
+    end
+  end
+end

data/spec/entry_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.dirname(__FILE__) + '/../lib/gdata_jruby_client'
+
+include GoogleHelpers
+
+describe GData::Entry do
+  it "should able to initialize a new entry without attributes" do
+    entry = GData::CalendarEventEntry.new
+    entry.title = 'New Title'.to_plain_text
+    
+    entry.title.plain_text.should == 'New Title'
+  end
+  
+  it "should able to initialize a new entry with attributes" do
+    entry = GData::CalendarEventEntry.new({
+      :title => 'New Title'.to_plain_text,
+      :content => 'New Content'.to_plain_text })
+    
+    entry.title.plain_text.should == 'New Title'
+    entry.content.plain_text.should == 'New Content'
+  end
+end

data/spec/google_calendar_service_spec.rb

@@ -0,0 +1,296 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.dirname(__FILE__) + '/../lib/gdata_jruby_client'
+require File.dirname(__FILE__) + '/google_keys.rb'
+
+include GoogleHelpers
+
+describe GData::CalendarService do
+  
+  before(:each) do
+    create_service
+  end
+  
+  it "should able to retrieving all calendars" do
+    feed = @service.find_feed(:url => GData::CalendarService::ALL_CALENDAR_URL)
+    feed.should_not be_nil
+    entries = feed.entries
+    entries.size.should > 0
+    entries.each do |e|
+      e.title.plain_text.should_not be_nil
+    end
+  end
+  
+  it "should able to retrieving own calendars" do
+    feed = @service.find_feed(:url => GData::CalendarService::OWN_CALENDAR_URL)
+    feed.should_not be_nil
+    entries = feed.entries
+    entries.size.should > 0
+    entries.each do |e|
+      e.title.plain_text.should_not be_nil
+    end
+  end
+  
+  # Commented out if you run this test case too many times which will hit
+  # the API throttle limit
+  it "should be able to create, update and delete new calendars" do   
+    # Create a new calendar
+    calendar = GData::CalendarEntry.new(
+      :title => "New Calendar".to_plain_text,
+      :summary => "This is a new Calendar.".to_plain_text,
+      :time_zone => GData::TimeZoneProperty.new('America/Los_Angeles'),
+      :hidden => GData::HiddenProperty::FALSE,
+      :color => GData::ColorProperty.new('#2952A3'))
+    calendar.add_location GData::Where.new("", "", "Palo Alto")
+    
+    calendar = @service.create_entry(:url => GData::CalendarService::OWN_CALENDAR_URL, 
+      :entry => calendar)
+    calendar.should_not be_nil
+    calendar.id.should_not be_nil
+    calendar.title.plain_text.should == "New Calendar"
+    
+    #Update a new calendar
+    calendar.title = "New Title".to_gdata
+    calendar = calendar.update 
+    calendar.title.plain_text.should == "New Title"
+    
+    # Delete the calendar
+    lambda do
+      calendar.delete
+    end.should_not raise_error
+    
+    feed = @service.find_feed(:url => GData::CalendarService::OWN_CALENDAR_URL)
+    entries = feed.entries
+    entries.each do |e|
+      e.id.should_not == calendar.id
+    end
+  end
+  
+  it "should be able to create, update, and delete events" do
+    event = GData::CalendarEventEntry.new(
+      :title => 'New Event'.to_plain_text,
+      :content => 'New Content'.to_plain_text)
+    event_time = GData::When.new(
+      :start_time => Time.local(2010, "dec", 25, 20, 0, 0),
+      :end_time => Time.local(2010, "dec", 25, 21, 0, 0))
+    event.add_time(event_time)
+    event = @service.create_entry(:url => GData::CalendarService::DEFAULT_CALENDAR_URI, 
+      :entry => event)
+    event.id.should_not be_nil
+    
+    event.title = 'New Title'.to_plain_text
+    event = event.update
+    event.title.plain_text.should == 'New Title'
+    
+    lambda do
+      event.delete
+    end.should_not raise_error
+  end
+  
+  it "should able to quick add an event" do
+    event = GData::CalendarEventEntry.new(
+      :content => "Say Hi to Jerry Oct 31, 2010 12pm-1pm".to_plain_text,
+      :quick_add => true)
+    
+    event = @service.create_entry(:url => GData::CalendarService::DEFAULT_CALENDAR_URI, 
+      :entry => event)
+    
+    event.id.should_not be_nil
+    
+    event.title.plain_text.should == "Say Hi to Jerry"
+    start_time = Time.from_joda_time(event.times.first.start_time)
+    start_time.should == Time.local(2010, 10, 31, 12, 0, 0, "-07:00", nil)
+    
+    lambda do
+      event.delete
+    end.should_not raise_error
+  end
+  
+  it "should be able to create recurring events" do
+    recur_data = "DTSTART;VALUE=DATE:20070501\n" + 
+                 "DTEND;VALUE=DATE:20070502\n" + 
+                 "RRULE:FREQ=WEEKLY;BYDAY=Tu;UNTIL=20070904"
+    recur = GData::Recurrence.new(recur_data)
+    event = GData::CalendarEventEntry.new(:recurrence => recur)
+    
+    event = @service.create_entry(:url => GData::CalendarService::DEFAULT_CALENDAR_URI, 
+      :entry => event)
+    
+    event.id.should_not be_nil
+    event.recurrence.value.should == recur_data
+    
+    lambda do
+      event.delete
+    end.should_not raise_error
+  end
+  
+  # Copied from Google: When working with batch requests, the size of the request must be 
+  # under a megabyte and it's best to limit batches to 50-100 operations at a time.
+  it "should be able to perform multiple operations with a batch request" do
+    # Create a test calendar so this test case won't have dependency on the test account
+    calendar = GData::CalendarEntry.new(:title => "Test Calendar".to_plain_text)
+    calendar = @service.create_entry(:url => GData::CalendarService::OWN_CALENDAR_URL, 
+      :entry => calendar)
+    calendar_url = calendar.get_link(nil, nil).href
+    
+    # Create some events
+    1.upto 3 do |i|
+      event = GData::CalendarEventEntry.new(:title => "Test Event #{i}".to_plain_text)
+      event = @service.create_entry(:url => calendar_url, :entry => event)
+    end
+    
+    # Give it a small delay such that the changes is propagated
+    sleep(2)
+    
+    # Get some events to operate on
+    feed = @service.find_feed(:url => calendar_url)
+    
+    insert_event = GData::CalendarEventEntry.new(:title => 'first batch event'.to_plain_text)
+    GData::BatchUtils.set_batch_id(insert_event, "1")
+    GData::BatchUtils.set_batch_operation_type(insert_event, GData::BatchOperationType::INSERT)
+    
+    query_event = feed.entries[0]
+    GData::BatchUtils.set_batch_id(query_event, "2")
+    GData::BatchUtils.set_batch_operation_type(query_event, GData::BatchOperationType::QUERY)
+    
+    update_event = feed.entries[1]
+    update_event.title = 'update via batch'.to_plain_text
+    GData::BatchUtils.set_batch_id(update_event, "3")
+    GData::BatchUtils.set_batch_operation_type(update_event, GData::BatchOperationType::UPDATE)
+    
+    delete_event = feed.entries[2]
+    GData::BatchUtils.set_batch_id(delete_event, "4")
+    GData::BatchUtils.set_batch_operation_type(delete_event, GData::BatchOperationType::DELETE)
+    
+    batch_request = GData::CalendarEventFeed.new
+    batch_request.entries << insert_event
+    batch_request.entries << query_event
+    batch_request.entries << update_event
+    batch_request.entries << delete_event
+    
+    # Get the batch link URL and send the batch request there
+    batch_url = feed.get_link(GData::Link::Rel::FEED_BATCH, GData::Link::Type::ATOM).href
+    batch_response = @service.create_batch(:url => batch_url, :feed => batch_request)
+    
+    batch_response.entries.each do |entry|
+      unless GData::BatchUtils.success?(entry)
+        batch_id = GData::BatchUtils.getBatchId(entry)
+        status = GData::BatchUtils.getBatchStatus(entry)
+        puts "#{batch_id} failed (#{status.reason}) #{status.content}"
+      end
+      GData::BatchUtils.success?(entry).should == true
+    end
+    
+    # Clean up
+    sleep(3)
+    calendar.delete
+  end
+  
+  it "should be able to add extented properties to the event" do
+    event = GData::CalendarEventEntry.new(
+      :title => 'New Event'.to_plain_text,
+      :content => 'New Content'.to_plain_text)
+    event_time = GData::When.new(
+      :start_time => Time.local(2010, "dec", 25, 20, 0, 0),
+      :end_time => Time.local(2010, "dec", 25, 21, 0, 0))
+    event.add_time(event_time)
+    
+    property = GData::ExtendedProperty.new(
+      :name => 'http://schemas.presdo.com/2009#event.id',
+      :value => '1234')
+    event.add_extended_property(property)
+    
+    event = @service.create_entry(:url => GData::CalendarService::DEFAULT_CALENDAR_URI, 
+      :entry => event)
+    event.id.should_not be_nil
+    
+    event.extended_properties.first.name.should == 'http://schemas.presdo.com/2009#event.id'
+    event.extended_properties.first.value.should == '1234'
+    
+    lambda do
+      event.delete
+    end.should_not raise_error
+  end
+
+  describe "Retrieving events" do
+    before(:all) do
+      create_service
+      
+      @calendar = GData::CalendarEntry.new(
+        :title => "Test Calendar".to_plain_text,
+        :time_zone => GData::TimeZoneProperty.new('America/Los_Angeles'))
+      @calendar = @service.create_entry(:url => GData::CalendarService::OWN_CALENDAR_URL, 
+        :entry => @calendar)
+      @calendar_url = @calendar.get_link(nil, nil).href
+      
+      @event = GData::CalendarEventEntry.new(:title => 'Test Event'.to_plain_text)
+      @event_time = GData::When.new(
+        :start_time => Time.local(2010, "dec", 25, 20, 0, 0), 
+        :end_time => Time.local(2010, "dec", 25, 21, 0, 0))
+      @event.add_time(@event_time)
+      @event = @service.create_entry(:url => @calendar_url, :entry => @event)
+    end
+    
+    after(:all) do
+      sleep(3)
+      @calendar.delete
+    end
+    
+    it "should retrieve events without query parameters" do
+      feed = @service.find_feed(:url => @calendar_url)
+      feed.should_not be_nil
+      entries = feed.entries
+      entries.size.should == 1
+      entries.first.id.should == @event.id
+    end
+    
+    it "should retrieve events for a specified date range" do
+      query = GData::CalendarQuery.new(
+        :url => @calendar_url,
+        :minimum_start_time => Time.local(2010, "dec", 25, 0, 0, 0),
+        :maximum_start_time => Time.local(2010, "dec", 26, 0, 0, 0))
+      
+      feed = @service.find_feed(:query => query)
+      feed.should_not be_nil
+      entries = feed.entries
+      entries.size.should == 1
+      entries.first.id.should == @event.id
+      
+      query = GData::CalendarQuery.new(@calendar_url)
+      query.minimum_start_time = Time.local(2010, "dec", 20, 0, 0, 0).to_joda_time
+      query.maximum_start_time = Time.local(2010, "dec", 21, 0, 0, 0).to_joda_time
+      
+      feed = @service.find_feed(:query => query)
+      feed.should_not be_nil
+      feed.entries.size.should == 0
+    end
+    
+    it "should retrieve events matching a full text query" do
+      query = GData::CalendarQuery.new(
+        :url => @calendar_url,
+        :full_text_query => "Test Event")
+      
+      feed = @service.find_feed(:query => query)
+      feed.should_not be_nil
+      entries = feed.entries
+      entries.size.should == 1
+      entries.first.id.should == @event.id
+    end
+    
+  end
+  
+  def create_service
+    @service = GData::CalendarService.new DEFAULT_APPLICATION_NAME
+    # Use OAuth
+    credentials = GData::GoogleOAuthParameters.new
+    credentials.attributes = {
+      :consumer_key => CONSUMER_KEY,
+      :consumer_secret => CONSUMER_SECRET,
+      :token => TOKEN,
+      :token_secret => TOKEN_SECRET }
+    @service.oauth_credentials = credentials
+    # Use AuthSubToken
+    # @service.auth_sub_token = SESSION_TOKEN
+    @service
+  end
+  
+end