google-oauth-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee18c4c8bf054e4a04d18b104b22c72e0360355864e2090361f1f520c1bf95f6
+  data.tar.gz: 6ee8403f8a338e57c7dc199fbc50580577b711b100b651f2f3e0027dd9b07c91
+SHA512:
+  metadata.gz: 2ecfed6455a9a51e70ff931ae78c9e0d1ad20fe65d0d87774b0cd37690b6cefb6b140f495215eb88d5994aea157cf6846b7c12193f33d3c3899528f196194a37
+  data.tar.gz: d2693bb74664c645a7ef5ea7d421847a95ab51f6ccd51076278191c07a8d7ebee231843db0ec7571b24504138ca2ccfe386d468feac0177f6b963fc653ecfddd

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Naming/FileName:
+  Exclude:
+    - 'lib/google-oauth-cli.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in google-oauth-cli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    google-oauth-cli (0.1.0)
+      googleauth (~> 1.5)
+      launchy (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.3)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    googleauth (1.5.0)
+      faraday (>= 0.17.3, < 3.a)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (>= 0.16, < 2.a)
+    json (2.6.3)
+    jwt (2.7.0)
+    launchy (2.5.2)
+      addressable (~> 2.8)
+    memoist (0.16.2)
+    multi_json (1.15.0)
+    os (1.1.4)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    signet (0.17.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  google-oauth-cli!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yusuke Fujiki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# google-oauth-cli
+
+google-oauth-cli is a RubyGems library that allows you to perform OAuth authentication with Google from the command-line interface (CLI).
+
+## Features
+
+- Authenticates with Google using OAuth from CLI.
+- Spins up a simple web server to receive the authorization code.
+- Supports passing a file path as an optional argument to persist the refresh token, making it easier to handle token refreshing in subsequent requests.
+
+## Motivation
+
+Google deprecates to the OOB flow by Google in February 2022.
+
+## Usage
+
+```rb
+auth = GoogleOAuthCli.new(
+  client_id: ENV["client_id"],
+  client_secret: ENV["client_secret"],
+  scope: ["https://www.googleapis.com/auth/drive", "https://spreadsheets.google.com/feeds"],
+  credentials_file: "~/.config/google-test.json"
+)
+
+# Starts authentication flow and returns Google::Auth::UserRefreshCredentials
+credentials = auth.login
+
+drive = Google::Apis::DriveV3::DriveService.new
+drive.authorization = credentials
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/google-oauth-cli.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/google-oauth-cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "google-oauth-cli"
+  spec.version = GoogleOAuthCli::VERSION
+  spec.authors = ["Yusuke Fujiki"]
+  spec.email = ["yusuke@fujikkys.com"]
+
+  spec.summary = "Library for Google OAuth authentication from CLI"
+  spec.description = <<~DESC
+    Perform Google OAuth authentication from the CLI using redirect flows.
+    Authentication information is saved in a file and can be used for the next authentication.
+  DESC
+  spec.homepage = "https://github.com/fujikky/google-oauth-cli"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fujikky/google-oauth-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/fujikky/google-oauth-cli/tree/main/CHANGELOG"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "googleauth", "~> 1.5"
+  spec.add_dependency "launchy", "~> 2.5"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/google-oauth-cli/server.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class GoogleOAuthCli
+  class Server
+    def initialize(port:, state:)
+      @server = TCPServer.new port
+      @state = state
+    end
+
+    def start
+      loop do
+        connection = server.accept
+        request = connection.gets
+        data = handle_request(request)
+        connection.write <<~DOC
+          HTTP/1.1 200 OK
+          Content-Type: text/plain; charset=UTF-8
+
+          OAuth request received. You can close this window now.
+        DOC
+        connection.close
+        if data
+          server.close
+          return data
+        end
+      end
+      server.close
+    end
+
+    private
+
+    attr_reader :server, :state
+
+    def handle_request(request)
+      _, full_path = request.split
+      return if URI(full_path).path != "/authorize"
+
+      params = CGI.parse(URI.parse(full_path).query)
+      raise(Error, "Invalid oauth request received") if @state != params["state"][0]
+
+      params["code"][0]
+    end
+  end
+end

data/lib/google-oauth-cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class GoogleOAuthCli
+  VERSION = "0.1.0"
+end

data/lib/google-oauth-cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "googleauth"
+require "launchy"
+require_relative "google-oauth-cli/version"
+require_relative "google-oauth-cli/server"
+
+class GoogleOAuthCli
+  class Error < StandardError; end
+
+  def initialize(client_id:, client_secret:, scope:, credentials_file: nil, port: 9876)
+    @credentials = Google::Auth::UserRefreshCredentials.new(
+      client_id: client_id,
+      client_secret: client_secret,
+      scope: scope,
+      redirect_uri: "http://localhost:#{port}/authorize",
+      additional_parameters: { access_type: "offline" }
+    )
+    if credentials_file
+      @credentials_file = Pathname.new(File.expand_path(credentials_file))
+      @credentials_file
+    end
+    @port = port
+  end
+
+  def login
+    authorize_from_credentials || authorize_from_authorization_code_flow
+  end
+
+  private
+
+  attr_reader :credentials, :credentials_file, :port
+
+  def authorize_from_credentials
+    return nil unless credentials_file&.exist?
+
+    token = JSON.parse(credentials_file.read)["refresh_token"]
+    return nil if token.nil?
+
+    credentials.refresh_token = token
+    fetch_and_save_token!
+
+    credentials
+  end
+
+  def authorize_from_authorization_code_flow
+    state = SecureRandom.base64(16)
+    credentials.state = state
+
+    uri = credentials.authorization_uri
+    Launchy.open(uri) do |exception|
+      raise(Error, "Attempted to open #{uri} and failed because #{exception}")
+    end
+
+    credentials.code = start_server_and_receive_code(state)
+    fetch_and_save_token!
+
+    credentials
+  end
+
+  def fetch_and_save_token!
+    credentials.fetch_access_token!
+    credentials_file&.write({ refresh_token: credentials.refresh_token }.to_json)
+  end
+
+  def start_server_and_receive_code(state)
+    server = Thread.new do
+      Thread.current.report_on_exception = false
+      Server.new(port: port, state: state).start
+    end
+    server.join
+    server.value
+  end
+end

data/sig/google-oauth-cli.rbs

@@ -0,0 +1,7 @@
+class GoogleOAuthCli
+  VERSION: String
+
+  def initialize(client_id: String, client_secret: String, scope: String | Array[String], credentials_file: String?, port: Integer?) -> void
+
+  def login -> Google::Auth::UserRefreshCredentials
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: google-oauth-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Fujiki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: |
+  Perform Google OAuth authentication from the CLI using redirect flows.
+  Authentication information is saved in a file and can be used for the next authentication.
+email:
+- yusuke@fujikkys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- google-oauth-cli.gemspec
+- lib/google-oauth-cli.rb
+- lib/google-oauth-cli/server.rb
+- lib/google-oauth-cli/version.rb
+- sig/google-oauth-cli.rbs
+homepage: https://github.com/fujikky/google-oauth-cli
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/fujikky/google-oauth-cli
+  source_code_uri: https://github.com/fujikky/google-oauth-cli
+  changelog_uri: https://github.com/fujikky/google-oauth-cli/tree/main/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Library for Google OAuth authentication from CLI
+test_files: []