bps-google-api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bb3f5af2dbe6a57df4945c7d082aab5e6f68edb
-  data.tar.gz: 225fd27b21ae836d6d051bf32a81b96e17ed71f7
+  metadata.gz: 9db47ec4d8765e23f5eaf19a0d0fab4927fdde18
+  data.tar.gz: 3bdc229d7f57a1cb9a1efbb5d86b88f1b38c6117
 SHA512:
-  metadata.gz: 031d62aac72e1de816ac5d309fed95d8886c7b205633f25c9accf6ca8e43fa389c62334943a57f9ed4a0f85c47583149daab492eff8be4db403b7018c90b09a7
-  data.tar.gz: 3e5e6374f3731ba02d763d515bf3877d35e635a0c5f1f87a465ac8fb891581aa288a42c83eed1fbf93a963dba681115269a497efe864d71c31116f0580940e45
+  metadata.gz: 327541c28d54c819b6827cf1c7024c11a45de98efa04e873a36d8f834c8b99f3012afb61885608a65be911ce50fcf3daef7757e5e3fd8a9a3a9774bd207a20db
+  data.tar.gz: a2f81f09ec656b48000906fb7a566cafcda0d617c2aa3890415485d418e18ead19e2662ac42a5b11f059fef119a50d992e9124b4e6755dcf199146fa4fbe2e17

data/Gemfile.lock

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

data/bps-google-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'bps-google-api'
-  s.version       = '0.2.0'
+  s.version       = '0.2.1'
   s.date          = '2019-06-20'
   s.summary       = 'Configured Google API'
   s.description   = 'A configured Google API wrapper.'

data/lib/ext/hash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Import assert_valid_keys from Rails if not already defined
+class Hash
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+
+    each_key do |k|
+      next if valid_keys.include?(k)
+
+      raise(
+        ArgumentError,
+        "Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}"
+      )
+    end
+  end
+end

data/lib/ext/silent_progress_bar.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ProgressBar
+  class Silent
+    def self.tty?
+      true
+    end
+
+    def self.print(str)
+      str
+    end
+
+    def self.flush
+      self
+    end
+  end
+end

data/lib/google_api.rb

@@ -14,4 +14,8 @@ module GoogleAPI
   require 'google_api/base'
   require 'google_api/calendar'
   require 'google_api/group'
+  require 'google_api/configured'
+
+  require 'ext/hash' unless defined?(Rails)
+  require 'ext/silent_progress_bar'
 end

data/lib/google_api/base.rb

@@ -36,8 +36,7 @@ module GoogleAPI
     end
 
     def last_token_path
-      path = %w[tmp run last_page_token]
-      File.join(root_path, *path)
+      File.join(root_path, 'tmp', 'run', 'last_page_token')
     end
   end
 end

data/lib/google_api/base/authorization.rb

@@ -37,7 +37,7 @@ module GoogleAPI
         url = authorizer.get_authorization_url(base_url: OOB_URI)
         puts("Open this URL to authorize:\n", url)
         print("\nResponse code: ")
-        gets
+        ENV.key?('GOOGLE_AUTHORIZATION_CODE') ? ENV['GOOGLE_AUTHORIZATION_CODE'] : gets
       end
 
       def authorizer
@@ -61,12 +61,12 @@ module GoogleAPI
         {
           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'])
+          GOOGLE_AUTH_SCOPES: auth.scope, GOOGLE_AUTH_EXP: expires_milli(auth.expires_at.to_s)
         }
       end
 
       def expires_milli(time)
-        DateTime.strptime(time, '%Y-%m-%dT%H:%M:%S.%L%:z').to_i * 1000
+        Time.strptime(time, '%Y-%m-%d %H:%M:%S %:z').to_i * 1000
       end
 
       def store_key(path, key)

data/lib/google_api/calendar.rb

@@ -56,7 +56,7 @@ module GoogleAPI
   private
 
     def event(event_options)
-      validate_event_options(event_options)
+      event_options.assert_valid_keys(VALID_EVENT_KEYS)
       event_options[:start] = date(event_options[:start])
       event_options[:end] = date(event_options[:end])
 
@@ -67,16 +67,5 @@ module GoogleAPI
       key = date&.is_a?(String) ? :date : :date_time
       Google::Apis::CalendarV3::EventDateTime.new(key => date, time_zone: ENV['TZ'])
     end
-
-    def last_token_path
-      path = %w[tmp run last_page_token]
-      defined?(Rails) ? Rails.root.join(*path) : File.join(*path)
-    end
-
-    def validate_event_options(event_options)
-      return unless event_options.respond_to?(:assert_valid_keys)
-
-      event_options.assert_valid_keys(VALID_EVENT_KEYS)
-    end
   end
 end

data/lib/google_api/calendar/clear_test_calendar.rb

@@ -3,14 +3,16 @@
 module GoogleAPI
   class Calendar < GoogleAPI::Base
     module ClearTestCalendar
-      def clear_test_calendar(page_token: nil, page_limit: 50, verbose: false)
+      def clear_test_calendar(page_token: nil, page_limit: 50, verbose: false, error: false)
+        raise Google::Apis::RateLimitError, '(Rate Limit Exceeded)' if error
+
         @verbose = verbose
         Google::Apis.logger.level = Logger::WARN
         choose_page_token(page_token)
         loop_over_pages(ENV['GOOGLE_CALENDAR_ID_TEST'], page_limit: page_limit)
         puts '*** Cleared all events!' if @verbose
       rescue Google::Apis::RateLimitError
-        puts "\n\n*** Google::Apis::RateLimitError (Rate Limit Exceeded)"
+        puts "\n\n*** Google::Apis::RateLimitError (Rate Limit Exceeded)" if @verbose
       ensure
         log_last_page_token if token?
       end
@@ -58,10 +60,14 @@ module GoogleAPI
       end
 
       def progress_bar(total)
-        ProgressBar.create(
+        bar_config = {
           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"
-        )
+        }
+
+        bar_config = bar_config.merge(output: ProgressBar::Silent) if ENV.key?('HIDE_PROGRESS_BARS')
+
+        ProgressBar.create(bar_config)
       end
     end
   end

data/lib/google_api/configured.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  module Configured
+    require 'google_api/configured/calendar'
+    require 'google_api/configured/group'
+  end
+end

data/lib/google_api/configured/calendar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  module Configured
+    class Calendar
+      CALENDAR_API ||= GoogleAPI::Calendar.new
+
+      attr_reader :calendar_id
+
+      def initialize(calendar_id)
+        @calendar_id = calendar_id
+      end
+
+      def list(max_results: 2500, page_token: nil)
+        CALENDAR_API.list(calendar_id, max_results: max_results, page_token: page_token)
+      end
+
+      def create(event_options = {})
+        CALENDAR_API.create(calendar_id, event_options)
+      end
+
+      def get(event_id)
+        CALENDAR_API.get(calendar_id, event_id)
+      end
+
+      def update(event_id, event_options = {})
+        CALENDAR_API.update(calendar_id, event_id, event_options)
+      end
+
+      def delete(event_id)
+        CALENDAR_API.delete(calendar_id, event_id)
+      end
+
+      def permit(user = nil, email: nil)
+        CALENDAR_API.permit(calendar_id, user, email: email)
+      end
+
+      def unpermit(user = nil, calendar_rule_id: nil)
+        CALENDAR_API.unpermit(calendar_id, user, calendar_rule_id: calendar_rule_id)
+      end
+
+      def clear_test_calendar(page_token: nil, page_limit: 50, verbose: false, error: false)
+        CALENDAR_API.clear_test_calendar(
+          page_token: page_token, page_limit: page_limit, verbose: verbose, error: error
+        )
+      end
+    end
+  end
+end

data/lib/google_api/configured/group.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GoogleAPI
+  module Configured
+    class Group
+      GROUP_API ||= GoogleAPI::Group.new
+
+      attr_reader :group_id
+
+      def initialize(group_id)
+        @group_id = group_id
+      end
+
+      def get
+        GROUP_API.get(group_id)
+      end
+
+      def members
+        GROUP_API.members(group_id)
+      end
+
+      def add(email)
+        GROUP_API.add(group_id, email)
+      end
+
+      def remove(email)
+        GROUP_API.remove(group_id, email)
+      end
+    end
+  end
+end

data/lib/google_api/group.rb

@@ -4,27 +4,26 @@ module GoogleAPI
   class Group < GoogleAPI::Base
     SERVICE_CLASS = Google::Apis::AdminDirectoryV1::DirectoryService
 
-    def initialize(id, auth: true)
-      @group_id = id
+    def initialize(auth: true)
       super(auth: auth)
     end
 
-    def get
-      call(:get_group, @group_id)
+    def get(group_id)
+      call(:get_group, group_id)
     end
 
-    def members
-      call(:list_members, @group_id)
+    def members(group_id)
+      call(:list_members, group_id)
     end
 
-    def add(email)
-      call(:insert_member, @group_id, member(email))
+    def add(group_id, email)
+      call(:insert_member, group_id, member(email))
     rescue Google::Apis::ClientError
       :already_exists
     end
 
-    def remove(email)
-      call(:delete_member, @group_id, email)
+    def remove(group_id, email)
+      call(:delete_member, group_id, email)
     rescue Google::Apis::ClientError
       :not_found
     end

data/spec/lib/google_api/base_spec.rb

@@ -10,4 +10,24 @@ RSpec.describe GoogleAPI::Base do
       NameError, 'uninitialized constant GoogleAPI::Base::SERVICE_CLASS'
     )
   end
+
+  context 'with a valid subclass' do
+    subject { GoogleAPI::Calendar }
+
+    it 'returns the correct last token path' do
+      expect(subject.new.send(:last_token_path)).to eql('./tmp/run/last_page_token')
+    end
+
+    it 'returns an array from authorize with reveal' do
+      expect(subject.new(auth: false).authorize!(reveal: true)).to be_a(Array)
+    end
+
+    let(:reauth) { proc(subject.new(auth: false).authorize!(refresh: true)) }
+
+    it 'reauthorizes' do
+      silently do
+        expect { reauth.call }.to raise_error(Signet::AuthorizationError)
+      end
+    end
+  end
 end

data/spec/lib/google_api/calendar_spec.rb

@@ -3,73 +3,130 @@
 require 'spec_helper'
 
 RSpec.describe GoogleAPI::Calendar do
-  subject { described_class.new }
-
-  it 'has a service class' do
-    expect { subject.send(:service_class) }.not_to raise_error
+  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
 
-  it 'has the correct service class' do
-    expect(subject.send(:service_class)).to eql(Google::Apis::CalendarV3::CalendarService)
+  describe 'service class' do
+    subject { described_class.new }
+
+    it 'does not raise an error' do
+      expect { subject.send(:service_class) }.not_to raise_error
+    end
+
+    it 'is the correct class' do
+      expect(subject.send(:service_class)).to eql(Google::Apis::CalendarV3::CalendarService)
+    end
   end
 
-  describe 'list' do
-    it 'returns not found for a nonexistent calendar' do
-      expect { subject.list('not-a-calendar') }.to raise_error(
+  context 'with an invalid calendar' do
+    let(:test_cal_id) { 'not-a-calendar' }
+
+    subject { GoogleAPI::Configured::Calendar.new(test_cal_id) }
+
+    it 'returns not found from list' do
+      expect { subject.list }.to raise_error(
         Google::Apis::ClientError, 'notFound: Not Found'
       )
     end
-  end
 
-  describe 'create' do
-    it 'returns not found for a nonexistent calendar' do
-      expect { subject.create('not-a-calendar') }.to raise_error(
+    it 'returns not found from create' do
+      expect { subject.create }.to raise_error(
         Google::Apis::ClientError, 'notFound: Not Found'
       )
     end
-  end
 
-  describe 'get' do
-    it 'returns not found for a nonexistent calendar' do
-      expect { subject.get('not-a-calendar', 'not-an-event') }.to raise_error(
+    it 'returns not found from get' do
+      expect { subject.get('not-an-event') }.to raise_error(
         Google::Apis::ClientError, 'notFound: Not Found'
       )
     end
-  end
 
-  describe 'update' do
-    it 'returns not found for a nonexistent calendar' do
-      expect { subject.update('not-a-calendar', 'not-an-event') }.to raise_error(
+    it 'returns not found from update' do
+      expect { subject.update('not-an-event') }.to raise_error(
         Google::Apis::ClientError, 'notFound: Not Found'
       )
     end
-  end
 
-  describe 'delete' do
-    it 'returns event not found for a nonexistent calendar' do
-      expect(subject.delete('not-a-calendar', 'not-an-event')).to eql(
+    it 'returns event not found from delete' do
+      expect(subject.delete('not-an-event')).to eql(
         :event_not_found
       )
     end
-  end
 
-  describe 'permit' do
-    it 'returns nil for a nonexistent calendar' do
-      expect(subject.permit('not-a-calendar', email: 'not-a-user')).to be_nil
+    it 'returns nil from permit' do
+      expect(subject.permit(email: 'not-a-user')).to be_nil
     end
-  end
 
-  describe 'unpermit' do
-    it 'returns permission not found for a nonexistent calendar' do
-      expect(subject.unpermit('not-a-calendar', calendar_rule_id: 'not-a-user')).to eql(
-        :permission_not_found
-      )
+    it 'returns permission not found from unpermit' do
+      expect(subject.unpermit(calendar_rule_id: 'not-a-user')).to eql(:permission_not_found)
     end
   end
 
-  describe 'clear test calendar' do
-    it 'does not raise any errors' do
-      expect { subject.clear_test_calendar }.not_to raise_error
+  context 'with a valid calendar' do
+    let(:test_cal_id) { ENV['GOOGLE_CALENDAR_ID_TEST'] }
+
+    subject { GoogleAPI::Configured::Calendar.new(test_cal_id) }
+
+    it 'returns a list' do
+      expect(subject.list).to be_a(Google::Apis::CalendarV3::Events)
+    end
+
+    it 'creates an event' do
+      expect(subject.create(test_event)).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 '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.')
+    end
+
+    it 'deletes an event' do
+      event = subject.create(test_event)
+
+      expect(subject.delete(event.id)).to eql('')
+    end
+
+    it 'returns nil from permit' do
+      expect(subject.permit(email: 'not-a-user')).to be_nil
+    end
+
+    it 'returns permission not found from unpermit' do
+      expect(subject.unpermit(calendar_rule_id: 'not-a-user')).to eql(:permission_not_found)
+    end
+
+    describe 'clear test calendar' do
+      it 'does not raise any errors' do
+        expect { subject.clear_test_calendar }.not_to raise_error
+      end
+
+      it 'rescues from an unhandled rate limit exception' do
+        expect { subject.clear_test_calendar(error: true) }.not_to raise_error
+      end
+
+      it 'does not raise any errors with verbose' do
+        subject.create(test_event)
+
+        silently do
+          expect do
+            GoogleAPI::Configured::Calendar.new('test').clear_test_calendar(verbose: true)
+          end.not_to raise_error
+        end
+      end
     end
   end
 end

data/spec/lib/google_api/group_spec.rb

@@ -3,41 +3,47 @@
 require 'spec_helper'
 
 RSpec.describe GoogleAPI::Group do
-  subject { described_class.new('test-group@example.com') }
+  describe 'service class' do
+    subject { described_class.new }
 
-  it 'has a service class' do
-    expect { subject.send(:service_class) }.not_to raise_error
-  end
+    it 'has a service class' do
+      expect { subject.send(:service_class) }.not_to raise_error
+    end
 
-  it 'has the correct service class' do
-    expect(subject.send(:service_class)).to eql(Google::Apis::AdminDirectoryV1::DirectoryService)
+    it 'has the correct service class' do
+      expect(subject.send(:service_class)).to eql(Google::Apis::AdminDirectoryV1::DirectoryService)
+    end
   end
 
-  describe 'get' do
-    it 'returns not found for a nonexistent group' do
-      expect { subject.get }.to raise_error(
-        Google::Apis::ClientError, 'forbidden: Not Authorized to access this resource/api'
-      )
+  context 'with an invalid group' do
+    subject { GoogleAPI::Configured::Group.new('test-group@example.com') }
+
+    describe 'get' do
+      it 'returns not found for a nonexistent group' do
+        expect { subject.get }.to raise_error(
+          Google::Apis::ClientError, 'forbidden: Not Authorized to access this resource/api'
+        )
+      end
     end
-  end
 
-  describe 'members' do
-    it 'returns forbidden for a nonexistent group' do
-      expect { subject.members }.to raise_error(
-        Google::Apis::ClientError, 'forbidden: Not Authorized to access this resource/api'
-      )
+    describe 'members' do
+      it 'returns forbidden for a nonexistent group' do
+        expect { subject.members }.to raise_error(
+          Google::Apis::ClientError, 'forbidden: Not Authorized to access this resource/api'
+        )
+      end
     end
-  end
 
-  describe 'add' do
-    it 'returns not found for a nonexistent group' do
-      expect(subject.add('test-member@example.com')).to eql(:already_exists)
+    describe 'add' do
+      it 'returns not found for a nonexistent group' do
+        expect(subject.add('test-member@example.com')).to eql(:already_exists)
+      end
     end
-  end
 
-  describe 'remove' do
-    it 'returns not found for a nonexistent group' do
-      expect(subject.remove('test-member@example.com')).to eql(:not_found)
+    describe 'remove' do
+      it 'returns not found for a nonexistent group' do
+        expect(subject.remove('test-member@example.com')).to eql(:not_found)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,12 +5,25 @@ Bundler.setup
 require 'simplecov'
 SimpleCov.start do
   add_filter '/spec'
+  add_filter '/lib/ext'
 end
+SimpleCov.minimum_coverage(100)
 
 require 'google_api'
 
+def silently
+  original_stdout = $stdout
+  $stdout = File.new(File.join('tmp', 'null'), 'w')
+  yield
+  $stdout = original_stdout
+end
+
 RSpec.configure do |config|
   config.before(:suite) do
-    FileUtils.mkdir_p('tmp/run')
+    FileUtils.mkdir_p(File.join('tmp', 'run'))
+    FileUtils.rm(Dir.glob(File.join('config', 'keys', '*')))
+
+    ENV['GOOGLE_AUTHORIZATION_CODE'] = 'test-auth-code'
+    ENV['HIDE_PROGRESS_BARS'] = 'true'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bps-google-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Julian Fiander
@@ -120,11 +120,16 @@ files:
 - Gemfile.lock
 - Readme.md
 - bps-google-api.gemspec
+- lib/ext/hash.rb
+- lib/ext/silent_progress_bar.rb
 - lib/google_api.rb
 - lib/google_api/base.rb
 - lib/google_api/base/authorization.rb
 - lib/google_api/calendar.rb
 - lib/google_api/calendar/clear_test_calendar.rb
+- lib/google_api/configured.rb
+- lib/google_api/configured/calendar.rb
+- lib/google_api/configured/group.rb
 - lib/google_api/group.rb
 - spec/.rubocop.yml
 - spec/lib/google_api/base_spec.rb