sendproof-core 0.1.0.alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +55 -0
- data/lib/sendproof/assets.rb +70 -0
- data/lib/sendproof/attribution.rb +98 -0
- data/lib/sendproof/capture.rb +66 -0
- data/lib/sendproof/clock.rb +54 -0
- data/lib/sendproof/configuration.rb +241 -0
- data/lib/sendproof/data_store.rb +34 -0
- data/lib/sendproof/dynamodb/store.rb +183 -0
- data/lib/sendproof/dynamodb.rb +17 -0
- data/lib/sendproof/elasticsearch/store.rb +24 -0
- data/lib/sendproof/elasticsearch.rb +17 -0
- data/lib/sendproof/firestore/interceptor.rb +38 -0
- data/lib/sendproof/firestore/store.rb +150 -0
- data/lib/sendproof/firestore.rb +99 -0
- data/lib/sendproof/handler.rb +23 -0
- data/lib/sendproof/identity.rb +37 -0
- data/lib/sendproof/limits.rb +113 -0
- data/lib/sendproof/middleware.rb +68 -0
- data/lib/sendproof/mongo/engine.rb +692 -0
- data/lib/sendproof/mongo/guarded.rb +100 -0
- data/lib/sendproof/mongo/plain.rb +45 -0
- data/lib/sendproof/mongo/store.rb +54 -0
- data/lib/sendproof/mongo/subscriber.rb +21 -0
- data/lib/sendproof/mongo.rb +41 -0
- data/lib/sendproof/mongoid/store.rb +58 -0
- data/lib/sendproof/mongoid.rb +65 -0
- data/lib/sendproof/observed_request.rb +108 -0
- data/lib/sendproof/opensearch/store.rb +21 -0
- data/lib/sendproof/opensearch.rb +17 -0
- data/lib/sendproof/operation_matcher.rb +28 -0
- data/lib/sendproof/pool_hooks.rb +80 -0
- data/lib/sendproof/preview_request.rb +44 -0
- data/lib/sendproof/preview_transport.rb +331 -0
- data/lib/sendproof/protocol.rb +81 -0
- data/lib/sendproof/provider.rb +83 -0
- data/lib/sendproof/recorder.rb +298 -0
- data/lib/sendproof/redaction.rb +98 -0
- data/lib/sendproof/redis/commands.rb +76 -0
- data/lib/sendproof/redis/store.rb +205 -0
- data/lib/sendproof/redis.rb +18 -0
- data/lib/sendproof/search/middleware.rb +39 -0
- data/lib/sendproof/search/store.rb +213 -0
- data/lib/sendproof/search.rb +82 -0
- data/lib/sendproof/stores/classify.rb +346 -0
- data/lib/sendproof/stores/guard.rb +127 -0
- data/lib/sendproof/stores/tables.rb +1328 -0
- data/lib/sendproof/stores.rb +12 -0
- data/lib/sendproof/trace_store.rb +110 -0
- data/lib/sendproof/transaction_control.rb +187 -0
- data/lib/sendproof/ui/action-bar.js +91 -0
- data/lib/sendproof/ui/api.js +239 -0
- data/lib/sendproof/ui/app.css +848 -0
- data/lib/sendproof/ui/app.js +742 -0
- data/lib/sendproof/ui/autofill.js +137 -0
- data/lib/sendproof/ui/code-copy.js +71 -0
- data/lib/sendproof/ui/code-picker.js +149 -0
- data/lib/sendproof/ui/commands.js +197 -0
- data/lib/sendproof/ui/components.js +77 -0
- data/lib/sendproof/ui/context-bar.js +82 -0
- data/lib/sendproof/ui/copy.js +92 -0
- data/lib/sendproof/ui/coverage-popover.js +35 -0
- data/lib/sendproof/ui/crumb-fit.js +80 -0
- data/lib/sendproof/ui/deprecation.js +164 -0
- data/lib/sendproof/ui/display-settings.js +175 -0
- data/lib/sendproof/ui/doc-diff.js +209 -0
- data/lib/sendproof/ui/docs-view.js +347 -0
- data/lib/sendproof/ui/favicon.png +0 -0
- data/lib/sendproof/ui/favicon.svg +1 -0
- data/lib/sendproof/ui/field-help.js +52 -0
- data/lib/sendproof/ui/field-modules.js +23 -0
- data/lib/sendproof/ui/fields/controls.js +179 -0
- data/lib/sendproof/ui/fields/dom.js +36 -0
- data/lib/sendproof/ui/fields/infer.js +71 -0
- data/lib/sendproof/ui/fields/lookup-source.js +63 -0
- data/lib/sendproof/ui/fields/lookup.js +285 -0
- data/lib/sendproof/ui/fields/render.js +496 -0
- data/lib/sendproof/ui/fields/select.js +175 -0
- data/lib/sendproof/ui/fields/validate.js +363 -0
- data/lib/sendproof/ui/fields/validation-formats.js +164 -0
- data/lib/sendproof/ui/fields/validation-references.js +68 -0
- data/lib/sendproof/ui/fields/validation-values.js +137 -0
- data/lib/sendproof/ui/generate-menu.js +44 -0
- data/lib/sendproof/ui/generate.js +184 -0
- data/lib/sendproof/ui/header-editor.js +777 -0
- data/lib/sendproof/ui/headers.js +188 -0
- data/lib/sendproof/ui/highlight.js +257 -0
- data/lib/sendproof/ui/history-popover.js +24 -0
- data/lib/sendproof/ui/i18n.js +253 -0
- data/lib/sendproof/ui/icons.js +87 -0
- data/lib/sendproof/ui/index.html +70 -0
- data/lib/sendproof/ui/issues.js +187 -0
- data/lib/sendproof/ui/json-view.js +166 -0
- data/lib/sendproof/ui/lang-icons.js +62 -0
- data/lib/sendproof/ui/layout.js +262 -0
- data/lib/sendproof/ui/listbox.js +334 -0
- data/lib/sendproof/ui/locales/ar-capture.js +366 -0
- data/lib/sendproof/ui/locales/ar-stores.js +116 -0
- data/lib/sendproof/ui/locales/ar.js +561 -0
- data/lib/sendproof/ui/locales/cs-capture.js +442 -0
- data/lib/sendproof/ui/locales/cs-stores.js +116 -0
- data/lib/sendproof/ui/locales/cs.js +689 -0
- data/lib/sendproof/ui/locales/da-capture.js +347 -0
- data/lib/sendproof/ui/locales/da-stores.js +116 -0
- data/lib/sendproof/ui/locales/da.js +522 -0
- data/lib/sendproof/ui/locales/de-capture.js +347 -0
- data/lib/sendproof/ui/locales/de-stores.js +116 -0
- data/lib/sendproof/ui/locales/de.js +519 -0
- data/lib/sendproof/ui/locales/el-capture.js +347 -0
- data/lib/sendproof/ui/locales/el-stores.js +116 -0
- data/lib/sendproof/ui/locales/el.js +520 -0
- data/lib/sendproof/ui/locales/en-capture.js +349 -0
- data/lib/sendproof/ui/locales/en-stores.js +95 -0
- data/lib/sendproof/ui/locales/en.js +522 -0
- data/lib/sendproof/ui/locales/es-capture.js +353 -0
- data/lib/sendproof/ui/locales/es-stores.js +116 -0
- data/lib/sendproof/ui/locales/es.js +525 -0
- data/lib/sendproof/ui/locales/fa-capture.js +348 -0
- data/lib/sendproof/ui/locales/fa-stores.js +116 -0
- data/lib/sendproof/ui/locales/fa.js +521 -0
- data/lib/sendproof/ui/locales/fi-capture.js +347 -0
- data/lib/sendproof/ui/locales/fi-stores.js +116 -0
- data/lib/sendproof/ui/locales/fi.js +523 -0
- data/lib/sendproof/ui/locales/fr-capture.js +353 -0
- data/lib/sendproof/ui/locales/fr-stores.js +116 -0
- data/lib/sendproof/ui/locales/fr.js +525 -0
- data/lib/sendproof/ui/locales/he-capture.js +358 -0
- data/lib/sendproof/ui/locales/he-stores.js +116 -0
- data/lib/sendproof/ui/locales/he.js +529 -0
- data/lib/sendproof/ui/locales/hi-capture.js +348 -0
- data/lib/sendproof/ui/locales/hi-stores.js +116 -0
- data/lib/sendproof/ui/locales/hi.js +523 -0
- data/lib/sendproof/ui/locales/id-capture.js +347 -0
- data/lib/sendproof/ui/locales/id-stores.js +116 -0
- data/lib/sendproof/ui/locales/id.js +521 -0
- data/lib/sendproof/ui/locales/it-capture.js +361 -0
- data/lib/sendproof/ui/locales/it-stores.js +116 -0
- data/lib/sendproof/ui/locales/it.js +523 -0
- data/lib/sendproof/ui/locales/ja-capture.js +346 -0
- data/lib/sendproof/ui/locales/ja-stores.js +116 -0
- data/lib/sendproof/ui/locales/ja.js +521 -0
- data/lib/sendproof/ui/locales/ko-capture.js +346 -0
- data/lib/sendproof/ui/locales/ko-stores.js +116 -0
- data/lib/sendproof/ui/locales/ko.js +522 -0
- data/lib/sendproof/ui/locales/nb-capture.js +349 -0
- data/lib/sendproof/ui/locales/nb-stores.js +116 -0
- data/lib/sendproof/ui/locales/nb.js +521 -0
- data/lib/sendproof/ui/locales/nl-capture.js +355 -0
- data/lib/sendproof/ui/locales/nl-stores.js +116 -0
- data/lib/sendproof/ui/locales/nl.js +520 -0
- data/lib/sendproof/ui/locales/pl-capture.js +432 -0
- data/lib/sendproof/ui/locales/pl-stores.js +116 -0
- data/lib/sendproof/ui/locales/pl.js +528 -0
- data/lib/sendproof/ui/locales/pt-BR-capture.js +350 -0
- data/lib/sendproof/ui/locales/pt-BR-stores.js +116 -0
- data/lib/sendproof/ui/locales/pt-BR.js +523 -0
- data/lib/sendproof/ui/locales/pt-PT-capture.js +350 -0
- data/lib/sendproof/ui/locales/pt-PT-stores.js +116 -0
- data/lib/sendproof/ui/locales/pt-PT.js +523 -0
- data/lib/sendproof/ui/locales/ru-capture.js +437 -0
- data/lib/sendproof/ui/locales/ru-stores.js +116 -0
- data/lib/sendproof/ui/locales/ru.js +624 -0
- data/lib/sendproof/ui/locales/sv-capture.js +349 -0
- data/lib/sendproof/ui/locales/sv-stores.js +116 -0
- data/lib/sendproof/ui/locales/sv.js +518 -0
- data/lib/sendproof/ui/locales/th-capture.js +347 -0
- data/lib/sendproof/ui/locales/th-stores.js +116 -0
- data/lib/sendproof/ui/locales/th.js +521 -0
- data/lib/sendproof/ui/locales/tr-capture.js +348 -0
- data/lib/sendproof/ui/locales/tr-stores.js +116 -0
- data/lib/sendproof/ui/locales/tr.js +521 -0
- data/lib/sendproof/ui/locales/uk-capture.js +442 -0
- data/lib/sendproof/ui/locales/uk-stores.js +116 -0
- data/lib/sendproof/ui/locales/uk.js +630 -0
- data/lib/sendproof/ui/locales/vi-capture.js +346 -0
- data/lib/sendproof/ui/locales/vi-stores.js +116 -0
- data/lib/sendproof/ui/locales/vi.js +523 -0
- data/lib/sendproof/ui/locales/zh-Hans-capture.js +347 -0
- data/lib/sendproof/ui/locales/zh-Hans-stores.js +116 -0
- data/lib/sendproof/ui/locales/zh-Hans.js +523 -0
- data/lib/sendproof/ui/locales/zh-Hant-capture.js +346 -0
- data/lib/sendproof/ui/locales/zh-Hant-stores.js +116 -0
- data/lib/sendproof/ui/locales/zh-Hant.js +522 -0
- data/lib/sendproof/ui/manifest.json +866 -0
- data/lib/sendproof/ui/markdown.js +39 -0
- data/lib/sendproof/ui/model-view.js +182 -0
- data/lib/sendproof/ui/navigation.js +233 -0
- data/lib/sendproof/ui/operation-header.js +76 -0
- data/lib/sendproof/ui/operations.js +7 -0
- data/lib/sendproof/ui/overview-view.js +63 -0
- data/lib/sendproof/ui/personas.js +59 -0
- data/lib/sendproof/ui/popover.js +71 -0
- data/lib/sendproof/ui/preview-false.js +108 -0
- data/lib/sendproof/ui/request-editor.js +496 -0
- data/lib/sendproof/ui/response-metadata.js +354 -0
- data/lib/sendproof/ui/response-viewer.js +618 -0
- data/lib/sendproof/ui/result-blocked.js +155 -0
- data/lib/sendproof/ui/result-capture.js +25 -0
- data/lib/sendproof/ui/result-database.js +185 -0
- data/lib/sendproof/ui/result-effects.js +176 -0
- data/lib/sendproof/ui/result-headers.js +106 -0
- data/lib/sendproof/ui/result-logs.js +408 -0
- data/lib/sendproof/ui/result-states.js +213 -0
- data/lib/sendproof/ui/results.js +371 -0
- data/lib/sendproof/ui/router.js +118 -0
- data/lib/sendproof/ui/schema-model.js +336 -0
- data/lib/sendproof/ui/schema-tree.js +344 -0
- data/lib/sendproof/ui/schema.js +397 -0
- data/lib/sendproof/ui/security.js +31 -0
- data/lib/sendproof/ui/seeded-menu.js +69 -0
- data/lib/sendproof/ui/settings.js +93 -0
- data/lib/sendproof/ui/shortcuts-sheet.js +73 -0
- data/lib/sendproof/ui/shortcuts.js +190 -0
- data/lib/sendproof/ui/sidebar.js +289 -0
- data/lib/sendproof/ui/signin.js +259 -0
- data/lib/sendproof/ui/snippets.js +530 -0
- data/lib/sendproof/ui/store-marks.js +47 -0
- data/lib/sendproof/ui/stores.js +131 -0
- data/lib/sendproof/ui/styles.css +971 -0
- data/lib/sendproof/ui/toggletip.js +53 -0
- data/lib/sendproof/ui/uuid.js +10 -0
- data/lib/sendproof/ui/view.js +122 -0
- data/lib/sendproof/ui/views.css +653 -0
- data/lib/sendproof/version.rb +9 -0
- data/lib/sendproof/workbench.rb +102 -0
- data/lib/sendproof-core.rb +3 -0
- data/lib/sendproof.rb +121 -0
- metadata +292 -0
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sendproof
|
|
4
|
+
# The workbench's own routes under +/sendproof+: UI assets, discovery and trace retrieval.
|
|
5
|
+
class Workbench
|
|
6
|
+
def initialize(config)
|
|
7
|
+
@config = config
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
# @param path [String] PATH_INFO, which starts with +/sendproof+
|
|
11
|
+
# @return [Array] Rack response
|
|
12
|
+
def call(env, request, path)
|
|
13
|
+
denied = authorize(request)
|
|
14
|
+
return denied if denied
|
|
15
|
+
|
|
16
|
+
case path
|
|
17
|
+
when "/sendproof" then redirect(request)
|
|
18
|
+
when "/sendproof/", "/sendproof/signin.html" then asset("index.html", request)
|
|
19
|
+
when "/sendproof/_api/capabilities" then capabilities(request)
|
|
20
|
+
when %r{\A/sendproof/_api/traces/([^/]+)\z} then trace(request, Regexp.last_match(1))
|
|
21
|
+
when "/sendproof/_api/challenge" then not_found
|
|
22
|
+
else
|
|
23
|
+
name = path.delete_prefix("/sendproof/")
|
|
24
|
+
name.start_with?("_") ? not_found : asset(Rack::Utils.unescape_path(name), request)
|
|
25
|
+
end
|
|
26
|
+
rescue Assets::BundleError => error
|
|
27
|
+
@config.logger&.error("Sendproof UI bundle problem: #{error.message}")
|
|
28
|
+
Protocol.problem(503, "The Sendproof UI bundle is unavailable.")
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
private
|
|
32
|
+
|
|
33
|
+
def authorize(request)
|
|
34
|
+
return nil if @config.authorized?(request)
|
|
35
|
+
|
|
36
|
+
@config.identity_for(request) ? Protocol.problem(403, "The workbench is forbidden.") :
|
|
37
|
+
Protocol.problem(401, "Authentication is required for the workbench.")
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
def not_found = [404, { "content-type" => "text/plain", "cache-control" => "no-store" }, ["Not Found"]]
|
|
41
|
+
|
|
42
|
+
def redirect(request)
|
|
43
|
+
query = request.query_string.to_s
|
|
44
|
+
location = "#{request.script_name}/sendproof/#{query.empty? ? '' : "?#{query}"}"
|
|
45
|
+
[302, { "location" => location, "content-length" => "0" }, []]
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def asset(name, request)
|
|
49
|
+
return [405, { "allow" => "GET, HEAD", "content-length" => "0" }, []] unless request.get? || request.head?
|
|
50
|
+
|
|
51
|
+
@config.assets.serve(name, request) || not_found
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def capabilities(request)
|
|
55
|
+
provider = @config.preview_provider
|
|
56
|
+
operations = provider ? @config.operations : []
|
|
57
|
+
unavailable = provider ? @config.unavailable_operations : []
|
|
58
|
+
stores = @config.data_stores.map { |store| store.describe.compact }
|
|
59
|
+
base = request.script_name.to_s
|
|
60
|
+
open_api_url = base + @config.open_api_url
|
|
61
|
+
documents = @config.documents.map { |document| { name: document[:name], url: base + document[:url] } }
|
|
62
|
+
documents.unshift({ name: @config.api_name, url: open_api_url }) if documents.none? { |d| d[:url] == open_api_url }
|
|
63
|
+
identity = @config.identity_for(request)
|
|
64
|
+
document = {
|
|
65
|
+
protocolVersion: 1,
|
|
66
|
+
openApiUrl: open_api_url,
|
|
67
|
+
fieldModules: @config.field_modules.map { |url| base + url },
|
|
68
|
+
apiName: @config.api_name,
|
|
69
|
+
environment: @config.environment,
|
|
70
|
+
database: database(@config.provider),
|
|
71
|
+
binding: { language: "ruby", framework: @config.framework },
|
|
72
|
+
identity: identity && { name: identity.name, **(identity.role ? { role: identity.role } : {}) },
|
|
73
|
+
authProviders: @config.auth_providers.map { |p| p.merge(url: p[:url] && base + p[:url]) },
|
|
74
|
+
previewOperations: operations,
|
|
75
|
+
observedSend: !operations.empty?,
|
|
76
|
+
documents:
|
|
77
|
+
}
|
|
78
|
+
document[:previewUnavailable] = unavailable unless unavailable.empty?
|
|
79
|
+
document[:dataStores] = stores unless stores.empty?
|
|
80
|
+
Protocol.json(200, document, { "cache-control" => "no-store", "x-content-type-options" => "nosniff" })
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# The database as discovery shows it: a display name, or +{name:, system:}+ when the provider says
|
|
84
|
+
# which SQL system it is, so the workbench shows that system's mark.
|
|
85
|
+
def database(provider)
|
|
86
|
+
return nil unless provider
|
|
87
|
+
|
|
88
|
+
name = provider.database
|
|
89
|
+
system = provider.respond_to?(:database_system) ? provider.database_system : nil
|
|
90
|
+
system ? { name: name, system: system } : name
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
def trace(request, id)
|
|
94
|
+
headers = { "cache-control" => "no-store", "x-content-type-options" => "nosniff" }
|
|
95
|
+
owner = Protocol.same_origin?(request) && @config.identity_for(request)&.owner(request.script_name)
|
|
96
|
+
trace = owner && @config.trace_store.read(id, owner)
|
|
97
|
+
return [404, headers.merge("content-type" => "text/plain"), ["Not Found"]] unless trace
|
|
98
|
+
|
|
99
|
+
Protocol.json(200, trace, headers)
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
data/lib/sendproof.rb
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "json"
|
|
4
|
+
require "securerandom"
|
|
5
|
+
require "digest"
|
|
6
|
+
require "rack"
|
|
7
|
+
|
|
8
|
+
require_relative "sendproof/version"
|
|
9
|
+
|
|
10
|
+
# Sendproof: an in-app workbench that previews what an API call will do.
|
|
11
|
+
#
|
|
12
|
+
# The core speaks bench protocol v1 over plain Rack. Framework adapters
|
|
13
|
+
# (sendproof-rails) and data-layer providers (sendproof-activerecord) plug into
|
|
14
|
+
# the interfaces documented in {Sendproof::Provider} and {Sendproof::Handler}.
|
|
15
|
+
module Sendproof
|
|
16
|
+
# Raised when the host configuration cannot work.
|
|
17
|
+
class ConfigurationError < StandardError; end
|
|
18
|
+
|
|
19
|
+
# Raised by a framework adapter when the endpoint selected by the router is not preview-enabled.
|
|
20
|
+
class IneligibleHandler < StandardError; end
|
|
21
|
+
|
|
22
|
+
# The Rack environment key that holds the active {PreviewRequest} or {ObservedRequest}.
|
|
23
|
+
ENV_KEY = "sendproof.request"
|
|
24
|
+
|
|
25
|
+
autoload :Assets, "sendproof/assets"
|
|
26
|
+
autoload :Attribution, "sendproof/attribution"
|
|
27
|
+
autoload :Capture, "sendproof/capture"
|
|
28
|
+
autoload :Clock, "sendproof/clock"
|
|
29
|
+
autoload :Configuration, "sendproof/configuration"
|
|
30
|
+
autoload :DataStore, "sendproof/data_store"
|
|
31
|
+
autoload :Handler, "sendproof/handler"
|
|
32
|
+
autoload :Identity, "sendproof/identity"
|
|
33
|
+
autoload :Owner, "sendproof/identity"
|
|
34
|
+
autoload :Limits, "sendproof/limits"
|
|
35
|
+
autoload :Middleware, "sendproof/middleware"
|
|
36
|
+
autoload :ObservedRequest, "sendproof/observed_request"
|
|
37
|
+
autoload :OperationMatcher, "sendproof/operation_matcher"
|
|
38
|
+
autoload :PoolHooks, "sendproof/pool_hooks"
|
|
39
|
+
autoload :PreviewRequest, "sendproof/preview_request"
|
|
40
|
+
autoload :PreviewTransactionControl, "sendproof/stores"
|
|
41
|
+
autoload :PreviewTransport, "sendproof/preview_transport"
|
|
42
|
+
autoload :PreviewWriteBlocked, "sendproof/stores"
|
|
43
|
+
autoload :Protocol, "sendproof/protocol"
|
|
44
|
+
autoload :Provider, "sendproof/provider"
|
|
45
|
+
autoload :ProviderContext, "sendproof/provider"
|
|
46
|
+
autoload :Recorder, "sendproof/recorder"
|
|
47
|
+
autoload :Redaction, "sendproof/redaction"
|
|
48
|
+
autoload :Stores, "sendproof/stores"
|
|
49
|
+
autoload :TraceStore, "sendproof/trace_store"
|
|
50
|
+
autoload :TransactionControl, "sendproof/transaction_control"
|
|
51
|
+
autoload :Workbench, "sendproof/workbench"
|
|
52
|
+
|
|
53
|
+
class << self
|
|
54
|
+
# @return [Boolean] true while a rollback preview is running on this thread.
|
|
55
|
+
def preview?
|
|
56
|
+
Capture.current&.rollback? || false
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# @return [Boolean] true while a preview or observed send captures this thread's request.
|
|
60
|
+
def capturing?
|
|
61
|
+
!Capture.current.nil?
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# Marks the block as background work that belongs to no request, such as a job worker or a scheduled
|
|
65
|
+
# task running in the server process, so its data-store writes are never refused. Without the mark, a
|
|
66
|
+
# write from outside any request is refused while a Preview is open, and blocks every Preview open at
|
|
67
|
+
# that moment, because it might come from a Preview handler's own thread. Never use it inside a handler: a write it sends
|
|
68
|
+
# escapes the Preview, like a client that was never hooked.
|
|
69
|
+
#
|
|
70
|
+
# Sendproof.detached { redis.incr("jobs:processed") }
|
|
71
|
+
#
|
|
72
|
+
# @return the block's result
|
|
73
|
+
def detached(&) = Attribution.detached(&)
|
|
74
|
+
|
|
75
|
+
# Records an intended side effect and tells the caller whether to skip it.
|
|
76
|
+
#
|
|
77
|
+
# During a preview the effect is recorded and suppressed (returns true). During an
|
|
78
|
+
# observed send it is recorded as delivered and the caller proceeds (returns false).
|
|
79
|
+
# Outside both, nothing is recorded and the caller proceeds.
|
|
80
|
+
#
|
|
81
|
+
# @param kind [String, Symbol] a conventional kind (email, http, job, message) or any label
|
|
82
|
+
# @param description [String] display text
|
|
83
|
+
# @param data [Hash, nil] JSON-serializable detail; see spec/README.md for conventional keys
|
|
84
|
+
# @return [Boolean] true when the host must suppress delivery
|
|
85
|
+
def record_effect(kind, description, data = nil)
|
|
86
|
+
Capture.current&.record_effect(kind.to_s, description.to_s, data) || false
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Records the effect, then runs the block unless a preview suppressed it.
|
|
90
|
+
# @return [Object, nil] the block's value, or nil when suppressed
|
|
91
|
+
def deliver(kind, description, data = nil)
|
|
92
|
+
yield unless record_effect(kind, description, data)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Records an email effect. Returns true when delivery must be skipped.
|
|
96
|
+
def record_email(description, from:, to:, subject:, text:, cc: [], html: nil)
|
|
97
|
+
record_effect(:email, description, { from:, to: Array(to), cc: Array(cc), subject:, text:, html: })
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Records an outbound HTTP call. Returns true when the call must be skipped.
|
|
101
|
+
def record_http(description, method:, url:, status: nil, body: nil)
|
|
102
|
+
record_effect(:http, description, { method:, url:, status:, body: })
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Records a background job. Returns true when scheduling must be skipped.
|
|
106
|
+
def record_job(description, name:, arguments: nil, queue: nil, run_at: nil)
|
|
107
|
+
record_effect(:job, description, { name:, arguments:, queue:, runAt: run_at&.iso8601 })
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Records a published message. Returns true when publishing must be skipped.
|
|
111
|
+
def record_message(description, topic:, payload: nil, key: nil)
|
|
112
|
+
record_effect(:message, description, { topic:, payload:, key: })
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Adds an application log entry to the active capture. Returns false when nothing is capturing.
|
|
116
|
+
# @param level [String] one of Trace, Debug, Information, Warning, Error, Critical
|
|
117
|
+
def log(level, message)
|
|
118
|
+
Capture.current&.record_log(level.to_s, message.to_s) || false
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: sendproof-core
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0.alpha.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Sendproof contributors
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 2026-11-22 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: rack
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '3.0'
|
|
19
|
+
- - "<"
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '4'
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
version: '3.0'
|
|
29
|
+
- - "<"
|
|
30
|
+
- !ruby/object:Gem::Version
|
|
31
|
+
version: '4'
|
|
32
|
+
description: Serves the embedded Sendproof UI, discovery, rollback preview transport
|
|
33
|
+
and observed-send traces for any Rack application. Framework and data-layer adapters
|
|
34
|
+
plug in through small interfaces.
|
|
35
|
+
executables: []
|
|
36
|
+
extensions: []
|
|
37
|
+
extra_rdoc_files: []
|
|
38
|
+
files:
|
|
39
|
+
- LICENSE
|
|
40
|
+
- README.md
|
|
41
|
+
- lib/sendproof-core.rb
|
|
42
|
+
- lib/sendproof.rb
|
|
43
|
+
- lib/sendproof/assets.rb
|
|
44
|
+
- lib/sendproof/attribution.rb
|
|
45
|
+
- lib/sendproof/capture.rb
|
|
46
|
+
- lib/sendproof/clock.rb
|
|
47
|
+
- lib/sendproof/configuration.rb
|
|
48
|
+
- lib/sendproof/data_store.rb
|
|
49
|
+
- lib/sendproof/dynamodb.rb
|
|
50
|
+
- lib/sendproof/dynamodb/store.rb
|
|
51
|
+
- lib/sendproof/elasticsearch.rb
|
|
52
|
+
- lib/sendproof/elasticsearch/store.rb
|
|
53
|
+
- lib/sendproof/firestore.rb
|
|
54
|
+
- lib/sendproof/firestore/interceptor.rb
|
|
55
|
+
- lib/sendproof/firestore/store.rb
|
|
56
|
+
- lib/sendproof/handler.rb
|
|
57
|
+
- lib/sendproof/identity.rb
|
|
58
|
+
- lib/sendproof/limits.rb
|
|
59
|
+
- lib/sendproof/middleware.rb
|
|
60
|
+
- lib/sendproof/mongo.rb
|
|
61
|
+
- lib/sendproof/mongo/engine.rb
|
|
62
|
+
- lib/sendproof/mongo/guarded.rb
|
|
63
|
+
- lib/sendproof/mongo/plain.rb
|
|
64
|
+
- lib/sendproof/mongo/store.rb
|
|
65
|
+
- lib/sendproof/mongo/subscriber.rb
|
|
66
|
+
- lib/sendproof/mongoid.rb
|
|
67
|
+
- lib/sendproof/mongoid/store.rb
|
|
68
|
+
- lib/sendproof/observed_request.rb
|
|
69
|
+
- lib/sendproof/opensearch.rb
|
|
70
|
+
- lib/sendproof/opensearch/store.rb
|
|
71
|
+
- lib/sendproof/operation_matcher.rb
|
|
72
|
+
- lib/sendproof/pool_hooks.rb
|
|
73
|
+
- lib/sendproof/preview_request.rb
|
|
74
|
+
- lib/sendproof/preview_transport.rb
|
|
75
|
+
- lib/sendproof/protocol.rb
|
|
76
|
+
- lib/sendproof/provider.rb
|
|
77
|
+
- lib/sendproof/recorder.rb
|
|
78
|
+
- lib/sendproof/redaction.rb
|
|
79
|
+
- lib/sendproof/redis.rb
|
|
80
|
+
- lib/sendproof/redis/commands.rb
|
|
81
|
+
- lib/sendproof/redis/store.rb
|
|
82
|
+
- lib/sendproof/search.rb
|
|
83
|
+
- lib/sendproof/search/middleware.rb
|
|
84
|
+
- lib/sendproof/search/store.rb
|
|
85
|
+
- lib/sendproof/stores.rb
|
|
86
|
+
- lib/sendproof/stores/classify.rb
|
|
87
|
+
- lib/sendproof/stores/guard.rb
|
|
88
|
+
- lib/sendproof/stores/tables.rb
|
|
89
|
+
- lib/sendproof/trace_store.rb
|
|
90
|
+
- lib/sendproof/transaction_control.rb
|
|
91
|
+
- lib/sendproof/ui/action-bar.js
|
|
92
|
+
- lib/sendproof/ui/api.js
|
|
93
|
+
- lib/sendproof/ui/app.css
|
|
94
|
+
- lib/sendproof/ui/app.js
|
|
95
|
+
- lib/sendproof/ui/autofill.js
|
|
96
|
+
- lib/sendproof/ui/code-copy.js
|
|
97
|
+
- lib/sendproof/ui/code-picker.js
|
|
98
|
+
- lib/sendproof/ui/commands.js
|
|
99
|
+
- lib/sendproof/ui/components.js
|
|
100
|
+
- lib/sendproof/ui/context-bar.js
|
|
101
|
+
- lib/sendproof/ui/copy.js
|
|
102
|
+
- lib/sendproof/ui/coverage-popover.js
|
|
103
|
+
- lib/sendproof/ui/crumb-fit.js
|
|
104
|
+
- lib/sendproof/ui/deprecation.js
|
|
105
|
+
- lib/sendproof/ui/display-settings.js
|
|
106
|
+
- lib/sendproof/ui/doc-diff.js
|
|
107
|
+
- lib/sendproof/ui/docs-view.js
|
|
108
|
+
- lib/sendproof/ui/favicon.png
|
|
109
|
+
- lib/sendproof/ui/favicon.svg
|
|
110
|
+
- lib/sendproof/ui/field-help.js
|
|
111
|
+
- lib/sendproof/ui/field-modules.js
|
|
112
|
+
- lib/sendproof/ui/fields/controls.js
|
|
113
|
+
- lib/sendproof/ui/fields/dom.js
|
|
114
|
+
- lib/sendproof/ui/fields/infer.js
|
|
115
|
+
- lib/sendproof/ui/fields/lookup-source.js
|
|
116
|
+
- lib/sendproof/ui/fields/lookup.js
|
|
117
|
+
- lib/sendproof/ui/fields/render.js
|
|
118
|
+
- lib/sendproof/ui/fields/select.js
|
|
119
|
+
- lib/sendproof/ui/fields/validate.js
|
|
120
|
+
- lib/sendproof/ui/fields/validation-formats.js
|
|
121
|
+
- lib/sendproof/ui/fields/validation-references.js
|
|
122
|
+
- lib/sendproof/ui/fields/validation-values.js
|
|
123
|
+
- lib/sendproof/ui/generate-menu.js
|
|
124
|
+
- lib/sendproof/ui/generate.js
|
|
125
|
+
- lib/sendproof/ui/header-editor.js
|
|
126
|
+
- lib/sendproof/ui/headers.js
|
|
127
|
+
- lib/sendproof/ui/highlight.js
|
|
128
|
+
- lib/sendproof/ui/history-popover.js
|
|
129
|
+
- lib/sendproof/ui/i18n.js
|
|
130
|
+
- lib/sendproof/ui/icons.js
|
|
131
|
+
- lib/sendproof/ui/index.html
|
|
132
|
+
- lib/sendproof/ui/issues.js
|
|
133
|
+
- lib/sendproof/ui/json-view.js
|
|
134
|
+
- lib/sendproof/ui/lang-icons.js
|
|
135
|
+
- lib/sendproof/ui/layout.js
|
|
136
|
+
- lib/sendproof/ui/listbox.js
|
|
137
|
+
- lib/sendproof/ui/locales/ar-capture.js
|
|
138
|
+
- lib/sendproof/ui/locales/ar-stores.js
|
|
139
|
+
- lib/sendproof/ui/locales/ar.js
|
|
140
|
+
- lib/sendproof/ui/locales/cs-capture.js
|
|
141
|
+
- lib/sendproof/ui/locales/cs-stores.js
|
|
142
|
+
- lib/sendproof/ui/locales/cs.js
|
|
143
|
+
- lib/sendproof/ui/locales/da-capture.js
|
|
144
|
+
- lib/sendproof/ui/locales/da-stores.js
|
|
145
|
+
- lib/sendproof/ui/locales/da.js
|
|
146
|
+
- lib/sendproof/ui/locales/de-capture.js
|
|
147
|
+
- lib/sendproof/ui/locales/de-stores.js
|
|
148
|
+
- lib/sendproof/ui/locales/de.js
|
|
149
|
+
- lib/sendproof/ui/locales/el-capture.js
|
|
150
|
+
- lib/sendproof/ui/locales/el-stores.js
|
|
151
|
+
- lib/sendproof/ui/locales/el.js
|
|
152
|
+
- lib/sendproof/ui/locales/en-capture.js
|
|
153
|
+
- lib/sendproof/ui/locales/en-stores.js
|
|
154
|
+
- lib/sendproof/ui/locales/en.js
|
|
155
|
+
- lib/sendproof/ui/locales/es-capture.js
|
|
156
|
+
- lib/sendproof/ui/locales/es-stores.js
|
|
157
|
+
- lib/sendproof/ui/locales/es.js
|
|
158
|
+
- lib/sendproof/ui/locales/fa-capture.js
|
|
159
|
+
- lib/sendproof/ui/locales/fa-stores.js
|
|
160
|
+
- lib/sendproof/ui/locales/fa.js
|
|
161
|
+
- lib/sendproof/ui/locales/fi-capture.js
|
|
162
|
+
- lib/sendproof/ui/locales/fi-stores.js
|
|
163
|
+
- lib/sendproof/ui/locales/fi.js
|
|
164
|
+
- lib/sendproof/ui/locales/fr-capture.js
|
|
165
|
+
- lib/sendproof/ui/locales/fr-stores.js
|
|
166
|
+
- lib/sendproof/ui/locales/fr.js
|
|
167
|
+
- lib/sendproof/ui/locales/he-capture.js
|
|
168
|
+
- lib/sendproof/ui/locales/he-stores.js
|
|
169
|
+
- lib/sendproof/ui/locales/he.js
|
|
170
|
+
- lib/sendproof/ui/locales/hi-capture.js
|
|
171
|
+
- lib/sendproof/ui/locales/hi-stores.js
|
|
172
|
+
- lib/sendproof/ui/locales/hi.js
|
|
173
|
+
- lib/sendproof/ui/locales/id-capture.js
|
|
174
|
+
- lib/sendproof/ui/locales/id-stores.js
|
|
175
|
+
- lib/sendproof/ui/locales/id.js
|
|
176
|
+
- lib/sendproof/ui/locales/it-capture.js
|
|
177
|
+
- lib/sendproof/ui/locales/it-stores.js
|
|
178
|
+
- lib/sendproof/ui/locales/it.js
|
|
179
|
+
- lib/sendproof/ui/locales/ja-capture.js
|
|
180
|
+
- lib/sendproof/ui/locales/ja-stores.js
|
|
181
|
+
- lib/sendproof/ui/locales/ja.js
|
|
182
|
+
- lib/sendproof/ui/locales/ko-capture.js
|
|
183
|
+
- lib/sendproof/ui/locales/ko-stores.js
|
|
184
|
+
- lib/sendproof/ui/locales/ko.js
|
|
185
|
+
- lib/sendproof/ui/locales/nb-capture.js
|
|
186
|
+
- lib/sendproof/ui/locales/nb-stores.js
|
|
187
|
+
- lib/sendproof/ui/locales/nb.js
|
|
188
|
+
- lib/sendproof/ui/locales/nl-capture.js
|
|
189
|
+
- lib/sendproof/ui/locales/nl-stores.js
|
|
190
|
+
- lib/sendproof/ui/locales/nl.js
|
|
191
|
+
- lib/sendproof/ui/locales/pl-capture.js
|
|
192
|
+
- lib/sendproof/ui/locales/pl-stores.js
|
|
193
|
+
- lib/sendproof/ui/locales/pl.js
|
|
194
|
+
- lib/sendproof/ui/locales/pt-BR-capture.js
|
|
195
|
+
- lib/sendproof/ui/locales/pt-BR-stores.js
|
|
196
|
+
- lib/sendproof/ui/locales/pt-BR.js
|
|
197
|
+
- lib/sendproof/ui/locales/pt-PT-capture.js
|
|
198
|
+
- lib/sendproof/ui/locales/pt-PT-stores.js
|
|
199
|
+
- lib/sendproof/ui/locales/pt-PT.js
|
|
200
|
+
- lib/sendproof/ui/locales/ru-capture.js
|
|
201
|
+
- lib/sendproof/ui/locales/ru-stores.js
|
|
202
|
+
- lib/sendproof/ui/locales/ru.js
|
|
203
|
+
- lib/sendproof/ui/locales/sv-capture.js
|
|
204
|
+
- lib/sendproof/ui/locales/sv-stores.js
|
|
205
|
+
- lib/sendproof/ui/locales/sv.js
|
|
206
|
+
- lib/sendproof/ui/locales/th-capture.js
|
|
207
|
+
- lib/sendproof/ui/locales/th-stores.js
|
|
208
|
+
- lib/sendproof/ui/locales/th.js
|
|
209
|
+
- lib/sendproof/ui/locales/tr-capture.js
|
|
210
|
+
- lib/sendproof/ui/locales/tr-stores.js
|
|
211
|
+
- lib/sendproof/ui/locales/tr.js
|
|
212
|
+
- lib/sendproof/ui/locales/uk-capture.js
|
|
213
|
+
- lib/sendproof/ui/locales/uk-stores.js
|
|
214
|
+
- lib/sendproof/ui/locales/uk.js
|
|
215
|
+
- lib/sendproof/ui/locales/vi-capture.js
|
|
216
|
+
- lib/sendproof/ui/locales/vi-stores.js
|
|
217
|
+
- lib/sendproof/ui/locales/vi.js
|
|
218
|
+
- lib/sendproof/ui/locales/zh-Hans-capture.js
|
|
219
|
+
- lib/sendproof/ui/locales/zh-Hans-stores.js
|
|
220
|
+
- lib/sendproof/ui/locales/zh-Hans.js
|
|
221
|
+
- lib/sendproof/ui/locales/zh-Hant-capture.js
|
|
222
|
+
- lib/sendproof/ui/locales/zh-Hant-stores.js
|
|
223
|
+
- lib/sendproof/ui/locales/zh-Hant.js
|
|
224
|
+
- lib/sendproof/ui/manifest.json
|
|
225
|
+
- lib/sendproof/ui/markdown.js
|
|
226
|
+
- lib/sendproof/ui/model-view.js
|
|
227
|
+
- lib/sendproof/ui/navigation.js
|
|
228
|
+
- lib/sendproof/ui/operation-header.js
|
|
229
|
+
- lib/sendproof/ui/operations.js
|
|
230
|
+
- lib/sendproof/ui/overview-view.js
|
|
231
|
+
- lib/sendproof/ui/personas.js
|
|
232
|
+
- lib/sendproof/ui/popover.js
|
|
233
|
+
- lib/sendproof/ui/preview-false.js
|
|
234
|
+
- lib/sendproof/ui/request-editor.js
|
|
235
|
+
- lib/sendproof/ui/response-metadata.js
|
|
236
|
+
- lib/sendproof/ui/response-viewer.js
|
|
237
|
+
- lib/sendproof/ui/result-blocked.js
|
|
238
|
+
- lib/sendproof/ui/result-capture.js
|
|
239
|
+
- lib/sendproof/ui/result-database.js
|
|
240
|
+
- lib/sendproof/ui/result-effects.js
|
|
241
|
+
- lib/sendproof/ui/result-headers.js
|
|
242
|
+
- lib/sendproof/ui/result-logs.js
|
|
243
|
+
- lib/sendproof/ui/result-states.js
|
|
244
|
+
- lib/sendproof/ui/results.js
|
|
245
|
+
- lib/sendproof/ui/router.js
|
|
246
|
+
- lib/sendproof/ui/schema-model.js
|
|
247
|
+
- lib/sendproof/ui/schema-tree.js
|
|
248
|
+
- lib/sendproof/ui/schema.js
|
|
249
|
+
- lib/sendproof/ui/security.js
|
|
250
|
+
- lib/sendproof/ui/seeded-menu.js
|
|
251
|
+
- lib/sendproof/ui/settings.js
|
|
252
|
+
- lib/sendproof/ui/shortcuts-sheet.js
|
|
253
|
+
- lib/sendproof/ui/shortcuts.js
|
|
254
|
+
- lib/sendproof/ui/sidebar.js
|
|
255
|
+
- lib/sendproof/ui/signin.js
|
|
256
|
+
- lib/sendproof/ui/snippets.js
|
|
257
|
+
- lib/sendproof/ui/store-marks.js
|
|
258
|
+
- lib/sendproof/ui/stores.js
|
|
259
|
+
- lib/sendproof/ui/styles.css
|
|
260
|
+
- lib/sendproof/ui/toggletip.js
|
|
261
|
+
- lib/sendproof/ui/uuid.js
|
|
262
|
+
- lib/sendproof/ui/view.js
|
|
263
|
+
- lib/sendproof/ui/views.css
|
|
264
|
+
- lib/sendproof/version.rb
|
|
265
|
+
- lib/sendproof/workbench.rb
|
|
266
|
+
homepage: https://github.com/mprync/sendproof
|
|
267
|
+
licenses:
|
|
268
|
+
- MIT
|
|
269
|
+
metadata:
|
|
270
|
+
source_code_uri: https://github.com/mprync/sendproof
|
|
271
|
+
bug_tracker_uri: https://github.com/mprync/sendproof/issues
|
|
272
|
+
changelog_uri: https://github.com/mprync/sendproof/releases
|
|
273
|
+
documentation_uri: https://github.com/mprync/sendproof/tree/main/adapters/ruby#readme
|
|
274
|
+
rubygems_mfa_required: 'true'
|
|
275
|
+
rdoc_options: []
|
|
276
|
+
require_paths:
|
|
277
|
+
- lib
|
|
278
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
279
|
+
requirements:
|
|
280
|
+
- - ">="
|
|
281
|
+
- !ruby/object:Gem::Version
|
|
282
|
+
version: '3.3'
|
|
283
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
284
|
+
requirements:
|
|
285
|
+
- - ">="
|
|
286
|
+
- !ruby/object:Gem::Version
|
|
287
|
+
version: '0'
|
|
288
|
+
requirements: []
|
|
289
|
+
rubygems_version: 3.6.9
|
|
290
|
+
specification_version: 4
|
|
291
|
+
summary: Framework-neutral Rack core for the Sendproof workbench (bench protocol v1).
|
|
292
|
+
test_files: []
|