google_calendar 0.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac5c278ba3dc50398192d02b52e133f0dbf7394d
-  data.tar.gz: 69d8905b95b054d7c373243f4237ce9dfc434c1e
+  metadata.gz: fc05a032b27f92d14375477f9f114fb4b57aafca
+  data.tar.gz: 7068f8e73c52864a6e0d77e26553a8a0c7e00a23
 SHA512:
-  metadata.gz: a5237336f30472193452d47bd2690b04ea6c574f86eafa2add99b97ad1ee6f90a489066fac7c47f18e4a630262847c14e44ce2713d764bd5f3a3b2508def7740
-  data.tar.gz: e54a2cb56293fd44585e15da46e236e0eef390d7cdff5efe23418be2bc096b1f471740f663cd3dddf9b22e620df65ee9241a752a9f57e12310843088baa904a8
+  metadata.gz: 21c6b93987a1c3a0f4f3a4a8dbd9cd8cdecaa36bb5168f796999f0567ebf0d43ef4b03490413debca6b2b01b1bcf34163047cee5a822af7fdaae46724ffc6c81
+  data.tar.gz: e159da8702d8621b4c0f2b434f64b9989a45a1d912e29d8000444b67de86613e9924f6b697aea58d1bfdeeca2b4a6834c4ec8d884a1a1a48a8fe6761e9d8fd6b

data/.gitignore

@@ -34,4 +34,5 @@ tmtags
 # For vim:
 #*.swp
 notes.md
-test_harness.rb
+test_harness.rb
+*.gem

data/Gemfile.lock

@@ -1,46 +1,51 @@
 PATH
   remote: .
   specs:
-    google_calendar (0.5)
+    google_calendar (0.5.1)
+      TimezoneParser (~> 0.2.0)
       json (~> 1.8)
       signet (~> 0.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    TimezoneParser (0.2.0)
+      insensitive_hash
+      tzinfo
     addressable (2.3.8)
     ansi (1.5.0)
     builder (3.2.2)
-    codeclimate-test-reporter (0.4.7)
+    codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     docile (1.1.5)
     extlib (0.9.16)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    json (1.8.2)
-    jwt (1.5.0)
+    insensitive_hash (0.3.3)
+    json (1.8.3)
+    jwt (1.5.1)
     metaclass (0.0.4)
-    minitest (5.6.1)
-    minitest-reporters (1.0.16)
+    minitest (5.8.1)
+    minitest-reporters (1.1.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.11.0)
+    multi_json (1.11.2)
     multipart-post (2.0.0)
     rake (10.4.2)
-    rb-fsevent (0.9.5)
+    rb-fsevent (0.9.6)
     rdoc (4.2.0)
       json (~> 1.4)
     ruby-progressbar (1.7.5)
     shoulda-context (1.2.1)
-    signet (0.6.0)
+    signet (0.6.1)
       addressable (~> 2.3)
       extlib (~> 0.9)
       faraday (~> 0.9)
-      jwt (~> 1.0)
+      jwt (~> 1.5)
       multi_json (~> 1.10)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -48,6 +53,9 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     terminal-notifier-guard (1.6.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/VERSION

@@ -1 +1 @@
-0.5
+0.5.1

data/google_calendar.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name = "google_calendar"
-  s.version = "0.5"
-  s.date = "2014-11-30"
+  s.version = "0.5.1"
+  s.date = "2015-10-05"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency(%q<signet>, ["~> 0.6"])
   s.add_runtime_dependency(%q<json>, ["~> 1.8"])
+  s.add_runtime_dependency(%q<TimezoneParser>, ["~> 0.2.0"])
 
   s.add_development_dependency(%q<terminal-notifier-guard>, ["~> 1.6"])
   s.add_development_dependency(%q<rb-fsevent>, ["~> 0.9"])

data/lib/google/calendar.rb

@@ -31,13 +31,40 @@ module Google
         :client_id => params[:client_id],
         :client_secret => params[:client_secret],
         :refresh_token => params[:refresh_token],
-        :redirect_url => params[:redirect_url]
+        :redirect_url => params[:redirect_url],
+        :state => params[:state]
       )
 
       @id = params[:calendar]
       # raise CalendarIDMissing unless @id
     end
 
+    #
+    # Setup, connect and create a Google Calendar.
+    #  the +params+ paramater accepts
+    # * :client_id => the client ID that you received from Google after registering your application with them (https://console.developers.google.com/). REQUIRED
+    # * :client_secret => the client secret you received from Google after registering your application with them. REQUIRED
+    # * :redirect_url => the url where your users will be redirected to after they have successfully permitted access to their calendars. Use 'urn:ietf:wg:oauth:2.0:oob' if you are using an 'application'" REQUIRED
+    # * :summary => title of the calendar being created.
+    # * :refresh_token => if a user has already given you access to their calendars, you can specify their refresh token here and you will be 'logged on' automatically (i.e. they don't need to authorize access again). OPTIONAL
+    #
+    # See Readme.rdoc or readme_code.rb for an explication on the OAuth2 authorization process.
+    #
+    # ==== Example
+    # Google::Calendar.create(
+    #                         :client_id => YOUR_CLIENT_ID,
+    #                         :client_secret => YOUR_SECRET,
+    #                         :summary => 'Test Calendar',
+    #                         :redirect_url => "urn:ietf:wg:oauth:2.0:oob" # this is what Google uses for 'applications'
+    #                        )
+    #
+    def self.create(params={}, connection=nil)
+      cal = new(params, connection)
+      cal.instance_variable_set(:@summary, params[:summary])
+
+      cal.save
+    end
+
     #
     # The URL you need to send a user in order to let them grant you access to their calendars.
     #
@@ -80,6 +107,16 @@ module Google
       @connection.login_with_refresh_token(refresh_token)
     end
 
+    #
+    # Save a new calender.
+    #  Returns:
+    #   the calendar that was saved.
+    #
+    def save
+      response = send_calendar_request("/", :post, {:summary => @summary}.to_json)
+      update_after_save(response)
+    end
+
     #
     # Find all of the events associated with this calendar.
     #  Returns:
@@ -97,6 +134,11 @@ module Google
     # 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.
+    #
+    # Note that it is not possible to query the extended properties using queries.
+    # If you need to do so, use the alternate methods find_events_by_extended_property
+    # and find_events_by_extended_property_in_range
+    #
     #  Returns:
     #   an empty array if nothing found.
     #   an array with one element if only one found.
@@ -147,6 +189,70 @@ module Google
       event_lookup(query)
     end
 
+    #
+    # Find all events that match at least one of the specified extended properties.
+    #
+    # the +extended_properties+ parameter is set up the same way that it is configured when creating an event
+    # for example, providing the following hash { 'shared' => {'p1' => 'v1', 'p2' => v2} } will return the list of events
+    # that contain either v1 for shared extended property p1 or v2 for p2.
+    #
+    # the +options+ parameter accepts
+    # :max_results => the maximum number of results to return defaults to 25 the largest number Google accepts is 2500
+    # :order_by => how you would like the results ordered, can be either 'startTime' or 'updated'. Defaults to 'startTime'. Note: it must be 'updated' if expand_recurring_events is set to false.
+    # :expand_recurring_events => When set to true each instance of a recurring event is returned. Defaults to true.
+    #
+    #  Returns:
+    #   an empty array if nothing found.
+    #   an array with one element if only one found.
+    #   an array of events if many found.
+    #
+    def find_events_by_extended_properties(extended_properties, options = {})
+      query_parts = []
+      ['shared', 'private'].each do |prop_type|
+        if extended_properties[prop_type]
+          query_parts << extended_properties[prop_type].map do |key, value|
+            (prop_type == "shared" ? "sharedExtendedProperty=" : "privateExtendedProperty=") + "#{key}%3D#{value}"
+          end.join("&")
+        end
+      end
+      query = "?" + query_parts.join('&') + parse_options(options)
+      event_lookup(query)
+    end
+
+    #
+    # Find all events that match at least one of the specified extended properties within a given time frame.
+    # The lower bound is inclusive, whereas the upper bound is exclusive.
+    # Events that overlap the range are included.
+    #
+    # the +extended_properties+ parameter is set up the same way that it is configured when creating an event
+    # for example, providing the following hash { 'shared' => {'p1' => 'v1', 'p2' => v2} } will return the list of events
+    # that contain either v1 for shared extended property p1 or v2 for p2.
+    #
+    # the +options+ parameter accepts
+    # :max_results => the maximum number of results to return defaults to 25 the largest number Google accepts is 2500
+    # :order_by => how you would like the results ordered, can be either 'startTime' or 'updated'. Defaults to 'startTime'. Note: it must be 'updated' if expand_recurring_events is set to false.
+    # :expand_recurring_events => When set to true each instance of a recurring event is returned. Defaults to true.
+    #
+    #  Returns:
+    #   an empty array if nothing found.
+    #   an array with one element if only one found.
+    #   an array of events if many found.
+    #
+    def find_events_by_extended_properties_in_range(extended_properties, start_min, start_max, options = {})
+      query_parts = []
+      ['shared', 'private'].each do |prop_type|
+        if extended_properties[prop_type]
+          query_parts << extended_properties[prop_type].map do |key, value|
+            (prop_type == "shared" ? "sharedExtendedProperty=" : "privateExtendedProperty=") + "#{key}%3D#{value}"
+          end.join("&")
+        end
+      end
+      formatted_start_min = encode_time(start_min)
+      formatted_start_max = encode_time(start_max)
+      query = "?" + query_parts.join('&') + (query_parts.length > 0 ? '&':'') + "timeMin=#{formatted_start_min}&timeMax=#{formatted_start_max}#{parse_options(options)}"
+      event_lookup(query)
+    end
+
     #
     # Attempts to find the event specified by the id
     #  Returns:
@@ -155,7 +261,7 @@ module Google
     #   an array of events if many found.
     #
     def find_event_by_id(id)
-      return nil unless id 
+      return nil unless id
       event_lookup("/#{id}")
     end
 
@@ -201,7 +307,6 @@ module Google
     def save_event(event)
       method = event.new_event? ? :post : :put
       body = event.use_quickadd? ? nil : event.to_json
-
       query_string =  if event.use_quickadd?
         "/quickAdd?text=#{event.title}"
       elsif event.new_event?
@@ -223,6 +328,18 @@ module Google
 
     protected
 
+    #
+    # Set the ID after google assigns it (only necessary when we are creating a new event)
+    #
+    def update_after_save(response) #:nodoc:
+      return if @id && @id != ''
+      @raw = JSON.parse(response.body)
+      @id = @raw['id']
+      @html_link = @raw['htmlLink']
+
+      self
+    end
+
     #
     # Utility method used to centralize the parsing of common query parameters.
     #
@@ -252,7 +369,7 @@ module Google
         return events if events.empty?
         events.length > 1 ? events : [events[0]]
       rescue Google::HTTPNotFound
-        return nil
+        return []
       end
     end
 
@@ -268,6 +385,13 @@ module Google
       event
     end
 
+    #
+    # Wraps the `send` method. Send a calendar related request to Google.
+    #
+    def send_calendar_request(path_and_query_string, method, content = '')
+      @connection.send("/calendars#{path_and_query_string}", method, content)
+    end
+
     #
     # Wraps the `send` method. Send an event related request to Google.
     #

data/lib/google/connection.rb

@@ -40,6 +40,7 @@ module Google
         :client_secret => params[:client_secret],
         :redirect_uri => params[:redirect_url],
         :refresh_token => params[:refresh_token],
+        :state => params[:state],
         :authorization_uri => AUTH_URI,
         :token_credential_uri => TOKEN_URI,
         :scope => SCOPE
@@ -110,7 +111,6 @@ module Google
     def send(path, method, content = '')
 
       uri = BASE_URI + path
-
       response = @client.fetch_protected_resource(
         :uri => uri,
         :method => method,

data/lib/google/event.rb

@@ -1,5 +1,6 @@
 require 'time'
 require 'json'
+require 'timezone_parser'
 
 module Google
 
@@ -26,10 +27,11 @@ module Google
   # * +html_link+ - An absolute link to this event in the Google Calendar Web UI. Read only.
   # * +raw+ - The full google json representation of the event. Read only.
   # * +visibility+ - The visibility of the event (*'default'*, 'public', 'private', 'confidential'). Read Write.
+  # * +extended_properties - Custom properties which may be shared or private. Read Write
   #
   class Event
     attr_reader :raw, :html_link, :status
-    attr_accessor :id, :title, :location, :calendar, :quickadd, :transparency, :attendees, :description, :reminders, :recurrence, :visibility, :creator_name, :color_id
+    attr_accessor :id, :title, :location, :calendar, :quickadd, :transparency, :attendees, :description, :reminders, :recurrence, :visibility, :creator_name, :color_id, :extended_properties
 
     #
     # Create a new event, and optionally set it's attributes.
@@ -52,9 +54,10 @@ module Google
     #                     {'email' => 'some.a.one@gmail.com', 'displayName' => 'Some A One', 'responseStatus' => 'tentative'},
     #                     {'email' => 'some.b.one@gmail.com', 'displayName' => 'Some B One', 'responseStatus' => 'tentative'}
     #                   ]
+    # event.extendedProperties = {'shared' => {'custom_str' => 'some custom string'}}
     #
     def initialize(params = {})
-      [:id, :status, :raw, :html_link, :title, :location, :calendar, :quickadd, :attendees, :description, :reminders, :recurrence, :start_time, :end_time, :color_id].each do |attribute|
+      [:id, :status, :raw, :html_link, :title, :location, :calendar, :quickadd, :attendees, :description, :reminders, :recurrence, :start_time, :end_time, :color_id, :extended_properties].each do |attribute|
         instance_variable_set("@#{attribute}", params[attribute])
       end
 
@@ -181,6 +184,27 @@ module Google
       @recurrence ||= {}
     end
 
+    #
+    # Stores custom data within extended properties which can be shared or private.
+    #
+    # Allowed contents:
+    # :private => a hash containing custom key/values (strings) private to the event   OPTIONAL
+    # :shared => a hash containing custom key/values (strings) shared with others       OPTIONAL
+    #
+    # Note: Both private and shared can be specified at once
+    #
+    # ===== Example
+    # event = cal.create_event do |e|
+    #   e.title = 'Work-day Event'
+    #   e.start_time = Time.now
+    #   e.end_time = Time.now + (60 * 60) # seconds * min
+    #   e.extended_properties = {'shared' => {'prop1' => 'value 1'}}
+    # end
+    #
+    def extended_properties
+      @extended_properties ||= {}
+    end
+
     #
     # Utility method that simplifies setting the transparency of an event.
     # You can pass true or false.  Defaults to transparent.
@@ -216,7 +240,7 @@ module Google
       if val
         @visibility = Event.parse_visibility(val)
       else
-        @visibility = "default"      
+        @visibility = "default"
       end
     end
 
@@ -248,6 +272,7 @@ module Google
         #{recurrence_json}
         #{color_json}
         #{attendees_json}
+        #{extended_properties_json}
         \"reminders\": {
           #{reminders_json}
         }
@@ -303,7 +328,9 @@ module Google
     # JSON representation of local timezone
     #
     def local_timezone_json
-      ",\"timeZone\" : \"#{Time.now.getlocal.zone}\""
+      tz = Time.now.getlocal.zone
+      tz_name = TimezoneParser::getTimezones(tz).last
+      ",\"timeZone\" : \"#{tz_name}\""
     end
 
     #
@@ -319,6 +346,28 @@ module Google
       "\"recurrence\": [\n\"#{rrule}\"],"
     end
 
+    #
+    # JSON representation of extended properties
+    # shared : whether this should handle shared or public properties
+    #
+    def extended_properties_json
+      return unless @extended_properties && (@extended_properties['shared'] || @extended_properties['private'])
+      json_extended_properties = []
+      ['shared', 'private'].each do |prop_type|
+        if @extended_properties[prop_type]
+          props_json = @extended_properties[prop_type].map do |key, value|
+            "\"#{key}\": \"#{value}\""
+          end.join(",\n")
+          json_extended_properties << "\"#{prop_type}\": {\n
+                                          #{props_json}
+                                      }\n"
+        end
+      end
+      "\n\"extendedProperties\": {\n
+        #{json_extended_properties.join(',')}\n
+      },\n"
+    end
+
     #
     # String representation of an event object.
     #
@@ -381,7 +430,8 @@ module Google
                 :attendees    => e['attendees'],
                 :recurrence   => Event.parse_recurrence_rule(e['recurrence']),
                 :visibility   => e['visibility'],
-                :color_id     => e['colorId'])
+                :color_id     => e['colorId'],
+                :extended_properties => e['extendedProperties'])
 
     end
 
@@ -402,14 +452,16 @@ module Google
     #
     # Set the ID after google assigns it (only necessary when we are creating a new event)
     #
-    def update_after_save(respose) #:nodoc:
+    def update_after_save(response) #:nodoc:
       return if @id && @id != ''
-      @raw = JSON.parse(respose.body)
+      @raw = JSON.parse(response.body)
       @id = @raw['id']
       @html_link = @raw['htmlLink']
     end
 
     def self.parse_json_time(time_hash)
+      return nil unless time_hash
+
       if time_hash['date']
         Time.parse(time_hash['date']).utc
       elsif time_hash['dateTime']
@@ -431,14 +483,14 @@ module Google
     # Validates id format
     #
     def self.parse_id(id)
-      raise ArgumentError, "Event ID is invalid. Please check Google documentation: https://developers.google.com/google-apps/calendar/v3/reference/events/insert" unless id.gsub(/(^[a-v0-9]{5,1024}$)/o)      
+      raise ArgumentError, "Event ID is invalid. Please check Google documentation: https://developers.google.com/google-apps/calendar/v3/reference/events/insert" unless id.gsub(/(^[a-v0-9]{5,1024}$)/o)
     end
 
     #
     # Validates visibility value
     #
     def self.parse_visibility(visibility)
-      raise ArgumentError, "Event visibility must be 'default', 'public', 'private' or 'confidential'." unless ['default', 'public', 'private', 'confidential'].include?(visibility)    
+      raise ArgumentError, "Event visibility must be 'default', 'public', 'private' or 'confidential'." unless ['default', 'public', 'private', 'confidential'].include?(visibility)
       return visibility
     end