amr_google_calendar 0.2.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Gems required to use google_calendar.
+gem "nokogiri", ">= 1.4.4"
+gem "addressable", ">= 2.2.2"
+
+# Gem development dependencies.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "mocha", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.10)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable (>= 2.2.2)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  mocha
+  nokogiri (>= 1.4.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Steve Zich
+
+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.

data/README.rdoc

@@ -0,0 +1,54 @@
+= Google Calendar
+
+A fast lightweight and minimalist wrapper around the google calendar api.
+
+== Install
+  [sudo] gem install 'google_calendar'
+
+Note: Google requests that you set the name of your application so they can better monitor the use of their services.
+
+== Usage
+  require 'rubygems'
+  require 'google_calendar'
+
+  cal = Google::Calendar.new(:username => 'some.person@gmail.com',
+                             :password => 'super-secret',
+                             :app_name => 'mycompany.com-googlecalendar-integration')
+
+  event = cal.create_event do |e|
+    e.title = 'A Cool Event'
+    e.start_time = Time.now
+    e.end_time = Time.now + (60 * 60) # seconds * min
+  end
+
+  puts event
+
+  event = cal.find_or_create_event_by_id(event.id) do |e|
+    e.title = 'An Updated Cool Event'
+    e.end_time = Time.now + (60 * 60 * 2) # seconds * min * hours
+  end
+
+  puts event
+
+  # All events
+  puts cal.events
+
+  # Query events
+  puts cal.find_events('my search string')
+
+
+Note: This is not a complete implementation of the calendar api, it just includes the features I needed to support our internal calendar integration.
+
+== Contributing to google_calendar
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Steve Zich. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "google_calendar"
+  gem.homepage = "http://github.com/northworld/google_calendar"
+  gem.license = "MIT"
+  gem.summary = %Q{A lightweight google calendar API wrapper}
+  gem.description = %Q{A minimal wrapper around the google calendar API, which uses nokogiri for fast parsing.}
+  gem.email = "steve.zich@gmail.com"
+  gem.authors = ["Steve Zich"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google_calendar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/google_calendar.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amr_google_calendar}
+  s.version = "0.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Amr Al-Hindi"]
+  s.date = %q{2012-11-18}
+  s.description = %q{A fork of the Google Calendar gem by Steve Zich. The gem is a minimal wrapper around the google calendar API, which uses nokogiri for fast parsing.}
+  s.email = %q{amr.alhindi@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "google_calendar.gemspec",
+    "lib/google/calendar.rb",
+    "lib/google/connection.rb",
+    "lib/google/errors.rb",
+    "lib/google/event.rb",
+    "lib/google/net/https.rb",
+    "lib/google_calendar.rb",
+    "test/helper.rb",
+    "test/mocks/create_event.xml",
+    "test/mocks/create_quickadd_event.xml",
+    "test/mocks/events.xml",
+    "test/mocks/find_event_by_id.xml",
+    "test/mocks/list_calendars.xml",
+    "test/mocks/query_events.xml",
+    "test/mocks/successful_login.txt",
+    "test/test_google_calendar.rb"
+  ]
+  s.homepage = %q{https://github.com/shami/google_calendar}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A lightweight google calendar API wrapper}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_google_calendar.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_runtime_dependency(%q<addressable>, [">= 2.2.2"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<addressable>, [">= 2.2.2"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<addressable>, [">= 2.2.2"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/google/calendar.rb

@@ -0,0 +1,223 @@
+require 'nokogiri'
+
+module Google
+
+  # Calendar is the main object you use to interact with events.
+  # use it to find, create, update and delete them.
+  #
+  class Calendar
+
+    # Setup and connect to the specified google calendar.
+    #  the +params+ paramater accepts
+    # * :username => the username of the specified calendar (i.e. some.guy@gmail.com)
+    # * :password => the password for the specified user (i.e. super-secret)
+    # * :calendar => the name of the calendar you would like to work with (optional, defaults to the calendar the user setup as their default one.)
+    # * :app_name => the name of your application (defaults to 'northworld.com-googlecalendar-integration')
+    # * :auth_url => the base url that is used to connect to google (defaults to 'https://www.google.com/accounts/ClientLogin')
+    #
+    # After creating an instace you are immediatly logged on and ready to go.
+    #
+    # ==== Examples
+    #   # Use the default calendar
+    #   Calendar.new(:username => 'some.guy@gmail.com', :password => 'ilovepie!')
+    #
+    #   # Specify the calendar
+    #   Calendar.new(:username => 'some.guy@gmail.com', :password => 'ilovepie!', :calendar => 'my.company@gmail.com')
+    #
+    #   # Specify the app_name
+    #   Calendar.new(:username => 'some.guy@gmail.com', :password => 'ilovepie!', :app_name => 'mycompany.com-googlecalendar-integration')
+    #
+
+    # Calendar attributes
+    attr_accessor :username, :password, :app_name, :auth_url, :connection, :calendar
+
+    def initialize(params)
+      self.username = params[:username]
+      self.password = params[:password]
+      self.calendar = params[:calendar]
+      self.app_name = params[:app_name]
+      self.auth_url = params[:auth_url]
+
+      self.connection = Connection.new(:username => username,
+                                   :password => password,
+                                   :app_name => app_name,
+                                   :auth_url => auth_url)
+    end
+
+    # Find all of the events associated with this calendar.
+    #  Returns:
+    #   nil if nothing found.
+    #   a single event if only one found.
+    #   an array of events if many found.
+    #
+    def events
+      event_lookup()
+    end
+
+    # This is equivalnt to running a search in
+    # the google calendar web application.  Google does not provide a way to easily specify
+    # what attributes you would like to search (i.e. title), by default it searches everything.
+    # If you would like to find specific attribute value (i.e. title=Picnic), run a query
+    # and parse the results.
+    #  Returns:
+    #   nil if nothing found.
+    #   a single event if only one found.
+    #   an array of events if many found.
+    #
+    def find_events(query)
+      event_lookup("?q=#{query}")
+    end
+
+    # Find all of the events associated with this calendar that start in the given time frame.
+    # The lower bound is inclusive, whereas the upper bound is exclusive.
+    # Events that overlap the range are included.
+    #  Returns:
+    #   nil if nothing found.
+    #   a single event if only one found.
+    #   an array of events if many found.
+    #
+    def find_events_in_range(start_min, start_max,query = nil)
+      formatted_start_min = start_min.strftime("%Y-%m-%dT%H:%M:%S")
+      formatted_start_max = start_max.strftime("%Y-%m-%dT%H:%M:%S")
+      if query
+        event_lookup("?q=#{query}&start-min=#{formatted_start_min}&start-max=#{formatted_start_max}&recurrence-expansion-start=#{formatted_start_min}&recurrence-expansion-end=#{formatted_start_max}")
+      else
+        event_lookup("?start-min=#{formatted_start_min}&start-max=#{formatted_start_max}&recurrence-expansion-start=#{formatted_start_min}&recurrence-expansion-end=#{formatted_start_max}")
+      end
+    end
+
+    # Attempts to find the event specified by the id
+    #  Returns:
+    #   nil if nothing found.
+    #   a single event if only one found.
+    #   an array of events if many found.
+    #
+    def find_event_by_id(id)
+      return nil unless id && id.strip != ''
+      event_lookup("/#{id}")
+    end
+
+    # Creates a new event and immediatly saves it.
+    # returns the event
+    #
+    # ==== Examples
+    #   # Use a block
+    #   cal.create_event do |e|
+    #     e.title = "A New Event"
+    #     e.where = "Room 101"
+    #   end
+    #
+    #   # Don't use a block (need to call save maunally)
+    #   event  = cal.create_event
+    #   event.title = "A New Event"
+    #   event.where = "Room 101"
+    #   event.save
+    #
+    def create_event(&blk)
+      setup_event(Event.new, &blk)
+    end
+
+    # looks for the spedified event id.
+    # If it is found it, updates it's vales and returns it.
+    # If the event is no longer on the server it creates a new one with the specified values.
+    # Works like the create_event method.
+    #
+    def find_or_create_event_by_id(id, &blk)
+      setup_event(find_event_by_id(id) || Event.new, &blk)
+    end
+
+    # Saves the specified event.
+    # This is a callback used by the Event class.
+    #
+    def save_event(event)
+      method = (event.id == nil || event.id == '') ? :post : :put
+      query_string = (method == :put) ? "/#{event.id}" : ''
+      @connection.send(Addressable::URI.parse(events_url + query_string), method, event.to_xml)
+    end
+
+    # Deletes the specified event.
+    # This is a callback used by the Event class.
+    #
+    def delete_event(event)
+      @connection.send(Addressable::URI.parse(events_url + "/#{event.id}"), :delete)
+    end
+
+    # Explicitly reload the connection to google calendar
+    #
+    # Examples
+    # class User
+    #   def calendar
+    #     @calendar ||= Google::Calendar.new :username => "foo@gmail.com", :password => "bar"
+    #   end
+    # end
+    # user = User.new
+    # 2.times { user.calendar }     #only one HTTP authentication request to google
+    # user.calendar.reload          #new HTTP authentication request to google
+    #
+    # Returns Google::Calendar instance
+    def reload
+      self.connection = Connection.new(:username => username,
+                                   :password => password,
+                                   :app_name => app_name,
+                                   :auth_url => auth_url)
+      self
+    end
+    
+    def display_color
+      calendar_data.xpath("//entry[title='#{@calendar}']/color/@value").first.value
+    end
+
+    protected
+
+    def event_lookup(query_string = '') #:nodoc:
+      begin
+      response = @connection.send(Addressable::URI.parse(events_url + query_string), :get)
+      events = Event.build_from_google_feed(response.body, self)
+      events.length > 1 ? events : events[0]
+      rescue Google::HTTPNotFound
+        return nil
+      end
+    end
+
+    def calendar_id #:nodoc:
+      @calendar || "default"
+    end
+
+    # Initialize the events URL given String attribute @calendar value :
+    #
+    # contains a '@'        : construct the feed url with @calendar.
+    # does not contain '@'  : fetch user's all calendars (http://code.google.com/apis/calendar/data/2.0/developers_guide_protocol.html#RetrievingAllCalendars)
+    #                         and return feed url matching @calendar.
+    # nil                   : default feed url.
+    #
+    # Returns:
+    #  a String url for a calendar feeds.
+    #  raise a Google::InvalidCalendar error if @calendar is invalid.
+    #
+    def events_url
+      if @calendar and !@calendar.include?("@")
+         link = calendar_data.xpath("//entry[title='#{@calendar}']/link[contains(@rel, '#eventFeed')]/@href").to_s
+         link.empty? ? raise(Google::InvalidCalendar) : link
+       else
+         "https://www.google.com/calendar/feeds/#{calendar_id}/private/full"
+      end
+    end
+    
+    def calendar_data
+      unless @calendar_data
+        xml = @connection.send(Addressable::URI.parse("https://www.google.com/calendar/feeds/default/allcalendars/full"), :get)
+        @calendar_data = Nokogiri::XML(xml.body)
+        @calendar_data.remove_namespaces!
+      end
+      @calendar_data
+    end
+
+    def setup_event(event) #:nodoc:
+      event.calendar = self
+       yield(event) if block_given?
+      event.save
+      event
+    end
+  end
+
+end