usage_credits 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcda02fd1ae61887b8a80d6fbf6c864843d363797d90dbbd66abafe2851ce8b
-  data.tar.gz: 6c1e67ec12f46bf5e33faa7d02ed723dc47926a29948a8140706392d1ffbe024
+  metadata.gz: 42e2dcff2633bf14d2390d436ab14f724fb1142bc6de5adf2b410ab36e13b785
+  data.tar.gz: fef29f9815fa2cb241ed30c342083f98003a607b9b6c95dfd1d86ed1df7a5753
 SHA512:
-  metadata.gz: cd9d8517d94b2c19d0b141d9b47f4362c65ee1bf9255bff400c2b55c34b14a87903cdd3f58987e92edad8c2116fbfe485f185ddc2e9696782ae912fc7f40402c
-  data.tar.gz: b9498add88988145a75e74abbdf24b086391fd76188d63719a108a97f4b1fa69af86d9ea9c941cdd45ac25a2d1e5319192b14d34361a2ea42058db333f6adb0e
+  metadata.gz: 59be8e233c0a004cc6ab205a5f80aa2c17ce38d64df2b7bd99f2521ab9a185779c309ca376b5ceee684420c27d1fe3111907aa5c26c52f3c96c2dba50187895f
+  data.tar.gz: 22cdd9089c33e9d50ecf598442d6aff6acd4924662542951e81eebbc3657d6300b8c66a746290aae6339b922d2ef7ef83caa097113aa3876a19cb3265c4ee0c4

data/Appraisals

@@ -1,25 +1,43 @@
 # frozen_string_literal: true
 
-# Test against Pay 8.3.x (minimum supported version)
+# Test minimum supported Rails version (with latest Pay)
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+  gem "pay", "~> 11.0"
+  gem "stripe", "~> 18.0"
+end
+
+# Test latest Rails version (with latest Pay) - this is the default/main Gemfile anyway
+appraise "rails-8.1" do
+  gem "rails", "~> 8.1.0"
+  gem "pay", "~> 11.0"
+  gem "stripe", "~> 18.0"
+end
+
+# Test minimum supported Pay version (with latest Rails)
 appraise "pay-8.3" do
   gem "pay", "~> 8.3.0"
   gem "stripe", "~> 13.0"
+  gem "rails", "~> 8.1.0"
 end
 
-# Test against Pay 9.0.x (current recommended version)
+# Test Pay 9.0 (popular stable version with latest Rails)
 appraise "pay-9.0" do
   gem "pay", "~> 9.0.0"
   gem "stripe", "~> 13.0"
+  gem "rails", "~> 8.1.0"
 end
 
-# Test against Pay 10.x (newly supported version)
+# Test Pay 10.0 (with latest Rails)
 appraise "pay-10.0" do
   gem "pay", "~> 10.0.0"
   gem "stripe", "~> 15.0"
+  gem "rails", "~> 8.1.0"
 end
 
-# Test against Pay 11.x (latest version)
+# Test latest Pay version (with latest Rails)
 appraise "pay-11.0" do
   gem "pay", "~> 11.0"
   gem "stripe", "~> 18.0"
+  gem "rails", "~> 8.1.0"
 end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.1] - 2026-01-15
+
+- Add custom `create_checkout_session` options (like `success_url`) to credit pack purchases by @yshmarov in https://github.com/rameerez/usage_credits/pull/5
+
 ## [0.2.0] - 2025-12-29
 
 - Add Claude Code GitHub Workflow by @rameerez in https://github.com/rameerez/usage_credits/pull/14

data/README.md

@@ -1,8 +1,11 @@
 # 💳✨ `usage_credits` - Add usage-based credits to your Rails app 
 
-[![Gem Version](https://badge.fury.io/rb/usage_credits.svg?v=0.1)](https://badge.fury.io/rb/usage_credits?v=0.1)
+[![Gem Version](https://badge.fury.io/rb/usage_credits.svg)](https://badge.fury.io/rb/usage_credits) [![Build Status](https://github.com/rameerez/usage_credits/workflows/Tests/badge.svg)](https://github.com/rameerez/usage_credits/actions)
 
-Allow your users to have in-app credits / tokens they can use to perform operations.
+> [!TIP]
+> **🚀 Ship your next Rails app 10x faster!** I've built **[RailsFast](https://railsfast.com)**, a production-ready Rails boilerplate template that comes with everything you need to launch a software business in days, not weeks.
+
+`usage_credits` allows your users to have in-app credits / tokens they can use to perform operations.
 
 ✨ Perfect for SaaS, AI apps, games, and API products that want to implement usage-based pricing.
 

data/gemfiles/pay_10.0.gemfile

@@ -2,28 +2,40 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
-gem "mocha"
-gem "simplecov", require: false
-gem "standard"
-gem "vcr"
-gem "webmock"
-gem "braintree", ">= 2.92.0"
-gem "lemonsqueezy", "~> 1.0"
-gem "paddle", "~> 2.6"
-gem "stripe", "~> 15.0"
-gem "prawn"
-gem "receipts"
-gem "sqlite3"
-gem "pg"
-gem "bootsnap", require: false
-gem "puma"
-gem "web-console", group: :development
-gem "importmap-rails"
-gem "sprockets-rails"
-gem "stimulus-rails"
-gem "turbo-rails"
-gem "rdoc", ">= 7.0"
+gem "rake", "~> 13.0"
 gem "pay", "~> 10.0.0"
+gem "stripe", "~> 15.0"
+gem "rails", "~> 8.1.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
 
 gemspec path: "../"

data/gemfiles/pay_11.0.gemfile

@@ -2,28 +2,40 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
-gem "mocha"
-gem "simplecov", require: false
-gem "standard"
-gem "vcr"
-gem "webmock"
-gem "braintree", ">= 2.92.0"
-gem "lemonsqueezy", "~> 1.0"
-gem "paddle", "~> 2.6"
-gem "stripe", "~> 18.0"
-gem "prawn"
-gem "receipts"
-gem "sqlite3"
-gem "pg"
-gem "bootsnap", require: false
-gem "puma"
-gem "web-console", group: :development
-gem "importmap-rails"
-gem "sprockets-rails"
-gem "stimulus-rails"
-gem "turbo-rails"
-gem "rdoc", ">= 7.0"
+gem "rake", "~> 13.0"
 gem "pay", "~> 11.0"
+gem "stripe", "~> 18.0"
+gem "rails", "~> 8.1.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
 
 gemspec path: "../"

data/gemfiles/pay_8.3.gemfile

@@ -2,28 +2,40 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
-gem "mocha"
-gem "simplecov", require: false
-gem "standard"
-gem "vcr"
-gem "webmock"
-gem "braintree", ">= 2.92.0"
-gem "lemonsqueezy", "~> 1.0"
-gem "paddle", "~> 2.6"
-gem "stripe", "~> 13.0"
-gem "prawn"
-gem "receipts"
-gem "sqlite3"
-gem "pg"
-gem "bootsnap", require: false
-gem "puma"
-gem "web-console", group: :development
-gem "importmap-rails"
-gem "sprockets-rails"
-gem "stimulus-rails"
-gem "turbo-rails"
-gem "rdoc", ">= 7.0"
+gem "rake", "~> 13.0"
 gem "pay", "~> 8.3.0"
+gem "stripe", "~> 13.0"
+gem "rails", "~> 8.1.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
 
 gemspec path: "../"

data/gemfiles/pay_9.0.gemfile

@@ -2,28 +2,40 @@
 
 source "https://rubygems.org"
 
-gem "appraisal"
-gem "mocha"
-gem "simplecov", require: false
-gem "standard"
-gem "vcr"
-gem "webmock"
-gem "braintree", ">= 2.92.0"
-gem "lemonsqueezy", "~> 1.0"
-gem "paddle", "~> 2.6"
-gem "stripe", "~> 13.0"
-gem "prawn"
-gem "receipts"
-gem "sqlite3"
-gem "pg"
-gem "bootsnap", require: false
-gem "puma"
-gem "web-console", group: :development
-gem "importmap-rails"
-gem "sprockets-rails"
-gem "stimulus-rails"
-gem "turbo-rails"
-gem "rdoc", ">= 7.0"
+gem "rake", "~> 13.0"
 gem "pay", "~> 9.0.0"
+gem "stripe", "~> 13.0"
+gem "rails", "~> 8.1.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
 
 gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,41 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "rails", "~> 7.2.0"
+gem "pay", "~> 11.0"
+gem "stripe", "~> 18.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
+
+gemspec path: "../"

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,41 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "rails", "~> 8.1.0"
+gem "pay", "~> 11.0"
+gem "stripe", "~> 18.0"
+
+group :development do
+  gem "appraisal"
+  gem "web-console"
+  gem "standard"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-minitest", "~> 0.35"
+  gem "rubocop-performance", "~> 1.0"
+end
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "simplecov", require: false
+  gem "vcr"
+  gem "webmock"
+  gem "braintree", ">= 2.92.0"
+  gem "lemonsqueezy", "~> 1.0"
+  gem "paddle", "~> 2.6"
+  gem "prawn"
+  gem "receipts"
+  gem "sqlite3"
+  gem "pg"
+  gem "bootsnap", require: false
+  gem "puma"
+  gem "importmap-rails"
+  gem "sprockets-rails"
+  gem "stimulus-rails"
+  gem "turbo-rails"
+  gem "rdoc", ">= 7.0"
+end
+
+gemspec path: "../"

data/lib/usage_credits/models/credit_pack.rb

@@ -123,10 +123,56 @@ module UsageCredits
     # Payment Integration
     # =========================================
 
-    # Create a Stripe Checkout session for this pack
-    def create_checkout_session(user)
+    # Create a Stripe Checkout session for this pack.
+    #
+    # Accepts optional checkout options that are passed through to the payment processor.
+    # Common options include:
+    #   - success_url: URL to redirect after successful payment
+    #   - cancel_url: URL to redirect if customer cancels
+    #   - allow_promotion_codes: Enable promotion code input (true/false)
+    #   - locale: Checkout page locale (e.g., "en", "es", "fr")
+    #   - customer_email: Pre-fill the customer's email
+    #
+    # Note: The following parameters are protected and cannot be overridden:
+    #   - mode: Always "payment" for credit packs
+    #   - line_items: Always the configured credit pack
+    #
+    # Custom metadata passed in options will be merged with (not replace) the
+    # base pack metadata required for credit fulfillment.
+    #
+    # @param user [Object] A user with a payment processor (via Pay gem)
+    # @param options [Hash] Additional checkout options passed to the payment processor
+    # @return [Object] The checkout session object
+    #
+    # @example Basic usage
+    #   pack.create_checkout_session(current_user)
+    #
+    # @example With custom options
+    #   pack.create_checkout_session(current_user,
+    #     success_url: credits_url,
+    #     cancel_url: pricing_url,
+    #     allow_promotion_codes: true
+    #   )
+    #
+    def create_checkout_session(user, **options)
       raise ArgumentError, "User must have a payment processor" unless user.respond_to?(:payment_processor) && user.payment_processor
 
+      # Merge custom metadata with base_metadata (base_metadata takes precedence for critical fields)
+      custom_metadata = options.delete(:metadata) || {}
+      merged_metadata = custom_metadata.merge(base_metadata)
+
+      # Handle payment_intent_data specially to preserve metadata
+      # We dup to avoid mutating the caller's original hash
+      custom_payment_intent_data = (options.delete(:payment_intent_data) || {}).dup
+      custom_pi_metadata = custom_payment_intent_data.delete(:metadata) || {}
+      merged_payment_intent_data = custom_payment_intent_data.merge(
+        metadata: custom_pi_metadata.merge(base_metadata)
+      )
+
+      # Remove protected parameters that could break credit fulfillment
+      options.delete(:mode)
+      options.delete(:line_items)
+
       user.payment_processor.checkout(
         mode: "payment",
         line_items: [{
@@ -140,8 +186,9 @@ module UsageCredits
           },
           quantity: 1
         }],
-        payment_intent_data: { metadata: base_metadata },
-        metadata: base_metadata
+        payment_intent_data: merged_payment_intent_data,
+        metadata: merged_metadata,
+        **options
       )
     end
 

data/lib/usage_credits/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UsageCredits
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: usage_credits
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - rameerez
 bindir: exe
 cert_chain: []
-date: 2025-12-29 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pay
@@ -43,104 +43,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.35'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.35'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Add a usage-based credit system to your Rails app, easily. Let users
   buy and spend credits on usage-based actions. Refill Stripe subscriptions with credits,
   sell one-time booster credit packs, implement PAYG (pay-as-you-go) billing, award
@@ -166,6 +68,8 @@ files:
 - gemfiles/pay_11.0.gemfile
 - gemfiles/pay_8.3.gemfile
 - gemfiles/pay_9.0.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.1.gemfile
 - lib/generators/usage_credits/install_generator.rb
 - lib/generators/usage_credits/templates/create_usage_credits_tables.rb.erb
 - lib/generators/usage_credits/templates/initializer.rb