nihaopay-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e27c0c50ef8f7cec23c8f238997b05a684e3112
-  data.tar.gz: 49ae05f6f7d2c446ff854fe3bd038ea7f6546568
+  metadata.gz: b7b4c64acc91099c56a7c9aa62ead290eeeb578b
+  data.tar.gz: d93246938e0dcfda73a733ea91ab71acb94a0be8
 SHA512:
-  metadata.gz: e2db81aac7112fa455519986ff3abb16ada295a9029468d6279be5de21b83b963721c0da77bcc4de26e6d6f0f60e57458ba789ab7656a828ae6fa550c473b66f
-  data.tar.gz: 1d178cb769e8462af6f0d4ccd7b85f6287e0608e480c18d099925f5823a017508a22e4a36e399fd562d86772504c2e48ce88049a8d89ad37e90074a33f9e5cec
+  metadata.gz: cd977863d45dadb49ea0a0035a32835cd28533e40931d68df91cc4a9ff9677e1c5a129e0c333a3308575ca48d493fce93fd935e08b63bbe92e1e95dba2093c2a
+  data.tar.gz: d90b8510e72895eb4864f4e04c2066fa4db41dab443834a5202ce89b99cf0d7d57f7c6c84d07808c28be995128779969993d9971cf01de60400e13b05623a144

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.1
+
+* API Addition: Allow sub_mid parameter (@JagdeepSingh)
+
 ## 0.2.0
 
 * API Change: Time should be returned as a Ruby time object (@JagdeepSingh)

data/README.md

@@ -20,7 +20,7 @@ and run `bundle install`
 
 Add a file *config/initializers/nihaopay.rb*.
 
-``` ruby
+```ruby
 Nihaopay.configure do |nihaopay|
   nihaopay.test_mode = true
   nihaopay.token = <your-merchant-token>
@@ -121,7 +121,7 @@ response = merchant.wechat_pay(amount, currency, options)
 
 You need the credit card details for initiating the transaction. You can build the credit card object as below:
 
-``` ruby
+```ruby
 credit_card = Nihaopay::CreditCard.new(
                 number: '6221558812340000',
                 expiry_year: 2017,
@@ -133,13 +133,13 @@ Acceptable values for `expiry_month` are `01` through `12`.
 
 Now initiate the transaction using above credit card.
 
-``` ruby
+```ruby
 express_pay = Nihaopay::Transactions::Authorize.start(amount, credit_card)
 ```
 
 This returns an instance of `Nihaopay::Transactions::ExpressPay` on which you can access following methods:
 
-``` ruby
+```ruby
 express_pay.transaction_id   # => "20160714132438002485"
 express_pay.status           # => "success"
 express_pay.reference        # => "3461fcc31aec471780ad1a4dc6111947"
@@ -153,7 +153,7 @@ Other methods available are `note` and `time`.
 
 #### Purchase transaction on ExpressPay
 
-``` ruby
+```ruby
 express_pay = Nihaopay::Transactions::Purchase.start(amount, credit_card)
 ```
 
@@ -163,18 +163,21 @@ This again returns an instance of `Nihaopay::Transactions::ExpressPay`.
 
 For `authorize` and `purchase`, you can pass `currency`, `description`, `note`, and `reference` as options.
 
-``` ruby
+```ruby
 express_pay = Nihaopay::Transactions::Authorize.start(amount, credit_card, { currency: 'USD',
                                                                              description: 'Your order description',
                                                                              note: 'Something to remember',
-                                                                             reference: 'A unique alphanumeric string' })
+                                                                             reference: 'A unique alphanumeric string',
+                                                                             sub_mid: 'unique ID for nihaopay merchant' })
 ```
 
 Acceptable currency codes are 'USD' and 'JPY'.
 
+The option `sub_mid` will be passed as a JSON string `{reserved: "{\"sub_mid\":\"XXX\"}" }` in the params. All the different types of ExpressPay transactions accept this option.
+
 #### Capture a transaction
 
-``` ruby
+```ruby
 captured = express_pay.capture
 captured.transaction_id           # => "20160718111604002633"
 captured.status                   # => "success"
@@ -185,7 +188,7 @@ captured.time                     # => 2017-01-18 12:08:42 +0900
 
 If you want to capture a partial amount, you can do:
 
-``` ruby
+```ruby
 captured = express_pay.partial_capture(amount)
 ```
 
@@ -195,7 +198,7 @@ Authorizations not captured within 30 days are automatically released and cannot
 
 Release an uncaptured transaction.
 
-``` ruby
+```ruby
 released = express_pay.release
 released.transaction_id           # => "20160718111604002633"
 released.status                   # => "success"
@@ -206,7 +209,7 @@ released.time                     # => 2017-01-18 12:08:42 +0900
 
 #### Cancel a transaction
 
-``` ruby
+```ruby
 cancelled = express_pay.cancel
 cancelled.transaction_id            # => "20160718111604002633"
 cancelled.status                    # => "success"
@@ -224,33 +227,33 @@ Transactions can only be cancelled before the daily settlement deadline. Transac
 
 Only SecurePay, ExpressPay, and Captured transactions can be returned. For details on Released, Cancelled, and Refunded transactions, please navigate to the [TMS](https://tms.nihaopay.com). Transactions are returned with the most recent transactions appearing first.
 
-``` ruby
+```ruby
 transactions = Nihaopay::Transactions::Base.fetch
 ```
 
 By default, only 10 transactions are returned at a time. This can be adjusted by calling `limit` before `fetch`. `limit` can range between 1 and 100.
 
-``` ruby
+```ruby
 transactions = Nihaopay::Transactions::Base.limit(5).fetch
 ```
 
 To retrieve transactions that were processed after the specified time, you can all `after` with `Time` object.
 
-``` ruby
+```ruby
 yesterday = Time.now - 24 * 60 * 60
 transactions = Nihaopay::Transactions::Base.after(yesterday).fetch
 ```
 
 Similarly, you can fetch the transactions that were processed before the specified time.
 
-``` ruby
+```ruby
 yesterday = Time.now - 24 * 60 * 60
 transactions = Nihaopay::Transactions::Base.before(yesterday).fetch
 ```
 
 You can chain methods to use multiple options:
 
-``` ruby
+```ruby
 yesterday = Time.now - 24 * 60 * 60
 week_ago = Time.now - 7 * 24 * 60 * 60
 transactions = Nihaopay::Transactions::Base.before(yesterday)
@@ -262,7 +265,7 @@ OR
 
 you can pass the options to `fetch`:
 
-``` ruby
+```ruby
 yesterday = Time.now - 24 * 60 * 60
 week_ago = Time.now - 7 * 24 * 60 * 60
 transactions = Nihaopay::Transactions::Base.fetch(before: yesterday,
@@ -274,7 +277,7 @@ transactions = Nihaopay::Transactions::Base.fetch(before: yesterday,
 
 Provide a unique transaction ID that was returned from a previous response in order to retrieve corresponding transaction’s details.
 
-``` ruby
+```ruby
 transaction = Nihaopay::Transactions::Base.find(transaction_id)
 transaction.transaction_id  # => "20160718111604002633"
 transaction.type            # => "charge"
@@ -289,7 +292,7 @@ Only SecurePay (UnionPay and AliPay), ExpressPay, and Captured transaction detai
 
 Full refunds can only be created once per transaction.
 
-``` ruby
+```ruby
 refunded = express_pay.refund
 refunded.transaction_id            # => "20160718111604002633"
 refunded.status                    # => "success"
@@ -300,13 +303,13 @@ refunded.time                      # => 2017-01-18 12:08:42 +0900
 
 You can pass a `reason` when refunding a transaction:
 
-``` ruby
+```ruby
 refunded = express_pay.refund(reason: 'Out of stock')
 ```
 
 Partial refunds can be created multiple times up to the amount of the Transaction.
 
-``` ruby
+```ruby
 refunded = express_pay.partial_refund(amount)
 refunded = express_pay.partial_refund(amount, reason: 'Cancellation fee')
 ```
@@ -315,7 +318,7 @@ refunded = express_pay.partial_refund(amount, reason: 'Cancellation fee')
 
 If you have multiple merchants configured to the Nihaopay payment gateway, they will have different tokens each. You can do transactions per merchant as below:
 
-``` ruby
+```ruby
 merchant_token = "6c4dc4828474fa73c5f438a9eb2fbf3092e44"
 nihaopay_merchant = Nihaopay::Merchant.new(merchant_token)
 express_pay = nihaopay_merchant.authorize(amount, credit_card)
@@ -323,15 +326,15 @@ express_pay = nihaopay_merchant.authorize(amount, credit_card)
 
 OR
 
-``` ruby
+```ruby
 express_pay = nihaopay_merchant.authorize(amount, credit_card, options)
 ```
 
-`options` may include `currency`, `description`, `reference`, and `note`.
+`options` may include `currency`, `description`, `reference`, `note`, and `sub_mid`.
 
 Similarly, you can do other transactions directly on `Nihaopay::Merchant` object:
 
-``` ruby
+```ruby
 # capture
 express_pay = nihaopay_merchant.capture(transaction_id, amount, currency)
 
@@ -342,7 +345,7 @@ express_pay = nihaopay_merchant.purchase(amount, credit_card, options)
 # release
 express_pay = nihaopay_merchant.release(transaction_id)
 
-#refund
+# refund
 express_pay = nihaopay_merchant.refund(transaction_id, amount, currency)
 express_pay = nihaopay_merchant.refund(transaction_id, amount, currency, reason: 'Cancellation fee')
 ```

data/lib/nihaopay-ruby.rb

@@ -19,8 +19,8 @@ require 'nihaopay/secure_pay/we_chat_pay'
 
 require 'nihaopay/transactions/base'
 require 'nihaopay/transactions/authorize'
-require 'nihaopay/transactions/cancel'
 require 'nihaopay/transactions/capture'
+require 'nihaopay/transactions/cancel'
 require 'nihaopay/transactions/purchase'
 require 'nihaopay/transactions/refund'
 require 'nihaopay/transactions/release'

data/lib/nihaopay/merchant.rb

@@ -26,8 +26,9 @@ module Nihaopay
       Nihaopay::Transactions::Authorize.start(amount, credit_card, options)
     end
 
-    def capture(transaction_id, amount, currency)
-      Nihaopay::Transactions::Capture.start(transaction_id, amount, currency, token: token)
+    def capture(transaction_id, amount, currency, options = {})
+      options[:token] = token
+      Nihaopay::Transactions::Capture.start(transaction_id, amount, currency, options)
     end
 
     def purchase(amount, credit_card, options = {})
@@ -35,8 +36,9 @@ module Nihaopay
       Nihaopay::Transactions::Purchase.start(amount, credit_card, options)
     end
 
-    def release(transaction_id)
-      Nihaopay::Transactions::Release.start(transaction_id, token: token)
+    def release(transaction_id, options = {})
+      options[:token] = token
+      Nihaopay::Transactions::Release.start(transaction_id, options)
     end
 
     def refund(transaction_id, amount, currency, options = {})

data/lib/nihaopay/transactions/authorize.rb

@@ -20,6 +20,7 @@ module Nihaopay
           params.merge! Nihaopay::HashUtil.slice(options, *valid_options)
           params[:capture] = capture_param
           params[:amount] = amount
+          params[:reserved] = { 'sub_mid' => options[:sub_mid].to_s }.to_json if options.key?(:sub_mid)
           params[:currency] ||= Nihaopay.currency
           params
         end

data/lib/nihaopay/transactions/cancel.rb

@@ -1,13 +1,14 @@
 module Nihaopay
   module Transactions
-    class Cancel < Base
+    class Cancel < Capture
       attr_accessor :cancelled, :cancel_transaction_id
 
       class << self
         def start(transaction_id, options = {})
           @token = options.delete(:token)
           url = request_url(transaction_id)
-          response = HTTParty.post(url, headers: request_headers, body: request_body)
+          params = request_params(options)
+          response = HTTParty.post(url, headers: request_headers, body: request_body(params))
           build_from_response!(response)
         end
 
@@ -15,6 +16,10 @@ module Nihaopay
           "#{base_url}/transactions/#{transaction_id}/cancel"
         end
 
+        def valid_options
+          []
+        end
+
         def valid_attributes
           %i(transaction_id status cancelled cancel_transaction_id time)
         end

data/lib/nihaopay/transactions/capture.rb

@@ -7,8 +7,8 @@ module Nihaopay
         def start(transaction_id, amount, currency, options = {})
           @token = options.delete(:token)
           url = request_url(transaction_id)
-          params = request_body(amount: amount, currency: currency)
-          response = HTTParty.post(url, headers: request_headers, body: params)
+          params = request_params(options.merge(amount: amount, currency: currency))
+          response = HTTParty.post(url, headers: request_headers, body: request_body(params))
           build_from_response!(response)
         end
 
@@ -16,6 +16,16 @@ module Nihaopay
           "#{base_url}/transactions/#{transaction_id}/capture"
         end
 
+        def request_params(options = {})
+          params = Nihaopay::HashUtil.slice(options, *valid_options)
+          params[:reserved] = { 'sub_mid' => options[:sub_mid].to_s }.to_json if options.key?(:sub_mid)
+          params
+        end
+
+        def valid_options
+          %i(amount currency)
+        end
+
         def valid_attributes
           %i(transaction_id status captured capture_transaction_id time)
         end

data/lib/nihaopay/transactions/refund.rb

@@ -1,23 +1,17 @@
 module Nihaopay
   module Transactions
-    class Refund < Base
-      VALID_OPTIONS = %i(reason).freeze
-
+    class Refund < Capture
       attr_accessor :refunded, :refund_transaction_id
 
       class << self
-        def start(transaction_id, amount, currency, options = {})
-          @token = options.delete(:token)
-          url = request_url(transaction_id)
-          params = Nihaopay::HashUtil.slice(options, *VALID_OPTIONS).merge(amount: amount, currency: currency)
-          response = HTTParty.post(url, headers: request_headers, body: request_body(params))
-          build_from_response!(response)
-        end
-
         def request_url(transaction_id)
           "#{base_url}/transactions/#{transaction_id}/refund"
         end
 
+        def valid_options
+          super | %i(reason)
+        end
+
         def valid_attributes
           %i(transaction_id status refunded refund_transaction_id time)
         end

data/lib/nihaopay/transactions/release.rb

@@ -1,16 +1,9 @@
 module Nihaopay
   module Transactions
-    class Release < Base
+    class Release < Cancel
       attr_accessor :released, :release_transaction_id
 
       class << self
-        def start(transaction_id, options = {})
-          @token = options.delete(:token)
-          url = request_url(transaction_id)
-          response = HTTParty.post(url, headers: request_headers, body: request_body)
-          build_from_response!(response)
-        end
-
         def request_url(transaction_id)
           "#{base_url}/transactions/#{transaction_id}/release"
         end

data/lib/nihaopay/version.rb

@@ -1,3 +1,3 @@
 module Nihaopay
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/spec/transactions/authorize_spec.rb

@@ -103,6 +103,22 @@ describe Nihaopay::Transactions::Authorize do
       end
     end
 
+    context 'with :sub_mid in options' do
+      let(:options) { { sub_mid: 'foobar' } }
+      let(:body) do
+        'card_number=6221558812340000'\
+        '&card_exp_year=17'\
+        '&card_exp_month=11'\
+        '&card_cvv=123'\
+        '&capture=false'\
+        '&amount=1000'\
+        '&reserved={"sub_mid":"foobar"}'\
+        '&currency=USD'
+      end
+      it { expect(HTTParty).to receive(:post).with(url, headers: headers, body: body) }
+      after { described_class.start(1000, cc, options) }
+    end
+
     describe '.build_from_response!' do
       it 'should return transaction object' do
         txn = described_class.start(1000, cc)

data/spec/transactions/capture_spec.rb

@@ -61,6 +61,13 @@ describe Nihaopay::Transactions::Capture do
       end
     end
 
+    context 'with :sub_mid in options' do
+      let(:options) { { sub_mid: 'foobar' } }
+      let(:body) { 'amount=1000&currency=JPY&reserved={"sub_mid":"foobar"}' }
+      it { expect(HTTParty).to receive(:post).with(url, headers: headers, body: body) }
+      after { described_class.start('1111', 1000, 'JPY', options) }
+    end
+
     describe '.build_from_response!' do
       it 'should return transaction object' do
         txn = described_class.start('1111', 1000, 'JPY')

data/spec/transactions/refund_spec.rb

@@ -50,7 +50,7 @@ describe Nihaopay::Transactions::Refund do
 
     context 'with options' do
       let(:options) { { reason: 'out of stock' } }
-      let(:body) { 'reason=out of stock&amount=1000&currency=JPY' }
+      let(:body) { 'amount=1000&currency=JPY&reason=out of stock' }
       it { expect(HTTParty).to receive(:post).with(url, headers: headers, body: body) }
       after { described_class.start('1111', 1000, 'JPY', options) }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nihaopay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - JagdeepSingh
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement