hecks 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7e80387e679bdc08c6a48b9c1eabefee28d7f9fd0e28a41f203e1fd9b207c34
-  data.tar.gz: 455038d69b310e2fc9ae72b30d811623c8c1a85a4a5da118b842b8af7fd082b0
+  metadata.gz: 07b56eefa1dd5cd2cc6308fa35aab4b8aba8af59da9418283d98a1235268e3c4
+  data.tar.gz: cc996a57a43dc3652a062c6af748545ec5846d50c08a43d372224e402c60fbf7
 SHA512:
-  metadata.gz: 7738a1869d51907dce7b981d7f0d3d1977f73a8baae57d947d2667155830495f9e19163a4c1fe5785e79fa262a7733c6d1d31086b6bc0ed85191bd31d6ad829b
-  data.tar.gz: f3506ffdc5133c083030ac87f0056a1373de5802520116956b0e30c00ea3d473e1e55f9fa62e813048e98c063aa05446a44e61ff49540dcc266e74546d6da7fa
+  metadata.gz: aab93180168cb073c8f65b05697cfe8c94f68d43a0516e2f8540d0c457d2ff238173fc223006f72e1681b870dcdd86b1ae65d1883d7d5375f62207b2b4a08b6d
+  data.tar.gz: 941f1214a2f1f7a144c57e8c0fc780d5444133973170afbc1d5dd6e646c0456feaaf73ac58da9382fc0b229af37a929e15eb8b77dd0dc36216187fd2341d8e04

data/lib/hecks/bluebook/capabilities.rb

@@ -32,9 +32,24 @@ module Hecks
       # "Newsletter". rust/host's newsletter routes dispatch these verbs
       # and read the subscribing aggregate's instances off `subscribe`.
       NEWSLETTER = "newsletter".freeze
+      # Sending an issue to the confirmed subscribers: the decision to send
+      # and the record of each email handed to the mail provider. A separate
+      # capability from `NEWSLETTER` so a chapter that only takes signups
+      # declares nothing more; rust/host serves the send route only when a
+      # chapter declares this one as well.
+      NEWSLETTER_ISSUES = "newsletter_issues".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 => {
+        AUTHORIZATION     => {
           # every assignment an actor holds, current or historical
           assignments: :query,
           # the command that grants an actor a role
@@ -42,7 +57,7 @@ module Hecks
           # every grant of one role acting as another
           transitions: :query
         }.freeze,
-        MEMBERSHIP    => {
+        MEMBERSHIP        => {
           # recognize a person who may eventually sign in
           admit:  :command,
           # grant an admitted person a role (the access-grant half)
@@ -50,7 +65,7 @@ module Hecks
           # every admitted person, for the admin listing
           people: :query
         }.freeze,
-        IDENTITY      => {
+        IDENTITY          => {
           # mint a stable identity, independent of how it authenticated
           register: :command,
           # associate an (issuer, subject) pair with that identity
@@ -58,7 +73,7 @@ module Hecks
           # look up the identity an authenticated pair resolves to
           resolve:  :query
         }.freeze,
-        NEWSLETTER    => {
+        NEWSLETTER        => {
           # a guest signs up; the aggregate it names is the subscriber
           subscribe:   :command,
           # attach a display name to an existing subscriber
@@ -67,6 +82,21 @@ module Hecks
           confirm:     :command,
           # a subscriber leaves from the emailed link
           unsubscribe: :command
+        }.freeze,
+        NEWSLETTER_ISSUES => {
+          # mark an issue sent; the issue aggregate is the one it names
+          send_issue:      :command,
+          # record one email handed to the mail provider; the delivery
+          # aggregate is the one it names
+          record_delivery: :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,15 @@ 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: "provides",        context: "Bluebook", at: "",  named: "send_issue",      kind: "text", required: "false", fills: "provides"
+      member keyword: "provides",        context: "Bluebook", at: "",  named: "record_delivery", 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,60 @@ module Hecks
         }
       end
 
+      # Which chapter answers sending a newsletter issue
+      # (`Registry#newsletter_issues_provider_for`), with its declared verbs
+      # qualified and the issue and delivery aggregates named off them.
+      # rust/host's send route reads this instead of naming
+      # Newsletter::Issue.Send and Newsletter::Delivery.Record. `{}` when
+      # nothing this domain attaches provides newsletter_issues.
+      # @param registry [Runtime::Registry] the booted registry `domain_name` is loaded in
+      # @param domain_name [String] the domain to export the issue-sending binding for
+      # @return [Hash{Symbol => String, nil}] `:provider` (name), `:send_issue`,
+      #   `:record_delivery` (qualified verbs), `:issue_aggregate` and `:delivery_aggregate`
+      #   (each verb's own leading qualified aggregate name); `{}` if nothing this domain
+      #   attaches provides newsletter_issues
+      def newsletter_issues(registry, domain_name)
+        provider = registry.newsletter_issues_provider_for(domain_name)
+        return {} unless provider
+
+        capability = Bluebook::Capabilities::NEWSLETTER_ISSUES
+        send_issue = provider.provided_verb(capability, :send_issue)
+        record_delivery = provider.provided_verb(capability, :record_delivery)
+        {
+          provider:           provider.name,
+          send_issue:         send_issue,
+          record_delivery:    record_delivery,
+          issue_aggregate:    send_issue&.split(".")&.first,
+          delivery_aggregate: record_delivery&.split(".")&.first
+        }
+      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,31 @@ module Hecks
         vendored_provider_for(domain, Bluebook::Capabilities::NEWSLETTER)
       end
 
+      # The chapter that answers sending a newsletter issue for `domain` —
+      # resolved the same way as `newsletter_provider_for`, by what it
+      # declares (`provides "newsletter_issues"`). Nil when none does.
+      #
+      # @param domain [String, Symbol] the domain whose issue-sending chapter is being resolved
+      # @return [Bluebook::Chapter, nil] the chapter that answers `domain`'s issue sending,
+      #   or nil if none does
+      def newsletter_issues_provider_for(domain)
+        vendored_provider_for(domain, Bluebook::Capabilities::NEWSLETTER_ISSUES)
+      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.3.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.3.0
 platform: ruby
 authors:
 - Chris Young