google_client 0.1.0 → 0.2.0

data/.rspec

@@ -1 +1,3 @@
---color --format doc
+--format documentation
+--colour
+--tty

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+
+# v0.2.0
+
+* Script folder with examples of use
+* Feature: added attendee status as a new attribute in the attendees list
+* Feature: fetch event by id
+* User#create_calendar allows an empty Hash as parameter
+* Create event: added parameters attendees and send_event_notifications
+* Create calendar: enable a block as parameter
+
+# v0.1.0  
+
+* First release
+

data/README.md

@@ -1,4 +1,3 @@
-
 This gem can be used to get access to a specific set of Google APIs.
 
 # Installation
@@ -20,33 +19,37 @@ This gem can be used to get access to a specific set of Google APIs.
 * Google Contacts
   * Fetch user contacts
 
+Take a look into [CHANGELOG.md](google_client/blob/master/CHANGELOG.md)
+
 # Getting started
 
 Any request that may be done on behalf of the user needs a valid authentication token:
 
-    require "gogole_client"
-    user = GoogleClient::User.new "user-authentication-token"
-
-    # Get user contacts
-    contacts = user.contacts
+```ruby
+require "gogole_client"
+user = GoogleClient::User.new "user-authentication-token"
 
-    # Get user calendars
-    calendars = user.calendars
+# Get user contacts
+contacts = user.contacts
 
-    # Get a specific user calendar
-    calendar = user.calendars("<calendar-id>")
+# Get user calendars
+calendars = user.calendars
 
-    # Fetch calendar events
-    events = calendar.events
+# Get a specific user calendar
+calendar = user.calendars("<calendar-id>")
 
-    # Create calendar
-    calendar = user.create_calendar({:title => "my-new-calendar", 
-                          :details => "Hello world", 
-                          :timezone => "Spain", :location => "Barcelona"})
+# Fetch calendar events
+events = calendar.events
 
-    # ...
+# Create calendar
+calendar = user.create_calendar({:title => "my-new-calendar", 
+                      :details => "Hello world", 
+                      :timezone => "Spain", :location => "Barcelona"})
+                      
+# ...
+```
 
-Take a look on the [user.rb](blob/master/lib/google_client/user.rb) file to check the available methods
+Take a look on the [user.rb](google_client/blob/master/lib/google_client/user.rb) file to check the available methods
 
 # Roadmap
 
@@ -89,4 +92,4 @@ Take a look on the [user.rb](blob/master/lib/google_client/user.rb) file to chec
     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.
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/google_client/calendar.rb

@@ -20,6 +20,7 @@ module GoogleClient
       @timezone = params[:timezone]
       @location = params[:location]
       @json_mode = true
+      block_given? and yield self
     end
 
     def to_s
@@ -78,8 +79,7 @@ module GoogleClient
         events = events["feed"]["entry"]
         events.map{ |event| Event.build_event(event, self)}
       elsif args.is_a?(String)
-        raise Error.new "Unable to fetch a Event by id"
-        #Event.new({:id => args, :calendar => self}).fetch
+        Event.new({:id => args, :calendar => self}).fetch
       elsif args.is_a?(Hash)
         if args.is_a?(Hash) && args.has_key?(:id)
           Event.new({:id => args[:id], :calendar => self}).fetch
@@ -103,6 +103,15 @@ module GoogleClient
               :to => (Time.now + time).strftime("%Y-%m-%dT%k:%M:%S").concat(timezone).gsub(/ /,"0")})
     end
 
+    # Create a new event in the calendar
+    # ==== Parameters
+    # * *params* Hash options
+    #   * c.send_event_notifications : true | false
+    #   * c.title                    : event title (string)
+    #   * c.description              : event detail description (string)
+    #   * c.start_time               : start time (time format)
+    #   * c.end_time                 : end time (time format)
+    #   * c.attendees                : array of emails or hashes with :name and :email
     def create_event(params = {})
       event = if block_given?
                     Event.create(params.merge({:calendar => self}), &Proc.new)

data/lib/google_client/event.rb

@@ -13,6 +13,7 @@ module GoogleClient
     attr_accessor :end_time
     attr_accessor :location
     attr_accessor :attendees
+    attr_accessor :send_event_notifications
     attr_accessor :comments
 
     def initialize(params = {})
@@ -25,7 +26,8 @@ module GoogleClient
       @calendar_id = params[:calendar_id]
       @calendar = params[:calendar]
       @comments = params[:comments]
-      @attendees = params[:attendees]
+      @attendees = params[:attendees].nil? ? [] : params[:attendees].map{|x| x.kind_of?(String) ? {:email => x} : x}
+      @send_event_notifications = params[:send_event_notifications]
 
       @calendar.nil? or @connection = @calendar.connection
       @json_mode = true
@@ -33,7 +35,7 @@ module GoogleClient
     end
 
     def to_s
-      "#{self.class.name} => { id: #{@id}, title: #{@title}, description: #{@description}, :start_time => #{@start_time}, :end_time => #{@end_time}, :location => #{@location}, :attendees => #{@attendees} }"
+      "#{self.class.name} => { id: #{@id}, title: #{@title}, description: #{@description}, :start_time => #{@start_time}, :end_time => #{@end_time}, :location => #{@location}, :attendees => #{@attendees}, :send_event_notifications => #{@send_event_notifications}, :calendar => #{@calendar} }"
     end
 
     def to_hash
@@ -42,7 +44,9 @@ module GoogleClient
         :details => @description,
         :timeZone => @timezone,
         :when => [{:start => @start_time,
-          :end => @end_time}]
+          :end => @end_time}],
+        :attendees => @attendees.map{|x| {:valueString => x[:name], :email => x[:email]}},
+        :sendEventNotifications  => @send_event_notifications || false
       }.delete_if{|k,v| v.nil?}
     end
 
@@ -97,7 +101,7 @@ module GoogleClient
         @calendar.nil? and raise Error.new "calendar or calendar_id must be valid in the event"
         @calendar_id = @calendar.id
       end
-      data = connection.get "/calendar/feeds/#{@calendar_id}/private/full/#{@id}"
+      data = decode_response connection.get "/calendar/feeds/#{@calendar_id}/private/full/#{@id}"
       self.class.build_event data["entry"], @calendar
     end
 
@@ -112,8 +116,17 @@ module GoogleClient
       end
 
       def build_event(data, calendar = nil)
+        data.nil? and return Event.new
+
         attendees = data["gd$who"]
-        attendees.nil? or attendees = attendees.map{|attendee| {:name => attendee["valueString"], :email => attendee["email"]}}
+        attendees.nil? or attendees = attendees.inject([]) do |values, attendee| 
+          if attendee.has_key?("gd$attendeeStatus")
+            values << { :name   => attendee["valueString"], 
+              :email  => attendee["email"], 
+              :status => attendee["gd$attendeeStatus"]["value"].split("\.").last}
+          end
+          values
+        end
 
         start_time = data["gd$when"][0]["startTime"]
         end_time = data["gd$when"][0]["endTime"]

data/lib/google_client/user.rb

@@ -95,7 +95,7 @@ module GoogleClient
     #
     # ==== Return
     # Calendar instance
-    def create_calendar(params)
+    def create_calendar(params = {})
       calendar = if block_given?
                     Calendar.create(params.merge({:user => self}), &Proc.new)
                   else

data/lib/google_client/version.rb

@@ -1,3 +1,3 @@
 module GoogleClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/scripts/create_calendar.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+timezone = "Spain"
+location = "Barcelona"
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.create_calendar do |c|
+  c.title    = "google_client"
+  c.details  = "Calendar created using google_client gem."
+  c.timezone = timezone
+  c.location = location
+end
+
+puts calendar

data/scripts/create_event.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.calendar(CALENDAR_ID)
+
+start_time = Time.now.strftime("%Y-%m-%dT%H:%M:%S.000%z")
+start_time = "#{start_time[0..-3]}:#{start_time[-2..-1]}"
+end_time   = (Time.now+60).strftime("%Y-%m-%dT%H:%M:%S.000%z")
+end_time   = "#{end_time[0..-3]}:#{end_time[-2..-1]}"
+
+event = calendar.create_event do |e|
+  e.send_event_notifications = true
+  e.title       = "This is a cool event"
+  e.description = "foo => bar"
+  e.start_time  = start_time
+  e.end_time    = end_time
+end
+
+puts event

data/scripts/delete_calendar.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.calendar(CALENDAR_ID)
+
+calendar.delete
+

data/scripts/delete_event.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.calendar(CALENDAR_ID)
+
+event = GoogleClient::Event.new({:id => ARGV.shift, :calendar => calendar})
+
+puts event.delete

data/scripts/fetch_calendar.rb

@@ -0,0 +1,13 @@
+
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+require 'pry'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.calendar(CALENDAR_ID)
+
+puts calendar
+

data/scripts/fetch_contacts.rb

@@ -0,0 +1,15 @@
+
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+require 'pry'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+begin
+  puts user.contacts
+rescue GoogleClient::AuthenticationError => ex
+  puts "Invalid token"
+end
+

data/scripts/fetch_events.rb

@@ -0,0 +1,16 @@
+
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+require 'pry'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+calendar = user.calendar(CALENDAR_ID)
+
+if ARGV.empty?
+  puts calendar.forthcoming_events(36000)
+else
+  puts calendar.events(ARGV.shift)
+end

data/scripts/refresh_token.rb

@@ -0,0 +1,10 @@
+
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+puts user.refresh REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET
+

data/scripts/user_profile.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.join("../", "lib")).unshift(".")
+
+require 'google_client'
+require 'script_config'
+
+user = GoogleClient::User.new AUTH_TOKEN
+
+puts user.profile

data/spec/calendar_spec.rb

@@ -11,8 +11,7 @@ describe GoogleClient::Calendar do
     GoogleClient::Calendar.new({:user => user, :id => CALENDAR_ID})
   end
 
-  describe "while initializing" do
-    
+  describe "while initializing" do    
     it "should set the OAuth credentials properly" do
       user.oauth_credentials.should eql(USER_TOKEN)
     end
@@ -21,13 +20,64 @@ describe GoogleClient::Calendar do
 
   describe "while fetching events" do
     it "should fetch all the calendar events when no param is provided" do      
-      pending("need to be developed")
+      http_connection = double("HttpConnection")
+      response = double("HttpResponse")
+      response.stub(:code) { 200 }
+      response.stub(:body) { "{\"version\":\"1.0\",\"encoding\":\"UTF-8\",\"feed\":\
+        {\"xmlns\":\"http://www.w3.org/2005/Atom\",\"xmlns$openSearch\":\"http://a9.com/-/spec/opensearchrss/1.0/\",\
+          \"xmlns$gCal\":\"http://schemas.google.com/gCal/2005\",\"xmlns$gd\":\"http://schemas.google.com/g/2005\",\
+          \"id\":{\"$t\":\"http://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full\"},\
+          \"updated\":{\"$t\":\"2011-11-13T22:11:56.000Z\"},\"category\":[{\"scheme\":\"http://schemas.google.com/g/2005#kind\",\
+          \"term\":\"http://schemas.google.com/g/2005#event\"}],\"title\":{\"$t\":\"connfurence\",\"type\":\"text\"},\
+          \"subtitle\":{\"$t\":\"This calendar must be used by the user to create conference events.\",\"type\":\"text\"},\
+          \"link\":[{\"rel\":\"alternate\",\"type\":\"text/html\",\
+          \"href\":\"https://www.google.com/calendar/embed?src=md8goqfs0pkpfbq0rintm786e4@group.calendar.google.com\"},\
+          {\"rel\":\"http://schemas.google.com/g/2005#feed\",\"type\":\"application/atom+xml\",\
+            \"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full\"},\
+            {\"rel\":\"http://schemas.google.com/g/2005#post\",\"type\":\"application/atom+xml\",\
+              \"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full\"},\
+              {\"rel\":\"http://schemas.google.com/g/2005#batch\",\"type\":\"application/atom+xml\",\
+                \"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full/batch\"},\
+                {\"rel\":\"self\",\"type\":\"application/atom+xml\",\
+                  \"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/\
+                  full?alt=json&max-results=25&start-min=2011-11-14T00%3A12%3A29%2B02%3A00&start-max=2011-11-14T10%3A12%3A29%2B02%3A00\"}],\
+                  \"author\":[{\"name\":{\"$t\":\"connfurence\"}}],\"generator\":{\"$t\":\"Google Calendar\",\"version\":\"1.0\",\
+                  \"uri\":\"http://www.google.com/calendar\"},\"openSearch$totalResults\":{\"$t\":1},\"openSearch$startIndex\":\
+                  {\"$t\":1},\"openSearch$itemsPerPage\":{\"$t\":25},\"gCal$timezone\":{\"value\":\"Asia/Jerusalem\"},\"gCal$timesCleaned\":\
+                  {\"value\":0},\"gd$where\":{\"valueString\":\"Tel Aviv\"},\"entry\":[{\"id\":{\"$t\":\
+                  \"http://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full/001q3b6f0n268mea33o59dopvs\"}\
+                  ,\"published\":{\"$t\":\"2011-11-13T22:11:55.000Z\"},\"updated\":{\"$t\":\"2011-11-13T22:11:55.000Z\"},\
+                  \"category\":[{\"scheme\":\"http://schemas.google.com/g/2005#kind\",\"term\":\"http://schemas.google.com/g/2005#event\"}],\
+                  \"title\":{\"$t\":\"This is a cool event\",\"type\":\"text\"},\"content\":{\"$t\":\"foo =\u003e bar\",\"type\":\"text\"},\
+                  \"link\":[{\"rel\":\"alternate\",\"type\":\"text/html\",\"href\":\"https://www.google.com/calendar/event?eid=MDAxcTNiNmYwbjI2OG1lYTMzbzU5ZG9wdnMgbWQ4Z29xZnMwcGtwZmJxMHJpbnRtNzg2ZTRAZw\",\"title\":\"alternate\"},{\"rel\":\"self\",\"type\":\"application/atom+xml\",\"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full/001q3b6f0n268mea33o59dopvs\"},{\"rel\":\"edit\",\"type\":\"application/atom+xml\",\"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full/001q3b6f0n268mea33o59dopvs/63456905515\"}],\"author\":[{\"name\":{\"$t\":\"juandebravo@gmail.com\"},\"email\":{\"$t\":\"juandebravo@gmail.com\"}}],\"gd$comments\":{\"gd$feedLink\":{\"href\":\"https://www.google.com/calendar/feeds/md8goqfs0pkpfbq0rintm786e4%40group.calendar.google.com/private/full/001q3b6f0n268mea33o59dopvs/comments\"}},\"gd$eventStatus\":{\"value\":\"http://schemas.google.com/g/2005#event.confirmed\"},\"gd$where\":[{}],\"gd$who\":[{\"email\":\"md8goqfs0pkpfbq0rintm786e4@group.calendar.google.com\",\"rel\":\"http://schemas.google.com/g/2005#event.organizer\",\"valueString\":\"connfurence\"}],\"gd$when\":[{\"endTime\":\"2011-11-14T00:13:07.000+02:00\",\"startTime\":\"2011-11-14T00:12:07.000+02:00\"}],\"gd$transparency\":{\"value\":\"http://schemas.google.com/g/2005#event.opaque\"},\"gd$visibility\":{\"value\":\"http://schemas.google.com/g/2005#event.default\"},\"gCal$anyoneCanAddSelf\":{\"value\":\"false\"},\"gCal$guestsCanInviteOthers\":{\"value\":\"true\"},\"gCal$guestsCanModify\":{\"value\":\"false\"},\"gCal$guestsCanSeeGuests\":{\"value\":\"true\"},\"gCal$sequence\":{\"value\":0},\"gCal$uid\":{\"value\":\"001q3b6f0n268mea33o59dopvs@google.com\"}}]}}"}
+      
+      http_connection.stub(:get).with("/calendar/feeds/#{CALENDAR_ID}/private/full") {
+        response        
+      }
+      calendar.stub(:connection) { http_connection }
+
+      events = calendar.events
+      events.length.should == 1
+      event = events[0]
+      event.should be_instance_of GoogleClient::Event
+      event.id.should == "001q3b6f0n268mea33o59dopvs"
+      event.title.should == "This is a cool event"
+      event.description.should == "foo => bar"
+      event.start_time.should == "2011-11-14T00:12:07.000+02:00"
+      event.end_time.should == "2011-11-14T00:13:07.000+02:00"
     end
   end
 
   describe "while deleting a calendar" do
     it "should delete the calendar when a valid id is set" do
-      pending("need to be developed")
+      http_connection = double("HttpConnection")
+      response = double("HttpResponse")
+      response.stub(:code) { 200 }
+      http_connection.stub(:delete).with("/calendar/feeds/default/owncalendars/full/#{CALENDAR_ID}") {
+        response        
+      }
+      calendar.stub(:connection) { http_connection }
+      calendar.delete.should be_true
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-06 00:00:00.000000000Z
+date: 2011-11-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2157293120 !ruby/object:Gem::Requirement
+  requirement: &2156255200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157293120
+  version_requirements: *2156255200
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &2157280100 !ruby/object:Gem::Requirement
+  requirement: &2156251080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157280100
+  version_requirements: *2156251080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157279480 !ruby/object:Gem::Requirement
+  requirement: &2156250640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157279480
+  version_requirements: *2156250640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157277600 !ruby/object:Gem::Requirement
+  requirement: &2156250220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157277600
+  version_requirements: *2156250220
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2157275880 !ruby/object:Gem::Requirement
+  requirement: &2156249780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157275880
+  version_requirements: *2156249780
 description: This gem is a wrapper on top of the Google API that allows a developer
   to handle calendars, events, contacts on behalf of the user.
 email:
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -93,6 +94,15 @@ files:
 - lib/google_client/profile.rb
 - lib/google_client/user.rb
 - lib/google_client/version.rb
+- scripts/create_calendar.rb
+- scripts/create_event.rb
+- scripts/delete_calendar.rb
+- scripts/delete_event.rb
+- scripts/fetch_calendar.rb
+- scripts/fetch_contacts.rb
+- scripts/fetch_events.rb
+- scripts/refresh_token.rb
+- scripts/user_profile.rb
 - spec/calendar_spec.rb
 - spec/contact_spec.rb
 - spec/event_spec.rb