fastlane-plugin-auth_with_github_app 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +54 -0
- data/lib/fastlane/plugin/auth_with_github_app/actions/auth_with_github_app_action.rb +96 -0
- data/lib/fastlane/plugin/auth_with_github_app/helper/auth_with_github_app_helper.rb +16 -0
- data/lib/fastlane/plugin/auth_with_github_app/version.rb +5 -0
- data/lib/fastlane/plugin/auth_with_github_app.rb +16 -0
- metadata +189 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: dac5a632ebf6d0b847a13863f4c09599d24a3c8218fc3732ddf32b5a35a123a9
|
4
|
+
data.tar.gz: cd78fa9656f4f453864d31ab3ff5d4bc78bfbcba61504c3375a5bd8414f4aed1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9ee944cf1737cd04b2334f8ad5439efec7ed1243432b3051a6d143e00ec9665e24397442fca47a67de8d776e6e9a85984e8721062893a5f4a7250a47f2aceb84
|
7
|
+
data.tar.gz: 732b5086430ba838e6be4f15b681a29896a8b14bd4743753294282a15a1aeb6f1e38c68867515876d26b472221e72302594cc193eec74a6cc9b3c92ddd41f3a8
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2023 k-kohey <kawagutsuchi@gmail.com>
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
# auth_with_github_app plugin
|
2
|
+
|
3
|
+
[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-auth_with_github_app)
|
4
|
+
|
5
|
+
## Getting Started
|
6
|
+
|
7
|
+
This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-auth_with_github_app`, add it to your project by running:
|
8
|
+
|
9
|
+
```bash
|
10
|
+
fastlane add_plugin auth_with_github_app
|
11
|
+
```
|
12
|
+
|
13
|
+
## About auth_with_github_app
|
14
|
+
|
15
|
+
Get a GitHub access token using the GitHub App
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
token = auth_with_github_app(app_id:00000, pem:"pem", installation_id:00000)
|
19
|
+
```
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
|
24
|
+
|
25
|
+
**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
|
26
|
+
|
27
|
+
## Run tests for this plugin
|
28
|
+
|
29
|
+
To run both the tests, and code style validation, run
|
30
|
+
|
31
|
+
```
|
32
|
+
rake
|
33
|
+
```
|
34
|
+
|
35
|
+
To automatically fix many of the styling issues, use
|
36
|
+
```
|
37
|
+
rubocop -a
|
38
|
+
```
|
39
|
+
|
40
|
+
## Issues and Feedback
|
41
|
+
|
42
|
+
For any other issues and feedback about this plugin, please submit it to this repository.
|
43
|
+
|
44
|
+
## Troubleshooting
|
45
|
+
|
46
|
+
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
|
47
|
+
|
48
|
+
## Using _fastlane_ Plugins
|
49
|
+
|
50
|
+
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
|
51
|
+
|
52
|
+
## About _fastlane_
|
53
|
+
|
54
|
+
_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
|
@@ -0,0 +1,96 @@
|
|
1
|
+
require 'fastlane/action'
|
2
|
+
require_relative '../helper/auth_with_github_app_helper'
|
3
|
+
require 'openssl'
|
4
|
+
require 'jwt'
|
5
|
+
|
6
|
+
module Fastlane
|
7
|
+
module Actions
|
8
|
+
class AuthWithGithubAppAction < Action
|
9
|
+
def self.run(params)
|
10
|
+
private_pem = params[:pem]
|
11
|
+
app_id = params[:app_id]
|
12
|
+
installation_id = params[:installation_id]
|
13
|
+
|
14
|
+
private_key = OpenSSL::PKey::RSA.new(private_pem)
|
15
|
+
|
16
|
+
payload = {
|
17
|
+
# issued at time, 60 seconds in the past to allow for clock drift
|
18
|
+
iat: Time.now.to_i - 60,
|
19
|
+
# JWT expiration time (10 minute maximum)
|
20
|
+
exp: Time.now.to_i + (10 * 60),
|
21
|
+
# GitHub App's identifier
|
22
|
+
iss: app_id
|
23
|
+
}
|
24
|
+
|
25
|
+
jwt = JWT.encode(payload, private_key, "RS256")
|
26
|
+
|
27
|
+
uri = URI.parse("https://api.github.com/app/installations/#{installation_id}/access_tokens")
|
28
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
29
|
+
http.use_ssl = true
|
30
|
+
|
31
|
+
headers = { Authorization: "Bearer #{jwt}", Accept: "application/vnd.github+json", 'User-Agent': "auth_with_github_app" }
|
32
|
+
req = Net::HTTP::Post.new(uri.path)
|
33
|
+
req.initialize_http_header(headers)
|
34
|
+
response = http.request(req)
|
35
|
+
|
36
|
+
if response.code.to_i < 200 || response.code.to_i > 299
|
37
|
+
UI.error("HTTP request to GitHub failed with status code #{response.code}\n detail: #{response.body}")
|
38
|
+
exit(1)
|
39
|
+
end
|
40
|
+
|
41
|
+
token = JSON.parse(response.body)['token']
|
42
|
+
if token == "" || token.nil?
|
43
|
+
UI.error("The Token obtained is empty; the response from the API may be invalid.")
|
44
|
+
exit(1)
|
45
|
+
end
|
46
|
+
|
47
|
+
return token
|
48
|
+
end
|
49
|
+
|
50
|
+
def self.description
|
51
|
+
"Get a GitHub access token using the GitHub App"
|
52
|
+
end
|
53
|
+
|
54
|
+
def self.authors
|
55
|
+
["k-kohey"]
|
56
|
+
end
|
57
|
+
|
58
|
+
def self.return_value
|
59
|
+
"API Token obtained using the GitHub App."
|
60
|
+
end
|
61
|
+
|
62
|
+
def self.details
|
63
|
+
# Optional:
|
64
|
+
""
|
65
|
+
end
|
66
|
+
|
67
|
+
def self.available_options
|
68
|
+
[
|
69
|
+
FastlaneCore::ConfigItem.new(key: :pem,
|
70
|
+
env_name: "GITHUB_APP_PEM",
|
71
|
+
description: "Private key available from the GitHub App administration screen",
|
72
|
+
optional: false,
|
73
|
+
type: String),
|
74
|
+
FastlaneCore::ConfigItem.new(key: :app_id,
|
75
|
+
env_name: "GITHUB_APP_ID",
|
76
|
+
description: "App ID available from the GitHub App administration screen",
|
77
|
+
optional: false,
|
78
|
+
type: Integer),
|
79
|
+
FastlaneCore::ConfigItem.new(key: :installation_id,
|
80
|
+
env_name: "GITHUB_APP_INSTLLATION_ID",
|
81
|
+
description: "Installation id available from the GitHub App administration screen",
|
82
|
+
optional: false,
|
83
|
+
type: Integer)
|
84
|
+
]
|
85
|
+
end
|
86
|
+
|
87
|
+
def self.is_supported?(platform)
|
88
|
+
# Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
|
89
|
+
# See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
|
90
|
+
#
|
91
|
+
# [:ios, :mac, :android].include?(platform)
|
92
|
+
true
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'fastlane_core/ui/ui'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
|
5
|
+
|
6
|
+
module Helper
|
7
|
+
class AuthWithGithubAppHelper
|
8
|
+
# class methods that you define here become available in your action
|
9
|
+
# as `Helper::AuthWithGithubAppHelper.your_method`
|
10
|
+
#
|
11
|
+
def self.show_message
|
12
|
+
UI.message("Hello from the auth_with_github_app plugin helper!")
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'fastlane/plugin/auth_with_github_app/version'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
module AuthWithGithubApp
|
5
|
+
# Return all .rb files inside the "actions" and "helper" directory
|
6
|
+
def self.all_classes
|
7
|
+
Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
# By default we want to import all available actions and helpers
|
13
|
+
# A plugin can contain any number of actions and plugins
|
14
|
+
Fastlane::AuthWithGithubApp.all_classes.each do |current|
|
15
|
+
require current
|
16
|
+
end
|
metadata
ADDED
@@ -0,0 +1,189 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fastlane-plugin-auth_with_github_app
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- k-kohey
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-02-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: fastlane
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.211.0
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.211.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: pry
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec_junit_formatter
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - '='
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: 1.12.1
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - '='
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: 1.12.1
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: rubocop-performance
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: rubocop-require_tools
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: simplecov
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
type: :development
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - ">="
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: '0'
|
153
|
+
description:
|
154
|
+
email: kawagutsuchi@gmail.com
|
155
|
+
executables: []
|
156
|
+
extensions: []
|
157
|
+
extra_rdoc_files: []
|
158
|
+
files:
|
159
|
+
- LICENSE
|
160
|
+
- README.md
|
161
|
+
- lib/fastlane/plugin/auth_with_github_app.rb
|
162
|
+
- lib/fastlane/plugin/auth_with_github_app/actions/auth_with_github_app_action.rb
|
163
|
+
- lib/fastlane/plugin/auth_with_github_app/helper/auth_with_github_app_helper.rb
|
164
|
+
- lib/fastlane/plugin/auth_with_github_app/version.rb
|
165
|
+
homepage: https://github.com/k-kohey/fastlane-plugin-auth-with-github-app
|
166
|
+
licenses:
|
167
|
+
- MIT
|
168
|
+
metadata:
|
169
|
+
rubygems_mfa_required: 'true'
|
170
|
+
post_install_message:
|
171
|
+
rdoc_options: []
|
172
|
+
require_paths:
|
173
|
+
- lib
|
174
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
175
|
+
requirements:
|
176
|
+
- - ">="
|
177
|
+
- !ruby/object:Gem::Version
|
178
|
+
version: '2.6'
|
179
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
180
|
+
requirements:
|
181
|
+
- - ">="
|
182
|
+
- !ruby/object:Gem::Version
|
183
|
+
version: '0'
|
184
|
+
requirements: []
|
185
|
+
rubygems_version: 3.2.32
|
186
|
+
signing_key:
|
187
|
+
specification_version: 4
|
188
|
+
summary: Get a GitHub access token using the GitHub App
|
189
|
+
test_files: []
|