foobara-remote-imports 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 303316f5bfc4dd44fe0e436894e38f01bab94497a890742558823dfe0f82459f
4
+ data.tar.gz: 0e22fb8f9708b786d9b9732c47e94284e5c8b97f2eb330b22069f9db77d98019
5
+ SHA512:
6
+ metadata.gz: 78d3271c3ff89a58ed0d5e0bf95cf61b982cb26036796702c691847a1ad215ec1d22022a00d80863a5713b23b4870906dd3fae806eb3d21b69cb53da68fb0cb6
7
+ data.tar.gz: 57592151a69f9c3852f3b74ae6a76acaaa00ab1390b963bee67b89536faf14f35bdb618c642f474822cde8689c6701e9eb25e4e3e629fee55bc7eaae7b2097ba
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ ## [0.0.1] - 2024-12-02
2
+
3
+ - Release as a gem
4
+
5
+ ## [0.0.0] - 2024-04-04
6
+
7
+ - Project birth
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
data/LICENSE.txt ADDED
@@ -0,0 +1,7 @@
1
+ This project is licensed under the MPL-2.0 license.
2
+
3
+ See LICENSE-MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/
4
+
5
+ This is equivalent to the following SPDX License Expression: MPL-2.0
6
+
7
+ Copyright (c) 2024 Miles Georgi
data/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # Foobara::RemoteImports
2
+
3
+ Used to import commands/entities/whatever from another system's command connector manifest
4
+
5
+ ## Installation
6
+
7
+ TODO
8
+
9
+ ## Usage
10
+
11
+ TODO: Write usage instructions here
12
+
13
+ ## Development
14
+
15
+ Run `bundle` then `rake` to run the tests/linter.
16
+
17
+ ## Contributing
18
+
19
+ Bug reports and pull requests are welcome on GitHub
20
+ at https://github.com/foobara/remote-imports
21
+
22
+ ## Licensing
23
+
24
+ This project is licensed under the Mozilla Public License Version 2.0. Please see LICENSE.txt for more info.
@@ -0,0 +1,3 @@
1
+ require "foobara/all"
2
+
3
+ Foobara::Util.require_directory "#{__dir__}/../../src"
@@ -0,0 +1,126 @@
1
+ require "json"
2
+ require "net/http"
3
+
4
+ module Foobara
5
+ class RemoteCommand < Command
6
+ class UnexpectedError < StandardError; end
7
+
8
+ # TODO: fill this out
9
+ class << self
10
+ attr_accessor :url_base
11
+
12
+ def subclass(
13
+ url_base:,
14
+ description:,
15
+ inputs:,
16
+ result:,
17
+ possible_errors:,
18
+ name:,
19
+ base: self
20
+ )
21
+ klass = Util.make_class_p(name, base)
22
+
23
+ klass.url_base = url_base
24
+ klass.description description
25
+ klass.inputs inputs
26
+ klass.result result
27
+
28
+ possible_errors.each_value do |possible_error_manifest|
29
+ error_class_name = possible_error_manifest.error.reference
30
+
31
+ error_class = Foobara.foobara_root_namespace.foobara_lookup_error!(error_class_name)
32
+ key = possible_error_manifest.key
33
+ symbol = possible_error_manifest.symbol
34
+ data = possible_error_manifest.processor_manifest_data
35
+
36
+ category = possible_error_manifest.category
37
+
38
+ possible_error = PossibleError.new(error_class, symbol:, data:, key:, category:)
39
+
40
+ if possible_error_manifest.manually_added
41
+ possible_error.manually_added = true
42
+ end
43
+
44
+ klass.register_possible_error_class(possible_error)
45
+ end
46
+
47
+ klass
48
+ end
49
+
50
+ def url
51
+ @url ||= "#{url_base}/run/#{name}"
52
+ end
53
+ end
54
+
55
+ def url
56
+ self.class.url
57
+ end
58
+
59
+ def execute
60
+ build_request_body
61
+ build_request_headers
62
+ # TODO: implement this for queries?
63
+ # build_query_string
64
+ issue_http_request
65
+ parse_response
66
+
67
+ parsed_result
68
+ end
69
+
70
+ attr_accessor :request_body, :request_headers, :response, :response_body, :response_code, :parsed_result
71
+
72
+ def build_request_body
73
+ self.request_body = inputs
74
+ end
75
+
76
+ def build_request_headers
77
+ self.request_headers = {
78
+ "Content-Type" => "application/json"
79
+ }
80
+ end
81
+
82
+ def issue_http_request
83
+ url = URI.parse(self.url)
84
+ self.response = Net::HTTP.post(url, JSON.generate(request_body), request_headers)
85
+ end
86
+
87
+ def parse_response
88
+ self.response_body = response.body
89
+ self.response_code = response.code
90
+
91
+ if response.is_a?(Net::HTTPSuccess)
92
+ self.parsed_result = JSON.parse(response_body)
93
+ elsif response.code.start_with?("4")
94
+ errors = JSON.parse(response_body)
95
+ errors.each do |error|
96
+ case error["category"]
97
+ when "runtime"
98
+ e = add_runtime_error(
99
+ symbol: error["symbol"],
100
+ message: error["message"],
101
+ context: error["context"],
102
+ halt: false
103
+ )
104
+ e.runtime_path = error["runtime_path"]
105
+ when "data"
106
+ add_input_error(
107
+ symbol: error["symbol"],
108
+ message: error["message"],
109
+ context: error["context"],
110
+ path: error["path"]
111
+ )
112
+ else
113
+ # :nocov:
114
+ raise "Bad error category: #{error["category"]}"
115
+ # :nocov:
116
+ end
117
+ end
118
+ halt!
119
+ else
120
+ # :nocov:
121
+ raise UnexpectedError, "#{response.code} from #{url}: #{response.body}"
122
+ # :nocov:
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,21 @@
1
+ module Foobara
2
+ module RemoteImports
3
+ class AlreadyImported
4
+ def imported
5
+ @imported ||= Set.new
6
+ end
7
+
8
+ def <<(manifest)
9
+ imported << to_key(manifest)
10
+ end
11
+
12
+ def to_key(manifest)
13
+ [manifest.path.first.to_sym, manifest.reference.to_sym]
14
+ end
15
+
16
+ def already_imported?(manifest)
17
+ imported.include?(to_key(manifest))
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,215 @@
1
+ require "digest/md5"
2
+ require "json"
3
+ require "net/http"
4
+
5
+ module Foobara
6
+ module RemoteImports
7
+ module ImportBase
8
+ # Why doesn't this automatically register the possible error??
9
+ class BadManifestInputsError < Foobara::RuntimeError
10
+ class << self
11
+ def context_type_declaration
12
+ {}
13
+ end
14
+ end
15
+ end
16
+
17
+ # TODO: why do we need this Value:: prefix?
18
+ class NotFoundError < Value::DataError
19
+ class << self
20
+ def context_type_declaration
21
+ { not_found: [:string] }
22
+ end
23
+ end
24
+ end
25
+
26
+ class << self
27
+ def included(klass)
28
+ klass.possible_input_error :to_import, NotFoundError
29
+ klass.possible_error BadManifestInputsError
30
+
31
+ klass.inputs(
32
+ manifest_url: :string,
33
+ raw_manifest: :associative_array,
34
+ cache: { type: :boolean, default: true },
35
+ cache_path: { type: :string, default: "tmp/cache/foobara-remote-imports" },
36
+ to_import: :duck,
37
+ already_imported: { type: :duck, allow_nil: true }
38
+ )
39
+
40
+ klass.result :duck
41
+ end
42
+ end
43
+
44
+ def execute
45
+ load_manifest
46
+
47
+ cache_manifest if should_cache?
48
+ determine_manifests_to_import
49
+ filter_manifests_to_import
50
+ import_objects_from_manifests
51
+
52
+ imported_objects
53
+ end
54
+
55
+ attr_accessor :manifest_data, :manifests_to_import, :manifest_to_import
56
+
57
+ def validate
58
+ super
59
+ validate_manifest
60
+ end
61
+
62
+ def validate_manifest
63
+ if manifest_url
64
+ if raw_manifest
65
+ add_runtime_error :bad_manifest_inputs, "Cannot provide both manifest_url and raw_manifest"
66
+ end
67
+ elsif !raw_manifest
68
+ add_runtime_error :bad_manifest_inputs, "Must provide either manifest_url or raw_manifest"
69
+ end
70
+ end
71
+
72
+ def already_exists?
73
+ method = "foobara_lookup_#{manifest_to_import.scoped_category}"
74
+
75
+ Foobara.foobara_root_namespace.send(
76
+ method,
77
+ manifest_to_import.reference,
78
+ mode: Namespace::LookupMode::ABSOLUTE
79
+ )
80
+ end
81
+
82
+ def already_imported
83
+ inputs[:already_imported] || AlreadyImported.new
84
+ end
85
+
86
+ def load_manifest
87
+ self.manifest_data = if raw_manifest
88
+ raw_manifest
89
+ elsif cache && cached?
90
+ load_cached_manifest
91
+ else
92
+ load_manifest_from_url
93
+ end
94
+ end
95
+
96
+ def load_manifest_from_url
97
+ url = URI.parse(manifest_url)
98
+ response = Net::HTTP.get_response(url)
99
+
100
+ manifest_json = if response.is_a?(Net::HTTPSuccess)
101
+ response.body
102
+ else
103
+ # :nocov:
104
+ raise "Could not get manifest from #{url}: " \
105
+ "#{response.code} #{response.message}"
106
+ # :nocov:
107
+ end
108
+
109
+ JSON.parse(manifest_json)
110
+ end
111
+
112
+ # TODO: feels like a command smell to pass manifests here... reconsider algorithm
113
+ def filter_manifests_to_import
114
+ return if to_import.nil? || to_import.empty?
115
+
116
+ references = manifests_to_import.map(&:reference)
117
+
118
+ filter = Util.array(to_import)
119
+
120
+ filter.map! do |name|
121
+ if references.include?(name)
122
+ name
123
+ else
124
+ suffix = "::#{name}"
125
+
126
+ partial_matches = references.select { |reference| reference.end_with?(suffix) }
127
+
128
+ if partial_matches.size == 1
129
+ partial_matches.first
130
+ else
131
+ name
132
+ end
133
+ end
134
+ end
135
+
136
+ not_found = filter - references
137
+
138
+ if not_found.any?
139
+ add_input_error :to_import, :not_found, "Could not find #{not_found}", not_found:
140
+ end
141
+
142
+ self.manifests_to_import = manifests_to_import.select do |manifest|
143
+ filter.include?(manifest.reference)
144
+ end
145
+ end
146
+
147
+ def root_manifest
148
+ @root_manifest ||= Manifest::RootManifest.new(manifest_data)
149
+ end
150
+
151
+ def cache_manifest
152
+ FileUtils.mkdir_p(cache_path)
153
+ File.write(cache_file_path, manifest_data.to_json)
154
+ end
155
+
156
+ def should_cache?
157
+ cache && manifest_url && !cached?
158
+ end
159
+
160
+ def cached?
161
+ File.exist?(cache_file_path)
162
+ end
163
+
164
+ def load_cached_manifest
165
+ JSON.parse(File.read(cache_file_path))
166
+ end
167
+
168
+ def cache_key
169
+ @cache_key ||= begin
170
+ hash = Digest::MD5.hexdigest(manifest_url)
171
+ escaped_url = manifest_url.gsub(/[^\w]/, "_")
172
+
173
+ "#{hash}_#{escaped_url}"
174
+ end
175
+ end
176
+
177
+ def cache_file_path
178
+ @cache_file_path ||= "#{cache_path}/#{cache_key}.json"
179
+ end
180
+
181
+ def determine_manifests_to_import
182
+ self.manifests_to_import = find_manifests_to_import
183
+ end
184
+
185
+ def find_manifests_to_import
186
+ # :nocov:
187
+ raise "subclass responsibility"
188
+ # :nocov:
189
+ end
190
+
191
+ def import_objects_from_manifests
192
+ manifests_to_import.each do |manifest|
193
+ unless already_imported.already_imported?(manifest)
194
+ self.manifest_to_import = manifest
195
+
196
+ next if already_exists?
197
+
198
+ imported_objects << import_object_from_manifest
199
+ already_imported << manifest
200
+ end
201
+ end
202
+ end
203
+
204
+ def import_object_from_manifest
205
+ # :nocov:
206
+ raise "subclass responsibility"
207
+ # :nocov:
208
+ end
209
+
210
+ def imported_objects
211
+ @imported_objects ||= []
212
+ end
213
+ end
214
+ end
215
+ end
@@ -0,0 +1,83 @@
1
+ require_relative "import_domain"
2
+ require_relative "import_type"
3
+ require_relative "import_error"
4
+ require_relative "../remote_command"
5
+
6
+ module Foobara
7
+ module RemoteImports
8
+ class ImportCommand < Command
9
+ include ImportBase
10
+
11
+ depends_on ImportDomain, ImportType, ImportError
12
+
13
+ def find_manifests_to_import
14
+ root_manifest.commands
15
+ end
16
+
17
+ def import_object_from_manifest
18
+ existing_command = Foobara.foobara_root_namespace.foobara_lookup_command(
19
+ manifest_to_import.reference,
20
+ mode: Namespace::LookupMode::ABSOLUTE
21
+ )
22
+
23
+ return if existing_command
24
+
25
+ domain_manifest = manifest_to_import.domain
26
+
27
+ run_subcommand!(
28
+ ImportDomain,
29
+ raw_manifest: manifest_data,
30
+ to_import: domain_manifest.reference,
31
+ already_imported:
32
+ )
33
+
34
+ Util.make_class_p(manifest_to_import.reference, RemoteCommand)
35
+
36
+ manifest_to_import.types_depended_on.each do |type|
37
+ run_subcommand!(
38
+ ImportType,
39
+ raw_manifest: manifest_data,
40
+ to_import: type.reference,
41
+ already_imported:
42
+ )
43
+ end
44
+
45
+ build_errors
46
+ build_command
47
+ end
48
+
49
+ def build_errors
50
+ manifest_to_import.possible_errors.each_value do |possible_error|
51
+ error = possible_error.error
52
+
53
+ existing_error = Foobara.foobara_root_namespace.foobara_lookup_error(
54
+ error.reference,
55
+ mode: Namespace::LookupMode::ABSOLUTE
56
+ )
57
+
58
+ next if existing_error
59
+
60
+ run_subcommand!(
61
+ ImportError,
62
+ raw_manifest: manifest_data,
63
+ to_import: error.reference,
64
+ already_imported:
65
+ )
66
+ end
67
+ end
68
+
69
+ def build_command
70
+ url_base = root_manifest.metadata["url"].gsub(/\/manifest$/, "")
71
+
72
+ RemoteCommand.subclass(
73
+ url_base:,
74
+ description: manifest_to_import.description,
75
+ inputs: manifest_to_import.inputs_type.relevant_manifest,
76
+ result: manifest_to_import.result_type.relevant_manifest,
77
+ possible_errors: manifest_to_import.possible_errors,
78
+ name: manifest_to_import.reference
79
+ )
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,30 @@
1
+ module Foobara
2
+ module RemoteImports
3
+ class ImportDomain < Command
4
+ include ImportBase
5
+
6
+ depends_on ImportOrganization
7
+
8
+ def find_manifests_to_import
9
+ root_manifest.domains
10
+ end
11
+
12
+ def import_object_from_manifest
13
+ if manifest_to_import.global?
14
+ return GlobalDomain
15
+ end
16
+
17
+ organization = manifest_to_import.organization
18
+
19
+ run_subcommand!(
20
+ ImportOrganization,
21
+ raw_manifest: manifest_data,
22
+ to_import: organization.reference,
23
+ already_imported:
24
+ )
25
+
26
+ Domain.create(manifest_to_import.reference)
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,64 @@
1
+ module Foobara
2
+ module RemoteImports
3
+ class ImportError < Command
4
+ include ImportBase
5
+
6
+ depends_on ImportDomain, ImportType
7
+
8
+ def find_manifests_to_import
9
+ root_manifest.errors
10
+ end
11
+
12
+ def import_object_from_manifest
13
+ existing_error = Foobara.foobara_root_namespace.foobara_lookup_error(
14
+ manifest_to_import.reference,
15
+ mode: Namespace::LookupMode::ABSOLUTE
16
+ )
17
+
18
+ return if existing_error
19
+
20
+ domain_manifest = manifest_to_import.domain
21
+
22
+ run_subcommand!(
23
+ ImportDomain,
24
+ raw_manifest: manifest_data,
25
+ to_import: domain_manifest.reference,
26
+ already_imported:
27
+ )
28
+
29
+ manifest_to_import.types_depended_on.each do |type|
30
+ run_subcommand!(
31
+ ImportType,
32
+ raw_manifest: manifest_data,
33
+ to_import: type.reference,
34
+ already_imported:
35
+ )
36
+ end
37
+
38
+ build_error
39
+ end
40
+
41
+ def build_error
42
+ base_error_name = manifest_to_import.base_error
43
+
44
+ base_error = if base_error_name
45
+ Foobara.foobara_root_namespace.foobara_lookup_error!(base_error_name)
46
+ else
47
+ # :nocov:
48
+ Foobara::Error
49
+ # :nocov:
50
+ end
51
+
52
+ Foobara::Error.subclass(
53
+ context_type_declaration: manifest_to_import.context_type_declaration,
54
+ name: manifest_to_import.error_class,
55
+ symbol: manifest_to_import.symbol.to_sym,
56
+ base_error:,
57
+ category: manifest_to_import.category.to_sym,
58
+ is_fatal: manifest_to_import.is_fatal,
59
+ abstract: manifest_to_import.abstract
60
+ )
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,21 @@
1
+ require_relative "import_base"
2
+
3
+ module Foobara
4
+ module RemoteImports
5
+ class ImportOrganization < Command
6
+ include ImportBase
7
+
8
+ def find_manifests_to_import
9
+ root_manifest.organizations
10
+ end
11
+
12
+ def import_object_from_manifest
13
+ if manifest_to_import.global?
14
+ return GlobalOrganization
15
+ end
16
+
17
+ Organization.create(manifest_to_import.reference)
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,59 @@
1
+ module Foobara
2
+ module RemoteImports
3
+ class ImportType < Command
4
+ include ImportBase
5
+
6
+ depends_on ImportDomain, ImportType
7
+
8
+ def find_manifests_to_import
9
+ root_manifest.types
10
+ end
11
+
12
+ def import_object_from_manifest
13
+ existing_type = Foobara.foobara_root_namespace.foobara_lookup_type(
14
+ manifest_to_import.reference,
15
+ mode: Namespace::LookupMode::ABSOLUTE
16
+ )
17
+
18
+ return if existing_type
19
+
20
+ domain_manifest = manifest_to_import.domain
21
+
22
+ run_subcommand!(
23
+ ImportDomain,
24
+ raw_manifest: manifest_data,
25
+ to_import: domain_manifest.reference,
26
+ already_imported:
27
+ )
28
+
29
+ domain_manifest = manifest_to_import.domain
30
+
31
+ domain = if domain_manifest.global?
32
+ GlobalDomain
33
+ else
34
+ Foobara.foobara_root_namespace.foobara_lookup_domain!(
35
+ domain_manifest.reference,
36
+ mode: Namespace::LookupMode::ABSOLUTE
37
+ )
38
+ end
39
+
40
+ manifest_to_import.types_depended_on.each do |depended_on_type|
41
+ run_subcommand!(
42
+ ImportType,
43
+ raw_manifest: manifest_data,
44
+ to_import: depended_on_type.reference,
45
+ already_imported:
46
+ )
47
+ end
48
+
49
+ containing_module_name = manifest_to_import.scoped_full_path[0..-2].join("::")
50
+ unless containing_module_name.empty?
51
+ Util.make_module_p(containing_module_name, tag: true)
52
+ end
53
+
54
+ type = domain.foobara_type_from_strict_stringified_declaration(manifest_to_import.declaration_data)
55
+ domain.foobara_register_type(manifest_to_import.scoped_path, type)
56
+ end
57
+ end
58
+ end
59
+ end
metadata ADDED
@@ -0,0 +1,74 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: foobara-remote-imports
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Miles Georgi
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-12-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: foobara
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ description:
28
+ email:
29
+ - azimux@gmail.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - CHANGELOG.md
35
+ - LICENSE-MPL-2.0.txt
36
+ - LICENSE.txt
37
+ - README.md
38
+ - lib/foobara/remote_imports.rb
39
+ - src/foobara/remote_command.rb
40
+ - src/foobara/remote_imports/already_imported.rb
41
+ - src/foobara/remote_imports/import_base.rb
42
+ - src/foobara/remote_imports/import_command.rb
43
+ - src/foobara/remote_imports/import_domain.rb
44
+ - src/foobara/remote_imports/import_error.rb
45
+ - src/foobara/remote_imports/import_organization.rb
46
+ - src/foobara/remote_imports/import_type.rb
47
+ homepage: https://github.com/foobara/remote-imports
48
+ licenses:
49
+ - MPL-2.0
50
+ metadata:
51
+ homepage_uri: https://github.com/foobara/remote-imports
52
+ source_code_uri: https://github.com/foobara/remote-imports
53
+ changelog_uri: https://github.com/foobara/remote-imports/blob/main/CHANGELOG.md
54
+ rubygems_mfa_required: 'true'
55
+ post_install_message:
56
+ rdoc_options: []
57
+ require_paths:
58
+ - lib
59
+ required_ruby_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: 3.2.2
64
+ required_rubygems_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ requirements: []
70
+ rubygems_version: 3.5.23
71
+ signing_key:
72
+ specification_version: 4
73
+ summary: Used to import commands/entities/whatever from another system into this one.
74
+ test_files: []