bps-google-api 0.4.4 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 788064cba2b4804e1160d25ce3821b0272fe639f
-  data.tar.gz: 033f65955b8ab308501341e7b6fc5b2516724492
+SHA256:
+  metadata.gz: de16bf3d1c0b8b9f1971b1bb77077ded52379e3502d667fb3ca168e74bf202aa
+  data.tar.gz: 9ef1b294632a591e4808a6d0456e346b2a29922bf0fb756905813586517d83af
 SHA512:
-  metadata.gz: 00cf09c82eaa74317ad14726400c0024fdf69782c578ad2f79402386e6e630ecbf3c11762d5bde80002047d9f7ec6f86bf6869aa30fc54ca39acd0badb746437
-  data.tar.gz: 5afe4b08a137a5838f356b66ecce7361ff2620be574c10c205daf003c6c036e969ad6a65f875102c433e44cf07291445c3e6cab6be30579688efbaaf79503837
+  metadata.gz: 4a5a51dc5e75da452e7d548ad643997b9935ff8f535da11cb289e595deb2025c8bbbf15e77296f2053fd2b75a487af8a9d493ad45f28610e37d7f1b3263dffc3
+  data.tar.gz: 140eac17905e9b5396c79e39e7523192c3ce8616090328f893e0afe057e769dae71759a1fdcaac0a731939f485ab80868a662b2db9f48ef72d09658a2f6d2a1e

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    bps-google-api (0.4.4)
-      exp_retry (~> 0.0.11)
+    bps-google-api (0.4.10)
+      exp_retry (~> 0.0.13)
       fileutils (~> 1.2)
       google-api-client (~> 0.23.4)
       ruby-progressbar (~> 1.10)
@@ -10,17 +10,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    declarative (0.0.10)
+    declarative (0.0.20)
     declarative-option (0.1.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    exp_retry (0.0.12)
-    faraday (0.15.4)
+    exp_retry (0.0.13)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-    fileutils (1.2.0)
+    fileutils (1.5.0)
     google-api-client (0.23.9)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.5, < 0.7.0)
@@ -38,19 +38,19 @@ GEM
       signet (~> 0.7)
     httpclient (2.8.3)
     jaro_winkler (1.5.3)
-    json (2.2.0)
-    jwt (2.2.1)
-    memoist (0.16.0)
-    mime-types (3.2.2)
+    json (2.3.1)
+    jwt (2.2.2)
+    memoist (0.16.2)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    multi_json (1.13.1)
+    mime-types-data (3.2021.0225)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    os (1.0.1)
+    os (1.1.1)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     representable (3.0.4)
       declarative (< 0.1.0)
@@ -78,9 +78,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    signet (0.11.0)
+    signet (0.14.1)
       addressable (~> 2.3)
-      faraday (~> 0.9)
+      faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
     simplecov (0.16.1)

data/Readme.md

@@ -36,6 +36,12 @@ GoogleAPI.configure do |config|
 end
 ```
 
+You can also alter the logging level using:
+
+```ruby
+GoogleAPI.logging!(:FATAL) # %i[INFO WARN ERROR FATAL]
+```
+
 Then add the following in `config/application.rb`:
 
 ```ruby

data/bps-google-api.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = 'bps-google-api'
-  s.version       = '0.4.4'
-  s.date          = '2019-06-27'
+  s.version       = '0.4.10'
+  s.date          = '2021-02-27'
   s.summary       = 'Configured Google API'
   s.description   = 'A configured Google API wrapper.'
   s.homepage      = 'http://rubygems.org/gems/bps-google-api'
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.4'
 
-  s.add_runtime_dependency 'exp_retry',         '~> 0.0.11'
+  s.add_runtime_dependency 'exp_retry',         '~> 0.0.13'
   s.add_runtime_dependency 'fileutils',         '~> 1.2'
   s.add_runtime_dependency 'google-api-client', '~> 0.23.4'
   s.add_runtime_dependency 'ruby-progressbar',  '~> 1.10'

data/lib/google_api.rb

@@ -1,41 +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
+# 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.configure
-    yield(configuration) if block_given?
-    FileUtils.mkdir_p(configuration.root)
-    configuration
+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/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.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/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?
 
@@ -74,6 +78,10 @@ class GoogleAPI
           )
         ]
       end
+
+      def conference_mock
+        { id: 'abc-defg-hjk', signature: SecureRandom.hex(32) }
+      end
     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/spec/lib/google_api/calendar_spec.rb

@@ -178,4 +178,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

@@ -25,9 +25,15 @@ RSpec.configure do |config|
       c.keys = 'tmp/spec/keys'
     end
 
+    GoogleAPI.logging!(:INFO)
+
     FileUtils.rm(Dir.glob(GoogleAPI.configuration.local_path('*', &:keys)))
 
     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.4
+  version: 0.4.10
 platform: ruby
 authors:
 - Julian Fiander
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exp_retry
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.0.13
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
@@ -159,12 +159,13 @@ 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:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,9 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Configured Google API
 test_files: []