tappay_ruby 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42349c6d543ca1fa3a3bf6ead0e0f6eb9f281c80b28d35811058d2661d084f10
-  data.tar.gz: 82da8ed41bed6cfa50845bf8d9751fb796e8c2373e7978c9e60d35d560c2ccb8
+  metadata.gz: 1396c7927613825f5182660db63871bc06c114cc38ef334b6143929e7e88f730
+  data.tar.gz: a6e2fcf2e65a3fa7d47e2a6f7f621d149e189f8be2ec980391e767ecc0000d27
 SHA512:
-  metadata.gz: bfd22c013a32a3aa5c13bc28c84d94e21f49cdaf71657b6f7cf39e2c0240cff23fe61db6b396ccbb02cdf0571802318689b022bc796e4253ea799bc3837c1898
-  data.tar.gz: 4878db49a06c88e21fc6a5affa06eed404bf2a90feaaa82921824ad27a280977caafe05d945765a43ca21cba41dba78bf52d6bd7cbdf8d59706a62207accacc3
+  metadata.gz: 1d9e6b6a5394f54f846562e38053a490145f0c779aca7e61096ec43e3c2ee6055387639790352885b52db8a0918119469897e8b83fcef910965ad7e0d8f5e278
+  data.tar.gz: ae5f360a2e89ede2df5c0f5d104105aeaefa10c0409b075074a903141d822690328a3e11ee7a55f8fb0256f632d72dac2f76f066b00440dd6cb89351c0c2d8f5

data/README.md

@@ -1,5 +1,6 @@
 # TapPay Ruby Gem
 
+![Gem Version](https://img.shields.io/gem/v/tappay_ruby)
 [![RSpec](https://github.com/7a6163/tappay/actions/workflows/rspec.yml/badge.svg)](https://github.com/7a6163/tappay/actions/workflows/rspec.yml)
 [![codecov](https://codecov.io/gh/7a6163/tappay/branch/main/graph/badge.svg)](https://codecov.io/gh/7a6163/tappay)
 
@@ -197,6 +198,24 @@ if result['status'] == 0
 end
 ```
 
+## URL Properties
+
+The `result_url` (JSONObject) property is required when using LINE Pay, JKOPAY, 悠遊付, Atome, Pi錢包, 全盈支付, or when three_domain_secure is true. It contains the following URL fields:
+
+```json
+{
+  "frontend_redirect_url": "https://example.com/redirect",  // Required - URL where consumer will be redirected after completing the transaction
+  "backend_notify_url": "https://example.com/notify",      // Required - URL where your server receives transaction results (only port 443)
+  "go_back_url": "https://example.com/back"               // Optional - URL for 3D verification error cases (E.SUN, Cathay United, Taishin banks)
+}
+```
+
+- `frontend_redirect_url` (String): After the consumer completes the transaction process in LINE Pay, JKOPAY, 悠遊付, Atome, Pi錢包, 全盈支付, or 3D verification, they will be redirected to this frontend URL. Must start with https.
+
+- `backend_notify_url` (String): URL where your server receives transaction results. Must start with https and only supports port 443.
+
+- `go_back_url` (String): For 3D verification transactions, this URL is used when consumers are redirected to the TapPay Error page due to improper operation. This scenario only occurs with E.SUN Bank, Cathay United Bank, and Taishin Bank. You can define this URL in the transaction request or set it in TapPay Portal > Developer Content > System Settings > Redirect Link Settings. It's strongly recommended to define this field for 3D transactions to ensure consumers can return to complete the transaction or view results.
+
 ## Usage
 
 ### Pay by Prime
@@ -224,7 +243,7 @@ if result['status'] == 0
     card_token = result['card_secret']['card_token']
     # Store card_key and card_token securely for future payments
   end
-  
+
   # Handle payment URL if present (for 3D Secure, LINE Pay, JKO Pay)
   if result['payment_url']
     redirect_to result['payment_url']
@@ -324,6 +343,36 @@ rescue Tappay::ValidationError => e
 end
 ```
 
+### Example Usage with result_url
+
+```ruby
+# Example of payment with result_url for LINE Pay
+result = Tappay::LinePay::Pay.create(
+  prime: 'prime_from_tappay_sdk',
+  amount: 100,
+  merchant_id: 'your_merchant_id',
+  details: 'Product Item',
+  result_url: {
+    frontend_redirect_url: 'https://example.com/payment/complete',
+    backend_notify_url: 'https://example.com/payment/notify',
+    go_back_url: 'https://example.com/payment/error'
+  }
+)
+
+# Example of payment with result_url for 3D verification
+result = Tappay::CreditCard::Pay.by_prime(
+  prime: 'prime_from_tappay_sdk',
+  amount: 100,
+  merchant_id: 'your_merchant_id',
+  three_domain_secure: true,
+  result_url: {
+    frontend_redirect_url: 'https://example.com/3d/complete',
+    backend_notify_url: 'https://example.com/3d/notify',
+    go_back_url: 'https://example.com/3d/error'
+  }
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.

data/lib/tappay/credit_card/instalment.rb

@@ -26,11 +26,24 @@ module Tappay
         Tappay::Endpoints::CreditCard.payment_by_prime_url
       end
 
+      def validate_options!
+        super
+        validate_result_url_for_instalment!
+      end
+
       private
 
       def additional_required_options
         [:prime, :cardholder, :instalment]
       end
+
+      def validate_result_url_for_instalment!
+        return if options[:result_url] && 
+                 options[:result_url][:frontend_redirect_url] && 
+                 options[:result_url][:backend_notify_url]
+
+        raise ValidationError, "result_url with frontend_redirect_url and backend_notify_url is required for instalment payments"
+      end
     end
 
     class InstalmentByToken < PaymentBase
@@ -50,11 +63,24 @@ module Tappay
         Tappay::Endpoints::CreditCard.payment_by_token_url
       end
 
+      def validate_options!
+        super
+        validate_result_url_for_instalment!
+      end
+
       private
 
       def additional_required_options
         [:card_key, :card_token, :instalment]
       end
+
+      def validate_result_url_for_instalment!
+        return if options[:result_url] && 
+                 options[:result_url][:frontend_redirect_url] && 
+                 options[:result_url][:backend_notify_url]
+
+        raise ValidationError, "result_url with frontend_redirect_url and backend_notify_url is required for instalment payments"
+      end
     end
   end
 end

data/lib/tappay/credit_card/pay.rb

@@ -61,6 +61,7 @@ module Tappay
           end
           data[:cardholder] = card_holder_data if options[:cardholder]
           data[:instalment] = options[:instalment] if options[:instalment]
+          data[:result_url] = options[:result_url] if options[:result_url]
         end
       end
 
@@ -83,6 +84,7 @@ module Tappay
         raise ValidationError, "Missing required options: #{missing.join(', ')}" if missing.any?
 
         validate_instalment! if options[:instalment]
+        validate_result_url! if options[:three_domain_secure]
       end
 
       private
@@ -100,6 +102,14 @@ module Tappay
           raise ValidationError, "Invalid instalment value. Must be between 1 and 12"
         end
       end
+
+      def validate_result_url!
+        return if options[:result_url] && 
+                 options[:result_url][:frontend_redirect_url] && 
+                 options[:result_url][:backend_notify_url]
+
+        raise ValidationError, "result_url with frontend_redirect_url and backend_notify_url is required when three_domain_secure is true"
+      end
     end
 
     class Pay < PaymentBase

data/lib/tappay/version.rb

@@ -1,3 +1,3 @@
 module Tappay
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

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