bps-google-api 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81ec7c00f00165af4b968536942fc7637ef08a7
-  data.tar.gz: f560253ee4e8ae7ada9dfaaf3a69b0158070d349
+  metadata.gz: d3fdf1dc00cb06bca57e8cec64ac829aa8c2b64d
+  data.tar.gz: f3f93c405057358d4867556026a215f5eba56159
 SHA512:
-  metadata.gz: e633ccdf18625cdb33f9b7c9eb67393617ebd9644910d4bf66319ea2d824e32c2bf2d3946b7c6900643be59f9f244a50739635a1a6196fafbb70cbe628bc2839
-  data.tar.gz: fc05951a3d4af73490f1d5b594987dd518260b27727e9ae167b4e391d1c9afb4ead756707fc101dbef5c90656480c5dc1557d092342784298d74078102f3d4fd
+  metadata.gz: 2dd2714fa3eb9d611b348e16a9a55fb02855991750ad8dccc58d33fa54506db8ead002e58725e36c5b456d75252689987007db78ed7c479b48a66deee7bb15a0
+  data.tar.gz: c2d6b1d4b0356552565d214e741f1027d7256781ad923af1d0b636c61f386153cc2a4eab1277775fad920f1a14a4771c310078e0f56f43a869bd31a2b7dfe71e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bps-google-api (0.2.10)
+    bps-google-api (0.3.0)
       exp_retry (~> 0.0.11)
       fileutils (~> 1.2)
       google-api-client (~> 0.23.4)
@@ -50,7 +50,7 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    public_suffix (3.1.0)
+    public_suffix (3.1.1)
     rainbow (3.0.0)
     representable (3.0.4)
       declarative (< 0.1.0)

data/Readme.md

@@ -16,6 +16,21 @@ or install directly:
 gem install bps-google-api
 ```
 
+Create an initializer to configure the root directory for the gem:
+
+```ruby
+GoogleAPI.configure do |config|
+  config.root = File.join('tmp', 'google_api')
+end
+```
+
+```ruby
+GoogleAPI.configure do |config|
+  config.root = Rails.root.join('config', 'google_api')
+  config.keys = Rails.root.join('config', 'keys')
+end
+```
+
 Then run 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.2.10'
-  s.date          = '2019-06-20'
+  s.version       = '0.3.0'
+  s.date          = '2019-06-25'
   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.rb

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
+  # 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
+
+  # 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,16 +1,12 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   class Base
     RETRIES ||= [
       Google::Apis::TransmissionError, Google::Apis::ServerError,
       Google::Apis::RateLimitError, Errno::ECONNRESET
     ].freeze
 
-    def self.root_path
-      defined?(Rails) ? Rails.root : File.dirname(__dir__)
-    end
-
     require 'google_api/base/authorization'
     include GoogleAPI::Base::Authorization
 

data/lib/google_api/base/authorization.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   class Base
     module Authorization
       OOB_URI ||= 'urn:ietf:wg:oauth:2.0:oob'
@@ -51,15 +51,15 @@ module GoogleAPI
         Google::Auth::ClientId.from_hash(
           JSON.parse(
             File.read(
-              File.join(GoogleAPI::Base.root_path, 'config', 'keys', 'google_api_client.json')
+              GoogleAPI.configuration.local_path('google_api_client.json', &:keys)
             )
           )
         )
       end
 
       def auth_token_store
-        Google::Auth::Stores::FileTokenStore.new(file:
-          File.join(GoogleAPI::Base.root_path, 'config', 'keys', 'google_token.yaml')
+        Google::Auth::Stores::FileTokenStore.new(
+          file: GoogleAPI.configuration.local_path('google_token.yaml', &:keys)
         )
       end
 
@@ -76,8 +76,7 @@ module GoogleAPI
       end
 
       def store_key(filename, key)
-        FileUtils.mkdir_p(File.join(GoogleAPI::Base.root_path, 'config', 'keys'))
-        path = File.join(GoogleAPI::Base.root_path, 'config', 'keys', filename)
+        path = GoogleAPI.configuration.local_path(filename, &:keys)
         return if File.exist?(path)
 
         File.open(path, 'w+') do |f|

data/lib/google_api/calendar.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   class Calendar < GoogleAPI::Base
     def self.last_token_path
-      FileUtils.mkdir_p(File.join(GoogleAPI::Base.root_path, 'tmp', 'run'))
-      File.join(GoogleAPI::Base.root_path, 'tmp', 'run', 'last_page_token')
+      GoogleAPI.configuration.local_path('tmp', 'run', 'last_page_token')
     end
 
     require 'google_api/calendar/clear_test_calendar'

data/lib/google_api/calendar/clear_test_calendar.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   class Calendar < GoogleAPI::Base
     module ClearTestCalendar
       def clear_test_calendar(page_token: nil, page_limit: 50, verbose: false, error: false)

data/lib/google_api/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class GoogleAPI
+  class Config
+    attr_accessor :root
+    attr_writer :keys
+
+    def initialize
+      self.root = __dir__
+
+      yield self if block_given?
+    end
+
+    def keys
+      @keys || root
+    end
+
+    def local_path(*path)
+      basepath = block_given? ? yield(self) : root
+      fullpath = File.join(basepath, *path)
+      paths = fullpath.split('/')
+      filename = paths.pop
+      path = File.join(*paths)
+
+      FileUtils.mkdir_p(path)
+      File.join(path, filename)
+    end
+  end
+end

data/lib/google_api/configured.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   module Configured
     require 'google_api/configured/calendar'
     require 'google_api/configured/group'

data/lib/google_api/configured/calendar.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   module Configured
     class Calendar
-      CALENDAR_API ||= GoogleAPI::Calendar.new
+      def self.api
+        @api ||= GoogleAPI::Calendar.new
+      end
 
       attr_reader :calendar_id
 
@@ -12,35 +14,35 @@ module GoogleAPI
       end
 
       def list(max_results: 2500, page_token: nil)
-        CALENDAR_API.list(calendar_id, max_results: max_results, page_token: page_token)
+        self.class.api.list(calendar_id, max_results: max_results, page_token: page_token)
       end
 
       def create(event_options = {})
-        CALENDAR_API.create(calendar_id, event_options)
+        self.class.api.create(calendar_id, event_options)
       end
 
       def get(event_id)
-        CALENDAR_API.get(calendar_id, event_id)
+        self.class.api.get(calendar_id, event_id)
       end
 
       def update(event_id, event_options = {})
-        CALENDAR_API.update(calendar_id, event_id, event_options)
+        self.class.api.update(calendar_id, event_id, event_options)
       end
 
       def delete(event_id)
-        CALENDAR_API.delete(calendar_id, event_id)
+        self.class.api.delete(calendar_id, event_id)
       end
 
       def permit(user = nil, email: nil)
-        CALENDAR_API.permit(calendar_id, user, email: email)
+        self.class.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)
+        self.class.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(
+        self.class.api.clear_test_calendar(
           page_token: page_token, page_limit: page_limit, verbose: verbose, error: error
         )
       end

data/lib/google_api/configured/group.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   module Configured
     class Group
-      GROUP_API ||= GoogleAPI::Group.new
+      def self.api
+        @api ||= GoogleAPI::Group.new
+      end
 
       attr_reader :group_id
 
@@ -12,19 +14,19 @@ module GoogleAPI
       end
 
       def get
-        GROUP_API.get(group_id)
+        self.class.api.get(group_id)
       end
 
       def members
-        GROUP_API.members(group_id)
+        self.class.api.members(group_id)
       end
 
       def add(email)
-        GROUP_API.add(group_id, email)
+        self.class.api.add(group_id, email)
       end
 
       def remove(email)
-        GROUP_API.remove(group_id, email)
+        self.class.api.remove(group_id, email)
       end
     end
   end

data/lib/google_api/group.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GoogleAPI
+class GoogleAPI
   class Group < GoogleAPI::Base
     SERVICE_CLASS = Google::Apis::AdminDirectoryV1::DirectoryService
 

data/spec/lib/google_api/base_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe GoogleAPI::Base do
 
     it 'returns the correct last token path' do
       expect(GoogleAPI::Calendar.last_token_path).to eql(
-        File.join(GoogleAPI::Base.root_path, 'tmp', 'run', 'last_page_token')
+        GoogleAPI.configuration.local_path('tmp', 'run', 'last_page_token')
       )
     end
 

data/spec/spec_helper.rb

@@ -13,15 +13,15 @@ require 'google_api'
 
 def silently
   original_stdout = $stdout
-  $stdout = File.new(File.join(GoogleAPI::Base.root_path, 'tmp', 'null'), 'w')
+  $stdout = File.new(GoogleAPI.configuration.local_path('tmp', 'null'), 'w')
   yield
   $stdout = original_stdout
 end
 
 RSpec.configure do |config|
   config.before(:suite) do
-    FileUtils.mkdir_p(File.join(GoogleAPI::Base.root_path, 'tmp', 'run'))
-    FileUtils.rm(Dir.glob(File.join(GoogleAPI::Base.root_path, 'config', 'keys', '*')))
+    FileUtils.mkdir_p(GoogleAPI.configuration.local_path('tmp', 'run'))
+    FileUtils.rm(Dir.glob(GoogleAPI.configuration.local_path('config', 'keys', '*')))
 
     ENV['GOOGLE_AUTHORIZATION_CODE'] = 'test-auth-code'
     ENV['HIDE_PROGRESS_BARS'] = 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bps-google-api
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exp_retry
@@ -147,6 +147,7 @@ files:
 - lib/google_api/base/authorization.rb
 - lib/google_api/calendar.rb
 - lib/google_api/calendar/clear_test_calendar.rb
+- lib/google_api/config.rb
 - lib/google_api/configured.rb
 - lib/google_api/configured/calendar.rb
 - lib/google_api/configured/group.rb