google_calendar 0.4.4 → 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac5c278ba3dc50398192d02b52e133f0dbf7394d
+  data.tar.gz: 69d8905b95b054d7c373243f4237ce9dfc434c1e
+SHA512:
+  metadata.gz: a5237336f30472193452d47bd2690b04ea6c574f86eafa2add99b97ad1ee6f90a489066fac7c47f18e4a630262847c14e44ce2713d764bd5f3a3b2508def7740
+  data.tar.gz: e54a2cb56293fd44585e15da46e236e0eef390d7cdff5efe23418be2bc096b1f471740f663cd3dddf9b22e620df65ee9241a752a9f57e12310843088baa904a8

data/Gemfile.lock

@@ -1,82 +1,53 @@
 PATH
   remote: .
   specs:
-    google_calendar (0.4.3)
+    google_calendar (0.5)
       json (~> 1.8)
-      signet (~> 0.5)
+      signet (~> 0.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
-    ansi (1.4.3)
+    addressable (2.3.8)
+    ansi (1.5.0)
     builder (3.2.2)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.2)
+    codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
     docile (1.1.5)
-    faraday (0.9.0)
+    extlib (0.9.16)
+    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.6)
-    formatador (0.2.5)
-    guard (2.10.1)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-minitest (2.3.2)
-      guard (~> 2.0)
-      minitest (>= 3.0)
-    hitimes (1.2.2)
-    json (1.8.1)
-    jwt (1.2.0)
-    listen (2.8.3)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
+    json (1.8.2)
+    jwt (1.5.0)
     metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.4.3)
-    minitest-reporters (1.0.8)
+    minitest (5.6.1)
+    minitest-reporters (1.0.16)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.10.1)
+    multi_json (1.11.0)
     multipart-post (2.0.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
     rake (10.4.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rdoc (4.1.2)
+    rb-fsevent (0.9.5)
+    rdoc (4.2.0)
       json (~> 1.4)
-    ruby-progressbar (1.7.0)
+    ruby-progressbar (1.7.5)
     shoulda-context (1.2.1)
-    signet (0.5.1)
-      addressable (>= 2.2.3)
-      faraday (>= 0.9.0.rc5)
-      jwt (>= 0.1.5)
-      multi_json (>= 1.0.0)
-    simplecov (0.9.1)
+    signet (0.6.0)
+      addressable (~> 2.3)
+      extlib (~> 0.9)
+      faraday (~> 0.9)
+      jwt (~> 1.0)
+      multi_json (~> 1.10)
+    simplecov (0.10.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     terminal-notifier-guard (1.6.4)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
 
 PLATFORMS
   ruby
@@ -85,7 +56,6 @@ DEPENDENCIES
   bundler (>= 1.2)
   codeclimate-test-reporter
   google_calendar!
-  guard-minitest (~> 2.3)
   minitest (~> 5.1)
   minitest-reporters (~> 1.0)
   mocha (~> 1.1)

data/Guardfile

@@ -1,7 +1,7 @@
-guard 'minitest' do
-  # with Minitest::Unit
-  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
-  watch(%r|^lib/(.*)([^/]+)\.rb|)  { 'test' }
-  watch(%r|^test/mocks(.*)([^/]+)\.json|)  { 'test' }
-  watch(%r|^test/helper\.rb|)      { 'test' }
-end
+# guard 'minitest' do
+#   # with Minitest::Unit
+#   watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+#   watch(%r|^lib/(.*)([^/]+)\.rb|)  { 'test' }
+#   watch(%r|^test/mocks(.*)([^/]+)\.json|)  { 'test' }
+#   watch(%r|^test/helper\.rb|)      { 'test' }
+# end

data/README.rdoc

@@ -89,7 +89,9 @@ A fast lightweight and minimalist wrapper around the {Google Calendar}[https://w
 
 This sample code is located in readme_code.rb in the root folder.
 
-Note: This is not a complete implementation of the calendar api, it just includes the features we needed to support our internal calendar integration.
+== Notes
+* This is not a complete implementation of the calendar api, it just includes the features we needed to support our internal calendar integration. Feel free to add additional features and we will happily integrate them.
+* Did you get an SSL exception?  If so take a look at this: https://gist.github.com/fnichol/867550
 
 == Contributing to google_calendar
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5

data/google_calendar.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "google_calendar"
-  s.version = "0.4.4"
+  s.version = "0.5"
   s.date = "2014-11-30"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   s.summary = "A lightweight Google Calendar API wrapper"
   s.description = "A minimal wrapper around the google calendar API"
   s.homepage = "http://northworld.github.io/google_calendar/"
-  s.licenses = ["MIT"]  
-  
+  s.licenses = ["MIT"]
+
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -26,12 +26,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = "2.2.2"
 
-  s.add_runtime_dependency(%q<signet>, ["~> 0.5"])
+  s.add_runtime_dependency(%q<signet>, ["~> 0.6"])
   s.add_runtime_dependency(%q<json>, ["~> 1.8"])
 
   s.add_development_dependency(%q<terminal-notifier-guard>, ["~> 1.6"])
   s.add_development_dependency(%q<rb-fsevent>, ["~> 0.9"])
-  s.add_development_dependency(%q<guard-minitest>, ["~> 2.3"])
+  # s.add_development_dependency(%q<guard-minitest>, ["~> 2.3"])
   s.add_development_dependency(%q<minitest>, ["~> 5.1"])
   s.add_development_dependency(%q<minitest-reporters>, ["~> 1.0"])
   s.add_development_dependency(%q<shoulda-context>, ["~> 1.2"])
@@ -39,5 +39,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<mocha>, ["~> 1.1"])
   s.add_development_dependency(%q<rake>, ["~> 10"])
   s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
-  
-end
+
+end

data/lib/google/calendar.rb

@@ -6,7 +6,7 @@ module Google
   #
   class Calendar
 
-    attr_reader :connection
+    attr_reader :id, :connection, :summary
 
     #
     # Setup and connect to the specified Google Calendar.
@@ -20,22 +20,22 @@ module Google
     # See Readme.rdoc or readme_code.rb for an explication on the OAuth2 authorization process.
     #
     # ==== Example
-    # Google::Calendar.new(:client_id => YOUR_CLIENT_ID, 
+    # 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 => "urn:ietf:wg:oauth:2.0:oob" # this is what Google uses for 'applications'
     #                     )
     #
-    def initialize(params={})
-      options = {
+    def initialize(params={}, connection=nil)
+      @connection = connection || Connection.new(
         :client_id => params[:client_id],
         :client_secret => params[:client_secret],
         :refresh_token => params[:refresh_token],
-        :redirect_url => params[:redirect_url],
-        :calendar_id => params[:calendar]
-      }
+        :redirect_url => params[:redirect_url]
+      )
 
-      @connection = Connection.new options
+      @id = params[:calendar]
+      # raise CalendarIDMissing unless @id
     end
 
     #
@@ -92,8 +92,8 @@ module Google
     end
 
     #
-    # This is equivalent to running a search in the Google calendar web application.  
-    # Google does not provide a way to specify what attributes you would like to 
+    # This is equivalent to running a search in the Google calendar web application.
+    # Google does not provide a way to 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.
@@ -121,7 +121,7 @@ module Google
     #   an array with one element if only one found.
     #   an array of events if many found.
     #
-    def find_events_in_range(start_min, start_max, options = {})     
+    def find_events_in_range(start_min, start_max, options = {})
       formatted_start_min = encode_time(start_min)
       formatted_start_max = encode_time(start_max)
       query = "?timeMin=#{formatted_start_min}&timeMax=#{formatted_start_max}#{parse_options(options)}"
@@ -155,7 +155,7 @@ module Google
     #   an array of events if many found.
     #
     def find_event_by_id(id)
-      return nil unless id && id.strip != ''
+      return nil unless id 
       event_lookup("/#{id}")
     end
 
@@ -210,7 +210,7 @@ module Google
         "/#{event.id}"
       end
 
-      @connection.send_events_request(query_string, method, body)
+      send_events_request(query_string, method, body)
     end
 
     #
@@ -218,7 +218,7 @@ module Google
     # This is a callback used by the Event class.
     #
     def delete_event(event)
-      @connection.send_events_request("/#{event.id}", :delete)
+      send_events_request("/#{event.id}", :delete)
     end
 
     protected
@@ -245,8 +245,10 @@ module Google
     #
     def event_lookup(query_string = '') #:nodoc:
       begin
-        response = @connection.send_events_request(query_string, :get)
-        events = Event.build_from_google_feed( JSON.parse(response.body) , self) || []
+        response = send_events_request(query_string, :get)
+        parsed_json = JSON.parse(response.body)
+        @summary = parsed_json['summary']
+        events = Event.build_from_google_feed(parsed_json, self) || []
         return events if events.empty?
         events.length > 1 ? events : [events[0]]
       rescue Google::HTTPNotFound
@@ -265,6 +267,13 @@ module Google
       event.save
       event
     end
+
+    #
+    # Wraps the `send` method. Send an event related request to Google.
+    #
+    def send_events_request(path_and_query_string, method, content = '')
+      @connection.send("/calendars/#{CGI::escape @id}/events#{path_and_query_string}", method, content)
+    end
   end
 
 end

data/lib/google/calendar_list.rb

@@ -0,0 +1,43 @@
+module Google
+
+  #
+  # CalendarList is the main object you use to find Calendars.
+  #
+  class CalendarList
+
+    attr_reader :connection
+
+    #
+    # Setup and connect to the user's list of Google Calendars.
+    #
+    # 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
+    # * :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.
+    #
+    def initialize(params={}, connection=nil)
+      @connection = connection || Connection.new(
+        :client_id => params[:client_id],
+        :client_secret => params[:client_secret],
+        :refresh_token => params[:refresh_token],
+        :redirect_url => params[:redirect_url]
+      )
+    end
+
+    #
+    # Find all entries on the user's calendar list. Returns an array of CalendarListEntry objects.
+    #
+    def fetch_entries
+      response = @connection.send("/users/me/calendarList", :get)
+
+      return nil if response.status != 200 || response.body.empty?
+
+      CalendarListEntry.build_from_google_feed(JSON.parse(response.body), @connection)
+    end
+
+  end
+
+end

data/lib/google/calendar_list_entry.rb

@@ -0,0 +1,40 @@
+module Google
+
+  #
+  # Represents a Google Calendar List Entry
+  #
+  # See https://developers.google.com/google-apps/calendar/v3/reference/calendarList#resource
+  #
+  # === Attributes
+  #
+  # * +id+ - The Google assigned id of the calendar. Read only.
+  # * +summary+ - Title of the calendar. Read-only.
+  # * +time_zone+ - The time zone of the calendar. Optional. Read-only.
+  # * +access_role+ - The effective access role that the authenticated user has on the calendar. Read-only.
+  # * +primary?+ - Whether the calendar is the primary calendar of the authenticated user. Read-only.
+  #
+  class CalendarListEntry
+    attr_reader :id, :summary, :time_zone, :access_role, :primary, :connection
+    alias_method :primary?, :primary
+
+    def initialize(params, connection)
+      @id = params['id']
+      @summary = params['summary']
+      @time_zone = params['timeZone']
+      @access_role = params['accessRole']
+      @primary = params.fetch('primary', false)
+      @connection = connection
+    end
+
+    def to_calendar
+      Calendar.new({:calendar => @id}, @connection)
+    end
+
+    def self.build_from_google_feed(response, connection)
+      items = response['items']
+      items.collect { |item| CalendarListEntry.new(item, connection) }
+    end
+
+  end
+
+end

data/lib/google/connection.rb

@@ -7,9 +7,21 @@ module Google
   #
   class Connection
     BASE_URI = "https://www.googleapis.com/calendar/v3"
-
+    TOKEN_URI ="https://accounts.google.com/o/oauth2/token"
+    AUTH_URI = "https://accounts.google.com/o/oauth2/auth"
+    SCOPE = "https://www.googleapis.com/auth/calendar"
     attr_accessor :client
 
+    def self.new_with_service_account(params)
+      client = Signet::OAuth2::Client.new(
+        :scope => SCOPE,
+        :issuer => params[:client_id],
+        :audience => TOKEN_URI,
+        :token_credential_uri => TOKEN_URI,
+        :signing_key => params[:signing_key]
+      )
+      Connection.new(params, client)
+    end
     #
     # Prepare a connection to google for fetching a calendar events
     #
@@ -19,29 +31,27 @@ module Google
     # * :redirect_uri => 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'"
     # * :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)
     #
-    def initialize(params)
+    def initialize(params, client=nil)
 
-      raise ArgumentError unless Connection.credentials_provided?(params)
+      raise ArgumentError unless client || Connection.credentials_provided?(params)
 
-      @client = Signet::OAuth2::Client.new(
+      @client = client || Signet::OAuth2::Client.new(
         :client_id => params[:client_id],
         :client_secret => params[:client_secret],
         :redirect_uri => params[:redirect_url],
         :refresh_token => params[:refresh_token],
-        :authorization_uri => 'https://accounts.google.com/o/oauth2/auth',
-        :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
-        :scope => "https://www.googleapis.com/auth/calendar"
+        :authorization_uri => AUTH_URI,
+        :token_credential_uri => TOKEN_URI,
+        :scope => SCOPE
       )
 
-      calendar_id = params[:calendar_id]
-
-      # raise CalenarIDMissing unless calendar_id
-      @events_url = "#{BASE_URI}/calendars/#{CGI::escape calendar_id}/events"
-
       # try to get an access token if possible.
       if params[:refresh_token]
         @client.refresh_token = params[:refresh_token]
         @client.grant_type = 'refresh_token'
+      end
+
+      if params[:refresh_token] || params[:signing_key]
         Connection.get_new_access_token(@client)
       end
 
@@ -97,7 +107,9 @@ module Google
     #
     # Send a request to google.
     #
-    def send(uri, method, content = '')
+    def send(path, method, content = '')
+
+      uri = BASE_URI + path
 
       response = @client.fetch_protected_resource(
         :uri => uri,
@@ -111,20 +123,13 @@ module Google
       return response
     end
 
-    #
-    # Wraps the `send` method. Send an event related request to Google.
-    #
-    def send_events_request(path_and_query_string, method, content = '')
-      send(@events_url + path_and_query_string, method, content)
-    end
-
     protected
 
     #
     # Utility method to centralize the process of getting an access token.
     #
     def self.get_new_access_token(client) #:nodoc:
-      begin 
+      begin
         client.fetch_access_token!
       rescue Signet::AuthorizationError
         raise HTTPAuthorizationFailed
@@ -150,6 +155,5 @@ module Google
       blank = /[^[:space:]]/
       !(params[:client_id] !~ blank) && !(params[:client_secret] !~ blank)
     end
-
   end
 end