kiosk-pay-stripe 0.5.20

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fec149e6c2424f7f54664ab1f78b58e0a6637c86157b132f86c11632f26043c7
+  data.tar.gz: 2b8e667195f02a284129d8a03fafc4bf72d75229a7cc979092c8138f98fe4691
+SHA512:
+  metadata.gz: c346ef027f8940c50a8141513e2ba18b5d88503083ba066fd5aa18c7d8e5e90b31c4def78ef94fe7c5df42bf8000c23ec9bf19a4edf80d93dff0f888a33eedb0
+  data.tar.gz: 2c362b0f9605864b32fb1a0a89a359f003b5340e478f8c3d7743208f6ff046fb4aaf9fa68ef096a96ea4ee3b645be09abbbdc40c47ee3788403489e041401a27

data/CHANGELOG.md

@@ -0,0 +1,126 @@
+# Changelog
+
+How to write an entry, and what a release section means: `CHANGELOG-RULE.md` at
+the root of this repository —
+<https://github.com/kiosk-hq/kiosk/blob/main/CHANGELOG-RULE.md>. In short: under
+200 characters, one or two sentences, the essence rather than the content; write it
+under `## [Unreleased]`; a cut renames that heading to
+`## [MAJOR.MINOR.PATCH] — <date>` and opens a fresh empty one above it; nothing
+already written is edited.
+
+## [Unreleased]
+
+## [0.5.20] — 2026-10-20
+
+- 2026-10-20: Version 0.5.20, the tree cut that matches skill 0.5.20.
+
+## [0.5.19] — 2026-10-20
+
+- 2026-10-20: Version 0.5.19, the tree cut that matches skill 0.5.19.
+
+## [0.5.18] — 2026-10-18
+
+- 2026-10-18: Version 0.5.18, the tree cut that matches skill 0.5.18.
+
+## [0.5.17] — 2026-10-18
+
+- 2026-10-18: kiosk-pay-stripe keys a capture by the Stripe customer and the cart mandate id, so the carts of two customers cannot share an idempotency key.
+- 2026-10-18: `refund` takes `key:`, which names the refund among the refunds of its charge; kiosk-pay-stripe keys the Stripe request by the charge and that key.
+- 2026-10-18: `PaymentFailed` takes no `reason:`; the engine reads only its message and `retryable?`.
+
+## [0.5.16] — 2026-10-18
+
+- 2026-10-18: Each adapter has its own Stripe client; `api_base:` names another API URL, e.g. stripe-mock. The adapter no longer sets `Stripe.api_key`.
+- 2026-10-18: A saved-card check is one Stripe call: the newest card on the Customer. A `pay` makes three calls, not five.
+
+## [0.5.15] — 2026-10-18
+
+- 2026-10-18: `bin/rails g kiosk:pay_stripe:install` writes the `stripe_customers` migration with its DDL in the file. `CustomerRecord.create_table` is removed.
+
+## [0.5.14] — 2026-10-18
+
+- 2026-10-18: Version 0.5.14, the tree cut that matches skill 0.5.14.
+
+- 2026-10-17: **`test_autocard:` and `attach_test_card` are removed**; a suite saves a card through `payment_setup`, as production does.
+
+- 2026-10-17: `Stripe::ChargeLookup` is removed; nothing an operator runs used it.
+
+## [0.5.13] — 2026-10-11
+
+- 2026-10-11: Version 0.5.13, the tree cut that matches skill 0.5.13.
+
+- 2026-10-09: **`Stripe.new` requires `api_key:`**; the adapter no longer falls back to `STRIPE_SECRET_KEY`.
+
+## [0.5.12] — 2026-10-08
+
+- 2026-10-08: Version 0.5.12, the tree cut that matches skill 0.5.12; this gem's surface is unchanged.
+
+## [0.5.11] — 2026-10-08
+
+- 2026-10-08: Version 0.5.11, the tree cut that matches skill 0.5.11; this gem's surface is unchanged.
+
+## [0.5.10] — 2026-10-08
+
+- 2026-10-08: Version 0.5.10, the tree cut that matches skill 0.5.10 and carries the entries below.
+
+- 2026-10-08: A capture settles only a `succeeded` card PaymentIntent, at what it received; any other status is refused as a decline or an unknown outcome.
+- 2026-10-08: A capture settles the confirmed intent's amount, the cart total the spec requires, rather than `amount_received`.
+- 2026-10-08: `CustomerRecord` keeps the principal→Customer mapping in a `stripe_customers` table and is the adapter's default, so an operator writes no mapping of its own.
+- 2026-10-08: `refund` reverses a capture by its PaymentIntent, so an operator can give the money back to the card it came from.
+- 2026-10-08: `Stripe::ChargeLookup` answers whether a cart mandate was charged, by the metadata the adapter stamps, for reconciling a capture the operator cannot account for.
+
+## [0.5.9] — 2026-10-08
+
+- 2026-10-08: Version 0.5.9, the tree cut that matches skill 0.5.9; this gem's surface is unchanged.
+
+## [0.5.8] — 2026-10-07
+
+- 2026-10-07: Version 0.5.8, the tree cut that matches skill 0.5.8; this gem's surface is unchanged.
+
+## [0.5.7] — 2026-10-07
+
+- 2026-10-07: Version 0.5.7, the tree cut that matches skill 0.5.7; this gem's surface is unchanged.
+
+## [0.5.6] — 2026-10-07
+
+- 2026-10-07: Version 0.5.6, the tree cut that matches skill 0.5.6; this gem's surface is unchanged.
+
+## [0.5.5] — 2026-10-07
+
+- 2026-10-07: Version 0.5.5, the tree cut that matches skill 0.5.5.
+
+- 2026-10-07: **`customer_resolver:` and `customer_saver:` are required**; the mode that charged a presented or `test_payment_method` card without them is gone (K-1994).
+- 2026-10-07: **A mapped Customer that Stripe no longer has counts as no saved card**; `setup_url` saves a fresh one through `customer_saver`, which now replaces the mapping (K-1993).
+## [0.5.4] — 2026-10-07
+
+- 2026-10-07: **`setup_url` takes the engine's `return_url`, and `setup_return_user_id` names whose human came back**, so the return page is kiosk-server's; the `return_url:` option is gone (T-219).
+
+## [0.5.3] — 2026-10-06
+
+- 2026-10-06: Version 0.5.3, the tree cut that matches skill 0.5.3; this gem's surface is unchanged.
+
+## [0.5.2] — 2026-10-06
+
+- 2026-10-05: **A `return_url:` path is joined to the origin being served**, so on a deployment serving several origins the human returns to the one they came from.
+
+- 2026-10-05: **The derived return URL names the origin being served** (`Kiosk.current_issuer`), not only the default issuer.
+
+## [0.5.0] — 2026-09-26
+- **The rubygems blurb stopped forecasting PSP adapters that do not exist (K-1673).** It names the base class a host subclasses instead.
+- **The rubygems blurb credited this gem's charging to a `kiosk-core` method that only raises (K-1688).** It names this adapter's own `#capture` now.
+- **`return_url:` — the keyword whose absence raises — is documented, and three stale or inverted comments are gone (K-1690, K-1691, K-1692).**
+- The two operator log lines that report a degraded `setup_url` now end in the
+  condition itself rather than in an internal tracker id nobody outside this
+  project can look up.
+- A failed lookup for the outstanding setup session is now logged instead of
+  passing for "there is none": the adapter still degrades to minting a fresh
+  session so the readiness probe keeps answering, but it says so, because the
+  degrade is otherwise byte-for-byte identical to the stable-url happy path.
+- `setup_url` is now stable across calls (K-492): it reuses the `mode:setup`
+  Checkout Session already outstanding for the customer instead of creating a
+  new one per call, so a host polling card-setup readiness keeps handing its
+  human the same link.
+- Initial Stripe PSP adapter (test mode): SetupIntent card-on-file with
+  off_session capture (`customer_resolver`/`customer_saver`, `setup_url`,
+  `setup_required?`, `saved_method?`), plus a `pm_card_visa` back-compat
+  fallback and a `test_autocard`/`attach_test_card` path for automated suites.

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,95 @@
+# kiosk-pay-stripe
+
+Stripe PSP adapter for [Kiosk](https://kiosk.tech). Implements
+`Kiosk::PaymentProviders::Base` over Stripe PaymentIntents.
+
+## Install
+
+> **Not on RubyGems yet** — so every `gem` line below carries `github: "kiosk-hq/kiosk"`, which is what makes it copy-pasteable today. Publication status and the canonical install are stated once, in the monorepo README's [Install](https://github.com/kiosk-hq/kiosk#install) section.
+
+There is no default PSP — `Kiosk::Configuration#payment_provider` starts `nil`
+— and neither `kiosk-server` nor `kiosk-all` pulls an adapter in, so taking
+payments means adding this one yourself:
+
+```ruby
+gem "kiosk-pay-stripe", github: "kiosk-hq/kiosk"
+```
+
+Bundler brings the three runtime dependencies with it: `activerecord`,
+`kiosk-core` and Stripe's own `stripe` gem. In a Rails app `Bundler.require`
+loads the adapter. The adapter does nothing until you assign it to
+`payment_provider`, as the block below shows.
+
+You also need a secret key for the **provider's own** Stripe account
+(`sk_test_…` for the PoC; test mode only, see below). The buyer's card is
+saved on that account, so there is no Kiosk-side Stripe account to configure.
+
+## Model: card-on-file + off_session (SetupIntent)
+
+The headline flow saves the buyer's card ONCE on the *provider's* Stripe
+account as a Customer + PaymentMethod (keyed to the synthetic principal /
+`user_id`). Subsequent purchases are charged `off_session`
+(merchant-initiated) against that saved card — the assistant authorizes,
+never presents a card.
+
+The `principal → Stripe Customer` mapping lives in the host's `stripe_customers`
+table, through `Kiosk::PaymentProviders::Stripe::CustomerRecord`. The install
+generator writes the migration that creates this table. Give it the same
+`--user-id-type` that you gave `kiosk:install`:
+
+```sh
+bin/rails generate kiosk:pay_stripe:install --user-id-type=uuid
+bin/rails db:migrate
+```
+
+```ruby
+require "kiosk/payment_providers/stripe"
+
+Kiosk.configure do |c|
+  c.payment_provider = Kiosk::PaymentProviders::Stripe.new(
+    api_key: ENV["STRIPE_SECRET_KEY"], # sk_test_… for the PoC
+  )
+end
+```
+
+An app that already keeps the mapping elsewhere passes `customer_resolver:
+->(user_id) { … }` and `customer_saver: ->(user_id, cus_id) { … }` instead.
+
+The saver replaces any earlier mapping for the principal: when Stripe no
+longer has the mapped Customer (deleted, or from another account), the adapter
+treats the principal as having no saved card and saves a fresh Customer.
+
+Card-setup handshake (see the Payment section of the spec):
+
+- `setup_required?(user_id:)` — true when the principal must set up a card
+  before a charge can proceed.
+- `setup_url(user_id:, return_url:)` — hosted Stripe Checkout URL (`mode: "setup"`). The
+  human opens it in a browser (NOT the chat) to enter their card on Stripe's
+  hosted page; Stripe then redirects them to kiosk-server's
+  `<mount>/payment_setup/return` page, which kiosk-server passes as `return_url`. The gem
+  never sees card data. **Stable across polls:** an already-outstanding
+  (`status: open`, same `return_url`) setup session is reused, so an assistant
+  polling readiness keeps handing its human the SAME link instead of a fresh
+  one per poll. One exception, and it is logged rather than hidden: if the
+  lookup itself errors, the adapter cannot tell "no outstanding session" from
+  "did not find out", so it mints a fresh session (the probe keeps answering)
+  and warns that the url is not stable until that clears.
+- `setup_return_user_id(params)` — the principal whose Checkout Session the
+  return page's `session_id` names, asked of Stripe; kiosk-server then pushes the
+  `payment_setup` event once `setup_required?` answers false.
+- `saved_method?(user_id:)` — true once the resolved Customer has a usable
+  saved card.
+- `refund(psp_reference:, amount_cents:, key:)` — reverses a capture by its
+  PaymentIntent, back to the card it came from; answers the `re_…` reference.
+  The Stripe request is keyed by the charge and `key`, so each refund of one
+  charge is its own, and a retry with the same key refunds once.
+
+Test mode only for the PoC (`sk_test_…`).
+
+### Test mode
+
+Automated suites point the Stripe SDK at `stripe-mock`
+(`Kiosk::TestHelpers::StripeMock` in `kiosk-test-support`) and take the same
+path as production: the assistant calls `payment_setup`, which creates and maps
+the Customer. stripe-mock lists a saved card for every Customer, so a later
+`pay` charges it.

data/lib/generators/kiosk/pay_stripe/install/install_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Kiosk
+  module PayStripe
+    module Generators
+      # `bin/rails g kiosk:pay_stripe:install`: writes the migration that creates
+      # the `stripe_customers` table, with its DDL written into the file.
+      # {Kiosk::PaymentProviders::Stripe::CustomerRecord} reads and writes that table.
+      class InstallGenerator < ::Rails::Generators::Base
+        include ::Rails::Generators::Migration
+
+        source_root File.expand_path('templates', __dir__)
+
+        desc 'Generate the migration for the stripe_customers table of kiosk-pay-stripe.'
+
+        class_option :user_id_type, type: :string, default: 'uuid', enum: %w[uuid bigint integer text],
+                                    desc: 'User-id column type: give the same type as to kiosk:install'
+
+        def self.next_migration_number(dirname) = ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+
+        def create_stripe_customers_migration
+          migration_template 'create_kiosk_pay_stripe_customers.rb.tt',
+                             'db/migrate/create_kiosk_pay_stripe_customers.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/kiosk/pay_stripe/install/templates/create_kiosk_pay_stripe_customers.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# The principal → Stripe Customer mapping kiosk-pay-stripe reads and writes.
+class CreateKioskPayStripeCustomers < ActiveRecord::Migration[ActiveRecord::Migration.current_version]
+  def change
+    create_table :stripe_customers do |t|
+      t.column :user_id, :<%= options[:user_id_type] %>, null: false
+      t.string :customer_id, null: false
+      t.timestamps
+    end
+    add_index :stripe_customers, :user_id, unique: true
+  end
+end

data/lib/kiosk/payment_providers/stripe/application_record.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Kiosk
+  module PaymentProviders
+    class Stripe < Base
+      # The base of the adapter's models.
+      class ApplicationRecord < ::ActiveRecord::Base
+        self.abstract_class = true
+      end
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe/charges.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Kiosk
+  module PaymentProviders
+    class Stripe < Base
+      # Creates the off_session PaymentIntent and maps its outcome to PaymentFailed.
+      module Charges
+        private
+
+        def charge(cart_mandate, customer_id, payment_method)
+          @stripe.payment_intents.create(
+            intent_params(cart_mandate, customer_id, payment_method),
+            { idempotency_key: "#{customer_id}-#{cart_mandate.id}-capture" }
+          )
+        rescue ::Stripe::CardError => e
+          # A definitive decline: nothing was charged, so a retry is safe.
+          raise PaymentFailed.new(card_decline_message(e), retryable: true)
+        rescue ::Stripe::StripeError
+          # The outcome is unknown: a blind retry could double-charge.
+          raise unknown_outcome('could not confirm the charge')
+        end
+
+        def intent_params(cart_mandate, customer_id, payment_method)
+          {
+            amount: cart_mandate.total_amount_cents,
+            currency: cart_mandate.currency,
+            customer: customer_id,
+            payment_method: payment_method,
+            payment_method_types: ['card'],
+            off_session: true,
+            confirm: true,
+            metadata: { cart_mandate_id: cart_mandate.id }
+          }
+        end
+
+        def ensure_paid!(intent)
+          return if intent.status == PAID
+
+          raise PaymentFailed.new('the payment method was declined', retryable: true) if
+            NOT_CHARGED.include?(intent.status)
+
+          raise unknown_outcome('has not completed the charge')
+        end
+
+        def unknown_outcome(what)
+          PaymentFailed.new("the payment processor #{what}; its status is unknown", retryable: false)
+        end
+
+        # Keyed on Stripe's stable error code: Stripe's own message can carry request ids.
+        def card_decline_message(error)
+          case error.respond_to?(:code) ? error.code : nil
+          when 'expired_card'            then 'the payment method has expired'
+          when 'insufficient_funds'      then 'the payment method has insufficient funds'
+          when 'authentication_required' then 'the payment method needs authentication an off-session charge cannot complete'
+          else 'the payment method was declined'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe/customer_record.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'kiosk/payment_providers/stripe/application_record'
+
+module Kiosk
+  module PaymentProviders
+    class Stripe < Base
+      # The principal → Stripe Customer mapping, one row per principal, in the
+      # host's `stripe_customers` table (`bin/rails g kiosk:pay_stripe:install`).
+      # The adapter's default resolver and saver.
+      class CustomerRecord < ApplicationRecord
+        self.table_name = 'stripe_customers'
+
+        def self.resolve(user_id) = find_by(user_id: user_id)&.customer_id
+
+        def self.save(user_id, customer_id)
+          find_or_initialize_by(user_id: user_id).update!(customer_id: customer_id)
+        end
+      end
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe/customers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kiosk
+  module PaymentProviders
+    class Stripe < Base
+      # Maps a principal to its Stripe Customer and the Customer's saved card.
+      module Customers
+        private
+
+        def ensure_customer(user_id)
+          existing = live_customer(user_id)
+          return existing.id if existing
+
+          cus = @stripe.customers.create({ name: "principal-#{user_id}" })
+          @customer_saver.call(user_id, cus.id)
+          cus.id
+        end
+
+        # nil when none is mapped or Stripe no longer has the mapped one.
+        def live_customer(user_id)
+          cus_id = @customer_resolver.call(user_id)
+          return nil unless cus_id
+
+          customer = @stripe.customers.retrieve(cus_id)
+          customer unless customer.respond_to?(:deleted) && customer.deleted
+        rescue ::Stripe::InvalidRequestError => e
+          raise unless e.code == 'resource_missing'
+        end
+
+        # `[customer_id, card_id]` for the newest card on the mapped Customer, or
+        # nil. One Stripe call: a deleted Customer keeps no card, and a Customer
+        # Stripe does not know is no card.
+        def saved_card(user_id)
+          cus_id = @customer_resolver.call(user_id)
+          return nil unless cus_id
+
+          card = @stripe.payment_methods.list(customer: cus_id, type: 'card', limit: 1).data.first
+          [cus_id, card.id] if card
+        rescue ::Stripe::InvalidRequestError => e
+          raise unless e.code == 'resource_missing'
+        end
+      end
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe/setup_sessions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Kiosk
+  module PaymentProviders
+    class Stripe < Base
+      # Finds an open setup Checkout Session that `setup_url` can hand out again.
+      module SetupSessions
+        private
+
+        def outstanding_setup_session(cus_id, success_url:)
+          open_sessions = Array(
+            @stripe.checkout.sessions.list(customer: cus_id, status: 'open', limit: SETUP_SESSION_LIST_LIMIT)&.data
+          )
+          match = open_sessions.find { |s| reusable_session?(s, success_url) }
+          warn_full_page(open_sessions.size) if match.nil? && open_sessions.size >= SETUP_SESSION_LIST_LIMIT
+          match
+        rescue ::Stripe::StripeError => e
+          log_warning("could not list open setup sessions (#{e.class}: #{e.message}); minting a " \
+                      'fresh one, so setup_url changes between polls until this clears')
+          nil
+        end
+
+        def reusable_session?(session, success_url)
+          field(session, :mode) == 'setup' &&
+            field(session, :success_url) == success_url &&
+            !field(session, :url).to_s.empty?
+        end
+
+        def warn_full_page(size)
+          log_warning("no reusable setup session among a full page of #{size} open " \
+                      'Checkout Sessions; minting a fresh one, so setup_url may change between polls')
+        end
+
+        def log_warning(text)
+          message = "[kiosk-pay-stripe] #{text}"
+          logger = ::Rails.logger if defined?(::Rails) && ::Rails.respond_to?(:logger)
+          logger ? logger.warn(message) : warn(message)
+        end
+
+        # The SDK's StripeObject raises NoMethodError for fields the API omitted.
+        def field(obj, name)
+          obj.respond_to?(name) ? obj.public_send(name) : nil
+        end
+      end
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kiosk
+  module PaymentProviders
+    module StripeVersion
+      VERSION = '0.5.20'
+    end
+  end
+end

data/lib/kiosk/payment_providers/stripe.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'kiosk'
+require 'kiosk/payment_providers/stripe/version'
+require 'kiosk/payment_providers/stripe/charges'
+require 'kiosk/payment_providers/stripe/customers'
+require 'kiosk/payment_providers/stripe/setup_sessions'
+
+module Kiosk
+  module PaymentProviders
+    # Stripe PSP adapter: the human saves a card once on the operator's Stripe
+    # account, and purchases are charged `off_session`.
+    # Always reference the SDK as `::Stripe` — bare `Stripe` is this class.
+    class Stripe < Base
+      include Charges
+      include Customers
+      include SetupSessions
+
+      VERSION = StripeVersion::VERSION
+
+      # Open Checkout Sessions the reuse lookup asks for. A full page with no
+      # match is logged: the reusable session may have been truncated away.
+      SETUP_SESSION_LIST_LIMIT = 10
+
+      # Stripe substitutes the session id on the redirect.
+      RETURN_QUERY = 'session_id={CHECKOUT_SESSION_ID}'
+
+      PAID        = 'succeeded'
+      # Terminal PaymentIntent states in which no money moved.
+      NOT_CHARGED = %w[canceled requires_payment_method].freeze
+
+      # @param customer_resolver [#call] `(user_id) -> customer_id | nil`; {CustomerRecord.resolve} when omitted
+      # @param customer_saver [#call] `(user_id, customer_id)`; {CustomerRecord.save} when omitted
+      # @param api_base [String, nil] the Stripe API URL, e.g. a local stripe-mock; Stripe's own when nil
+      def initialize(api_key:, customer_resolver: nil, customer_saver: nil, api_base: nil)
+        super()
+        @customer_resolver = customer_resolver || customer_record_method(:resolve)
+        @customer_saver    = customer_saver || customer_record_method(:save)
+        require 'stripe'
+        # This adapter's own client: the key and the URL are not process-global.
+        @stripe = ::Stripe::StripeClient.new(api_key, api_base:).v1
+      end
+
+      # A hosted Checkout page in `mode: "setup"`. An open setup session for the
+      # same return target is reused, so an assistant polling `payment_setup`
+      # keeps handing its human the same link. The SetupIntent the page creates
+      # takes Stripe's default `usage`, `off_session`, so `pay` can charge the card.
+      def setup_url(user_id:, return_url:)
+        success_url = "#{return_url}?#{RETURN_QUERY}"
+        cus_id      = ensure_customer(user_id)
+
+        outstanding_setup_session(cus_id, success_url: success_url)&.url ||
+          @stripe.checkout.sessions.create(
+            mode: 'setup',
+            customer: cus_id,
+            client_reference_id: user_id,
+            payment_method_types: ['card'],
+            success_url: success_url
+          ).url
+      end
+
+      # The principal the returning browser's Checkout Session was minted for.
+      def setup_return_user_id(params)
+        session_id = params['session_id'].to_s
+        return nil if session_id.empty?
+
+        @stripe.checkout.sessions.retrieve(session_id).client_reference_id
+      end
+
+      def setup_required?(user_id:) = !saved_method?(user_id: user_id)
+
+      def saved_method?(user_id:) = !saved_card(user_id).nil?
+
+      # Charges the principal's saved card off_session; the mandate's payment method is not used.
+      def capture(cart_mandate, **)
+        customer_id, payment_method = saved_card(cart_mandate.user_id)
+        raise SetupRequired unless payment_method
+
+        intent = charge(cart_mandate, customer_id, payment_method)
+        ensure_paid!(intent)
+        {
+          psp_reference: intent.id,
+          settled_amount_cents: intent.amount_received,
+          settled_at: Time.at(intent.created).utc
+        }
+      end
+
+      def refund(psp_reference:, amount_cents:, key:)
+        refund = @stripe.refunds.create(
+          { payment_intent: psp_reference, amount: amount_cents },
+          { idempotency_key: "#{psp_reference}-refund-#{key}" }
+        )
+        { psp_reference: refund.id, refunded_psp_reference: psp_reference,
+          refunded_amount_cents: amount_cents, refunded_at: Time.at(refund.created).utc }
+      rescue ::Stripe::StripeError
+        raise PaymentFailed, 'the payment processor did not refund the charge'
+      end
+
+      private
+
+      def customer_record_method(name)
+        require 'kiosk/payment_providers/stripe/customer_record'
+        CustomerRecord.method(name)
+      end
+    end
+  end
+end

data/lib/kiosk-pay-stripe.rb

@@ -0,0 +1,6 @@
+# rubocop:disable Naming/FileName -- Bundler.require loads the file named after the gem.
+# frozen_string_literal: true
+
+# Convenience entry — `require "kiosk-pay-stripe"` mirrors the gem name.
+require 'kiosk/payment_providers/stripe'
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: kiosk-pay-stripe
+version: !ruby/object:Gem::Version
+  version: 0.5.20
+platform: ruby
+authors:
+- Phil Pirozhkov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: kiosk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '19'
+description: |
+  kiosk-pay-stripe is the open-source Stripe payment adapter for Kiosk. It
+  implements both halves of the provider-acquired, card-on-file model:
+
+    - Card acquisition. `setup_url(user_id:, return_url:)` returns a hosted Stripe
+      Checkout session in `mode: "setup"` that saves the buyer's card on the
+      PROVIDER's own Stripe account (an existing open setup session is
+      reused, so the url is stable across polls); `setup_required?` tells the
+      wire whether a principal still has to complete it, backed by
+      `saved_method?`, which asks Stripe whether the resolved Customer has a
+      usable card.
+    - Charging. This adapter's own `#capture` settles an AP2 cart
+      mandate as an `off_session` (merchant-initiated) PaymentIntent against
+      that saved card — the assistant authorizes the cart, it never presents
+      a card.
+
+  The gem stays app-agnostic: the principal-to-Stripe-Customer mapping is
+  injected by the host through `customer_resolver:` / `customer_saver:`
+  callables, and no application table is read inside the gem.
+
+  Today only kiosk-pay-stripe ships; there is no default PSP
+  (Configuration#payment_provider is nil). A host that needs another PSP
+  subclasses Kiosk::PaymentProviders::Base and assigns the instance to
+  Kiosk.configuration.payment_provider.
+email:
+- hello@fili.pp.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/generators/kiosk/pay_stripe/install/install_generator.rb
+- lib/generators/kiosk/pay_stripe/install/templates/create_kiosk_pay_stripe_customers.rb.tt
+- lib/kiosk-pay-stripe.rb
+- lib/kiosk/payment_providers/stripe.rb
+- lib/kiosk/payment_providers/stripe/application_record.rb
+- lib/kiosk/payment_providers/stripe/charges.rb
+- lib/kiosk/payment_providers/stripe/customer_record.rb
+- lib/kiosk/payment_providers/stripe/customers.rb
+- lib/kiosk/payment_providers/stripe/setup_sessions.rb
+- lib/kiosk/payment_providers/stripe/version.rb
+homepage: https://kiosk.tech
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://kiosk.tech
+  source_code_uri: https://github.com/kiosk-hq/kiosk
+  changelog_uri: https://github.com/kiosk-hq/kiosk/blob/main/kiosk-pay-stripe/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kiosk-hq/kiosk/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Stripe PSP adapter for the Kiosk framework
+test_files: []