lavenda-pay-ruby 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574e87e7c3cdf2f4a985cc4269a4691d929153f6e515e304411595b061e94a7a
-  data.tar.gz: 4cd0279828335208b8a5582c144d9ceb88c5b67ca05f32f66dc842e86d8a1f07
+  metadata.gz: 39b5e1f0ee482056108e319e7c1231913d9cc2c34947b884176ee26214df40dd
+  data.tar.gz: 14d74a9dfec2e429cdc6f7f18099384b2d19162a1c3a0eb992f5d3ac3b7f9dfa
 SHA512:
-  metadata.gz: 23c4df6684ff61b6462c940da2a61c4dbb265ea44bceffa5d7d86e29d4d0b3a4e4689f73b0a22f6496ad7fb072e005285cab609546342e85926329c7551a1cc8
-  data.tar.gz: a266e6e3e0e4b556af750e0650c954a97496c3bf656c42ebf6062f86e7d6a690ef40b929f45a21f0fbef41fca13b41033a896cf65d6d74581762982d730d411f
+  metadata.gz: 4e771c230db541ff2f90b2e1178891a9d4cc341df303e457f8af55a6f80ebc6761a8f3cd9b88385405b0f29b41920c32792bb662daf3b76d73a4b79ec763f4dd
+  data.tar.gz: 2962469cbe01f0bd57645dfb997504f482e678ad7c1b02ba9d44281aaeec63bafc665fde208e218fc2829ae076f5e095d63e2c663936b808afbf518c541e193b

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## 0.1.0
+## 0.0.3
 
-- Initial release: customers, orders and webhook handling extracted from the
-  Catavento and Lavenda Store adapters.
+- Add `LavendaPay::Payments::Confirm` to confirm a pending payment outside production.
+
+## 0.0.2
+
+- Read settings from the `lavenda_pay` Rails credentials when the environment variable is not set.
+- Add `LavendaPay::Url.order_path` to build the public order page link.
+
+## 0.0.1
+
+- Initial release: customers, orders and webhook handling.

data/README.md

@@ -6,25 +6,40 @@ Framework-agnostic (no Rails/ActiveSupport dependency): create customers and ord
 ## Installation
 
 ```ruby
-gem "lavenda-pay-ruby", github: "LaVendaSoftware/pay-ruby"
+gem "lavenda-pay-ruby"
 ```
 
 ## Configuration
 
+Settings are read from `LAVENDA_PAY_*` environment variables and, inside a Rails app, from the `lavenda_pay`
+credentials, so a Rails app needs no initializer:
+
+```yaml
+# bin/rails credentials:edit
+lavenda_pay:
+  base_url: https://pay.example.com
+  api_token: ...
+  webhook_secret: ...
+```
+
+| Setting          | Environment variable         | Credential                     |
+| ---------------- | ---------------------------- | ------------------------------ |
+| `base_url`       | `LAVENDA_PAY_BASE_URL`       | `lavenda_pay.base_url`         |
+| `api_token`      | `LAVENDA_PAY_API_TOKEN`      | `lavenda_pay.api_token`        |
+| `webhook_secret` | `LAVENDA_PAY_WEBHOOK_SECRET` | `lavenda_pay.webhook_secret`   |
+
+`base_url` is the root of the Lavenda Pay installation, without the `/api` suffix. Use the company domain: the API
+accepts any host, but the public order pages are only served on the company's own domain.
+
+Values set explicitly win over both:
+
 ```ruby
-# config/initializers/lavenda_pay.rb
 LavendaPay.configure do |config|
-  config.base_url = ENV.fetch("LAVENDA_PAY_BASE_URL", Rails.application.credentials.dig(:lavenda_pay, :base_url))
-  config.api_token = ENV.fetch("LAVENDA_PAY_API_TOKEN", Rails.application.credentials.dig(:lavenda_pay, :api_token))
-  config.webhook_secret = ENV.fetch("LAVENDA_PAY_WEBHOOK_SECRET", Rails.application.credentials.dig(:lavenda_pay, :webhook_secret))
+  config.base_url = "https://pay.example.com"
+  config.logger = Rails.logger
 end
 ```
 
-`base_url` is the root of the Lavenda Pay installation, without the `/api` suffix.
-
-Outside Rails, set the values directly. Anything left unset falls back to the `LAVENDA_PAY_BASE_URL`,
-`LAVENDA_PAY_API_TOKEN` and `LAVENDA_PAY_WEBHOOK_SECRET` environment variables.
-
 Every operation is a class with `.call` that uses this global configuration. For several accounts, build a client and
 pass it to the operation:
 
@@ -68,6 +83,22 @@ order.pid    # => "order_..."
 order.status # => "draft"
 
 LavendaPay::Orders::Find.call(order.pid)
+
+# Public payment page for the order, built from `base_url`.
+LavendaPay::Url.order_path(order.pid) # => "https://pay.example.com/orders/order_..."
+```
+
+## Payments
+
+Sandbox only: confirm a pending payment as if the customer had paid it, to test your payment flow
+end to end. LavendaPay marks it as paid and, when the gateway supports it, confirms it there too.
+The endpoint does not exist in production, where it raises `LavendaPay::NotFoundError`.
+
+```ruby
+# The payment pid comes from the payment outcome webhooks.
+payment = LavendaPay::Payments::Confirm.call("pay_...")
+payment.status               # => "paid"
+payment.gateway_confirmation # => "confirmed", "failed" or "unsupported"
 ```
 
 ## Errors

data/lib/lavenda_pay/configuration.rb

@@ -14,11 +14,11 @@ module LavendaPay
     end
 
     # Root URL of the Lavenda Pay installation, without the `/api` suffix.
-    def base_url = @base_url || ENV["LAVENDA_PAY_BASE_URL"]
+    def base_url = @base_url || setting(:base_url)
 
-    def api_token = @api_token || ENV["LAVENDA_PAY_API_TOKEN"]
+    def api_token = @api_token || setting(:api_token)
 
-    def webhook_secret = @webhook_secret || ENV["LAVENDA_PAY_WEBHOOK_SECRET"]
+    def webhook_secret = @webhook_secret || setting(:webhook_secret)
 
     def validate!
       raise ConfigurationError, "LavendaPay base_url is not configured (LAVENDA_PAY_BASE_URL)" if blank?(base_url)
@@ -30,5 +30,18 @@ module LavendaPay
     private
 
     def blank?(value) = value.nil? || value.to_s.strip.empty?
+
+    # `LAVENDA_PAY_<KEY>` environment variable, then the `lavenda_pay` Rails
+    # credentials when running inside a Rails app.
+    def setting(key)
+      value = ENV["LAVENDA_PAY_#{key.to_s.upcase}"]
+      blank?(value) ? rails_credential(key) : value
+    end
+
+    def rails_credential(key)
+      return unless defined?(::Rails.application) && ::Rails.application
+
+      ::Rails.application.credentials.dig(:lavenda_pay, key)
+    end
   end
 end

data/lib/lavenda_pay/payments/confirm.rb

@@ -0,0 +1,16 @@
+module LavendaPay
+  module Payments
+    # Sandbox only: marks a pending payment as paid, and confirms it on the
+    # gateway when the gateway supports it. Production answers 404 (NotFoundError).
+    #
+    # LavendaPay::Payments::Confirm.call("pay_...") # => LavendaPay::Payment
+    class Confirm < Operation
+      def call(pid)
+        body = http.post("/v1/payments/#{escape(pid)}/confirmation")
+        gateway_confirmation = body.dig("meta", "gateway_confirmation")
+
+        Payment.new((body["payment"] || body).merge("gateway_confirmation" => gateway_confirmation))
+      end
+    end
+  end
+end

data/lib/lavenda_pay/resources/payment.rb

@@ -0,0 +1,6 @@
+module LavendaPay
+  class Payment < Resource
+    # Attributes: pid, status, and gateway_confirmation after a sandbox
+    # confirmation ("confirmed", "failed" or "unsupported").
+  end
+end

data/lib/lavenda_pay/url.rb

@@ -0,0 +1,14 @@
+require "uri"
+
+module LavendaPay
+  # Links to the public Lavenda Pay pages, built from `base_url`.
+  #
+  #   LavendaPay::Url.order_path("order_...") # => "https://.../orders/order_..."
+  module Url
+    module_function
+
+    def order_path(pid, configuration: LavendaPay.configuration)
+      "#{configuration.base_url.to_s.chomp("/")}/orders/#{URI.encode_www_form_component(pid.to_s)}"
+    end
+  end
+end

data/lib/lavenda_pay/version.rb

@@ -1,3 +1,3 @@
 module LavendaPay
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/lavenda_pay.rb

@@ -5,6 +5,7 @@ require_relative "lavenda_pay/http"
 require_relative "lavenda_pay/resource"
 require_relative "lavenda_pay/resources/customer"
 require_relative "lavenda_pay/resources/order"
+require_relative "lavenda_pay/resources/payment"
 require_relative "lavenda_pay/client"
 require_relative "lavenda_pay/operation"
 require_relative "lavenda_pay/customers/create"
@@ -13,6 +14,8 @@ require_relative "lavenda_pay/customers/list"
 require_relative "lavenda_pay/customers/find_by"
 require_relative "lavenda_pay/orders/create"
 require_relative "lavenda_pay/orders/find"
+require_relative "lavenda_pay/payments/confirm"
+require_relative "lavenda_pay/url"
 require_relative "lavenda_pay/webhooks"
 require_relative "lavenda_pay/engine" if defined?(Rails::Engine)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lavenda-pay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - La Venda Software
@@ -118,9 +118,12 @@ files:
 - lib/lavenda_pay/operation.rb
 - lib/lavenda_pay/orders/create.rb
 - lib/lavenda_pay/orders/find.rb
+- lib/lavenda_pay/payments/confirm.rb
 - lib/lavenda_pay/resource.rb
 - lib/lavenda_pay/resources/customer.rb
 - lib/lavenda_pay/resources/order.rb
+- lib/lavenda_pay/resources/payment.rb
+- lib/lavenda_pay/url.rb
 - lib/lavenda_pay/version.rb
 - lib/lavenda_pay/webhooks.rb
 - lib/lavenda_pay/webhooks/construct_event.rb
@@ -150,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Ruby client for the Lavenda Pay payments API.
 test_files: []