bps-google-api 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224c2c0919028cc227a062646c33d6b4d5b857ac
-  data.tar.gz: dd2263743ddf4b0b24683028463f1bacf5a6c38b
+  metadata.gz: 5e879f7388cbb93030b4c0ebb10ba8a7f0ebbce2
+  data.tar.gz: 2db793f99ffe1de7c5170b95e3c7d14278f30681
 SHA512:
-  metadata.gz: 133faee9d4e46358eafcd8f085eb99cc49dc24eafc1e46de3f5f2602c4ecc5893b82a768be57feb2200d40ab1c3395e232aa7d1c0783547794a32bb2ef833954
-  data.tar.gz: 34d2595ddf6987a230d1f05fbbff3932cdb1307b4f7e39758e9a7488b81b61144451811f582f7cfabfe167041a4e4b78b771b9b9236f02d48ea9eaf423f114b4
+  metadata.gz: 15b9400b2a26b43ea093798a9129115d61d3106b21f4d491075aaf191f2f86a729ff024fd39b7ba8ac341e9bf1bc85d664a9bc613c1f89279583e186501b005b
+  data.tar.gz: 22b09c587f8b7f831d31e586e1118660b1a7d1dca4d1ba88240209a6b38b413f4b9913d2eedb4aedd6a127f8a35973af71207ca16c5c6098cb484b8f7ac34b15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bps-google-api (0.3.2)
+    bps-google-api (0.4.0)
       exp_retry (~> 0.0.11)
       fileutils (~> 1.2)
       google-api-client (~> 0.23.4)

data/Readme.md

@@ -1,5 +1,8 @@
 # BPS Google API
 
+[![Gem Version](https://img.shields.io/gem/v/bps-google-api.svg)](https://rubygems.org/gems/bps-google-api)
+[![Build Status](https://travis-ci.org/jfiander/bps-google-api.svg)](https://travis-ci.org/jfiander/bps-google-api)
+
 A configured Google API wrapper.
 
 ## Installation
@@ -16,7 +19,7 @@ or install directly:
 gem install bps-google-api
 ```
 
-Create an initializer to configure the root directory for the gem:
+Configure the root directories for the gem:
 
 ```ruby
 GoogleAPI.configure do |config|
@@ -24,6 +27,8 @@ GoogleAPI.configure do |config|
 end
 ```
 
+For Rails, create an initializer:
+
 ```ruby
 GoogleAPI.configure do |config|
   config.root = Rails.root.join('config', 'google_api')
@@ -31,7 +36,7 @@ GoogleAPI.configure do |config|
 end
 ```
 
-Then run the following in `config/application.rb`:
+Then add the following in `config/application.rb`:
 
 ```ruby
 require 'google_api'
@@ -54,27 +59,48 @@ TZ # Timezone
 
 ## Usage
 
-If no configuration is available, `.new` will automatically run `.authorize!`
-and return a URL to generate an authorization token.
+By default, if no configuration is available, `.new` will automatically run
+`.authorize!` and return a URL to generate an authorization token.
 
 ```ruby
-calendar = GoogleAPI::Calendar.new
+calendar = GoogleAPI::Configured::Calendar.new(calendar_id)
 
-calendar.create(cal_id, event_options)
-calendar.list(cal_id, max_results: 2500, page_token: nil)
-calendar.get(cal_id, event_id)
-calendar.update(cal_id, event_id, event_options)
-calendar.delete(cal_id, event_id)
+calendar.create(event_options)
+calendar.list(max_results: 2500, page_token: nil)
+calendar.get(event_id)
+calendar.update(event_id, event_options)
+calendar.delete(event_id)
 
-calendar.permit(calendar, user)
-calendar.unpermit(calendar, user)
+calendar.permit(user)
+calendar.unpermit(user)
 ```
 
 ```ruby
-group = GoogleAPI::Group.new('group@example.com')
+group = GoogleAPI::Configured::Group.new('group@example.com')
 
 group.get
 group.members
 group.add('somebody@example.com')
 group.remove('somebody@example.com')
 ```
+
+### Event Options
+
+Available event options are listed in `GoogleAPI::Calendar::VALID_EVENT_KEYS`.
+
+```ruby
+repeat_pattern = 'WEEKLY' # 'DAILY', etc.
+recurrence = ["RRULE:FREQ=#{repeat_pattern};COUNT=#{sessions}"]
+
+event_options = {
+  start: start_date, end: end_date, recurrence: recurrence,
+  summary: event_title, description: event_description,
+  location: location
+}
+```
+
+To add a Meet call to an event, merge the following into `event_options`:
+
+```ruby
+{ conference: { id: meeting_id, signature: meeting_signature } }
+```

data/bps-google-api.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = 'bps-google-api'
-  s.version       = '0.3.2'
-  s.date          = '2019-06-25'
+  s.version       = '0.4.0'
+  s.date          = '2019-06-27'
   s.summary       = 'Configured Google API'
   s.description   = 'A configured Google API wrapper.'
   s.homepage      = 'http://rubygems.org/gems/bps-google-api'

data/lib/google_api.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 class GoogleAPI
+  # Core Dependencies
+  require 'date'
+
   # Google Dependencies
   require 'google/apis/calendar_v3'
   require 'google/apis/groupssettings_v1'

data/lib/google_api/base/authorization.rb

@@ -10,7 +10,8 @@ class GoogleAPI
       ].freeze
       TOKEN_SCOPES ||= [
         '"https://www.googleapis.com/auth/admin.directory.group"',
-        '"https://www.googleapis.com/auth/calendar"'
+        '"https://www.googleapis.com/auth/calendar"',
+        '"https://www.googleapis.com/auth/calendar.events"'
       ].freeze
 
       def authorize!(refresh: false, reveal: false)

data/lib/google_api/calendar.rb

@@ -6,12 +6,20 @@ class GoogleAPI
       GoogleAPI.configuration.local_path('tmp', 'run', 'last_page_token')
     end
 
+    require 'google_api/calendar/conference'
+    include GoogleAPI::Calendar::Conference
+
     require 'google_api/calendar/clear_test_calendar'
     include GoogleAPI::Calendar::ClearTestCalendar
 
     SERVICE_CLASS = Google::Apis::CalendarV3::CalendarService
     VALID_EVENT_KEYS ||= %i[
-      summary start end description location recurrence conference_data conference_data_version
+      summary start end description location recurrence conference
+      conference_data
+    ].freeze
+    VALID_PATCH_KEYS ||= %i[
+      summary start end description location recurrence conference_data created reminders creator
+      etag html_link i_cal_uid id kind organizer reminders sequence status updated
     ].freeze
 
     def create(calendar_id, event_options = {})
@@ -26,8 +34,12 @@ class GoogleAPI
       call(:get_event, calendar_id, event_id)
     end
 
+    def patch(calendar_id, event_id, patch_options = {})
+      call(:patch_event, calendar_id, event_id, patch_options, conference_data_version: 1)
+    end
+
     def update(calendar_id, event_id, event_options = {})
-      call(:update_event, calendar_id, event_id, event(event_options))
+      call(:update_event, calendar_id, event_id, event(event_options), conference_data_version: 1)
     end
 
     def delete(calendar_id, event_id)
@@ -58,15 +70,29 @@ class GoogleAPI
 
   private
 
-    def event(event_options)
-      event_options.assert_valid_keys(VALID_EVENT_KEYS)
-      event_options[:start] = date(event_options[:start])
-      event_options[:end] = date(event_options[:end])
+    def event(event_options, patch: false)
+      validate_keys(event_options, patch)
+
+      event_options = format_dates(event_options)
+      event_options = format_conference_data(event_options)
 
       Google::Apis::CalendarV3::Event.new(event_options.reject { |_, v| v.nil? })
     end
 
-    def date(date)
+    def validate_keys(event_options, patch)
+      event_options.assert_valid_keys(VALID_EVENT_KEYS) unless patch
+      event_options.assert_valid_keys(VALID_PATCH_KEYS) if patch
+    end
+
+    def format_dates(event_options)
+      event_options[:start] = format_date(event_options[:start])
+      event_options[:end] = format_date(event_options[:end])
+      event_options
+    end
+
+    def format_date(date)
+      return date if date.is_a?(Google::Apis::CalendarV3::EventDateTime)
+
       key = date&.is_a?(String) ? :date : :date_time
       Google::Apis::CalendarV3::EventDateTime.new(key => date, time_zone: ENV['TZ'])
     end

data/lib/google_api/calendar/conference.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class GoogleAPI
+  class Calendar < GoogleAPI::Base
+    module Conference
+      MEET_ICON ||= 'https://lh5.googleusercontent.com/proxy/bWvYBOb7O03a7HK5iKNEAPoUNPEXH1CHZjuOkiqxHx8OtyVn9sZ6Ktl8hfqBNQUUbCDg6T2unnsHx7RSkCyhrKgHcdoosAW8POQJm_ZEvZU9ZfAE7mZIBGr_tDlF8Z_rSzXcjTffVXg3M46v'
+
+      def add_conference(calendar_id, event_id)
+        patch_options = {
+          conference_data: {
+            create_request: { request_id: "#{Time.now.to_i}-#{SecureRandom.hex(16)}" }
+          }
+        }
+
+        call(:patch_event, calendar_id, event_id, patch_options, conference_data_version: 1)
+      end
+
+    private
+
+      def format_conference_data(event_options)
+        return event_options unless event_options.key?(:conference)
+
+        conference_options = event_options.delete(:conference)
+        event_options[:conference_data] = conference_hash(conference_options)
+        event_options
+      end
+
+      def conference_hash(conference_options)
+        if conference_options[:id] == :new
+          new_conference
+        else
+          conference(conference_options[:id], conference_options[:signature])
+        end
+      end
+
+      def conference(conf_id, signature)
+        {
+          conference: {
+            conference_id: conf_id, conference_solution: meet_solution,
+            entry_points: meet_entry(conf_id), signature: signature
+          }
+        }
+      end
+
+      def new_conference
+        {
+          create_request: {
+            request_id: "#{Time.now.to_i}-#{SecureRandom.hex(16)}"
+          }
+        }
+      end
+
+      def meet_solution
+        Google::Apis::CalendarV3::ConferenceSolution.new(
+          key: Google::Apis::CalendarV3::ConferenceSolutionKey.new(type: 'hangoutsMeet'),
+          name: 'Hangouts Meet',
+          icon_uri: MEET_ICON
+        )
+      end
+
+      def meet_entry(conf_id)
+        [
+          Google::Apis::CalendarV3::EntryPoint.new(
+            label: "meet.google.com/#{conf_id}",
+            uri: "https://meet.google.com/#{conf_id}",
+            entry_point_type: 'video'
+          )
+        ]
+      end
+    end
+  end
+end

data/lib/google_api/configured.rb

@@ -3,6 +3,7 @@
 class GoogleAPI
   module Configured
     require 'google_api/configured/calendar'
+    require 'google_api/configured/event'
     require 'google_api/configured/group'
   end
 end

data/lib/google_api/configured/calendar.rb

@@ -25,6 +25,10 @@ class GoogleAPI
         self.class.api.get(calendar_id, event_id)
       end
 
+      def patch(event_id, event_options = {})
+        self.class.api.patch(calendar_id, event_id, event_options)
+      end
+
       def update(event_id, event_options = {})
         self.class.api.update(calendar_id, event_id, event_options)
       end
@@ -46,6 +50,10 @@ class GoogleAPI
           page_token: page_token, page_limit: page_limit, verbose: verbose, error: error
         )
       end
+
+      def add_conference(event_id)
+        self.class.api.add_conference(calendar_id, event_id)
+      end
     end
   end
 end

data/lib/google_api/configured/event.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class GoogleAPI
+  module Configured
+    class Calendar
+      class Event
+        def self.api
+          @api ||= GoogleAPI::Calendar.new
+        end
+
+        attr_reader :calendar_id, :event_id
+
+        def initialize(calendar_id, event_id)
+          @calendar_id = calendar_id
+          @event_id = event_id
+        end
+
+        def get
+          self.class.api.get(calendar_id, event_id)
+        end
+
+        def patch(patch_options = {})
+          self.class.api.patch(calendar_id, event_id, patch_options)
+        end
+
+        def update(event_options = {})
+          self.class.api.update(calendar_id, event_id, event_options)
+        end
+
+        def delete
+          self.class.api.delete(calendar_id, event_id)
+        end
+
+        def add_conference
+          self.class.api.add_conference(calendar_id, event_id)
+        end
+      end
+    end
+  end
+end

data/spec/lib/google_api/calendar_spec.rb

@@ -81,18 +81,42 @@ RSpec.describe GoogleAPI::Calendar do
       expect(subject.create(test_event)).to be_a(Google::Apis::CalendarV3::Event)
     end
 
+    it 'creates an event with a new conference' do
+      event = test_event.merge(conference: { id: :new })
+      expect(subject.create(event)).to be_a(Google::Apis::CalendarV3::Event)
+    end
+
+    it 'creates an event with conference data' do
+      event = subject.create(test_event)
+      event = subject.add_conference(event.id)
+      event_options = test_event.merge(
+        conference: {
+          id: event.conference_data.conference_id,
+          signature: event.conference_data.signature
+        }
+      )
+
+      expect(subject.create(event_options)).to be_a(Google::Apis::CalendarV3::Event)
+    end
+
     it 'gets an event ' do
       event = subject.create(test_event)
       expect(subject.get(event.id)).to be_a(Google::Apis::CalendarV3::Event)
     end
 
+    it 'patches an event' do
+      event = subject.create(test_event)
+      subject.patch(event.id, description: 'Patched.')
+
+      expect(subject.get(event.id).description).to eql('Patched.')
+    end
+
     it 'updates an event' do
       event = subject.create(test_event)
       updated_test_event = test_event.merge(description: 'Updated.')
       subject.update(event.id, updated_test_event)
-      updated_event = subject.get(event.id)
 
-      expect(updated_event.description).to eql('Updated.')
+      expect(subject.get(event.id).description).to eql('Updated.')
     end
 
     it 'deletes an event' do
@@ -128,5 +152,11 @@ RSpec.describe GoogleAPI::Calendar do
         end
       end
     end
+
+    it 'adds conference data' do
+      event = subject.create(test_event)
+
+      expect(subject.add_conference(event.id)).to be_a(Google::Apis::CalendarV3::Event)
+    end
   end
 end

data/spec/lib/google_api/event_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GoogleAPI::Configured::Calendar::Event do
+  def test_event
+    {
+      summary: 'API Test Event',
+      description: 'This is a test event generated by the API gem.',
+      start: DateTime.strptime('201906051200', '%Y%m%d%H%M'),
+      end: DateTime.strptime('201906051400', '%Y%m%d%H%M')
+    }
+  end
+
+  let(:test_cal_id) { ENV['GOOGLE_CALENDAR_ID_TEST'] }
+
+  subject do
+    event = GoogleAPI::Configured::Calendar.new(test_cal_id).create(test_event)
+    GoogleAPI::Configured::Calendar::Event.new(test_cal_id, event.id)
+  end
+
+  it 'gets the event' do
+    expect(subject.get).to be_a(Google::Apis::CalendarV3::Event)
+  end
+
+  it 'patches the event' do
+    subject.patch(description: 'Patched.')
+
+    expect(subject.get.description).to eql('Patched.')
+  end
+
+  it 'updates the event' do
+    updated_test_event = test_event.merge(description: 'Updated.')
+    subject.update(updated_test_event)
+
+    expect(subject.get.description).to eql('Updated.')
+  end
+
+  it 'deletes the event' do
+    expect(subject.delete).to eql('')
+  end
+
+  it 'adds conference data' do
+    expect(subject.add_conference).to be_a(Google::Apis::CalendarV3::Event)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bps-google-api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exp_retry
@@ -147,14 +147,17 @@ files:
 - lib/google_api/base/authorization.rb
 - lib/google_api/calendar.rb
 - lib/google_api/calendar/clear_test_calendar.rb
+- lib/google_api/calendar/conference.rb
 - lib/google_api/config.rb
 - lib/google_api/configured.rb
 - lib/google_api/configured/calendar.rb
+- lib/google_api/configured/event.rb
 - lib/google_api/configured/group.rb
 - lib/google_api/group.rb
 - spec/.rubocop.yml
 - spec/lib/google_api/base_spec.rb
 - spec/lib/google_api/calendar_spec.rb
+- spec/lib/google_api/event_spec.rb
 - spec/lib/google_api/group_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/bps-google-api