tappay 0.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 910d88773959e2f6c92058ddbf0c953d3c3a95e0
-  data.tar.gz: f5b083ae6707ebe345558cf0ba770c402b2f1429
+SHA256:
+  metadata.gz: e6ba5b5a03d5a95d16eba5034a3e49ae5b3181ff9027f246d73b8c5ecc948664
+  data.tar.gz: ca52ff1b2b70d7849086ac34e4d54118ecd9e66557b9c58cc533d6588647a113
 SHA512:
-  metadata.gz: 76f0a683a632252c9ccf3c7dfab74a257e9de343e1dc310a969799f479f3bd54a081b46b6c3eb25b206671a8c9cee096b1bf1cc2ba5e8ab9d95059f8521fbce5
-  data.tar.gz: f2f2e504881825f070faf948764fefd675287d18afaaef5258b99b593c79db6d3190795deb434307d3324fca42375a68c38cb28b43201d457b48aa9711a540ef
+  metadata.gz: 2c072d7a95683c1f0f9d9270c2ea787ae079552b3585a06d14254987b4c078f44e7e4386ca0ca918d962e056c7feefd724cdbdec16ebd9e09294cb7d3978218a
+  data.tar.gz: fe70351ae1bcfe7c90b26d3032f5ae43ab5df68dd9560210476713279a267bc573645f2c3094b730a2dc243c08648c7de0a08d1082f111b379286240c432d633

data/.github/workflows/gempush.yml

@@ -0,0 +1,23 @@
+name: Ruby Gem
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.5, 2.4]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby version
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

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).
+
+## [2.0.0]
+* Removed merchant_id support from configuration options.
+* Removed support for Ruby version < 2.4
+
+## [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

@@ -1,5 +1,8 @@
 # TapPay
 
+[![Build Status](https://travis-ci.org/hzchirs/tappay-ruby.svg?branch=master)](https://travis-ci.org/hzchirs/tappay-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1bc81b37e0025c3de443/maintainability)](https://codeclimate.com/github/hzchirs/tappay-ruby/maintainability)
+
 A very simple [TapPay](https://www.tappaysdk.com/tch) API wrapper written in the Ruby language.
 
 ## Installation
@@ -23,23 +26,56 @@ See [TapPay Backend API](https://docs.tappaysdk.com/tutorial/zh/back.html#back).
 
 ## Usage
 
-You can setup mode, partner_key and merchant_id. It requests sandbox server or production server by mode.
-The partner_key and merchant_id are optional, thay could also be specified in request params.
+**Settings**
 
-```ruby
-# sandbox or production
-TapPay.mode = :sandbox
+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
 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: {
@@ -53,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
 ```
@@ -67,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,
@@ -74,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
 ```
@@ -88,14 +125,47 @@ 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
 ```
+
+### Card
+```ruby
+# bind
+params = {
+  prime: 'test_3a2fb2b7e892b914a03c95dd4dd5dc7970c908df67a49527c0a648b2bc9',
+  merchant_id: 'your_merchant_id',
+  currency: 'TWD',
+  cardholder: {
+        phone_number: "+886923456789",
+        name: "Jane Doe",
+        email: "Jane@Doe.com",
+        zip_code: "12345",
+        address: "123 1st Avenue, City, Country",
+        national_id: "A123456789"
+  }
+}
+
+TapPay::Card.bind(params) do |res|
+  res
+end
+
+# remove
+params = {
+  card_key: "your_card_key",
+  card_token: "your_card_token"
+}
+
+TapPay::Card.remove(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

@@ -1,55 +1,49 @@
-require "tappay/version"
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'tappay/version'
 
 require 'tappay/request'
-require 'tappay/api_resource'
-require 'tappay/pay_by_prime'
-require 'tappay/pay_by_token'
-require 'tappay/refund'
+require 'tappay/api_resources'
+require 'tappay/card'
+require 'tappay/payment'
+require 'tappay/transaction'
 
 module TapPay
-  @@mode = :sandbox
-  @@partner_key = ''
-  @@merchant_id = ''
+  VALID_MODES = [:sandbox, :production].freeze
+
+  @mode        = :sandbox
+  @app_id      = ''
+  @app_key     = ''
+  @partner_key = ''
 
   class << self
+    extend Forwardable
+    def_delegators TapPay::Payment, :pay_by_prime, :pay_by_token
+    def_delegators TapPay::Transaction, :refund
+
     def setup
       yield(self)
     end
 
     def mode=(mode)
-      @@mode = mode
-    end
+      unless VALID_MODES.include?(mode)
+        raise ArgumentError, "Invalid mode! mode must be one of `#{VALID_MODES}`"
+      end
 
-    def partner_key=(partner_key)
-      @@partner_key = partner_key.to_s
+      @mode = mode
     end
 
-    def merchant_id=(merchant_id)
-      @@merchant_id = merchant_id.to_s
+    def partner_key=(partner_key)
+      @partner_key = partner_key.to_s
     end
 
     def mode
-      @@mode
+      @mode
     end
 
     def partner_key
-      @@partner_key
-    end
-
-    def merchant_id
-      @@merchant_id
-    end
-
-    def pay_by_prime(payload, &block)
-      TapPay::PayByPrime.call(payload, &block)
-    end
-
-    def pay_by_token(payload, &block)
-      TapPay::PayByToken.call(payload, &block)
-    end
-
-    def refund(payload, &block)
-      TapPay::Refund.call(payload, &block)
+      @partner_key
     end
   end
 end

data/lib/tappay/api_resources.rb

@@ -0,0 +1,44 @@
+module TapPay
+  module APIResources
+    CARD = [
+      'bind',
+      'remove'
+    ].freeze
+
+    PAYMENT = [
+      'pay_by_prime',
+      'pay_by_token'
+    ].freeze
+
+    TRANSACTION = [
+      'cap',
+      'query',
+      'refund',
+      'trade_history'
+    ].freeze
+
+    def base_url
+      if TapPay.mode == :production
+        'https://prod.tappaysdk.com'.freeze
+      else
+        'https://sandbox.tappaysdk.com'.freeze
+      end
+    end
+
+    def class_name
+      self.name.split("::")[-1]
+    end
+
+    def resource_url(resource_name)
+      "#{base_url}/tpc/#{class_name.downcase}/#{resource_name.gsub('_', '-')}"
+    end
+
+    def generate_resources
+      TapPay::APIResources.const_get(class_name.upcase).each do |resource|
+        define_singleton_method(resource) do |params, &block|
+          TapPay::Request.post(resource_url(resource), params, &block)
+        end
+      end
+    end
+  end
+end

data/lib/tappay/card.rb

@@ -0,0 +1,7 @@
+module TapPay
+  class Card
+    extend TapPay::APIResources
+
+    generate_resources
+  end
+end

data/lib/tappay/payment.rb

@@ -0,0 +1,7 @@
+module TapPay
+  class Payment
+    extend TapPay::APIResources
+
+    generate_resources
+  end
+end

data/lib/tappay/request.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 
 module TapPay
   class Request
-    def self.send(url, params = {}, &block)
+    def self.post(url, params = {}, &block)
       payload = default_params.merge(params).to_json
       uri     = URI(url)
       req     = Net::HTTP::Post.new(uri)
@@ -22,8 +24,7 @@ module TapPay
 
     def self.default_params
       {
-        partner_key: TapPay.partner_key,
-        merchant_id: TapPay.merchant_id
+        partner_key: TapPay.partner_key
       }
     end
 

data/lib/tappay/transaction.rb

@@ -0,0 +1,7 @@
+module TapPay
+  class Transaction
+    extend TapPay::APIResources
+
+    generate_resources
+  end
+end

data/lib/tappay/version.rb

@@ -1,3 +1,3 @@
 module TapPay
-  VERSION = "0.4.1"
+  VERSION = "2.0.0"
 end

data/tappay.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "webmock", "~> 3.8"
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tappay
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - HzChris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 description: A very simple TapPay API wrapper for ruby. Currently support pay_by_prime,
   pay_by_token and refund.
 email:
@@ -74,9 +74,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,11 +85,11 @@ files:
 - bin/console
 - bin/setup
 - lib/tappay.rb
-- lib/tappay/api_resource.rb
-- lib/tappay/pay_by_prime.rb
-- lib/tappay/pay_by_token.rb
-- lib/tappay/refund.rb
+- lib/tappay/api_resources.rb
+- lib/tappay/card.rb
+- lib/tappay/payment.rb
 - lib/tappay/request.rb
+- lib/tappay/transaction.rb
 - lib/tappay/version.rb
 - tappay.gemspec
 homepage: https://github.com/hzchirs/tappay-ruby
@@ -103,15 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A very simple TapPay API wrapper for ruby.

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.1

data/lib/tappay/api_resource.rb

@@ -1,23 +0,0 @@
-module TapPay
-  module APIResource
-    def self.base_url
-      if TapPay.mode == :production
-        'https://prod.tappaysdk.com'
-      else
-        'https://sandbox.tappaysdk.com'
-      end
-    end
-
-    def self.pay_by_prime_url
-      "#{base_url}/tpc/payment/pay-by-prime"
-    end
-
-    def self.pay_by_token_url
-      "#{base_url}/tpc/payment/pay-by-token"
-    end
-
-    def self.refund_url
-      "#{base_url}/tpc/transaction/refund"
-    end
-  end
-end

data/lib/tappay/pay_by_prime.rb

@@ -1,7 +0,0 @@
-module TapPay
-  class PayByPrime
-    def self.call(params = {}, &block)
-      TapPay::Request.send(TapPay::APIResource.pay_by_prime_url, params, &block)
-    end
-  end
-end

data/lib/tappay/pay_by_token.rb

@@ -1,7 +0,0 @@
-module TapPay
-  class PayByToken
-    def self.call(params = {}, &block)
-      TapPay::Request.send(TapPay::APIResource.pay_by_token_url, params, &block)
-    end
-  end
-end

data/lib/tappay/refund.rb

@@ -1,7 +0,0 @@
-module TapPay
-  class Refund
-    def self.call(params = {}, &block)
-      TapPay::Request.send(TapPay::APIResource.refund_url, params, &block)
-    end
-  end
-end