bps-google-api 0.4.6 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9ffa3df8c2ddfecc62cfe5a9830ea2c48293aef1952240e9dd5acd12b260ca1
-  data.tar.gz: 1f3079fcec7a957a890fa217ee44e4ddcf664c31c0bc8129502ca70b92b0503f
+  metadata.gz: b9568cf68776abd0aa81f0ceaeecc4b8ca1152f9351f58afb2c6e00936b379bc
+  data.tar.gz: e21356e6b6928dd1e678e442e3bb87e524e3a90308ec741d4670def3838b326b
 SHA512:
-  metadata.gz: 6412ddc986f1aff995bde999836779c649d9025fd885ab98e7ebb6dd1cc1e35c02f7685648cfa5308069e641e9c1da4bcb435c48a1274ccf7621bfc191849253
-  data.tar.gz: 7745f51650c013b668e1bdb535db57f5957f9ad5cf5b49b785e8280b91f0aeab2bef2f9964c1e6735b50ec87d45b48a954ee89e516098c4f3b36d7b1c8ee348a
+  metadata.gz: 53244017cd5d5b904bd30489f31e6788d05a9bd40ca660870409afb6113f059dc469a6442b5c7627fa56ff00d87a2b7a447e41d3182a6313b529b37989b8c475
+  data.tar.gz: def98ec0603bcbd7d13b4c793ed1f3b52b31dbf5023e71a47a78554cb5c6f220d8e76761ee308baefde47978e0b48e842d54336d234e6e536ab7b0b232d162d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bps-google-api (0.4.6)
+    bps-google-api (0.4.11)
       exp_retry (~> 0.0.13)
       fileutils (~> 1.2)
       google-api-client (~> 0.23.4)
@@ -10,15 +10,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     declarative (0.0.20)
-    declarative-option (0.1.0)
     diff-lcs (1.3)
     docile (1.3.2)
     exp_retry (0.0.13)
-    faraday (0.17.3)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
     fileutils (1.5.0)
     google-api-client (0.23.9)
@@ -39,11 +38,11 @@ GEM
     httpclient (2.8.3)
     jaro_winkler (1.5.3)
     json (2.3.1)
-    jwt (2.2.2)
+    jwt (2.2.3)
     memoist (0.16.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
+    mime-types-data (3.2021.0901)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     os (1.1.1)
@@ -52,9 +51,9 @@ GEM
       ast (~> 2.4.0)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    representable (3.0.4)
+    representable (3.1.1)
       declarative (< 0.1.0)
-      declarative-option (< 0.2.0)
+      trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
     retriable (3.1.2)
     rspec (3.8.0)
@@ -88,6 +87,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    trailblazer-option (0.1.1)
     uber (0.1.0)
     unicode-display_width (1.6.0)
 

data/Readme.md

@@ -1,7 +1,7 @@
 # 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)
+[![Build Status](https://travis-ci.com/jfiander/bps-google-api.svg)](https://travis-ci.com/jfiander/bps-google-api)
 
 A configured Google API wrapper.
 

data/bps-google-api.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = 'bps-google-api'
-  s.version       = '0.4.6'
-  s.date          = '2021-01-30'
+  s.version       = '0.4.11'
+  s.date          = '2021-09-15'
   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/base.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
+require 'google_api/base/authorization'
+
 class GoogleAPI
   class Base
+    include GoogleAPI::Base::Authorization
+
     RETRIES ||= [
       Google::Apis::TransmissionError, Google::Apis::ServerError,
       Google::Apis::RateLimitError, Errno::ECONNRESET
     ].freeze
 
-    require 'google_api/base/authorization'
-    include GoogleAPI::Base::Authorization
-
     def initialize(auth: true)
       authorize! if auth
     end
@@ -27,7 +28,17 @@ class GoogleAPI
     end
 
     def call(method, *args)
-      ExpRetry.for(exception: RETRIES) { service.send(method, *args) }
+      if GoogleAPI.mock
+        send(:mock, method, *args)
+      else
+        ExpRetry.for(exception: RETRIES) { service.send(method, *args) }
+      end
+    end
+
+    # :nocov:
+    def mock(*)
+      raise 'This method must be overwritten by the inheriting class.'
     end
+    # :nocov:
   end
 end

data/lib/google_api/calendar/conference.rb

@@ -15,7 +15,11 @@ class GoogleAPI
         call(:patch_event, calendar_id, event_id, patch_options, conference_data_version: 1)
       end
 
-      def conference_info(calendar_id, event_id, all: false)
+      def conference_info(calendar_id, event_id = nil, all: false)
+        return conference_mock if GoogleAPI.mock
+
+        raise ArgumentError, 'event_id is required' if event_id.nil?
+
         conf = call(:get_event, calendar_id, event_id).conference_data
         return conf if all || conf.nil?
 
@@ -42,10 +46,8 @@ class GoogleAPI
 
       def conference(conf_id, signature)
         {
-          conference: {
-            conference_id: conf_id, conference_solution: meet_solution,
-            entry_points: meet_entry(conf_id), signature: signature
-          }
+          conference_id: conf_id, conference_solution: meet_solution,
+          entry_points: meet_entry(conf_id), signature: signature
         }
       end
 
@@ -74,6 +76,10 @@ class GoogleAPI
           )
         ]
       end
+
+      def conference_mock
+        { id: 'abc-defg-hjk', signature: SecureRandom.hex(32) }
+      end
     end
   end
 end

data/lib/google_api/calendar.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
+require 'google_api/calendar/conference'
+require 'google_api/calendar/clear_test_calendar'
+
 class GoogleAPI
   class Calendar < GoogleAPI::Base
-    def self.last_token_path
-      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
@@ -21,6 +17,10 @@ class GoogleAPI
       etag html_link i_cal_uid id kind organizer reminders sequence status updated
     ].freeze
 
+    def self.last_token_path
+      GoogleAPI.configuration.local_path('tmp', 'run', 'last_page_token')
+    end
+
     def create(calendar_id, event_options = {})
       call(:insert_event, calendar_id, event(event_options), conference_data_version: 1)
     end
@@ -111,5 +111,13 @@ class GoogleAPI
       key = date&.is_a?(String) ? :date : :date_time
       Google::Apis::CalendarV3::EventDateTime.new(key => date, time_zone: ENV['TZ'])
     end
+
+    def mock(*)
+      Google::Apis::CalendarV3::Event.new(
+        id: SecureRandom.hex(8),
+        html_link: 'http://calendar.google.com',
+        conference_id: 'abc-defg-hjk'
+      )
+    end
   end
 end

data/lib/google_api/configured/calendar.rb

@@ -60,6 +60,8 @@ class GoogleAPI
       end
 
       def conference_info(event_id, all: false)
+        return self.class.api.send(:conference_mock) if GoogleAPI.mock
+
         self.class.api.conference_info(calendar_id, event_id, all: all)
       end
     end

data/lib/google_api/group.rb

@@ -33,5 +33,13 @@ class GoogleAPI
     def member(email)
       Google::Apis::AdminDirectoryV1::Member.new(email: email)
     end
+
+    def mock(*)
+      Google::Apis::AdminDirectoryV1::Members.new(
+        members: [
+          Google::Apis::AdminDirectoryV1::Member.new(email: 'nobody@example.com')
+        ]
+      )
+    end
   end
 end

data/lib/google_api.rb

@@ -1,47 +1,57 @@
 # frozen_string_literal: true
 
-class GoogleAPI
-  # Core Dependencies
-  require 'date'
-
-  # Google Dependencies
-  require 'google/apis/calendar_v3'
-  require 'google/apis/groupssettings_v1'
-  require 'google/apis/admin_directory_v1'
-  require 'googleauth'
-  require 'googleauth/stores/file_token_store'
-
-  # External dependencies
-  require 'exp_retry'
-  require 'fileutils'
-  require 'ruby-progressbar'
-
-  # Configuration
-  require 'google_api/config'
-
-  def self.configuration
-    @configuration ||= GoogleAPI::Config.new
-  end
-
-  def self.configure
-    yield(configuration) if block_given?
-    FileUtils.mkdir_p(configuration.root)
-    configuration
-  end
+# Core Dependencies
+require 'date'
+
+# Google Dependencies
+require 'google/apis/calendar_v3'
+require 'google/apis/groupssettings_v1'
+require 'google/apis/admin_directory_v1'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+
+# External dependencies
+require 'exp_retry'
+require 'fileutils'
+require 'ruby-progressbar'
+
+# Configuration
+require 'google_api/config'
+
+# Internal requires
+require 'google_api/base'
+require 'google_api/calendar'
+require 'google_api/group'
+require 'google_api/configured'
+
+# Extensions
+require 'ext/hash' unless defined?(Rails)
+require 'ext/silent_progress_bar'
 
-  def self.logging!(level = :FATAL)
-    raise ArgumentError, 'Unknown logging level' unless %i[INFO WARN ERROR FATAL].include?(level)
-
-    Google::Apis.logger.level = Logger.const_get(level)
+class GoogleAPI
+  class << self
+    def configuration
+      @configuration ||= GoogleAPI::Config.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      FileUtils.mkdir_p(configuration.root)
+      configuration
+    end
+
+    def logging!(level = :FATAL)
+      raise ArgumentError, 'Unknown level' unless %i[DEBUG INFO WARN ERROR FATAL].include?(level)
+
+      Google::Apis.logger.level = Logger.const_get(level)
+    end
+
+    def mock!(value = true)
+      @mock = value
+    end
+
+    def mock
+      @mock || false
+    end
   end
-
-  # Internal requires
-  require 'google_api/base'
-  require 'google_api/calendar'
-  require 'google_api/group'
-  require 'google_api/configured'
-
-  # Extensions
-  require 'ext/hash' unless defined?(Rails)
-  require 'ext/silent_progress_bar'
 end

data/spec/lib/google_api/calendar_spec.rb

@@ -83,6 +83,23 @@ RSpec.describe GoogleAPI::Calendar do
       expect(subject.list_all.map(&:class).uniq).to eql([Google::Apis::CalendarV3::Event])
     end
 
+    context 'with multiple pages' do
+      let(:calendar) { subject.class.api }
+
+      before do
+        allow(calendar).to receive(:call).and_return(
+          Google::Apis::CalendarV3::Events.new(items: [Google::Apis::CalendarV3::Event], next_page_token: 'abc'),
+          Google::Apis::CalendarV3::Events.new(items: [Google::Apis::CalendarV3::Event], next_page_token: nil)
+        )
+      end
+
+      it 'returns the array of all events from list_all when paginated' do
+        expect(calendar).to receive(:call).twice
+
+        subject.list_all
+      end
+    end
+
     it 'creates an event' do
       expect(subject.create(test_event)).to be_a(Google::Apis::CalendarV3::Event)
     end
@@ -94,7 +111,7 @@ RSpec.describe GoogleAPI::Calendar do
         expect(subject.create(event)).to be_a(Google::Apis::CalendarV3::Event)
       end
 
-      it 'creates an event with conference data' do
+      it 'creates an event with conference data', :aggregate_failures do
         event = subject.create(test_event)
         event = subject.add_conference(event.id)
         event_options = test_event.merge(
@@ -104,7 +121,9 @@ RSpec.describe GoogleAPI::Calendar do
           }
         )
 
-        expect(subject.create(event_options)).to be_a(Google::Apis::CalendarV3::Event)
+        event = subject.create(event_options)
+        expect(event).to be_a(Google::Apis::CalendarV3::Event)
+        expect(event.conference_data).not_to be_nil
       end
 
       it 'returns valid conference information' do
@@ -178,4 +197,22 @@ RSpec.describe GoogleAPI::Calendar do
       expect(subject.add_conference(event.id)).to be_a(Google::Apis::CalendarV3::Event)
     end
   end
+
+  describe 'mock' do
+    subject { described_class.new }
+
+    before { GoogleAPI.mock! }
+
+    it 'calls the mock method' do
+      expect(subject).to receive(:mock).and_call_original
+
+      subject.create({})
+    end
+
+    it 'calls the conference_mock method' do
+      expect(subject).to receive(:conference_mock).and_call_original
+
+      subject.conference_info('')
+    end
+  end
 end

data/spec/lib/google_api/group_spec.rb

@@ -46,4 +46,16 @@ RSpec.describe GoogleAPI::Group do
       end
     end
   end
+
+  describe 'mock' do
+    subject { described_class.new }
+
+    before { GoogleAPI.mock! }
+
+    it 'calls the mock method' do
+      expect(subject).to receive(:mock).and_call_original
+
+      subject.members({})
+    end
+  end
 end

data/spec/lib/google_api_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GoogleAPI do
+  it 'sets the log level correctly' do
+    expect { GoogleAPI.logging!(:FATAL) }.to(
+      change(Google::Apis.logger, :level).from(Logger::WARN).to(Logger::FATAL)
+    )
+  end
+
+  it 'raises for invalid levels' do
+    expect { GoogleAPI.logging!(:WRONG) }.to raise_error(ArgumentError, 'Unknown level')
+  end
+
+  it 'sets the mock flag' do
+    expect { GoogleAPI.mock! }.to change { GoogleAPI.mock }.from(false).to(true)
+  end
+end

data/spec/spec_helper.rb

@@ -32,4 +32,8 @@ RSpec.configure do |config|
     ENV['GOOGLE_AUTHORIZATION_CODE'] = 'test-auth-code'
     ENV['HIDE_PROGRESS_BARS'] = 'true'
   end
+
+  config.after do
+    GoogleAPI.mock!(false) # Reset mock state
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bps-google-api
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.11
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exp_retry
@@ -159,6 +159,7 @@ files:
 - spec/lib/google_api/calendar_spec.rb
 - spec/lib/google_api/event_spec.rb
 - spec/lib/google_api/group_spec.rb
+- spec/lib/google_api_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/bps-google-api
 licenses: