tappay_ruby 0.10.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ce90cd2b717fd362fe27f9823797cbda3d53aaf94edae8d57ec012d4bcceaea
-  data.tar.gz: 550b70b62f2c0d02414cbbce136900610badb978cec8b68ee36511daa4f23255
+  metadata.gz: 3c06097c577042d4efb81f434670795a3247ed8badd8e6fd7efcd41436373942
+  data.tar.gz: d9ff01cc3df47d3333328bf8593bd99afa91b995ea5aea00dbc98dda91b825c4
 SHA512:
-  metadata.gz: c66bade29b78ca9518fd519d4cbcf91916af5d9cd20c04e96294ea6ad9967f409199b1af700e0e8011490a05cce4056d25c9ce1c351bd3b327acc6713b8bf7f5
-  data.tar.gz: eb409d49cab817ad4cb31af5fc63184ee4c6458b817026d1953ef71a71e43fd8eefd2086c269393c3f6338a3bf4dda70021be74250ef0cf377d763620fbdc4ba
+  metadata.gz: a60520e14ad7946a7768e00f8c4044260266eb95363a18a884c4e33e0dc37610df4af584ff5883ce5799f3981556784bdb767c3d185dc4ea769d00395545a6f7
+  data.tar.gz: ed3fcbaae8b9154635f13c1f94e5259d33a560e3f5269f8bbf825516ebd78e5c77ef4466161f3d38b042aa903620a064fdd13f68b82f2c65644dc1dca2f73c43

data/README.md

@@ -10,12 +10,13 @@ A Ruby library for integrating with TapPay payment services. This gem provides a
 
 - Multiple payment methods:
   - Credit card payments (one-time and tokenized)
-  - Instalment payments (3, 6, 12, 24 and 36 months)
+  - Instalment payments (3, 6, 12, 18, 24, 30 months)
   - Line Pay
   - JKO Pay
 - Flexible merchant identification:
   - Support for both `merchant_id` and `merchant_group_id`
   - Automatic fallback handling
+  - Priority-based merchant ID resolution
 - Refund processing
 - Transaction status queries
 - Comprehensive error handling
@@ -53,91 +54,37 @@ The simplest way to configure the gem:
 
 ```ruby
 Tappay.configure do |config|
-  # Environment settings
-  config.mode = Rails.env.production? ? :production : :sandbox
-
-  # Common settings
-  config.partner_key = 'your_partner_key'.freeze
-  config.app_id = 'your_app_id'.freeze
+  config.partner_key = 'YOUR_PARTNER_KEY'
 
-  # Merchant settings (use either merchant_id or merchant_group_id, not both)
-  config.merchant_id = 'your_merchant_id'.freeze
+  # Primary merchant identification
+  # You can use either merchant_id or merchant_group_id
+  config.merchant_id = 'YOUR_MERCHANT_ID'
   # OR
-  config.merchant_group_id = 'your_merchant_group_id'.freeze
+  config.merchant_group_id = 'YOUR_MERCHANT_GROUP_ID'
 
-  # Payment-specific merchant IDs
-  config.instalment_merchant_id = 'your_instalment_merchant_id'.freeze
-  config.line_pay_merchant_id = 'your_line_pay_merchant_id'.freeze
-  config.jko_pay_merchant_id = 'your_jko_pay_merchant_id'.freeze
+  # Optional merchant IDs for specific payment methods
+  # Note: These will be ignored if merchant_group_id is set
+  config.jko_pay_merchant_id = 'YOUR_JKO_PAY_MERCHANT_ID'
+  config.line_pay_merchant_id = 'YOUR_LINE_PAY_MERCHANT_ID'
+  config.instalment_merchant_id = 'YOUR_INSTALMENT_MERCHANT_ID'
 
-  config.currency = 'TWD'.freeze
-  config.vat_number = 'your_vat_number'.freeze
+  config.mode = :sandbox # or :production
 end
 ```
 
-Note: When both `merchant_id` and `merchant_group_id` are provided, `merchant_group_id` will be used for payment processing.
-
-### Merchant ID Configuration
-
-The gem supports flexible merchant ID configuration:
-
-1. Global merchant ID:
-   - `merchant_id`: Default merchant ID for all payments
-   - `merchant_group_id`: Group merchant ID (mutually exclusive with merchant_id)
-
-2. Payment-specific merchant IDs:
-   - `instalment_merchant_id`: Specific merchant ID for instalment payments
-   - `line_pay_merchant_id`: Specific merchant ID for Line Pay transactions
-   - `jko_pay_merchant_id`: Specific merchant ID for JKO Pay transactions
-
-Merchant ID Priority:
-1. Payment options merchant ID (if provided in the payment call)
-2. Payment-specific merchant ID (if configured)
-3. Global merchant ID
-
-Example of merchant ID usage:
-```ruby
-# Using default merchant ID
-result = Tappay::CreditCard::Pay.by_prime(
-  prime: 'prime_from_tappay_sdk',
-  amount: 100,
-  order_number: 'ORDER-123'
-)
-
-# Using payment-specific merchant ID
-# This will automatically use line_pay_merchant_id if configured
-result = Tappay::LinePay::Pay.new(
-  prime: 'line_pay_prime',
-  amount: 100,
-  frontend_redirect_url: 'https://example.com/line_pay/result',
-  backend_notify_url: 'https://example.com/line_pay/notify'
-).execute
-
-# Overriding merchant ID in payment options
-result = Tappay::CreditCard::Pay.by_prime(
-  prime: 'prime_from_tappay_sdk',
-  amount: 100,
-  merchant_id: 'override_merchant_id',  # This takes highest priority
-  order_number: 'ORDER-123'
-)
-```
+### Merchant ID Resolution
 
-### 2. Using Environment Variables
+The gem uses the following priority order when resolving merchant IDs:
 
-For better security, you can use environment variables:
+1. If `merchant_group_id` is set (either in configuration or options):
+   - Uses `merchant_group_id` for all payment types
+   - Ignores all other merchant IDs (including specific ones for Line Pay, JKO Pay, etc.)
 
-```ruby
-Tappay.configure do |config|
-  config.mode = Rails.env.production? ? :production : :sandbox
-  config.partner_key = ENV['TAPPAY_PARTNER_KEY'].freeze
-  config.app_id = ENV['TAPPAY_APP_ID'].freeze
-  config.merchant_id = ENV['TAPPAY_MERCHANT_ID'].freeze
-  config.line_pay_merchant_id = ENV['TAPPAY_LINE_PAY_MERCHANT_ID'].freeze
-  config.instalment_merchant_id = ENV['TAPPAY_INSTALMENT_MERCHANT_ID'].freeze
-  config.jko_pay_merchant_id = ENV['TAPPAY_JKO_PAY_MERCHANT_ID'].freeze
-  # ... other configurations
-end
-```
+2. If `merchant_group_id` is not set:
+   - For Line Pay: Uses `line_pay_merchant_id` if set, otherwise falls back to `merchant_id`
+   - For JKO Pay: Uses `jko_pay_merchant_id` if set, otherwise falls back to `merchant_id`
+   - For Instalments: Uses `instalment_merchant_id` if set, otherwise falls back to `merchant_id`
+   - For other payment types: Uses `merchant_id`
 
 ## Usage
 

data/lib/tappay/credit_card/instalment.rb

@@ -34,6 +34,10 @@ module Tappay
       private
 
       def get_merchant_id
+        # If merchant_group_id is set, it takes precedence
+        return nil if Tappay.configuration.merchant_group_id
+        
+        # Otherwise, use instalment_merchant_id or fall back to default merchant_id
         Tappay.configuration.instalment_merchant_id || super
       end
 
@@ -75,6 +79,10 @@ module Tappay
       private
 
       def get_merchant_id
+        # If merchant_group_id is set, it takes precedence
+        return nil if Tappay.configuration.merchant_group_id
+        
+        # Otherwise, use instalment_merchant_id or fall back to default merchant_id
         Tappay.configuration.instalment_merchant_id || super
       end
 

data/lib/tappay/jko_pay/pay.rb

@@ -3,11 +3,6 @@
 module Tappay
   module JkoPay
     class Pay < PaymentBase
-      def initialize(options = {})
-        super
-        validate_jko_pay_options!
-      end
-
       def endpoint_url
         Endpoints::Payment.pay_by_prime_url
       end
@@ -15,17 +10,18 @@ module Tappay
       private
 
       def get_merchant_id
+        # If merchant_group_id is set, it takes precedence
+        return nil if Tappay.configuration.merchant_group_id
+
+        # Otherwise, use jko_pay_merchant_id or fall back to default merchant_id
         Tappay.configuration.jko_pay_merchant_id || super
       end
 
-      def validate_jko_pay_options!
-        validate_result_urls!
+      def additional_required_options
+        [:prime, :frontend_redirect_url, :backend_notify_url]
       end
 
-      def validate_result_urls!
-        raise ValidationError, 'frontend_redirect_url is required for JKO Pay' if options[:frontend_redirect_url].nil?
-        raise ValidationError, 'backend_notify_url is required for JKO Pay' if options[:backend_notify_url].nil?
-      end
+      protected
 
       def payment_data
         data = super
@@ -34,7 +30,6 @@ module Tappay
           backend_notify_url: options[:backend_notify_url]
         }
         data[:prime] = options[:prime]
-        data[:remember] = options[:remember] || false
         data
       end
     end

data/lib/tappay/line_pay/pay.rb

@@ -5,17 +5,6 @@ require 'tappay/payment_base'
 module Tappay
   module LinePay
     class Pay < PaymentBase
-      def payment_data
-        super.merge(
-          prime: options[:prime],
-          result_url: {
-            frontend_redirect_url: options[:frontend_redirect_url],
-            backend_notify_url: options[:backend_notify_url]
-          },
-          remember: options[:remember] || false
-        )
-      end
-
       def endpoint_url
         Tappay::Endpoints::Payment.pay_by_prime_url
       end
@@ -23,12 +12,28 @@ module Tappay
       private
 
       def get_merchant_id
+        # If merchant_group_id is set, it takes precedence
+        return nil if Tappay.configuration.merchant_group_id
+
+        # Otherwise, use line_pay_merchant_id or fall back to default merchant_id
         Tappay.configuration.line_pay_merchant_id || super
       end
 
       def additional_required_options
         [:prime, :frontend_redirect_url, :backend_notify_url]
       end
+
+      protected
+
+      def payment_data
+        super.merge(
+          prime: options[:prime],
+          result_url: {
+            frontend_redirect_url: options[:frontend_redirect_url],
+            backend_notify_url: options[:backend_notify_url]
+          }
+        )
+      end
     end
   end
-end
+end

data/lib/tappay/payment_base.rb

@@ -2,7 +2,7 @@
 
 module Tappay
   class PaymentBase < Client
-    VALID_INSTALMENT_VALUES = [0, 3, 6, 12, 24, 30].freeze
+    VALID_INSTALMENT_VALUES = [0, 3, 6, 12, 18, 24, 30].freeze
 
     def initialize(options = {})
       super
@@ -81,6 +81,10 @@ module Tappay
     end
 
     def get_merchant_id
+      # If merchant_group_id is set, it takes precedence over all other merchant IDs
+      return nil if Tappay.configuration.merchant_group_id
+      
+      # Otherwise, return the default merchant_id
       Tappay.configuration.merchant_id
     end
 

data/lib/tappay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tappay
-  VERSION = "0.10.0"
+  VERSION = "0.12.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tappay_ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Zac
 bindir: exe
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty