bps-google-api 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '080247a8c27b19573d393857fec05b41d6cc86f4228839e8e95db37315cddd6b'
+  data.tar.gz: deebd40f8b6018230ff34fb637ce2041c9a65881254f54d33995dd0134dadf85
+SHA512:
+  metadata.gz: 5a376bfde8ff5efcc98a2b397d452dd0f293db272445225b6411c650631bd0d2b05ecc7603f2086bc7803c7f417991beffd8b1359a0dac3c264510f641710337
+  data.tar.gz: 94edc78b009e1ac136178b3eefc1ccd4348aa7e5c34ad2b001350f13e9700af953daeb6545e763d1650547b2ceb0224c97b6c9aad587901b45bab85f12648b4d

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    bps-google-api (0.0.5)
+      exp_retry (~> 0.0.8)
+      fileutils (~> 1.2)
+      google-api-client (~> 0.23.4)
+      ruby-progressbar (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    exp_retry (0.0.9)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    fileutils (1.2.0)
+    google-api-client (0.23.9)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.7.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (~> 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.9)
+    googleauth (0.6.7)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    httpclient (2.8.3)
+    jwt (2.1.0)
+    memoist (0.16.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    os (1.0.0)
+    public_suffix (3.0.3)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    ruby-progressbar (1.10.0)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    uber (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bps-google-api!
+
+BUNDLED WITH
+   2.0.0

data/Readme.md

@@ -0,0 +1,65 @@
+# BPS Google API
+
+A configured Google API wrapper.
+
+## Installation
+
+Add this to your Gemfile:
+
+```ruby
+gem 'bps-google-api'
+```
+
+or install directly:
+
+```bash
+gem install bps-google-api
+```
+
+Then run the following in `config/application.rb`:
+
+```ruby
+require 'google_api'
+```
+
+## Required Environment
+
+```bash
+GOOGLE_CLIENT_ID
+GOOGLE_CLIENT_SECRET
+
+GOOGLE_ACCESS_TOKEN
+GOOGLE_REFRESH_TOKEN
+GOOGLE_AUTH_EXP
+
+GOOGLE_AUTH_SCOPE_CALENDAR
+GOOGLE_AUTH_SCOPE_GROUP
+
+GOOGLE_CALENDAR_ID_GEN
+GOOGLE_CALENDAR_ID_EDUC
+GOOGLE_CALENDAR_ID_TEST
+```
+
+## Usage
+
+```ruby
+calendar = GoogleAPI::Calendar.new
+
+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.permit(calendar, user)
+calendar.unpermit(calendar, user)
+```
+
+```ruby
+group = GoogleAPI::Group.new('group@example.com')
+
+group.get
+group.members
+group.add('somebody@example.com')
+group.remove('somebody@example.com')
+```

data/bps-google-api.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name          = 'bps-google-api'
+  s.version       = '0.0.5'
+  s.date          = '2019-04-11'
+  s.summary       = 'Configured Google API'
+  s.description   = 'A configured Google API wrapper.'
+  s.homepage      = 'http://rubygems.org/gems/bps-google-api'
+  s.license       = 'GPL-3.0'
+  s.authors       = ['Julian Fiander']
+  s.email         = 'julian@fiander.one'
+  s.require_paths = %w[lib]
+  s.files         = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency 'google-api-client', '~> 0.23.4'
+  s.add_runtime_dependency 'exp_retry',         '~> 0.0.8'
+  s.add_runtime_dependency 'ruby-progressbar',  '~> 1.10'
+  s.add_runtime_dependency 'fileutils',         '~> 1.2'
+end

data/lib/google_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  require 'google/apis/calendar_v3'
+  require 'google/apis/groupssettings_v1'
+  require 'google/apis/admin_directory_v1'
+  require 'googleauth'
+  require 'googleauth/stores/file_token_store'
+
+  require 'google_api/concerns'
+
+  require 'google_api/base'
+  require 'google_api/calendar'
+  require 'google_api/group'
+end

data/lib/google_api/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  class Base
+    include GoogleAPI::Concerns::Base::Authorization
+
+    def initialize(auth: true)
+      self.authorize! if auth
+    end
+
+    def self.root_path
+      defined?(Rails) ? Rails.root : './'
+    end
+
+  private
+
+    def service
+      raise 'No service class defined.' unless defined?(service_class)
+
+      @service ||= service_class.new
+    end
+
+    def root_path
+      path = self.class.root_path
+      FileUtils.mkdir_p(path)
+      path
+    end
+  end
+end

data/lib/google_api/calendar.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  class Calendar < GoogleAPI::Base
+    include GoogleAPI::Concerns::Calendar::ClearTestCalendar
+    include GoogleAPI::Concerns::Calendar::Permission
+
+    LAST_TOKEN_PATH ||= "#{root_path}/tmp/run/last_page_token"
+
+    def create(calendar_id, event_options = {})
+      service.insert_event(calendar_id, event(event_options), conference_data_version: 1)
+    end
+
+    def list(calendar_id, max_results: 2500, page_token: nil)
+      service.list_events(calendar_id, max_results: max_results, page_token: page_token)
+    end
+
+    def get(calendar_id, event_id)
+      service.get_event(calendar_id, event_id)
+    end
+
+    def update(calendar_id, event_id, event_options = {})
+      service.update_event(calendar_id, event_id, event(event_options))
+    end
+
+    def delete(calendar_id, event_id)
+      service.delete_event(calendar_id, event_id)
+    rescue Google::Apis::ClientError
+      :event_not_found
+    end
+
+  private
+
+    def service_class
+      Google::Apis::CalendarV3::CalendarService
+    end
+
+    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])
+
+      Google::Apis::CalendarV3::Event.new(event_options.reject { |_, v| v.nil? })
+    end
+
+    def valid_event_keys
+      %i[summary start end description location recurrence conference_data conference_data_version]
+    end
+
+    def date(date)
+      key = date&.is_a?(String) ? :date : :date_time
+      Google::Apis::CalendarV3::EventDateTime.new(key => date, time_zone: 'America/Detroit')
+    end
+  end
+end

data/lib/google_api/concerns.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  module Concerns
+    module Base
+      require 'google_api/concerns/base/authorization'
+    end
+
+    module Calendar
+      require 'google_api/concerns/calendar/clear_test_calendar'
+      require 'google_api/concerns/calendar/permission'
+    end
+  end
+end

data/lib/google_api/concerns/base/authorization.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module GoogleAPI::Concerns::Base
+  module Authorization
+    OOB_URI ||= 'urn:ietf:wg:oauth:2.0:oob'
+    AUTH_SCOPES ||= [
+      Google::Apis::AdminDirectoryV1::AUTH_ADMIN_DIRECTORY_GROUP,
+      Google::Apis::CalendarV3::AUTH_CALENDAR
+    ].freeze
+
+    def authorize!(refresh: false, reveal: false)
+      client_id_file
+      token_file
+
+      auth = authorize(refresh: refresh)
+      service.authorization = auth
+      return true unless reveal
+
+      [auth, auth_keys(auth)]
+    end
+
+  private
+
+    def authorize(user_id = 'default', refresh: false)
+      @credentials = authorizer.get_credentials(user_id)
+      return @credentials unless @credentials.nil? || refresh
+
+      @credentials = authorizer.get_and_store_credentials_from_code(
+        user_id: user_id, code: request_authorization, base_url: OOB_URI
+      )
+    end
+
+    def request_authorization
+      url = authorizer.get_authorization_url(base_url: OOB_URI)
+      puts("Open this URL to authorize:\n", url)
+      print("\nResponse code: ")
+      gets
+    end
+
+    def authorizer
+      @authorizer ||= Google::Auth::UserAuthorizer.new(auth_client_id, AUTH_SCOPES, auth_token_store)
+    end
+
+    def auth_client_id
+      client_id_file
+      Google::Auth::ClientId.from_hash(JSON.parse(File.read('config/keys/google_api_client.json')))
+    end
+
+    def auth_token_store
+      Google::Auth::Stores::FileTokenStore.new(file: 'config/keys/google_token.yaml')
+    end
+
+    def auth_keys(auth)
+      {
+        GOOGLE_CLIENT_ID: auth.client_id, GOOGLE_CLIENT_SECRET: auth.client_secret,
+        GOOGLE_ACCESS_TOKEN: auth.access_token, GOOGLE_REFRESH_TOKEN: auth.refresh_token,
+        GOOGLE_AUTH_SCOPES: auth.scope, GOOGLE_AUTH_EXP: expires_milli(auth.as_json['expires_at'])
+      }
+    end
+
+    def expires_milli(time)
+      DateTime.strptime(time, '%Y-%m-%dT%H:%M:%S.%L%:z').to_i * 1000
+    end
+
+    def store_key(path, key)
+      return if File.exist?(path)
+
+      ensure_file(path)
+      File.open(path, 'w+') do |f|
+        File.chmod(0600, f)
+        block_given? ? yield(f) : f.write(key)
+      end
+    end
+
+    def ensure_file(path)
+      path = path.split('/')
+      file = path.pop
+      path = path.join('/')
+      FileUtils.mkdir_p(path)
+    end
+
+    def client_id_file
+      store_key(
+        File.join(root_path, 'config/keys/google_api_client.json'),
+        <<~KEY
+          {"installed":{"client_id":"#{ENV['GOOGLE_CLIENT_ID']}","project_id":"charming-scarab-208718",
+          "auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://accounts.google.com/o/oauth2/token",
+          "auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_secret":"#{ENV['GOOGLE_CLIENT_SECRET']}",
+          "redirect_uris":["#{OOB_URI}","http://localhost"]}}
+        KEY
+      )
+    end
+
+    def token_file
+      store_key(
+        File.join(root_path, 'config/keys/google_token.yaml'),
+        <<~KEY
+          ---
+          default: '{"client_id":"#{ENV['GOOGLE_CLIENT_ID']}","access_token":"#{ENV['GOOGLE_ACCESS_TOKEN']}",
+          "refresh_token":"#{ENV['GOOGLE_REFRESH_TOKEN']}","scope":[#{scopes}],
+          "expiration_time_millis":#{ENV['GOOGLE_AUTH_EXP']}}'
+        KEY
+      )
+    end
+
+    def scopes
+      ENV.select { |k, v| k =~ /GOOGLE_AUTH_SCOPE_/ }.values.map { |s| "\"#{s}\"" }.join(',')
+    end
+  end
+end

data/lib/google_api/concerns/calendar/clear_test_calendar.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module GoogleAPI::Concerns::Calendar
+  module ClearTestCalendar
+    RETRIABLE_EXCEPTIONS = [
+      Google::Apis::RateLimitError,
+      Google::Apis::TransmissionError
+    ].freeze
+
+    def clear_test_calendar(page_token: nil, page_limit: 50)
+      Google::Apis.logger.level = Logger::WARN
+      set_page_token(page_token)
+      loop_over_pages(ENV['GOOGLE_CALENDAR_ID_TEST'], page_limit: page_limit)
+      puts '*** Cleared all events!'
+    rescue Google::Apis::RateLimitError
+      puts "\n\n*** Google::Apis::RateLimitError (Rate Limit Exceeded)"
+    ensure
+      log_last_page_token unless @page_token.blank?
+    end
+
+  private
+
+    def set_page_token(page_token)
+      last_token = GoogleAPI::Calendar::LAST_TOKEN_PATH
+      @page_token ||= File.read(last_token) if File.exist?(last_token)
+      @page_token = page_token if page_token.present?
+    end
+
+    def loop_over_pages(cal_id, page_limit: 50)
+      puts "*** Starting with page token: #{@page_token}" if @page_token.present?
+
+      while (@page_token = clear_page(cal_id)) && page_limit.positive?
+        page_limit -= 1
+      end
+    end
+
+    def clear_page(cal_id)
+      response = list(cal_id, page_token: @page_token)
+      clear_events_from_page(cal_id, response.items) unless response.items.blank?
+      response.next_page_token
+    end
+
+    def clear_events_from_page(cal_id, items)
+      puts "*** Page token: #{@page_token}"
+      pb = progress_bar(items.count)
+      items&.each_with_index do |event, index|
+        ExpRetry.for(exception: RETRIABLE_EXCEPTIONS) do
+          delete(cal_id, event.id)
+          pb.increment
+        end
+      end
+    end
+
+    def log_last_page_token
+      puts "\n\n*** Last page token cleared: #{@page_token}"
+      File.open(GoogleAPI::Calendar::LAST_TOKEN_PATH, 'w+') do |f|
+        f.write(@page_token)
+      end
+      puts "\n*** Token stored in #{GoogleAPI::Calendar::LAST_TOKEN_PATH}"
+    end
+
+    def progress_bar(total)
+      ProgressBar.create(
+        title: 'Page cleared', starting_at: 0, total: total, progress_mark: ' ',
+        remainder_mark: "\u{FF65}", format: "%a [%R/sec] %E | %b\u{15E7}%i %c/%C (%P%%) %t"
+      )
+    end
+  end
+end

data/lib/google_api/concerns/calendar/permission.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GoogleAPI::Concerns::Calendar
+  module Permission
+    def permit(calendar, user)
+      rule = Google::Apis::CalendarV3::AclRule.new(
+        scope: { type: 'user', value: user.email }, role: 'writer'
+      )
+
+      result = service.insert_acl(calendar, rule)
+      user.update(calendar_rule_id: result.id)
+    end
+
+    def unpermit(calendar, user)
+      service.delete_acl(calendar, user&.calendar_rule_id)
+    rescue Google::Apis::ClientError
+      :permission_not_found
+    ensure
+      user.update(calendar_rule_id: nil)
+    end
+  end
+end

data/lib/google_api/group.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  class Group < GoogleAPI::Base
+    def initialize(id, auth: false)
+      @group_id = id
+      super(auth: auth)
+    end
+
+    def get
+      service.get_group(@group_id)
+    end
+
+    def members
+      service.list_members(@group_id)
+    end
+
+    def add(email)
+      service.insert_member(@group_id, member(email))
+    rescue Google::Apis::ClientError, 'duplicate: Member already exists.'
+      :already_exists
+    end
+
+    def remove(email)
+      service.delete_member(@group_id, email)
+    rescue Google::Apis::ClientError, '(required: Missing required field: memberKey)'
+      :not_found
+    end
+
+  private
+
+    def service_class
+      Google::Apis::AdminDirectoryV1::DirectoryService
+    end
+
+    def member(email)
+      Google::Apis::AdminDirectoryV1::Member.new(email: email)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: bps-google-api
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Julian Fiander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.4
+- !ruby/object:Gem::Dependency
+  name: exp_retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A configured Google API wrapper.
+email: julian@fiander.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Readme.md
+- bps-google-api.gemspec
+- lib/google_api.rb
+- lib/google_api/base.rb
+- lib/google_api/calendar.rb
+- lib/google_api/concerns.rb
+- lib/google_api/concerns/base/authorization.rb
+- lib/google_api/concerns/calendar/clear_test_calendar.rb
+- lib/google_api/concerns/calendar/permission.rb
+- lib/google_api/group.rb
+homepage: http://rubygems.org/gems/bps-google-api
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Configured Google API
+test_files: []