tappay 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dbea2463bcce294e9cd5c09df6f2ad4c68616bde
-  data.tar.gz: 7940b43a0be475f917dbee009fe64a5ae6741224
+SHA256:
+  metadata.gz: c80c6879c24468637180dc99def0c0e7727e79d5e342935dab5ae39021870065
+  data.tar.gz: bf4707515ffca803365a5c7abbd2192dc9d9e24a1f43abea7a536cf6a80b5b3f
 SHA512:
-  metadata.gz: e9607512bffdc66755bff9993b89b3f59655315ade0e5af4fb7f09e7ed5c96fe606ba43fb81c3d68480b1b557c79fd2dee573658b547f1317589008fa1d681c9
-  data.tar.gz: 571ead5ac836480ad7dafe7ad515d42aa3ec45b579bfd570ce21213d4661ddeec2a69feacb07fd577ae8cdd4440459865bae07390684e5da256f6a04547afd96
+  metadata.gz: 002b2c137bfc4beded5f8ca10d4315b64d1dda5d1c1cf80cd3eaeef1979c8c660831cfa2bc264d7e44a68b6ecf0a54282f2d1c70516deaf9820066cf2176b062
+  data.tar.gz: b138932f859f31b52083d59bb95055413a45851f6ab9737ab3e30e567911c0af3ea11402fa4da1941b26466438c333147327586fb8a8dbb845b7f290513ca7b3

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+* Removed merchant_id support from configuration options.
+* Removed support for Ruby 2.0
+
+## [1.0.1] - 2019-09-05
+* Added deprecation warning when setting merchant_id, app_id, app_key in config options.
+
+## [1.0.0] - 2018-06-29
+* Use semantic versioning.
+* Start running in https://statementdog.com production environment.

data/README.md

@@ -26,23 +26,56 @@ See [TapPay Backend API](https://docs.tappaysdk.com/tutorial/zh/back.html#back).
 
 ## Usage
 
+**Settings**
+
 You need to setup mode which affects requests sent to sandbox or production server.
 The partner_key and merchant_id are optional, they could also be specified in request params.
 
 ```ruby
-# sandbox or production
-TapPay.mode = :sandbox
-
 TapPay.setup do |config|
+  config.mode = Rails.env.production? ? :production : :sandbox # sandbox or production
   config.partner_key = 'your_partner_key' # optional
-  config.merchant_id = 'your_merchant_id' # optional
 end
 ```
 
+**Map API Resources to Module and Action**
+
+It is easy to map api resources to the TapPay module's namespace and action. 
+For example, the **pay by prime** api is: 
+https://sandbox.tappaysdk.com/tpc/payment/pay-by-prime , 
+the last two parts `payment` and `pay-by-prime` are mapped to
+namespace `Payment` and action `pay_by_prime`, so it could be called by
+`TapPay::Payment.pay_by_prime(params)`.
+
+Another example is *bind card*, the bind card api is: 
+https://sandbox.tappaysdk.com/tpc/card/bind , so the api could be called by `TapPay::Card.bind(params)` as you expect.
+
+### Supported APIs
+**Payment**
+
+  * pay_by_prime
+  * pay_by_token
+
+**Card**
+
+  * bind
+  * remove
+
+**Transaction**
+
+  * cap
+  * query
+  * refund
+  * trade_history
+
+For more details about api request params and responses, please refer to the [TapPay Backend API Documentation](https://docs.tappaysdk.com/tutorial/zh/back.html#back).
+
+## More Examples
 ### Pay By Prime
 ```ruby
 params = {
   prime: 'test_3a2fb2b7e892b914a03c95dd4dd5dc7970c908df67a49527c0a648b2bc9',
+  merchant_id: 'your_merchant_id',
   details: "TapPay Test",
   amount: 100,
   cardholder: {
@@ -56,13 +89,13 @@ params = {
   remember: true
 }
 
-res = TapPay.pay_by_prime(params)
+res = TapPay::Payment.pay_by_prime(params)
 res #=> {"status"=>0, "msg"=>"Success", "amount"=>100, ...}
 res['status'] #=> 0
 res['msg'] #=> Success
 
 # Block Style
-TapPay.pay_by_prime(params) do |res|
+TapPay::Payment.pay_by_prime(params) do |res|
   res #=> {"status"=>0, "msg"=>"Success", "amount"=>100, ...}
 end
 ```
@@ -70,6 +103,7 @@ end
 ### Pay By Token
 ```ruby
 params = {
+  merchant_id: 'your_merchant_id',
   card_key: 'your_card_key_after_pay_by_prime_with_remember_true',
   card_token: 'your_card_token_after_pay_by_prime_with_remember_true',
   amount: 1,
@@ -77,10 +111,10 @@ params = {
   details: "An apple and a pen."
 }
 
-res = TapPay.pay_by_token(params)
+res = TapPay::Payment.pay_by_token(params)
 
 # Block Style
-TapPay.pay_by_token(params) do |res|
+TapPay::Payment.pay_by_token(params) do |res|
   res #=> {"status"=>0, "msg"=>"Success", "amount"=>100, ...}
 end
 ```
@@ -91,10 +125,10 @@ params = {
   rec_trade_id: 'your_rec_trade_id'
 }
 
-res = TapPay.refund(params)
+res = TapPay::Transaction.refund(params)
 
 # Block Style
-TapPay.refund(params) do |res|
+TapPay::Transaction.refund(params) do |res|
   res 
 end
 ```
@@ -103,6 +137,8 @@ end
 ```ruby
 # bind
 params = {
+  prime: 'test_3a2fb2b7e892b914a03c95dd4dd5dc7970c908df67a49527c0a648b2bc9',
+  merchant_id: 'your_merchant_id',
   currency: 'TWD',
   cardholder: {
         phone_number: "+886923456789",
@@ -129,20 +165,7 @@ TapPay::Card.remove(params) do |res|
 end
 ```
 
-### Transaction
-```ruby
-# cap
-TapPay::Transaction.cap(params) do |res|
-  res
-end
-
-# trade-history
-TapPay::Transaction.trade_history(params) do |res|
-  res
-end
-```
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/lib/tappay.rb

@@ -32,14 +32,23 @@ module TapPay
     end
 
     def merchant_id=(merchant_id)
+      warn <<-DEPRECATION_WARNING
+        [Deprecation] setting `merchant_id` in config options will be deprecated in the future releases.
+        It is recommaned to pass `merchant_id` to request params directly.
+      DEPRECATION_WARNING
+
       @merchant_id = merchant_id.to_s
     end
 
     def app_id=(app_id)
+      warn '[Deprecation] setting `app_id` in config options will be deprecated in the future releases.'
+
       @app_id = app_id
     end
 
     def app_key=(app_key)
+      warn '[Deprecation] setting `app_key` in config options will be deprecated in the future releases.'
+
       @app_key = app_key
     end
 

data/lib/tappay/api_resources.rb

@@ -1,21 +1,21 @@
 module TapPay
   module APIResources
     CARD = [
-      'bind'.freeze,
-      'remove'.freeze
-    ]
+      'bind',
+      'remove'
+    ].freeze
 
     PAYMENT = [
-      'pay_by_prime'.freeze,
-      'pay_by_token'.freeze
-    ]
+      'pay_by_prime',
+      'pay_by_token'
+    ].freeze
 
     TRANSACTION = [
-      'cap'.freeze,
-      'query'.freeze,
-      'refund'.freeze,
-      'trade_history'.freeze
-    ]
+      'cap',
+      'query',
+      'refund',
+      'trade_history'
+    ].freeze
 
     def base_url
       if TapPay.mode == :production

data/lib/tappay/request.rb

@@ -21,10 +21,11 @@ module TapPay
     end
 
     def self.default_params
-      {
-        partner_key: TapPay.partner_key,
-        merchant_id: TapPay.merchant_id
-      }
+      params = {}
+      params[:partner_key] = TapPay.partner_key unless TapPay.partner_key.nil?
+      params[:merchant_id] = TapPay.merchant_id unless TapPay.merchant_id.nil?
+
+      params
     end
 
     private_class_method :default_params

data/lib/tappay/version.rb

@@ -1,3 +1,3 @@
 module TapPay
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tappay
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - HzChris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A very simple TapPay API wrapper for ruby.