tappay_ruby 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e47e2732e236d1bca9d0daa16466fbff08b9c43e044ccb9020e2a505632fcf2a
-  data.tar.gz: af086bf4adf1a925fc1beb1cfc25dc3903421592b80c73e3efc8007c8a463d75
+  metadata.gz: 920fd5c582914989062cb76fc47306e6ec3b4714b2558e2d4f04e2e43c4c11a0
+  data.tar.gz: 85a9f5331b47bdfbb78f81da3236d5123086f873e1260fb68b5c757bb7984e1d
 SHA512:
-  metadata.gz: 93ab78ddbcbd031929a051fe085cd7c8b63d289e88f0defc9eb5299924795692b35145680e373c87503f893403077d0e439339cdec4b50efb9ca9d339f9e9fc9
-  data.tar.gz: 94023de9c35c2ac47265f3abf9f2beeee0659fd2c977a5ce7cc3962cdc55867b5313c115327b3f2a2b17340f737c59d42f08747e5dd722f3ad4ef5f9c0e6adf4
+  metadata.gz: 9fb651e7b40a652a725896d697a75a3e47484f58bc64102b057bfa2a8b049f0427b8c1bdb0dcaa229d84f999898e291b9bfd36548e0ce012fdff4cb706201b03
+  data.tar.gz: 62b665b0e9d15c07966cc61998d215ff2e531a1664d5dffd824b9fc116db93a4c031f1f5271e5701cc445793056bd167ca561c6688064a281707dcba17e27839

data/README.md

@@ -10,9 +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 to 24 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
@@ -50,89 +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
 ```
 
-### Merchant ID Configuration
-
-The gem supports flexible merchant ID configuration:
+### Merchant ID Resolution
 
-1. Global merchant ID:
-   - `merchant_id`: Default merchant ID for all payments
-   - `merchant_group_id`: Group merchant ID (mutually exclusive with merchant_id)
+The gem uses the following priority order when resolving merchant IDs:
 
-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'
-)
+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.)
 
-# 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'
-)
-```
-
-### 2. Using Environment Variables
-
-For better security, you can use environment variables:
-
-```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
 
@@ -186,6 +138,7 @@ result = Tappay::LinePay::Pay.new(
 Tappay.configure do |config|
   config.partner_key = 'YOUR_PARTNER_KEY'
   config.merchant_id = 'YOUR_MERCHANT_ID'
+  config.merchant_group_id = 'YOUR_MERCHANT_GROUP_ID' # Optional, mutually exclusive with merchant_id
   config.jko_pay_merchant_id = 'YOUR_JKO_PAY_MERCHANT_ID' # Optional, falls back to merchant_id if not set
   config.sandbox = true # Set to false for production
 end

data/lib/tappay/configuration.rb

@@ -36,7 +36,7 @@ module Tappay
 
     def validate!
       raise ValidationError, 'partner_key is required' if partner_key.nil?
-      raise ValidationError, 'merchant_id is required' if merchant_id.nil?
+      raise ValidationError, 'Either merchant_id or merchant_group_id is required' if merchant_id.nil? && merchant_group_id.nil?
     end
   end
 end

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

@@ -15,6 +15,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 jko_pay_merchant_id or fall back to default merchant_id
         Tappay.configuration.jko_pay_merchant_id || super
       end
 

data/lib/tappay/line_pay/pay.rb

@@ -23,6 +23,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 line_pay_merchant_id or fall back to default merchant_id
         Tappay.configuration.line_pay_merchant_id || super
       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
@@ -20,48 +20,26 @@ module Tappay
     end
 
     def payment_data
-      # Check configuration conflicts first
-      if Tappay.configuration.merchant_group_id && Tappay.configuration.merchant_id
-        raise Tappay::ValidationError, "merchant_group_id and merchant_id cannot be used together"
-      end
-
-      # Get values from options
-      opt_group_id = options[:merchant_group_id]
-      opt_merchant_id = options[:merchant_id]
-
-      # Check for conflicts in options
-      if opt_group_id && opt_merchant_id
-        raise Tappay::ValidationError, "merchant_group_id and merchant_id cannot be used together"
-      end
-
-      # If options has any ID, use it exclusively
-      if opt_group_id || opt_merchant_id
-        merchant_group_id = opt_group_id
-        merchant_id = opt_merchant_id
+      # Prioritize merchant_group_id from options, then configuration
+      merchant_group_id = options[:merchant_group_id] || Tappay.configuration.merchant_group_id
+      merchant_id = options[:merchant_id] || get_merchant_id
+      
+      # Determine which identifier to use
+      identifier = if merchant_group_id
+        { merchant_group_id: merchant_group_id }
       else
-        # If no options, use configuration
-        merchant_group_id = Tappay.configuration.merchant_group_id
-        merchant_id = get_merchant_id
-      end
-
-      # Check if at least one is provided
-      unless merchant_group_id || merchant_id
-        raise Tappay::ValidationError, "Either merchant_group_id or merchant_id must be provided"
+        raise Tappay::ValidationError, "Either merchant_group_id or merchant_id must be provided" unless merchant_id
+        { merchant_id: merchant_id }
       end
 
-      {
+      identifier.merge({
         partner_key: Tappay.configuration.partner_key,
         amount: options[:amount],
         details: options[:details],
         currency: options[:currency] || 'TWD',
         order_number: options[:order_number],
         three_domain_secure: options[:three_domain_secure] || false
-      }.tap do |data|
-        if merchant_group_id
-          data[:merchant_group_id] = merchant_group_id
-        else
-          data[:merchant_id] = merchant_id
-        end
+      }).tap do |data|
         data[:cardholder] = card_holder_data if options[:cardholder]
         data[:result_url] = options[:result_url] if options[:result_url]
         data[:instalment] = options[:instalment] || 0
@@ -103,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.9.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tappay_ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Zac