train-rest 0.3.2 → 0.4.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +202 -0
- data/lib/train-rest/auth_handler/authtype-apikey.rb +24 -0
- data/lib/train-rest/auth_handler/basic.rb +5 -3
- data/lib/train-rest/auth_handler/bearer.rb +24 -0
- data/lib/train-rest/auth_handler/header.rb +24 -0
- data/lib/train-rest/auth_handler.rb +35 -8
- data/lib/train-rest/connection.rb +29 -1
- data/lib/train-rest/version.rb +1 -1
- data/lib/train-rest.rb +3 -0
- metadata +11 -10
- data/Gemfile +0 -3
- data/README.md +0 -246
- data/train-rest.gemspec +0 -30
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bdaed9296e5756a522d6fbaf9fd8d5aca6ed8f2e74250387a97f65fbf58c51b2
|
4
|
+
data.tar.gz: 0bd7dd4791ea737ff122343445bb58a974c0e01e03431a31ab57616e548805aa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dc8d624d5b44cf12e3fb1810cc0f3e84acd53230e503a4a46dee3d04335aef445d21178959b35a712e3b9d2e98eb6328eb45c6e8dc55684cecd1322f3a8be128
|
7
|
+
data.tar.gz: cd8d93fc0e5b0926ce86c6d1ab826f0a84c1996b0c15586e46cd7d78096e851127a4f82fac49998a34e57e3b04d626ef274b5870c771eb824450cf8179b7d2ce
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require "base64" unless defined?(Base64)
|
2
|
+
|
3
|
+
require_relative "../auth_handler"
|
4
|
+
|
5
|
+
module TrainPlugins
|
6
|
+
module Rest
|
7
|
+
# Authentication via "Apikey" type in Authorization headers.
|
8
|
+
#
|
9
|
+
# Could not find a norm for this, just references in e.g. ElasticSearch & Cloud Conformity APIs.
|
10
|
+
class AuthtypeApikey < AuthHandler
|
11
|
+
def check_options
|
12
|
+
raise ArgumentError.new("Need :apikey for `Authorization: Apikey` authentication") unless options[:apikey]
|
13
|
+
end
|
14
|
+
|
15
|
+
def auth_parameters
|
16
|
+
{
|
17
|
+
headers: {
|
18
|
+
"Authorization" => format("Apikey %s", options[:apikey]),
|
19
|
+
},
|
20
|
+
}
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -4,11 +4,13 @@ require_relative "../auth_handler"
|
|
4
4
|
|
5
5
|
module TrainPlugins
|
6
6
|
module Rest
|
7
|
-
# Authentication via
|
7
|
+
# Authentication via Basic Authentication.
|
8
|
+
#
|
9
|
+
# @see https://www.rfc-editor.org/rfc/rfc2617#section-4.1
|
8
10
|
class Basic < AuthHandler
|
9
11
|
def check_options
|
10
|
-
raise ArgumentError.new("Need username for Basic authentication") unless options[:username]
|
11
|
-
raise ArgumentError.new("Need password for Basic authentication") unless options[:password]
|
12
|
+
raise ArgumentError.new("Need :username for Basic authentication") unless options[:username]
|
13
|
+
raise ArgumentError.new("Need :password for Basic authentication") unless options[:password]
|
12
14
|
end
|
13
15
|
|
14
16
|
def auth_parameters
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require "base64" unless defined?(Base64)
|
2
|
+
|
3
|
+
require_relative "../auth_handler"
|
4
|
+
|
5
|
+
module TrainPlugins
|
6
|
+
module Rest
|
7
|
+
# Authentication via Bearer Authentication.
|
8
|
+
#
|
9
|
+
# @see https://datatracker.ietf.org/doc/html/rfc6750#section-2.1
|
10
|
+
class Bearer < AuthHandler
|
11
|
+
def check_options
|
12
|
+
raise ArgumentError.new("Need :token for Bearer authentication") unless options[:token]
|
13
|
+
end
|
14
|
+
|
15
|
+
def auth_parameters
|
16
|
+
{
|
17
|
+
headers: {
|
18
|
+
"Authorization" => format("Bearer %s", options[:token]),
|
19
|
+
},
|
20
|
+
}
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require_relative "../auth_handler"
|
2
|
+
|
3
|
+
module TrainPlugins
|
4
|
+
module Rest
|
5
|
+
# Authentication via additional Header.
|
6
|
+
#
|
7
|
+
# Header name defaults to "X-API-Key"
|
8
|
+
class Header < AuthHandler
|
9
|
+
def check_options
|
10
|
+
raise ArgumentError.new("Need :apikey for Header-based authentication") unless options[:apikey]
|
11
|
+
|
12
|
+
options[:header] = "X-API-Key" unless options[:header]
|
13
|
+
end
|
14
|
+
|
15
|
+
def auth_parameters
|
16
|
+
{
|
17
|
+
headers: {
|
18
|
+
options[:header] => options[:apikey],
|
19
|
+
},
|
20
|
+
}
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -13,7 +13,16 @@ module TrainPlugins
|
|
13
13
|
#
|
14
14
|
# @return [String]
|
15
15
|
def self.name
|
16
|
-
self.to_s.split("::").last
|
16
|
+
class_name = self.to_s.split("::").last
|
17
|
+
|
18
|
+
convert_to_snake_case(class_name)
|
19
|
+
end
|
20
|
+
|
21
|
+
# List authentication handlers
|
22
|
+
#
|
23
|
+
# @return [Array] Classes derived from `AuthHandler`
|
24
|
+
def self.descendants
|
25
|
+
ObjectSpace.each_object(Class).select { |klass| klass < self }
|
17
26
|
end
|
18
27
|
|
19
28
|
# Store authenticator options and trigger validation
|
@@ -29,10 +38,18 @@ module TrainPlugins
|
|
29
38
|
# @raise [ArgumentError] if options are not as needed
|
30
39
|
def check_options; end
|
31
40
|
|
32
|
-
# Handle
|
41
|
+
# Handle login
|
33
42
|
def login; end
|
34
43
|
|
35
|
-
# Handle
|
44
|
+
# Handle session renewal
|
45
|
+
def renew_session; end
|
46
|
+
|
47
|
+
# Return if session renewal needs to happen soon
|
48
|
+
#
|
49
|
+
# @return [Boolean]
|
50
|
+
def renewal_needed?; end
|
51
|
+
|
52
|
+
# Handle logout
|
36
53
|
def logout; end
|
37
54
|
|
38
55
|
# Headers added to the rest-client call
|
@@ -50,11 +67,21 @@ module TrainPlugins
|
|
50
67
|
{ headers: auth_headers }
|
51
68
|
end
|
52
69
|
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
70
|
+
class << self
|
71
|
+
private
|
72
|
+
|
73
|
+
# Convert a class name to snake case.
|
74
|
+
#
|
75
|
+
# @param [String] Class name
|
76
|
+
# @return [String]
|
77
|
+
# @see https://github.com/chef/chef/blob/main/lib/chef/mixin/convert_to_class_name.rb
|
78
|
+
def convert_to_snake_case(str)
|
79
|
+
str = str.dup
|
80
|
+
str.gsub!(/[A-Z]/) { |s| "_" + s }
|
81
|
+
str.downcase!
|
82
|
+
str.sub!(/^\_/, "")
|
83
|
+
str
|
84
|
+
end
|
58
85
|
end
|
59
86
|
end
|
60
87
|
end
|
@@ -86,6 +86,9 @@ module TrainPlugins
|
|
86
86
|
|
87
87
|
# User-faced API
|
88
88
|
|
89
|
+
# Allow (programmatically) setting additional headers apart from global transport configuration
|
90
|
+
attr_accessor :override_headers
|
91
|
+
|
89
92
|
%i{get post put patch delete head}.each do |method|
|
90
93
|
define_method(method) do |path, **keywords|
|
91
94
|
request(path, method, **keywords)
|
@@ -93,6 +96,8 @@ module TrainPlugins
|
|
93
96
|
end
|
94
97
|
|
95
98
|
def request(path, method = :get, request_parameters: {}, data: nil, headers: {}, json_processing: true)
|
99
|
+
auth_handler.renew_session if auth_handler.renewal_needed?
|
100
|
+
|
96
101
|
parameters = global_parameters.merge(request_parameters)
|
97
102
|
|
98
103
|
parameters[:method] = method
|
@@ -106,7 +111,9 @@ module TrainPlugins
|
|
106
111
|
parameters[:payload] = data
|
107
112
|
end
|
108
113
|
|
109
|
-
|
114
|
+
# Merge override headers + request specific headers
|
115
|
+
parameters[:headers].merge!(override_headers || {})
|
116
|
+
parameters[:headers].merge!(headers)
|
110
117
|
parameters.compact!
|
111
118
|
|
112
119
|
logger.info format("[REST] => %s", parameters.to_s) if options[:debug_rest]
|
@@ -116,6 +123,27 @@ module TrainPlugins
|
|
116
123
|
transform_response(response, json_processing)
|
117
124
|
end
|
118
125
|
|
126
|
+
# Allow switching generic handlers for an API-specific one.
|
127
|
+
#
|
128
|
+
# New handler needs to be loaded prior and be derived from TrainPlugins::REST::AuthHandler.
|
129
|
+
def switch_auth_handler(new_handler)
|
130
|
+
return if active_auth_handler == new_handler
|
131
|
+
|
132
|
+
logout
|
133
|
+
|
134
|
+
options[:auth_type] = new_handler.to_sym
|
135
|
+
@auth_handler = nil
|
136
|
+
|
137
|
+
login
|
138
|
+
end
|
139
|
+
|
140
|
+
# Return active auth handler.
|
141
|
+
#
|
142
|
+
# @return [Symbol]
|
143
|
+
def active_auth_handler
|
144
|
+
options[:auth_type]
|
145
|
+
end
|
146
|
+
|
119
147
|
# Auth Handlers-faced API
|
120
148
|
|
121
149
|
def auth_parameters
|
data/lib/train-rest/version.rb
CHANGED
data/lib/train-rest.rb
CHANGED
@@ -7,5 +7,8 @@ require "train-rest/transport"
|
|
7
7
|
require "train-rest/connection"
|
8
8
|
|
9
9
|
require "train-rest/auth_handler/anonymous"
|
10
|
+
require "train-rest/auth_handler/authtype-apikey"
|
11
|
+
require "train-rest/auth_handler/header"
|
10
12
|
require "train-rest/auth_handler/basic"
|
13
|
+
require "train-rest/auth_handler/bearer"
|
11
14
|
require "train-rest/auth_handler/redfish"
|
metadata
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: train-rest
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Thomas Heinen
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-03-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name: train
|
14
|
+
name: train-core
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
@@ -58,14 +58,14 @@ dependencies:
|
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version: '
|
61
|
+
version: '2.2'
|
62
62
|
type: :development
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
66
|
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version: '
|
68
|
+
version: '2.2'
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: guard
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -115,18 +115,19 @@ executables: []
|
|
115
115
|
extensions: []
|
116
116
|
extra_rdoc_files: []
|
117
117
|
files:
|
118
|
-
-
|
119
|
-
- README.md
|
118
|
+
- LICENSE
|
120
119
|
- lib/train-rest.rb
|
121
120
|
- lib/train-rest/auth_handler.rb
|
122
121
|
- lib/train-rest/auth_handler/anonymous.rb
|
122
|
+
- lib/train-rest/auth_handler/authtype-apikey.rb
|
123
123
|
- lib/train-rest/auth_handler/basic.rb
|
124
|
+
- lib/train-rest/auth_handler/bearer.rb
|
125
|
+
- lib/train-rest/auth_handler/header.rb
|
124
126
|
- lib/train-rest/auth_handler/redfish.rb
|
125
127
|
- lib/train-rest/connection.rb
|
126
128
|
- lib/train-rest/transport.rb
|
127
129
|
- lib/train-rest/version.rb
|
128
|
-
-
|
129
|
-
homepage: https://github.com/sgre-chef/train-rest
|
130
|
+
homepage: https://github.com/tecracer-chef/train-rest
|
130
131
|
licenses:
|
131
132
|
- Apache-2.0
|
132
133
|
metadata: {}
|
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
145
146
|
- !ruby/object:Gem::Version
|
146
147
|
version: '0'
|
147
148
|
requirements: []
|
148
|
-
rubygems_version: 3.0.3
|
149
|
+
rubygems_version: 3.0.3.1
|
149
150
|
signing_key:
|
150
151
|
specification_version: 4
|
151
152
|
summary: Train transport for REST
|
data/Gemfile
DELETED
data/README.md
DELETED
@@ -1,246 +0,0 @@
|
|
1
|
-
# train-rest - Train transport
|
2
|
-
|
3
|
-
Provides a transport to communicate easily with RESTful APIs.
|
4
|
-
|
5
|
-
## Requirements
|
6
|
-
|
7
|
-
- Gem `rest-client` in Version 2.1
|
8
|
-
|
9
|
-
## Installation
|
10
|
-
|
11
|
-
You will have to build this gem yourself to install it as it is not yet on
|
12
|
-
Rubygems.Org. For this there is a rake task which makes this a one-liner:
|
13
|
-
|
14
|
-
```bash
|
15
|
-
rake install:local
|
16
|
-
```
|
17
|
-
|
18
|
-
## Transport parameters
|
19
|
-
|
20
|
-
| Option | Explanation | Default |
|
21
|
-
| -------------------- | --------------------------------------- | ----------- |
|
22
|
-
| `endpoint` | Endpoint of the REST API | _required_ |
|
23
|
-
| `verify_ssl` | Check certificate and chain | true |
|
24
|
-
| `auth_type` | Authentication type | `anonymous` |
|
25
|
-
| `debug_rest` | Enable debugging of HTTP traffic | false |
|
26
|
-
| `logger` | Alternative logging class | |
|
27
|
-
|
28
|
-
## Authenticators
|
29
|
-
|
30
|
-
### Anonymous
|
31
|
-
|
32
|
-
Identifier: `auth_type: :anonymous`
|
33
|
-
|
34
|
-
No actions for authentication, logging in/out or session handing are made. This
|
35
|
-
assumes a public API.
|
36
|
-
|
37
|
-
### Basic Authentication
|
38
|
-
|
39
|
-
Identifier: `auth_type: :basic`
|
40
|
-
|
41
|
-
| Option | Explanation | Default |
|
42
|
-
| -------------------- | --------------------------------------- | ----------- |
|
43
|
-
| `username` | Username for `basic` authentication | _required_ |
|
44
|
-
| `password` | Password for `basic` authentication | _required_ |
|
45
|
-
|
46
|
-
If you supply a `username` and a `password`, authentication will automatically
|
47
|
-
switch to `basic`.
|
48
|
-
|
49
|
-
### Redfish
|
50
|
-
|
51
|
-
Identifier: `auth_type: :redfish`
|
52
|
-
|
53
|
-
| Option | Explanation | Default |
|
54
|
-
| -------------------- | --------------------------------------- | ----------- |
|
55
|
-
| `username` | Username for `redfish` authentication | _required_ |
|
56
|
-
| `password` | Password for `redfish` authentication | _required_ |
|
57
|
-
|
58
|
-
For access to integrated management controllers on standardized server hardware.
|
59
|
-
The Redfish standard is defined in <http://www.dmtf.org/standards/redfish> and
|
60
|
-
this handler does initial login, reuses the received session and logs out when
|
61
|
-
closing the transport cleanly.
|
62
|
-
|
63
|
-
Known vendors which implement RedFish based management for their systems include
|
64
|
-
HPE, Dell, IBM, SuperMicro, Lenovo, Huawei and others.
|
65
|
-
|
66
|
-
## Debugging and use in Chef
|
67
|
-
|
68
|
-
You can activate debugging by setting the `debug_rest` flag to `true'. Please
|
69
|
-
note, that this will also log any confidential parts of HTTP traffic as well.
|
70
|
-
|
71
|
-
For better integration into Chef custom resources, all REST debug output will
|
72
|
-
be printed on `info` level. This allows debugging Chef resources without
|
73
|
-
crawling through all other debug output:
|
74
|
-
|
75
|
-
```ruby
|
76
|
-
train = Train.create('rest', {
|
77
|
-
endpoint: 'https://api.example.com/v1/',
|
78
|
-
debug_rest: true,
|
79
|
-
logger: Chef::Log
|
80
|
-
})
|
81
|
-
```
|
82
|
-
|
83
|
-
## Request Methods
|
84
|
-
|
85
|
-
This transport does not implement the `run_command` method, as there is no
|
86
|
-
line-based protocol to execute commands against. Instead, it implements its own
|
87
|
-
custom methods which suit REST interfaces. Trying to call this method will
|
88
|
-
throw an Exception.
|
89
|
-
|
90
|
-
### Generic Request
|
91
|
-
|
92
|
-
The `request` methods allows to send free-form requests against any defined or
|
93
|
-
custom methods.
|
94
|
-
|
95
|
-
`request(path, method = :get, request_parameters: {}, data: nil, headers: {},
|
96
|
-
json_processing: true)`
|
97
|
-
|
98
|
-
- `path`: The path to request, which will be appended to the `endpoint`
|
99
|
-
- `method`: The HTTP method in Ruby Symbol syntax
|
100
|
-
- `request_parameters`: A hash of parameters to the `rest-client` request
|
101
|
-
method for additional settings
|
102
|
-
- `data`: Data for actions like `:post` or `:put`. Not all methods accept
|
103
|
-
a data body.
|
104
|
-
- `headers`: Additional headers for the request
|
105
|
-
- `json_processing`: If the response is a JSON and you want to receive a
|
106
|
-
processed Hash/Array instead of text
|
107
|
-
|
108
|
-
For `request_parameters` and `headers`, there is data mixed in to add
|
109
|
-
authenticator responses, JSON processing etc. Please check the
|
110
|
-
implementation in `connection.rb` for details.
|
111
|
-
|
112
|
-
### Convenience Methods
|
113
|
-
|
114
|
-
Simplified wrappers are generated for the most common request types:
|
115
|
-
|
116
|
-
- `delete(path, request_parameters: {}, headers: {}, json_processing: true)`
|
117
|
-
- `head(path, request_parameters: {}, headers: {}, json_processing: true)`
|
118
|
-
- `get(path, request_parameters: {}, headers: {}, json_processing: true)`
|
119
|
-
- `post(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
|
120
|
-
- `put(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
|
121
|
-
- `patch(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
|
122
|
-
|
123
|
-
## Example use
|
124
|
-
|
125
|
-
```ruby
|
126
|
-
require 'train-rest'
|
127
|
-
|
128
|
-
train = Train.create('rest', {
|
129
|
-
endpoint: 'https://api.example.com/v1/',
|
130
|
-
|
131
|
-
logger: Logger.new($stdout, level: :info)
|
132
|
-
})
|
133
|
-
conn = train.connection
|
134
|
-
|
135
|
-
# Get some hypothetical data
|
136
|
-
data = conn.get('device/1/settings')
|
137
|
-
|
138
|
-
# Modify + Patch
|
139
|
-
data['disabled'] = false
|
140
|
-
conn.patch('device/1/settings', data)
|
141
|
-
|
142
|
-
conn.close
|
143
|
-
```
|
144
|
-
|
145
|
-
Example for basic authentication:
|
146
|
-
|
147
|
-
```ruby
|
148
|
-
require 'train-rest'
|
149
|
-
|
150
|
-
# This will immediately do a login and add headers
|
151
|
-
train = Train.create('rest', {
|
152
|
-
endpoint: 'https://api.example.com/v1/',
|
153
|
-
|
154
|
-
auth_type: :basic,
|
155
|
-
username: 'admin',
|
156
|
-
password: '*********'
|
157
|
-
})
|
158
|
-
conn = train.connection
|
159
|
-
|
160
|
-
# ... do work, each request will resend Basic authentication headers ...
|
161
|
-
|
162
|
-
conn.close
|
163
|
-
```
|
164
|
-
|
165
|
-
Example for logging into a RedFish based system. Please note that the RedFish
|
166
|
-
authentication handler will append `redfish/v1` to the endpoint automatically,
|
167
|
-
if it is not present.
|
168
|
-
|
169
|
-
Due to this, you can use RedFish systems either with a base URL like in the
|
170
|
-
example below or with a full one. Your own code needs to match the style
|
171
|
-
you choose.
|
172
|
-
|
173
|
-
```ruby
|
174
|
-
require 'train-rest'
|
175
|
-
|
176
|
-
# This will immediately do a login and add headers
|
177
|
-
train = Train.create('rest', {
|
178
|
-
endpoint: 'https://10.20.30.40',
|
179
|
-
verify_ssl: false,
|
180
|
-
|
181
|
-
auth_type: :redfish,
|
182
|
-
username: 'iloadmin',
|
183
|
-
password: '*********'
|
184
|
-
})
|
185
|
-
conn = train.connection
|
186
|
-
|
187
|
-
# ... do work ...
|
188
|
-
|
189
|
-
# Handles logout as well
|
190
|
-
conn.close
|
191
|
-
```
|
192
|
-
|
193
|
-
## Use with Redfish, Your Custom Resources and Chef Target Mode
|
194
|
-
|
195
|
-
1. Set up a credentials file under `~/.chef/credentials` or `/etc/chef/credentials`:
|
196
|
-
|
197
|
-
```toml
|
198
|
-
['10.0.0.1']
|
199
|
-
endpoint = 'https://10.0.0.1/redfish/v1/'
|
200
|
-
username = 'user'
|
201
|
-
password = 'pass'
|
202
|
-
verify_ssl = false
|
203
|
-
auth_type = 'redfish'
|
204
|
-
```
|
205
|
-
|
206
|
-
1. Configure Chef to use the REST transport in `client.rb`:
|
207
|
-
|
208
|
-
```toml
|
209
|
-
target_mode.protocol = "rest"
|
210
|
-
```
|
211
|
-
|
212
|
-
1. Write your custom resources for REST APIs
|
213
|
-
1. Mark them up using the REST methods for target mode:
|
214
|
-
|
215
|
-
```ruby
|
216
|
-
provides :rest_resource, target_mode: true, platform: 'rest'
|
217
|
-
```
|
218
|
-
|
219
|
-
1. Run against the defiend targets via Chef Target Mode:
|
220
|
-
|
221
|
-
```shell
|
222
|
-
chef-client --local-mode --target 10.0.0.1 --runlist 'recipe[my-cookbook::setup]'
|
223
|
-
```
|
224
|
-
|
225
|
-
## Use with Prerecorded API responses
|
226
|
-
|
227
|
-
For testing during and after development, not all APIs can be used to verify your solution against.
|
228
|
-
The VCR gem offers the possibility to hook into web requests and intercept them to play back canned
|
229
|
-
responses.
|
230
|
-
|
231
|
-
Please read the documentation of the VCR gem on how to record your API and the concepts like
|
232
|
-
"cassettes", "libraries" and matchers.
|
233
|
-
|
234
|
-
The following options are available in train-rest for this:
|
235
|
-
|
236
|
-
| Option | Explanation | Default |
|
237
|
-
| -------------------- | --------------------------------------- | ------------ |
|
238
|
-
| `vcr_cassette` | Name of the response file | nil |
|
239
|
-
| `vcr_library` | Directory to search responses in | `vcr` |
|
240
|
-
| `vcr_match_on` | Elements to match request by | `method uri` |
|
241
|
-
| `vcr_record` | Recording mode | `none` |
|
242
|
-
| `vcr_hook_into` | Base library for intercepting | `webmock` |
|
243
|
-
|
244
|
-
VCR will only be required as a Gem and activated, if you supply a cassette name.
|
245
|
-
|
246
|
-
You can use all these settings in your Chef Target Mode `credentials` file as well.
|
data/train-rest.gemspec
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
lib = File.expand_path("lib", __dir__)
|
2
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
-
require "train-rest/version"
|
4
|
-
|
5
|
-
Gem::Specification.new do |spec|
|
6
|
-
spec.name = "train-rest"
|
7
|
-
spec.version = TrainPlugins::Rest::VERSION
|
8
|
-
spec.authors = ["Thomas Heinen"]
|
9
|
-
spec.email = ["theinen@tecracer.de"]
|
10
|
-
spec.summary = "Train transport for REST"
|
11
|
-
spec.description = "Provides a transport to communicate easily with RESTful APIs."
|
12
|
-
spec.homepage = "https://github.com/sgre-chef/train-rest"
|
13
|
-
spec.license = "Apache-2.0"
|
14
|
-
|
15
|
-
spec.files = %w{
|
16
|
-
README.md train-rest.gemspec Gemfile
|
17
|
-
} + Dir.glob(
|
18
|
-
"lib/**/*", File::FNM_DOTMATCH
|
19
|
-
).reject { |f| File.directory?(f) }
|
20
|
-
spec.require_paths = ["lib"]
|
21
|
-
|
22
|
-
spec.add_dependency "train", "~> 3.0"
|
23
|
-
spec.add_dependency "rest-client", "~> 2.1"
|
24
|
-
|
25
|
-
spec.add_development_dependency "bump", "~> 0.9"
|
26
|
-
spec.add_development_dependency "chefstyle", "~> 0.14"
|
27
|
-
spec.add_development_dependency "guard", "~> 2.16"
|
28
|
-
spec.add_development_dependency "mdl", "~> 0.9"
|
29
|
-
spec.add_development_dependency "rake", "~> 13.0"
|
30
|
-
end
|