bps-google-api 0.4.0 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e879f7388cbb93030b4c0ebb10ba8a7f0ebbce2
-  data.tar.gz: 2db793f99ffe1de7c5170b95e3c7d14278f30681
+SHA256:
+  metadata.gz: f9ffa3df8c2ddfecc62cfe5a9830ea2c48293aef1952240e9dd5acd12b260ca1
+  data.tar.gz: 1f3079fcec7a957a890fa217ee44e4ddcf664c31c0bc8129502ca70b92b0503f
 SHA512:
-  metadata.gz: 15b9400b2a26b43ea093798a9129115d61d3106b21f4d491075aaf191f2f86a729ff024fd39b7ba8ac341e9bf1bc85d664a9bc613c1f89279583e186501b005b
-  data.tar.gz: 22b09c587f8b7f831d31e586e1118660b1a7d1dca4d1ba88240209a6b38b413f4b9913d2eedb4aedd6a127f8a35973af71207ca16c5c6098cb484b8f7ac34b15
+  metadata.gz: 6412ddc986f1aff995bde999836779c649d9025fd885ab98e7ebb6dd1cc1e35c02f7685648cfa5308069e641e9c1da4bcb435c48a1274ccf7621bfc191849253
+  data.tar.gz: 7745f51650c013b668e1bdb535db57f5957f9ad5cf5b49b785e8280b91f0aeab2bef2f9964c1e6735b50ec87d45b48a954ee89e516098c4f3b36d7b1c8ee348a

data/.gitignore

@@ -1,3 +1,4 @@
 config/
 coverage/
-tmp/
+tmp/
+lib/google_api/tmp

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    bps-google-api (0.4.0)
-      exp_retry (~> 0.0.11)
+    bps-google-api (0.4.6)
+      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.3)
       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.2020.1104)
+    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
@@ -62,13 +68,22 @@ TZ # Timezone
 By default, if no configuration is available, `.new` will automatically run
 `.authorize!` and return a URL to generate an authorization token.
 
+### Configured Classes
+
+There are configured classes for both calendars and groups. This allows you to
+only specify the parent id once.
+
 ```ruby
 calendar = GoogleAPI::Configured::Calendar.new(calendar_id)
 
 calendar.create(event_options)
 calendar.list(max_results: 2500, page_token: nil)
+calendar.list_all
 calendar.get(event_id)
-calendar.update(event_id, event_options)
+calendar.patch(event_id, patch_options)
+calendar.update(event_id, updated_event_options)
+calendar.add_conference(event_id)
+calendar.conference_info(event_id, all: false)
 calendar.delete(event_id)
 
 calendar.permit(user)
@@ -84,6 +99,19 @@ group.add('somebody@example.com')
 group.remove('somebody@example.com')
 ```
 
+There is also an event-specific configured class:
+
+```ruby
+event = GoogleAPI::Configured::Calendar::Event.new(calendar_id, event_id)
+
+event.get
+event.patch(patch_options)
+event.update(updated_event_options)
+event.add_conference
+event.conference_info(all: false)
+event.delete
+```
+
 ### Event Options
 
 Available event options are listed in `GoogleAPI::Calendar::VALID_EVENT_KEYS`.
@@ -104,3 +132,32 @@ To add a Meet call to an event, merge the following into `event_options`:
 ```ruby
 { conference: { id: meeting_id, signature: meeting_signature } }
 ```
+
+To create a new Meet call on an event, merge the following into
+`event_options` instead:
+
+```ruby
+{ conference: { id: :new } }
+```
+
+## Testing
+
+### Rspec
+
+Rspec testing is available:
+
+`bundle exec rspec`
+
+The spec suite will fail if under 100% coverage.
+
+### Rubocop
+
+Rubocop formatting validation is available:
+
+`bundle exec rubocop`
+
+### Automatic Builds
+
+Builds are generated automatically by [Travis CI](https://travis-ci.org/jfiander/bps-google-api).
+
+Build success requires both `rspec` and `rubocop` to pass.

data/bps-google-api.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = 'bps-google-api'
-  s.version       = '0.4.0'
-  s.date          = '2019-06-27'
+  s.version       = '0.4.6'
+  s.date          = '2021-01-30'
   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

@@ -29,6 +29,12 @@ class GoogleAPI
     configuration
   end
 
+  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)
+  end
+
   # Internal requires
   require 'google_api/base'
   require 'google_api/calendar'

data/lib/google_api/calendar.rb

@@ -14,8 +14,7 @@ class GoogleAPI
 
     SERVICE_CLASS = Google::Apis::CalendarV3::CalendarService
     VALID_EVENT_KEYS ||= %i[
-      summary start end description location recurrence conference
-      conference_data
+      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
@@ -30,6 +29,22 @@ class GoogleAPI
       call(:list_events, calendar_id, max_results: max_results, page_token: page_token)
     end
 
+    def list_all(calendar_id, verbose: false)
+      events = []
+
+      list = call(:list_events, calendar_id)
+      events += list.items
+
+      while (page_token = list.next_page_token)
+        list = call(:list_events, calendar_id, page_token: page_token)
+        page_token = list.next_page_token
+        events += list.items
+        print('.') if verbose
+      end
+
+      events
+    end
+
     def get(calendar_id, event_id)
       call(:get_event, calendar_id, event_id)
     end

data/lib/google_api/calendar/conference.rb

@@ -15,6 +15,13 @@ 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)
+        conf = call(:get_event, calendar_id, event_id).conference_data
+        return conf if all || conf.nil?
+
+        { id: conf.conference_id, signature: conf.signature }
+      end
+
     private
 
       def format_conference_data(event_options)

data/lib/google_api/config.rb

@@ -6,7 +6,7 @@ class GoogleAPI
     attr_writer :keys
 
     def initialize
-      self.root = __dir__
+      self.root = File.join(__dir__, 'tmp')
 
       yield self if block_given?
     end

data/lib/google_api/configured/calendar.rb

@@ -17,6 +17,10 @@ class GoogleAPI
         self.class.api.list(calendar_id, max_results: max_results, page_token: page_token)
       end
 
+      def list_all
+        self.class.api.list_all(calendar_id)
+      end
+
       def create(event_options = {})
         self.class.api.create(calendar_id, event_options)
       end
@@ -54,6 +58,10 @@ class GoogleAPI
       def add_conference(event_id)
         self.class.api.add_conference(calendar_id, event_id)
       end
+
+      def conference_info(event_id, all: false)
+        self.class.api.conference_info(calendar_id, event_id, all: all)
+      end
     end
   end
 end

data/lib/google_api/configured/event.rb

@@ -34,6 +34,10 @@ class GoogleAPI
         def add_conference
           self.class.api.add_conference(calendar_id, event_id)
         end
+
+        def conference_info(all: false)
+          self.class.api.conference_info(calendar_id, event_id, all: all)
+        end
       end
     end
   end

data/spec/lib/google_api/calendar_spec.rb

@@ -77,26 +77,45 @@ RSpec.describe GoogleAPI::Calendar do
       expect(subject.list).to be_a(Google::Apis::CalendarV3::Events)
     end
 
+    it 'returns the array of all events from list_all' do
+      subject.create(test_event) # Ensure at least one event exists
+
+      expect(subject.list_all.map(&:class).uniq).to eql([Google::Apis::CalendarV3::Event])
+    end
+
     it 'creates an event' 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
+    describe 'conference data' do
+      it 'creates an event with a new conference' do
+        event = test_event.merge(conference: { id: :new })
 
-    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: {
+        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 'returns valid conference information' do
+        event = subject.create(test_event)
+        event = subject.add_conference(event.id)
+
+        expect(subject.conference_info(event.id)).to eql(
           id: event.conference_data.conference_id,
           signature: event.conference_data.signature
-        }
-      )
-
-      expect(subject.create(event_options)).to be_a(Google::Apis::CalendarV3::Event)
+        )
+      end
     end
 
     it 'gets an event ' do

data/spec/lib/google_api/event_spec.rb

@@ -40,7 +40,18 @@ RSpec.describe GoogleAPI::Configured::Calendar::Event do
     expect(subject.delete).to eql('')
   end
 
-  it 'adds conference data' do
-    expect(subject.add_conference).to be_a(Google::Apis::CalendarV3::Event)
+  describe 'conference data' do
+    it 'adds conference data' do
+      expect(subject.add_conference).to be_a(Google::Apis::CalendarV3::Event)
+    end
+
+    it 'returns valid conference information' do
+      event = subject.add_conference
+
+      expect(subject.conference_info).to eql(
+        id: event.conference_data.conference_id,
+        signature: event.conference_data.signature
+      )
+    end
   end
 end

data/spec/spec_helper.rb

@@ -25,6 +25,8 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bps-google-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.6
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2021-01-30 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
@@ -179,8 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: Configured Google API