openreceive-rails 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2630ff34c45af80ce708fcb7699b0e85d05dc7f7d0eae576167ebb0f4b14b10
-  data.tar.gz: 872cbe866154f015e63610472334019bafb88a76e26d061cf8e3ee6bf4788575
+  metadata.gz: 146123aec012ee584a8b76fd2a0377abb9e972fafd56f5332e67deee15fc7ad3
+  data.tar.gz: d38a035c403bffa06b058ed1030a7bb55170cce1e9853c26d8ff71d4698ec6be
 SHA512:
-  metadata.gz: 352d5656c3be6653facb48e78e26412e787e7b8a2dbbc21154347f1d203753c1ee9e7b5aaa6dc1a265f532e5f6610476eebf1d3b88cd4f388449e3cdf7d3541e
-  data.tar.gz: a5103807910d7b6153fa6124875d189842c9399dc713c2f696ecc823c0964b86e5a8d43bb73d1d395056100820edc467bb2e33339d2b9e24688302bee128c6d1
+  metadata.gz: 4703f944a363b826d607c7e63a3e918fb76465e5e260f54bc59a00e2e84b316ebdfd5909a91943a1bf3e7ce92051216b0c7f35b61a2e6b17a66cf20b81f3e92a
+  data.tar.gz: 9b13db6baea87e02685030ef09ec88f741c3bd18b13b30a54189d43e2c3ecb9ba2b7e656c93b1aff2c80bd321d99bd96aebfc99eae0046b8ab0873e914fa0126

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## 0.3.0 - 2026-08-26
+
+### `config.amount_for` may return a `:description` beside the price
+
+One optional display string — what the payer is buying — returned from the same
+hook that already answers the price:
+
+```ruby
+config.amount_for = lambda do |reference|
+  order = Order.find_by(reference: reference)
+  next nil unless order
+  { currency: "USD", value: order.total.to_s, description: "#{order.line_items.size} items" }
+end
+```
+
+The engine peels it off before the amount reaches the minting service, and the
+handler echoes it on the prepare and create responses, where both shipped
+checkout renderers draw it above the amount. Deliberately one string and not a
+line-item schema: OpenReceive owns no orders. The install generator's
+initializer documents it inline.
+
+The full release narrative lives in the repository-root
+[CHANGELOG](https://github.com/openreceive/openreceive/blob/master/CHANGELOG.md).
+
+## 0.2.4 - 2026-08-26
+
+No Ruby changes in this release. 0.2.4 is browser-side only —
+`@openreceive/browser`, `@openreceive/elements`, `@openreceive/react` and
+`@openreceive/provider-data`. This gem is byte-identical to 0.2.3 and ships to
+keep the one-version-for-everything rule, so the engine, the HTTP contract and
+the settlement path are unchanged. The full release narrative lives in the
+repository-root
+[CHANGELOG](https://github.com/openreceive/openreceive/blob/master/CHANGELOG.md).
+
+## 0.2.3 - 2026-08-25
+
+The Ruby gems release in lockstep with the npm workspace version. The full
+release narrative lives in the repository-root
+[CHANGELOG](https://github.com/openreceive/openreceive/blob/master/CHANGELOG.md);
+entries here are scoped to this gem.
+
+- The mounted engine inherits `openreceive-server`'s `POST /checkouts` change:
+  the response now carries `payment_methods` alongside `checkout` (HTTP
+  contract 0.4.1). No configuration change; hosts using `@openreceive/browser`
+  see no difference.
+
 ## 0.2.2 - 2026-08-25
 
 The Ruby gems release in lockstep with the npm workspace version. The full

data/lib/generators/openreceive/install/templates/initializer.rb

@@ -40,10 +40,17 @@ OpenReceive.configure do |config|
   # { sats: 1200 }, or nil when there is nothing to pay for (a 404). The
   # engine refuses to serve checkouts until this is set.
   #
+  # An optional :description beside the price is what the payer is BUYING, in
+  # your own words — one display string the checkout renders above the amount.
+  # Without it the payer sees a QR and a number and no sign of what the number
+  # is for; OpenReceive owns no line items, so this is the whole of what it can
+  # show on its own.
+  #
   # TODO(price): look the reference up in your own application, e.g.
   # config.amount_for = lambda do |reference|
   #   order = Order.find_by(id: reference)
-  #   order && { currency: "USD", value: order.total.to_s }
+  #   order && { currency: "USD", value: order.total.to_s,
+  #              description: "#{order.line_items.size} items" }
   # end
 
   # Runs inside the settlement transaction, only for the order's first settled

data/lib/openreceive/configuration.rb

@@ -264,9 +264,16 @@ module OpenReceive
     def engine_resolve_checkout
       lambda do |action:, request:, reference:, input:, pay_in_asset: nil|
         pricing = %w[checkout.prepare swap.quote checkout.create swap.create].include?(action)
-        amount = pricing ? @amount_for.call(reference) : nil
-        raise OpenReceive::Server::NotFoundError, "Unknown reference." if pricing && amount.nil?
-        next({ amount: amount }) if %w[checkout.prepare swap.quote].include?(action)
+        price = pricing ? @amount_for.call(reference) : nil
+        raise OpenReceive::Server::NotFoundError, "Unknown reference." if pricing && price.nil?
+        # `description` — what the payer is buying, in the host's own words — is
+        # returned beside the price and peeled off here, so the amount handed to
+        # the minting service stays exactly the price.
+        amount = price_only(price)
+        description = price_description(price)
+        if %w[checkout.prepare swap.quote].include?(action)
+          next({ amount: amount, description: description }.compact)
+        end
 
         requested_hash = input["payment_hash"] || input[:payment_hash]
         begin
@@ -285,6 +292,7 @@ module OpenReceive
 
         {
           amount: amount,
+          description: description,
           payment_hash: payment&.payment_hash,
           checkout: payment&.checkout_data,
           swap_data: payment&.swap_data
@@ -292,6 +300,25 @@ module OpenReceive
       end
     end
 
+    # The price alone. A host that returns a display string beside it must not
+    # have that string reach the amount resolver.
+    def price_only(price)
+      return price unless price.is_a?(Hash)
+
+      price.reject { |key, _| key.to_s == "description" }
+    end
+
+    # One optional display string, blank treated as absent.
+    def price_description(price)
+      return nil unless price.is_a?(Hash)
+
+      value = price[:description] || price["description"]
+      return nil unless value.is_a?(String)
+
+      trimmed = value.strip
+      trimmed.empty? ? nil : trimmed
+    end
+
     def engine_on_checkout_created
       lambda do |reference:, payment_hash:, checkout:, swap_data: nil, client_ip: nil, **|
         begin

data/lib/openreceive/rails/version.rb

@@ -5,6 +5,6 @@ module OpenReceive
   # top-level `::Rails` framework constant — engine code always references the framework as
   # `::Rails` to avoid shadowing.
   module Rails
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openreceive-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenReceive
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: openreceive-server
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement