hecks 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7e80387e679bdc08c6a48b9c1eabefee28d7f9fd0e28a41f203e1fd9b207c34
-  data.tar.gz: 455038d69b310e2fc9ae72b30d811623c8c1a85a4a5da118b842b8af7fd082b0
+  metadata.gz: 1fad5f64ba40ddec2720f013efc33d54e7ce5ebaf0926bc0670b642f91e53416
+  data.tar.gz: a714cad37a3a9c02f2ece530fc2c417e019f3ac47e0f0b76fd2c336416c2d55d
 SHA512:
-  metadata.gz: 7738a1869d51907dce7b981d7f0d3d1977f73a8baae57d947d2667155830495f9e19163a4c1fe5785e79fa262a7733c6d1d31086b6bc0ed85191bd31d6ad829b
-  data.tar.gz: f3506ffdc5133c083030ac87f0056a1373de5802520116956b0e30c00ea3d473e1e55f9fa62e813048e98c063aa05446a44e61ff49540dcc266e74546d6da7fa
+  metadata.gz: 3ed37d25061346166c25415b92be46409ecefa3eb762fef81941c4758ecc3a2681241f29a4c819a28ad360ee0267919612f9fedb9c56c1be00d0a9a70d512e6e
+  data.tar.gz: 7b6b0df13da60ef2a40a002d2a847b284164518c51363227c01f1d00e548e3d544b25a27d28053ff1af2469c6f802f4a5bd94103b6d2a9a9ed491710b9152217

data/lib/hecks/bluebook/capabilities.rb

@@ -32,6 +32,14 @@ module Hecks
       # "Newsletter". rust/host's newsletter routes dispatch these verbs
       # and read the subscribing aggregate's instances off `subscribe`.
       NEWSLETTER = "newsletter".freeze
+      # Taking a payment through an external processor: start one, then
+      # hear the processor's verdict — recognised by declaration, not the
+      # literal chapter name "Payments". rust/host's checkout and webhook
+      # routes dispatch these verbs and read the paying aggregate's
+      # instances off `initiate`. The two verdicts are hecksagon port
+      # operations (the processor's webhook, translated into this chapter's
+      # vocabulary), not commands.
+      PAYMENTS = "payments".freeze
 
       CONTRACTS = {
         AUTHORIZATION => {
@@ -67,6 +75,14 @@ module Hecks
           confirm:     :command,
           # a subscriber leaves from the emailed link
           unsubscribe: :command
+        }.freeze,
+        PAYMENTS      => {
+          # start a payment; the aggregate it names is the payment
+          initiate:  :command,
+          # the processor reports the money arrived
+          succeeded: :port_operation,
+          # the processor reports the payment failed or expired
+          failed:    :port_operation
         }.freeze
       }.freeze
     end

data/lib/hecks/language/bluebook/bluebook.bluebook

@@ -296,6 +296,13 @@ Hecks.bluebook "Bluebook", version: "1" do
       member keyword: "provides",        context: "Bluebook", at: "",  named: "register",    kind: "text", required: "false", fills: "provides"
       member keyword: "provides",        context: "Bluebook", at: "",  named: "link",        kind: "text", required: "false", fills: "provides"
       member keyword: "provides",        context: "Bluebook", at: "",  named: "resolve",     kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "subscribe",   kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "add_name",    kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "confirm",     kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "unsubscribe", kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "initiate",    kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "succeeded",   kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "failed",      kind: "text", required: "false", fills: "provides"
       member keyword: "aggregate",       context: "Bluebook", at: "1", named: "",        kind: "text",     required: "true",  fills: "name"
       member keyword: "read_model", context: "Bluebook", at: "1", named: "", kind: "text", required: "true", fills: "name"
       member keyword: "policy",          context: "Bluebook", at: "1", named: "",        kind: "text",     required: "true",  fills: "name"

data/lib/hecks/projector/exporter.rb

@@ -202,6 +202,32 @@ module Hecks
         }
       end
 
+      # Same seam as `newsletter` — which chapter takes payments
+      # (`Registry#payments_provider_for`), with its declared verbs
+      # qualified and the paying aggregate named off `initiate`. rust/host
+      # reads this instead of naming Payments::Payment.Initiate and the
+      # PaymentGateway operations. `{}` when nothing this domain attaches
+      # provides payments.
+      # @param registry [Runtime::Registry] the booted registry `domain_name` is loaded in
+      # @param domain_name [String] the domain to export the payments binding for
+      # @return [Hash{Symbol => String, nil}] `:provider` (name), `:initiate`, `:succeeded`,
+      #   `:failed` (qualified verbs), and `:aggregate` (`:initiate`'s own leading qualified
+      #   aggregate name); `{}` if nothing this domain attaches provides payments
+      def payments(registry, domain_name)
+        provider = registry.payments_provider_for(domain_name)
+        return {} unless provider
+
+        capability = Bluebook::Capabilities::PAYMENTS
+        initiate = provider.provided_verb(capability, :initiate)
+        {
+          provider:  provider.name,
+          initiate:  initiate,
+          succeeded: provider.provided_verb(capability, :succeeded),
+          failed:    provider.provided_verb(capability, :failed),
+          aggregate: initiate&.split(".")&.first
+        }
+      end
+
       # Translation IR, always as an array, with each aggregate's
       # precompiled SQL attached (`compiled_translation_aggregate`) —
       # this is the export a consumer embeds (`ir.json`'s `translations`

data/lib/hecks/runtime/registry.rb

@@ -392,6 +392,20 @@ module Hecks
         vendored_provider_for(domain, Bluebook::Capabilities::NEWSLETTER)
       end
 
+      # The chapter that takes payments for `domain` — the domain's own
+      # chapter, a framework member, or a vendored embryonaut bluebook it
+      # attaches, that declares `provides "payments"`. Nil when none does.
+      # Payments is recognised by what it declares (Initiate and the
+      # processor's two verdicts), so a chapter that declares the same
+      # thing is recognised the same way.
+      #
+      # @param domain [String, Symbol] the domain whose payments chapter is being resolved
+      # @return [Bluebook::Chapter, nil] the chapter that takes `domain`'s payments, or nil
+      #   if none does
+      def payments_provider_for(domain)
+        vendored_provider_for(domain, Bluebook::Capabilities::PAYMENTS)
+      end
+
       # The chapter that provides `capability` for `domain`: the domain's
       # own chapter, any framework member its hecksagon attaches, or any
       # vendored embryonaut bluebook it attaches, that declares it. Falls

data/lib/hecks/version.rb

@@ -12,5 +12,5 @@ module Hecks
   # it there, or even in the consuming Gemfile, never closed the gap,
   # because gemspec evaluation happens before anything Bundler
   # resolves is actually loadable yet.
-  VERSION = "2.1.0".freeze
+  VERSION = "2.2.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hecks
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Chris Young