google_calendar 0.6.2 → 0.7.0

data/lib/google/errors.rb

@@ -1,8 +1,78 @@
 module Google
-  class HTTPRequestFailed < StandardError; end
+  # Signet::AuthorizationError
+  # Not part of Google Calendar API Errors
   class HTTPAuthorizationFailed < StandardError; end
+
+  # Google Calendar API Errors per documentation
+  # https://developers.google.com/google-apps/calendar/v3/errors
+  
+  # 400: Bad Request
+  #
+  # User error. This can mean that a required field or parameter has not been
+  # provided, the value supplied is invalid, or the combination of provided
+  # fields is invalid.
+  class HTTPRequestFailed < StandardError; end
+
+  # 401: Invalid Credentials
+  #
+  # Invalid authorization header. The access token you're using is either
+  # expired or invalid.
+  class InvalidCredentialsError < StandardError; end
+
+  # 403: Daily Limit Exceeded
+  #
+  # The Courtesy API limit for your project has been reached.
+  class DailyLimitExceededError < StandardError; end
+
+  # 403: User Rate Limit Exceeded
+  #
+  # The per-user limit from the Developer Console has been reached.
+  class UserRateLimitExceededError < StandardError; end
+  
+  # 403: Rate Limit Exceeded
+  #
+  # The user has reached Google Calendar API's maximum request rate per
+  # calendar or per authenticated user.
+  class RateLimitExceededError < StandardError; end
+
+  # 403: Calendar usage limits exceeded
+  #
+  # The user reached one of the Google Calendar limits in place to protect
+  # Google users and infrastructure from abusive behavior.
+  class CalendarUsageLimitExceededError < StandardError; end
+
+  # 404: Not Found
+  #
+  # The specified resource was not found.
   class HTTPNotFound < StandardError; end
-  class HTTPTooManyRedirections < StandardError; end
-  class InvalidCalendar < StandardError; end
-  class CalenarIDMissing < StandardError; end
+
+  # 409: The requested identifier already exists
+  #
+  # An instance with the given ID already exists in the storage.
+  class RequestedIdentifierAlreadyExistsError < StandardError; end
+
+  # 410: Gone
+  #
+  # SyncToken or updatedMin parameters are no longer valid. This error can also
+  # occur if a request attempts to delete an event that has already been
+  # deleted.
+  class GoneError < StandardError; end
+
+  # 412: Precondition Failed
+  #
+  # The etag supplied in the If-match header no longer corresponds to the
+  # current etag of the resource.
+  class PreconditionFailedError < StandardError; end
+
+  # 500: Backend Error
+  #
+  # An unexpected error occurred while processing the request.
+  class BackendError < StandardError; end
+
+  #
+  # 403: Forbidden Error
+  #
+  # User has no authority to conduct the requested operation on the resource.
+  # This is not a part of official Google Calendar API Errors documentation.
+  class ForbiddenError < StandardError; end
 end

data/lib/google/event.rb

@@ -1,5 +1,6 @@
 require 'time'
 require 'json'
+require 'sorted_set' # TimezoneParser relies on the top-level SortedSet, removed from stdlib in Ruby 3.2+
 require 'timezone_parser'
 
 module Google
@@ -120,7 +121,7 @@ module Google
     # Returns whether the Event is an all-day event, based on whether the event starts at the beginning and ends at the end of the day.
     #
     def all_day?
-      time = (@start_time.is_a?  String) ? Time.parse(@start_time) : @start_time.dup.utc
+      time = (@start_time.is_a? String) ? Time.parse(@start_time) : @start_time.dup.utc
       duration % (24 * 60 * 60) == 0 && time == Time.local(time.year,time.month,time.day)
     end
 
@@ -216,10 +217,10 @@ module Google
     # You can pass true or false.  Defaults to transparent.
     #
     def transparency=(val)
-      if val == false || val.to_s.downcase == 'opaque'
-        @transparency = 'opaque'
-      else
+      if val == true || val.to_s.downcase == 'transparent'
         @transparency = 'transparent'
+      else
+        @transparency = 'opaque'
       end
     end
 
@@ -314,7 +315,7 @@ module Google
       return {} unless @attendees
 
       attendees = @attendees.map do |attendee|
-        attendee.select { |k,v| ['displayName', 'email', 'responseStatus'].include?(k) }
+        attendee.select { |k,_v| ['displayName', 'email', 'responseStatus'].include?(k) }
       end
 
       { "attendees" => attendees }
@@ -396,7 +397,7 @@ module Google
     def extended_properties_attributes
       return {} unless @extended_properties && (@extended_properties['shared'] || @extended_properties['private'])
 
-      { "extendedProperties" => @extended_properties.select {|k,v| ['shared', 'private'].include?(k) } }
+      { "extendedProperties" => @extended_properties.select {|k,_v| ['shared', 'private'].include?(k) } }
     end
 
     #

data/lib/google/freebusy.rb

@@ -16,7 +16,7 @@ module Google
     # The +params+ parameter 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
+    # * :redirect_url => the url where your users will be redirected to after they have successfully permitted access to their calendars. REQUIRED
     # * :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.
@@ -46,7 +46,7 @@ module Google
     private
 
     #
-    # Prepare the JSON 
+    # Prepare the JSON
     #
     def json_for_query(calendar_ids, start_time, end_time)
       {}.tap{ |obj|
@@ -62,10 +62,9 @@ module Google
       return nil unless query_result['calendars'].is_a? Hash
 
       query_result['calendars'].each_with_object({}) do |(calendar_id, value), result|
+        value['busy'].each { |date_times| date_times.transform_values! { |date_time| DateTime.parse(date_time) } }
         result[calendar_id] = value['busy'] || []
       end
     end
-
   end
-
 end

data/readme_code.rb

@@ -12,7 +12,7 @@ require 'google_calendar'
 cal = Google::Calendar.new(:client_id     => YOUR_CLIENT_ID,
                            :client_secret => YOUR_SECRET,
                            :calendar      => YOUR_CALENDAR_ID,
-                           :redirect_url  => "urn:ietf:wg:oauth:2.0:oob" # this is what Google uses for 'applications'
+                           :redirect_url  => YOUR_REDIRECT_URL # this is what Google uses for 'applications'
                            )
 
 puts "Do you already have a refresh token? (y/n)"
@@ -23,7 +23,7 @@ if has_token.downcase != 'y'
   # A user needs to approve access in order to work with their calendars.
   puts "Visit the following web page in your browser and approve access."
   puts cal.authorize_url
-  puts "\nCopy the code that Google returned and paste it here:"
+  puts "\nCopy the code out of the paramters after Google redirects you to your provided redirect_url"
 
   # Pass the ONE TIME USE access code here to login and get a refresh token that you can use for access from now on.
   refresh_token = cal.login_with_auth_code( $stdin.gets.chomp )

data/test/helper.rb

@@ -14,7 +14,7 @@ end
 require "minitest/autorun"
 require 'minitest/reporters'
 require 'shoulda/context'
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'faraday'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/test/mocks/400.json

@@ -0,0 +1,15 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "calendar",
+    "reason": "timeRangeEmpty",
+    "message": "The specified time range is empty.",
+    "locationType": "parameter",
+    "location": "timeMax",
+   }
+  ],
+  "code": 400,
+  "message": "The specified time range is empty."
+ }
+}

data/test/mocks/401.json

@@ -1,15 +1,15 @@
 {
-  "error": {
-    "code": 401, 
-    "message": "Invalid Credentials", 
-    "errors": [
-      {
-        "locationType": "header", 
-        "domain": "global", 
-        "message": "Invalid Credentials", 
-        "reason": "authError", 
-        "location": "Authorization"
-      }
-    ]
-  }
+ "error": {
+  "errors": [
+   {
+    "domain": "global",
+    "reason": "authError",
+    "message": "Invalid Credentials",
+    "locationType": "header",
+    "location": "Authorization",
+   }
+  ],
+  "code": 401,
+  "message": "Invalid Credentials"
+ }
 }

data/test/mocks/403_calendar_rate_limit.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "message": "Calendar usage limits exceeded.",
+    "reason": "quotaExceeded"
+   }
+  ],
+  "code": 403,
+  "message": "Calendar usage limits exceeded."
+ }
+}

data/test/mocks/403_daily_limit.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "reason": "dailyLimitExceeded",
+    "message": "Daily Limit Exceeded"
+   }
+  ],
+  "code": 403,
+  "message": "Daily Limit Exceeded"
+ }
+}

data/test/mocks/403_forbidden.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "reason": "ForbiddenError",
+    "message": "Forbidden"
+   }
+  ],
+  "code": 403,
+  "message": "Forbidden"
+ }
+}

data/test/mocks/403_rate_limit.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "reason": "rateLimitExceeded",
+    "message": "Rate Limit Exceeded"
+   }
+  ],
+  "code": 403,
+  "message": "Rate Limit Exceeded"
+ }
+}

data/test/mocks/403_unknown.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "reason": "SomeRandomError",
+    "message": "RandomError"
+   }
+  ],
+  "code": 403,
+  "message": "RandomError"
+ }
+}

data/test/mocks/403_user_rate_limit.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "usageLimits",
+    "reason": "userRateLimitExceeded",
+    "message": "User Rate Limit Exceeded"
+   }
+  ],
+  "code": 403,
+  "message": "User Rate Limit Exceeded"
+ }
+}

data/test/mocks/409.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "global",
+    "reason": "duplicate",
+    "message": "The requested identifier already exists."
+   }
+  ],
+  "code": 409,
+  "message": "The requested identifier already exists."
+ }
+}

data/test/mocks/410.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "global",
+    "reason": "deleted",
+    "message": "Resource has been deleted"
+   }
+  ],
+  "code": 410,
+  "message": "Resource has been deleted"
+ }
+}

data/test/mocks/412.json

@@ -0,0 +1,15 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "global",
+    "reason": "conditionNotMet",
+    "message": "Precondition Failed",
+    "locationType": "header",
+    "location": "If-Match",
+    }
+  ],
+  "code": 412,
+  "message": "Precondition Failed"
+ }
+}

data/test/mocks/500.json

@@ -0,0 +1,13 @@
+{
+ "error": {
+  "errors": [
+   {
+    "domain": "global",
+    "reason": "backendError",
+    "message": "Backend Error",
+   }
+  ],
+  "code": 500,
+  "message": "Backend Error"
+ }
+}

data/test/mocks/create_calendar.json

@@ -0,0 +1,6 @@
+{
+ "kind": "calendar#calendar",
+ "etag": "\"W8S50vTLOjlc76YTrehSZVQwSEE/ai1KY6CkM6KpTpfYTn2jy_Z5fsc\"",
+ "id": "djg1ts9g20ih03ccb0fgsegkio@group.calendar.google.com",
+ "summary": "A New Calendar"
+}

data/test/mocks/get_calendar.json

@@ -0,0 +1,9 @@
+{
+ "kind": "calendar#calendar",
+ "etag": "\"W8S50vTLOjlc76YTghtSZVQwSEE/cpIguMlgGWrAb4L_lleRpa2ALCA\"",
+ "id": "gqeb0i6v737kfu5md0f35htjlg@group.calendar.google.com",
+ "summary": "Some Calendar",
+ "description": "Our work events",
+ "location": "Portland",
+ "timeZone": "America/Los_Angeles"
+}

data/test/mocks/update_calendar.json

@@ -0,0 +1,7 @@
+{
+ "kind": "calendar#calendar",
+ "etag": "\"W8S50vTLOjlc76YTghtSZVQwSEE/cpIguMlgGWrAb4L_lleRpa2ALCA\"",
+ "id": "gqeb0i6v737kfu5md0f35htjlg@group.calendar.google.com",
+ "summary": "Our Company",
+ "description": "Work event list"
+}