github-app-auth 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7de14445c693279f09a86e7e1cd7c349c492b30a532b0951d49aed52eec90a96
-  data.tar.gz: b9d44e07749d0e017430f7614d6250ad1370f185839a0ed778573d39a6046e25
+  metadata.gz: 3be0a29d282ba73edc1e0b3c7816cf53b9c335b3c46f10b30b3b7a731ec0b584
+  data.tar.gz: 0b7440d8f9bdcfb1c59ddcb11526120db6cdcd773c5f8a4d71bb0bde49fe5c20
 SHA512:
-  metadata.gz: c10995031a23f2b0ee9b4fe6f6e5dbced77fe1fdcd9575d61f59de493a3d4b3190abff8212134e125d6e0bdb6cdc118e7a584141312372c0faa6aa8ef63b956f
-  data.tar.gz: 0db53d013d400c848debb9b5f38092128a8704d199947af608215a911d12bbf5586a945db23509c31692d1f4b232d22ec67afea1a4076e0fbe04f5c99006301f
+  metadata.gz: a3c04c0f3b7e4c5089cdf9a2ab970ce9ccb74636f32590b0f2465e2b1408575630c3c2e606bfe193e8520c15d35e388ce1ca420a978578670f1f5faa44f92ede
+  data.tar.gz: 0b34fca8d227fa565563efad2abb2a2c5f8245ddfdb091a5f4eb4089f9c70e5ab6a5f07525ca49a277c9ef0a5922937162fd4ce9f6ce1297446cc3a06b5df347

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 0.3.0
+  - deprecates app_* methods that were only repository installations
+  - adds methods to do organization, repository, and user installations
+
+## 0.2.0
+  - changed lib path to `github-app-auth` instead of `github/app/auth`
+
+## 0.1.0
+  - initial release with support for repository installation authentication

data/README.md

@@ -67,14 +67,44 @@ See [the GitHub documentation](https://docs.github.com/en/apps/creating-github-a
 
 The examples are using the gem as an includable module, but can also be used with the available AuthClass class..
 
-Auth as an application installation for a repo and return an Octokit::Client.
+There are several methods of authenticating as an application installation.
+
+#### Organization Installation
+
+Auth as an application installation for an organization and return an Octokit::Client.
+```
+client = organization_installation_client("myorg")
+```
+
+Alternatively you can retrieve the token, and then set up your own GitHub client (Octokit or whatever you prefer) as needed.
+```
+token = organization_installation_token("myorg")
+client = Octokit::Client.new({ bearer_token: token, ... })
+```
+
+#### Repository Installation
+
+Auth as an application installation for a repository and return an Octokit::Client.
+```
+client = repository_installation_client("myaccount/myrepo")
+```
+
+Alternatively you can retrieve the token, and then set up your own GitHub client (Octokit or whatever you prefer) as needed.
+```
+token = repository_installation_token("myaccount/myrepo")
+client = Octokit::Client.new({ bearer_token: token, ... })
+```
+
+#### User Installation
+
+Auth as an application installation for a user and return an Octokit::Client.
 ```
-client = app_installation_client("myaccount/myrepo")
+client = user_installation_client("myorg")
 ```
 
 Alternatively you can retrieve the token, and then set up your own GitHub client (Octokit or whatever you prefer) as needed.
 ```
-token = app_instalation_token("myaccount/myrepo")
+token = user_installation_token("myorg")
 client = Octokit::Client.new({ bearer_token: token, ... })
 ```
 

data/lib/github-app-auth/app_installation.rb

@@ -1,14 +1,65 @@
 module GitHub
   module App
     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 = {})
-        application_client = app_client
-        installation = application_client.find_repository_installation(repo)
+        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
+
+      def organization_installation_token(org, options = {})
+        installation_token(:organization, org, options)
+      end
+
+      def repository_installation_client(repo, options = {})
+        client(bearer_token: repository_installation_token(repo, options))
+      end
+
+      def repository_installation_token(repo, options = {})
+        installation_token(:repository, repo, options)
+      end
+
+      def user_installation_client(user, options = {})
+        client(bearer_token: user_installation_token(user, options))
+      end
+
+      def user_installation_token(user, options = {})
+        installation_token(:user, user, options)
+      end
+
+      # 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
+
+        if installation.nil? || installation[:id].nil?
+          raise GitHub::App::Auth::InstallationError, "Could not find installation for #{type}: #{name}"
+        end
+
         resp = application_client.create_app_installation_access_token(installation[:id])
+        if resp.nil? || resp[:token].nil?
+          raise GitHub::App::Auth::TokenError, "Could generate installation token for #{type}: #{name}"
+        end
         resp[:token]
       end
     end

data/lib/github-app-auth/version.rb

@@ -1,7 +1,7 @@
 module GitHub
   module App
     module Auth
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/github-app-auth.rb

@@ -5,6 +5,10 @@ require "github-app-auth/version"
 module GitHub
   module App
     module Auth
+      class Error < StandardError; end
+      class InstallationError < Error; end
+      class TokenError< Error; end
+
       class AuthClass
         include GitHub::App::Auth
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-app-auth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Horton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md