drive_v3 0.2.0

data/lib/drive_v3/create_credential.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'json_schemer'
+
+module DriveV3
+  # Creates a Google API credential with an access token
+  #
+  class CreateCredential
+    # Creates a Google API credential with an access token
+    #
+    # This wraps the boiler plate code into one function to make constructing a
+    # credential easy and less error prone.
+    #
+    # @example Constructing a credential from the contents of ~/.credential
+    #   credential_source = File.read(File.join(Dir.home, '.credential'))
+    #   scope = Google::Apis::DriveV3::AUTH_DRIVE
+    #   credential = DriveV3::CreateCredential.call(credential_source, scope)
+    #
+    # @param [Google::Auth::*, String, IO, nil] credential_source may be one of four things:
+    #   (1) a previously created credential that you want to reuse, (2) a credential read
+    #   into a string, (3) an IO object with the credential ready to be read, or (4)
+    #   if nill, the credential is read from ~/.google-api-credential.json
+    # @param scopes [Object, Array] one or more scopes to access.
+    # @param credential_factory [#make_creds] Used inject the credential_factory for tests
+    #
+    # @return [Object] a credential object with an access token
+    #
+    def self.call(
+      credential_source, scopes, credential_factory = Google::Auth::DefaultCredentials
+    )
+      return credential_source if credential?(credential_source)
+
+      credential_source ||= default_credential_source
+      options = make_creds_options(credential_source, scopes)
+      credential_factory.make_creds(options).tap(&:fetch_access_token)
+    end
+
+    private
+
+    # Reads credential source from `~/.google-api-credential.json`
+    #
+    # @return [String] the credential as a string
+    #
+    # @api private
+    #
+    private_class_method def self.default_credential_source
+      File.read(File.expand_path('~/.google-api-credential.json'))
+    end
+
+    # Constructs creds_options needed to create a credential
+    #
+    # @param [Google::Auth::*, String, #read] credential_source a credential (which
+    #   is an object whose class is in the Google::Auth module), a String containing
+    #   the credential, or a IO object with the credential ready to be read.
+    #
+    # @return [Hash] returns the cred_options
+    #
+    # @api private
+    #
+    private_class_method def self.make_creds_options(credential_source, scopes)
+      { json_key_io: to_io(credential_source), scope: scopes }
+    end
+
+    # Wraps a credential_source that is a string in a StringIO
+    #
+    # @param [Google::Auth::*, String, #read] credential_source a credential (which
+    #   is an object whose class is in the Google::Auth module), a String containing
+    #   the credential, or a IO object with the credential ready to be read.
+    #
+    # @return [IO, StringIO] returns a StringIO object is a String was passed in.
+    #
+    # @api private
+    #
+    private_class_method def self.to_io(credential_source)
+      credential_source.is_a?(String) ? StringIO.new(credential_source) : credential_source
+    end
+
+    # Determines if a credential_source is already a credential
+    #
+    # @param [Google::Auth::*, String, #read] credential_source a credential (which
+    #   is an object whose class is in the Google::Auth module), a String containing
+    #   the credential, or a IO object with the credential ready to be read.
+    #
+    # @return [Boolean] true if the credential source is an object whose class is in the
+    #   Google::Auth module.
+    #
+    # @api private
+    #
+    private_class_method def self.credential?(credential_source)
+      credential_source.class.name.start_with?('Google::Auth::')
+    end
+  end
+end

data/lib/drive_v3/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DriveV3
+  # The version of this gem
+  VERSION = '0.2.0'
+end

data/lib/drive_v3.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'drive_v3/version'
+require_relative 'drive_v3/create_credential'
+
+require 'google/apis/drive_v3'
+require 'json'
+require 'logger'
+
+# Unofficial helpers for the Google Drive V3 API
+#
+# @api public
+#
+module DriveV3
+  class << self
+    # Create a new Google::Apis::DriveV3::DriveService object
+    #
+    # Simplifies creating and configuring a the credential.
+    #
+    # @example using the credential in `~/.google-api-credential`
+    #   DriveV3.drive_service
+    #
+    # @example using a credential passed in as a string
+    #   credential_source = File.read(File.expand_path('~/.google-api-credential.json'))
+    #   DriveV3.drive_service(credential_source:)
+    #
+    # @example using a credential passed in as an IO
+    #   credential_source = File.open(File.expand_path('~/.google-api-credential.json'))
+    #   DriveV3.drive_service(credential_source:)
+    #
+    # @param credential_source [nil, String, IO, Google::Auth::*] may
+    #   be either an already constructed credential, the credential read into a String or
+    #   an open file with the credential ready to be read. Passing `nil` will result
+    #   in the credential being read from `~/.google-api-credential.json`.
+    #
+    # @param scopes [Object, Array] one or more scopes to access.
+    #
+    # @param credential_creator [#credential] Used to inject the credential creator for
+    #   testing.
+    #
+    # @return a new DriveService instance
+    #
+    def drive_service(credential_source: nil, scopes: nil, credential_creator: DriveV3::CreateCredential)
+      credential_source ||= File.read(File.expand_path('~/.google-api-credential.json'))
+      scopes ||= [Google::Apis::DriveV3::AUTH_DRIVE]
+
+      Google::Apis::DriveV3::DriveService.new.tap do |service|
+        service.authorization = credential_creator.call(credential_source, scopes)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,307 @@
+--- !ruby/object:Gem::Specification
+name: drive_v3
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- James Couball
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: create_github_release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: github_pages_rake_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: google-apis-drive_v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rltk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Unofficial helpers and extensions for the Google Drive V3 API
+email:
+- jcouball@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".markdownlint.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/README.md
+- examples/drive_service_batch
+- examples/file_create
+- examples/file_create_folder
+- examples/file_create_spreadsheet
+- examples/file_delete
+- examples/file_download_content
+- examples/file_export_spreadsheet
+- examples/file_get
+- examples/file_recover_from_trash
+- examples/file_search
+- examples/file_send_to_trash
+- examples/file_upload_content
+- examples/permission_create
+- examples/permission_delete
+- examples/permission_list
+- examples/permission_update
+- lib/drive_v3.rb
+- lib/drive_v3/create_credential.rb
+- lib/drive_v3/version.rb
+homepage: https://github.com/main-branch/drive_v3
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/main-branch/drive_v3
+  source_code_uri: https://github.com/main-branch/drive_v3
+  changelog_uri: https://rubydoc.info/gems/drive_v3/file/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Unofficial helpers and extensions for the Google Drive V3 API
+test_files: []