github-app-auth 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3be0a29d282ba73edc1e0b3c7816cf53b9c335b3c46f10b30b3b7a731ec0b584
-  data.tar.gz: 0b7440d8f9bdcfb1c59ddcb11526120db6cdcd773c5f8a4d71bb0bde49fe5c20
+  metadata.gz: 5dfa01cb297c9e23c8f0342a92500065145151061ccf3d5ccc0c9a88f6882500
+  data.tar.gz: 4e320ac747cde80c1734b40d67463be810beadb303d08ed87ce35f461f1c6f0f
 SHA512:
-  metadata.gz: a3c04c0f3b7e4c5089cdf9a2ab970ce9ccb74636f32590b0f2465e2b1408575630c3c2e606bfe193e8520c15d35e388ce1ca420a978578670f1f5faa44f92ede
-  data.tar.gz: 0b34fca8d227fa565563efad2abb2a2c5f8245ddfdb091a5f4eb4089f9c70e5ab6a5f07525ca49a277c9ef0a5922937162fd4ce9f6ce1297446cc3a06b5df347
+  metadata.gz: fb5af34f92a868bdfe6276e19784ae2f8366bee7df538e38aa279558f1038510485a295b714a266b9cc11f778968507316214c276565e3fc9c46b51cdee20015
+  data.tar.gz: 7c203243829d4d54557616f0d514f0ac4da37aff788846d6bfcc89253e4013a16ef6bad1710bf75441dfa7138e061a9a8a4274a92c3bca1f5cca3f12841e32f3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.4.0
+  - remove deprecated app_* methods that were only repository installations
+  - change require to 'github_app_auth' when adding linter
+
 ## 0.3.0
   - deprecates app_* methods that were only repository installations
   - adds methods to do organization, repository, and user installations

data/README.md

@@ -1,5 +1,8 @@
 # GitHub::App::Auth
 
+![Tests](https://github.com/hortoncd/github-app-auth/actions/workflows/tests.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/github-app-auth.svg)](https://badge.fury.io/rb/github-app-auth)
+
 A gem to make (at least) some forms of GitHub App authentication easy.  It is built as an includable module, with the option of a class to
 instantiate if preferred.
 
@@ -22,7 +25,7 @@ Or install it yourself as:
 ## Usage
 
 ```
-require "github-app-auth"
+require "github_app_auth"
 ```
 
 Include the module in your class
@@ -99,12 +102,12 @@ client = Octokit::Client.new({ bearer_token: token, ... })
 
 Auth as an application installation for a user and return an Octokit::Client.
 ```
-client = user_installation_client("myorg")
+client = user_installation_client("myuser")
 ```
 
 Alternatively you can retrieve the token, and then set up your own GitHub client (Octokit or whatever you prefer) as needed.
 ```
-token = user_installation_token("myorg")
+token = user_installation_token("myuser")
 client = Octokit::Client.new({ bearer_token: token, ... })
 ```
 

data/lib/{github-app-auth → github_app_auth}/app.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require "jwt"
 require "openssl"
 require_relative "client"
 
 module GitHub
   module App
+    # GitHub App Authentication
     module Auth
       def app_client(options = {})
-        client(:bearer_token => app_token(options))
+        client(bearer_token: app_token(options))
       end
 
       # options: the following can be passed via the options hash.  if missing
@@ -32,19 +35,11 @@ module GitHub
       end
 
       def app_id(options = {})
-        if options[:github_app_id]
-          options[:github_app_id]
-        else
-          ENV["GITHUB_APP_ID"]
-        end
+        options[:github_app_id] || ENV["GITHUB_APP_ID"]
       end
 
       def app_private_key(options = {})
-        if options[:github_app_private_key]
-          options[:github_app_private_key]
-        else
-          ENV["GITHUB_APP_PRIVATE_KEY"]
-        end
+        options[:github_app_private_key] || ENV["GITHUB_APP_PRIVATE_KEY"]
       end
     end
   end

data/lib/{github-app-auth → github_app_auth}/app_installation.rb

@@ -1,17 +1,9 @@
+# frozen_string_literal: true
+
 module GitHub
   module App
+    # GitHub App Installation Authentication
     module Auth
-      # legacy support because original only supported repo
-      def app_installation_client(repo, options = {})
-        puts "DEPRECATED: app_installation_client will be removed in v0.4.0, use repository_installation_client instead"
-        client(bearer_token: app_installation_token(repo, options))
-      end
-
-      def app_installation_token(repo, options = {})
-        puts "DEPRECATED: app_installation_token will be removed in v0.4.0, use repository_installation_token instead"
-        installation_token(:repository, repo, options)
-      end
-
       def organization_installation_client(org, options = {})
         client(bearer_token: organization_installation_token(org, options))
       end
@@ -38,19 +30,8 @@ module GitHub
 
       # Supported types are :organization, :repository, :user
       def installation_token(type, name, options = {})
-        application_client = app_client(options)
-        installation = begin
-          case type
-          when :organization
-            application_client.find_organization_installation(name)
-          when :repository
-            application_client.find_repository_installation(name)
-          when :user
-            application_client.find_user_installation(name)
-          else
-            raise ArgumentError, "Unsupported installation type: #{type}"
-          end
-        end
+        application_client(options)
+        installation = installation_by_type(type, name)
 
         if installation.nil? || installation[:id].nil?
           raise GitHub::App::Auth::InstallationError, "Could not find installation for #{type}: #{name}"
@@ -60,8 +41,26 @@ module GitHub
         if resp.nil? || resp[:token].nil?
           raise GitHub::App::Auth::TokenError, "Could generate installation token for #{type}: #{name}"
         end
+
         resp[:token]
       end
+
+      def installation_by_type(type, name)
+        case type
+        when :organization
+          application_client.find_organization_installation(name)
+        when :repository
+          application_client.find_repository_installation(name)
+        when :user
+          application_client.find_user_installation(name)
+        else
+          raise ArgumentError, "Unsupported installation type: #{type}"
+        end
+      end
+
+      def application_client(options = {})
+        @application_client ||= app_client(options)
+      end
     end
   end
 end

data/lib/{github-app-auth → github_app_auth}/client.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require "octokit"
 
 module GitHub
   module App
+    # GitHub App client
     module Auth
       def client(options = {})
         Octokit::Client.new(options)

data/lib/{github-app-auth → github_app_auth}/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module GitHub
   module App
     module Auth
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/{github-app-auth.rb → github_app_auth.rb}

@@ -1,13 +1,16 @@
-require "github-app-auth/app"
-require "github-app-auth/app_installation"
-require "github-app-auth/version"
+# frozen_string_literal: true
+
+require "github_app_auth/app"
+require "github_app_auth/app_installation"
+require "github_app_auth/version"
 
 module GitHub
   module App
+    # GitHub App Authentication
     module Auth
       class Error < StandardError; end
       class InstallationError < Error; end
-      class TokenError< Error; end
+      class TokenError < Error; end
 
       class AuthClass
         include GitHub::App::Auth

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-app-auth
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Horton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -63,11 +63,11 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- lib/github-app-auth.rb
-- lib/github-app-auth/app.rb
-- lib/github-app-auth/app_installation.rb
-- lib/github-app-auth/client.rb
-- lib/github-app-auth/version.rb
+- lib/github_app_auth.rb
+- lib/github_app_auth/app.rb
+- lib/github_app_auth/app_installation.rb
+- lib/github_app_auth/client.rb
+- lib/github_app_auth/version.rb
 homepage: https://github.com/hortoncd/github-app-auth
 licenses:
 - MIT
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="