github-authentication 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a279af637a4369feb5bff421697bed089b09f8096d6829eccb37b3c4911d7ba9
-  data.tar.gz: edb60c288c631aafd17fbc0b361fef03f86e019a38a77d1debcc1544627e424d
+  metadata.gz: 232b7d332cfdf5a3b6ec3e6854b13203dcc204c4f242d730ea2a8510bb25164a
+  data.tar.gz: 8715cff617884f40643eb2569704bca0ad3ce306277d0298806e550889d63b3f
 SHA512:
-  metadata.gz: 10259c8db9c441f9d899962653a0307cc0eed4584797135857c883a047c4609027909cf7bfdc2828ebe6b3b9f520244cdf4267e0fa8957fa2daea46795bbc83b
-  data.tar.gz: f6d4ab126dbc799ec03fea9a6d7c5893d4abae73fb50b16cb3a15169876f615ee01756593d21d1b86f7cadf88b8630faa6f7fd7ca7941f49103031636bee078d
+  metadata.gz: ab1d75961e37a620932f1cefe273c00bd95e96332368a13268b868114649d1d8b96c4133770adb898c4a2c1a3502d7c16fab3e840671cc7f90064d89ce6835c1
+  data.tar.gz: 8ab8c0af8067b378f0a981173ff3e5ea53728c65cf6264a8ebeecd6fe8c30d75b739d89ec9aed893c292950bdc414ac2be46fe065eac48c722dbbbce98329f36

data/.github/workflows/tests.yml

@@ -3,31 +3,47 @@ name: Tests
 on: [push]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+
+      - name: Lint Ruby
+        run: |
+          bin/rubocop
+
   ruby-tests:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [ '2.6' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/checkout@v4
+
       - name: Setup timezone
         uses: zcong1993/setup-timezone@master
         with:
           timezone: UTC
-      - name: Lint Ruby
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-          bin/rubocop
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
       - name: Run Ruby tests
         run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
           bin/rake test
         env:
           SUITE: ruby

data/.rubocop.yml

@@ -2,8 +2,8 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
-  CacheRootDirectory: tmp/rubocop
+  TargetRubyVersion: 2.7
+  CacheRootDirectory: tmp/rubocop-cache
   UseCache: true
 
 Style/MethodCallWithArgsParentheses:
@@ -18,6 +18,8 @@ Style/MethodCallWithArgsParentheses:
     - refute_nil
     - assert_kind_of
     - refute_kind_of
+    - assert_predicate
+    - refute_predicate
 
 Naming/FileName:
   Exclude:

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,75 +1,94 @@
 PATH
   remote: .
   specs:
-    github-authentication (1.0.2)
+    github-authentication (1.1.0)
       jwt (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    concurrent-ruby (1.1.9)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crack (0.4.5)
+      rexml
+    drb (2.2.0)
+      ruby2_keywords
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    jwt (2.3.0)
-    minitest (5.14.0)
-    mocha (1.11.2)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    rexml (3.2.5)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    json (2.6.3)
+    jwt (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
+    mutex_m (0.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
-      rexml
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-shopify (1.0.2)
-      rubocop (~> 0.82.0)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    timecop (0.9.1)
-    tzinfo (2.0.4)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.8)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    vcr (5.1.0)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   activesupport
   github-authentication!
   minitest (~> 5.0)
-  mocha (~> 1.11)
-  rake (~> 12.3)
-  rubocop (~> 0.52)
+  mocha (~> 2)
+  rake (~> 13)
   rubocop-shopify
   timecop (~> 0.9)
-  vcr (~> 5.1)
+  vcr (~> 6.2)
   webmock (~> 3.8)
 
 BUNDLED WITH
-   2.2.22
+   2.4.21

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/bin/rake

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/rubocop

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/exe/git-credential-github-app

@@ -1,30 +1,30 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'github_authentication'
+require "github_authentication"
 
 begin
-  require 'active_support'
-  require 'active_support/cache'
-  require 'active_support/notifications'
+  require "active_support"
+  require "active_support/cache"
+  require "active_support/notifications"
 rescue LoadError
   warn("Active Support is required for the credential helper")
   exit(2)
 end
 
 case ARGV[0]
-when 'get'
+when "get"
   exit_status = GithubAuthentication::GitCredentialHelper.new(
-    pem: File.read(ENV.fetch('GITHUB_APP_KEYFILE')),
-    app_id: ENV.fetch('GITHUB_APP_ID'),
-    installation_id: ENV.fetch('GITHUB_APP_INSTALLATION_ID'),
-    storage: ActiveSupport::Cache::FileStore.new(ENV.fetch('GITHUB_APP_CREDENTIAL_STORAGE_PATH'))
+    pem: File.read(ENV.fetch("GITHUB_APP_KEYFILE")),
+    app_id: ENV.fetch("GITHUB_APP_ID"),
+    installation_id: ENV.fetch("GITHUB_APP_INSTALLATION_ID"),
+    storage: ActiveSupport::Cache::FileStore.new(ENV.fetch("GITHUB_APP_CREDENTIAL_STORAGE_PATH")),
   ).handle_get
   exit(exit_status)
-when 'store'
+when "store"
   # We maintain our own internal storage, so no-op any `store` requests
-when nil, ''
-  warn('Supported operations: get, store')
+when nil, ""
+  warn("Supported operations: get, store")
   exit(1)
 else
   warn("Unknown argument: #{ARGV[0]}")

data/github-authentication.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   # 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(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -37,13 +37,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("jwt", "~> 2.2")
 
-  spec.add_development_dependency("rake", "~> 12.3")
+  spec.add_development_dependency("activesupport")
   spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("mocha", "~> 2")
+  spec.add_development_dependency("rake", "~> 13")
+  spec.add_development_dependency("rubocop-shopify")
   spec.add_development_dependency("timecop", "~> 0.9")
-  spec.add_development_dependency("mocha", "~> 1.11")
+  spec.add_development_dependency("vcr", "~> 6.2")
   spec.add_development_dependency("webmock", "~> 3.8")
-  spec.add_development_dependency("vcr", "~> 5.1")
-  spec.add_development_dependency("rubocop", "~> 0.52")
-  spec.add_development_dependency("rubocop-shopify")
-  spec.add_development_dependency("activesupport")
 end

data/lib/github_authentication/cache.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'github_authentication/token'
+require "github_authentication/token"
 
 module GithubAuthentication
   class Cache
     # storage = ActiveSupport::Cache
-    def initialize(storage:, key: '')
+    def initialize(storage:, key: "")
       @storage = storage
       @key = "github:authentication:#{key}"
     end

data/lib/github_authentication/generator/app.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'jwt'
+require "jwt"
 require "uri"
-require 'openssl'
+require "openssl"
 
 require "github_authentication/http"
 

data/lib/github_authentication/git_credential_helper.rb

@@ -13,14 +13,14 @@ module GithubAuthentication
     def handle_get
       description = parse_stdin
 
-      unless description['protocol'] == 'https' && description['host'] == 'github.com'
+      unless description["protocol"] == "https" && description["host"] == "github.com"
         warn("Unsupported description: #{description}")
         return 2
       end
 
       token = provider.token(seconds_ttl: min_cache_ttl)
       puts("password=#{token}")
-      puts('username=api')
+      puts("username=api")
 
       0
     end
@@ -35,13 +35,13 @@ module GithubAuthentication
     def parse_stdin
       # Credential description is written to STDIN in line delimited key=value form,
       # see https://git-scm.com/docs/git-credential#IOFMT
-      @stdin.each_line.map { |line| line.split('=', 2).map(&:strip) }.to_h
+      @stdin.each_line.map { |line| line.split("=", 2).map(&:strip) }.to_h
     end
 
     def provider
       @provider ||= Provider.new(
         generator: generator,
-        cache: Cache.new(storage: @storage || ObjectCache.new)
+        cache: Cache.new(storage: @storage || ObjectCache.new),
       )
     end
 
@@ -49,7 +49,7 @@ module GithubAuthentication
       @generator ||= Generator::App.new(
         pem: @pem,
         app_id: @app_id,
-        installation_id: @installation_id
+        installation_id: @installation_id,
       )
     end
   end

data/lib/github_authentication/http.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'timeout'
+require "net/http"
+require "timeout"
 
-require 'github_authentication/retriable'
+require "github_authentication/retriable"
 
 module GithubAuthentication
   module Http
@@ -17,7 +17,6 @@ module GithubAuthentication
           http.use_ssl = true
           http.start
           begin
-
             request = Net::HTTP::Post.new(uri.request_uri)
             yield(request) if block_given?
 

data/lib/github_authentication/object_cache.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'github_authentication/token'
+require "github_authentication/token"
 
 module GithubAuthentication
   class ObjectCache
@@ -14,7 +14,7 @@ module GithubAuthentication
       options = @cache[key][:options]
       if options.key?(:expires_at) && Time.now.utc > options[:expires_at]
         @cache.delete(key)
-        return nil
+        return
       end
 
       @cache[key][:value]

data/lib/github_authentication/provider.rb

@@ -1,28 +1,26 @@
 # frozen_string_literal: true
-require "mutex_m.rb"
 
-require 'github_authentication/retriable'
+require "github_authentication/retriable"
 
 module GithubAuthentication
   class Provider
     include Retriable
-    include Mutex_m
 
     Error = Class.new(StandardError)
     TokenGeneratorError = Class.new(Error)
 
     def initialize(generator:, cache:)
-      super()
       @token = nil
       @generator = generator
       @cache = cache
+      @mutex = Mutex.new
     end
 
     def token(seconds_ttl: 5 * 60)
       return @token if @token&.valid_for?(seconds_ttl)
 
       with_retries(TokenGeneratorError) do
-        mu_synchronize do
+        @mutex.synchronize do
           return @token if @token&.valid_for?(seconds_ttl)
 
           if (@token = @cache.read)

data/lib/github_authentication/retriable.rb

@@ -9,12 +9,12 @@ module GithubAuthentication
       begin
         return_value = yield(attempt, previous_failure)
       rescue *exceptions => exception
-        raise unless attempt < max_attempts
+        raise if attempt >= max_attempts
 
         sleep_after_attempt(
           attempt: attempt,
           base_sleep_time: sleep_between_attempts,
-          exponential_backoff: exponential_backoff
+          exponential_backoff: exponential_backoff,
         )
 
         attempt += 1
@@ -28,7 +28,7 @@ module GithubAuthentication
     private
 
     def sleep_after_attempt(attempt:, base_sleep_time:, exponential_backoff:)
-      return unless base_sleep_time > 0
+      return if base_sleep_time <= 0
 
       time_to_sleep = if exponential_backoff
         calculate_exponential_backoff(attempt: attempt, base_sleep_time: base_sleep_time)

data/lib/github_authentication/token.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module GithubAuthentication
   class Token
     attr_reader :expires_at
 
-    def self.from_json(data)
-      return nil if data.nil?
+    class << self
+      def from_json(data)
+        return if data.nil?
 
-      token, expires_at = JSON.parse(data).values_at('token', 'expires_at')
-      new(token, Time.iso8601(expires_at))
-    rescue JSON::ParserError
-      nil
+        token, expires_at = JSON.parse(data).values_at("token", "expires_at")
+        new(token, Time.iso8601(expires_at))
+      rescue JSON::ParserError
+        nil
+      end
     end
 
     def initialize(token, expires_at)

data/lib/github_authentication/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GithubAuthentication
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-authentication
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Frederik Dudzik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,103 +53,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
-- !ruby/object:Gem::Dependency
-  name: rubocop-shopify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 description: Authenticate with GitHub
 email:
 - frederik.dudzik@shopify.com
@@ -161,7 +147,6 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -209,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
 summary: GitHub Authetication

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2