mandarin-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc79f7e44ae3ead104e122e209f53cbf4a92f096
-  data.tar.gz: 99aac970640a5b9a2460868c05813833e8386bf5
+  metadata.gz: 1643d81e6774e7c811abcf111b636a289aa8839a
+  data.tar.gz: 63300bd786765890c7111e1d8d820c3d5fbe2558
 SHA512:
-  metadata.gz: c8fa1db3f95586312fc2d34c8ff53f60619364545dd8eabce526102edba61ce05ccb54a465deca925cbbaa2275441ee127c3140f2b053ad36028a5810757fc41
-  data.tar.gz: 637e953fab1122831321a5a862fbcc0d0839d7ba28d823476dd07ef3d12c3b3dc432dbe7cebedecc5f6be60e136cd116b816b81b521631874f1748495a05dcd4
+  metadata.gz: 122c5becef312f7e3a912e6c507dfb73b35e7a967acf70609996d6187c05989fc415344277b92ed964a6a4ac85c45d3c26c2aa19fedb0aa476420f19bace4817
+  data.tar.gz: 8be0eb3138d8d5fc5e176d9b84cad6ac4e36e8df9d6bd4b5a80255ae6087f325ab6ec64d5cddec7ce104f860add2275d63e0660a670574112818ec0b80c9a913

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mandarin-api (0.1.1)
+    mandarin-api (0.2.0)
       rest-client (>= 2.0, < 3.0)
 
 GEM

data/README.md

@@ -13,12 +13,22 @@ MandarinApi.configure do |config|
   config.request_url = 'https://secure.mandarinpay.com'
 end
 ```
+
+
+
 ###**Example of assigning a card:**
 ```ruby
-MandarinApi.assign_card user
+MandarinApi.assign_card user, urls
 ```
 `user` should be an instance or a Struct, and should respond to `#email` and `#phone` methods
 `#phone` should be serialized, for example '+79091234567' is correctly serialized number.
+`urls` is a hash that passes callback and redirect URLs:
+```ruby
+  {
+    return: 'https://www.your-page-to-return-user-to.com',
+    callback: 'https:/www.your-endpoint-for-callbacks.com'
+  }
+```
 `#assign_card` will return a hash.
 ###**Example:**
 ```ruby
@@ -30,6 +40,8 @@ MandarinApi.assign_card user
 ```
 Keep id, it will be used for pay/payouts requests. Use userWebLink to redirect user to Mandarin page for card data input.
 
+
+
 ###**Example of oneway card binding:**
 ```ruby
 MandarinApi.oneway_assign_card user, card_number
@@ -47,12 +59,14 @@ Keep id, it will be used for pay/payouts requests. Use userWebLink to redirect u
 Oneway binded card can only be used for payouts.
 
 
+
 ###**Example of performing payment:**
 ```ruby
 # order_id - id of order/bill, etc. in your system.
 # amount - sum of payout
 # assigned_card_uuid - the id you received assigning the card
-MandarinApi.payment(order_id, amount, assigned_card_uuid)
+# extra - an hash to keep your additional data
+MandarinApi.payment(order_id, amount, assigned_card_uuid, extra)
 ```
 `#payment` will return a hash with transaction id.
 ###**Example:**
@@ -60,12 +74,15 @@ MandarinApi.payment(order_id, amount, assigned_card_uuid)
 { 'id' => '721a5185314740aaa304278fb1d8ee63' }
 ```
 
+
+
 ###**Example of performing payout:**
 ```ruby
 # order_id - id of order/bill, etc. in your system.
 # amount - sum of payout
 # assigned_card_uuid - the id you received assigning the card
-MandarinApi.payout(order_id, amount, assigned_card_uuid)
+# extra - an hash to keep your additional data
+MandarinApi.payout(order_id, amount, assigned_card_uuid, extra)
 ```
 `#payout` will return a hash with transaction id.
 ###**Example:**
@@ -73,14 +90,27 @@ MandarinApi.payout(order_id, amount, assigned_card_uuid)
 { 'id' => '721a5185314740aaa304278fb1d8ee63' }
 ```
 
+
+
 ###**Example of charging user without card binding**
 ```ruby
 # order_id - id of order/bill, etc. in your system.
 # amount - sum of payout
-MandarinApi.charge(order_id, amount, user)
+MandarinApi.charge(order_id, amount, user, optional)
 ```
 `user` should be an instance or a Struct, and should respond to `#email` and `#phone` methods
 `#phone` should be serialized, for example '+79091234567' is correctly serialized number.
+`optional` is an hash to keep URLs, data visible on Mandarin page, and your technical data:
+```ruby
+{
+  urls: {
+    return: 'https://www.your-page-to-return-user-to.com',
+    callback: 'https:/www.your-endpoint-for-callbacks.com'
+  },
+  visible: { a: 'This value will be visible during payment process on Mandarin page' },
+  invisible: { some_additional_id: 12} # this value won't be visible and will be returned in callback
+}
+```
 `#charge` will return a hash.
 ###**Example:**
 ```ruby
@@ -91,6 +121,8 @@ MandarinApi.charge(order_id, amount, user)
 }
 ```
 
+
+
 ###**Example of performing refund:**
 ```ruby
 # order_id - id of order/bill, etc. in your system.
@@ -103,6 +135,8 @@ MandarinApi.refund(order_id, transaction_uuid)
 { 'id' => '721a5185314740aaa304278fb1d8ee63' }
 ```
 
+
+
 ###**Example of performing rebill:**
 ```ruby
 # order_id - id of order/bill, etc. in your system.
@@ -117,6 +151,7 @@ MandarinApi.rebill(order_id, amount, transaction_uuid)
 ```
 
 
+
 You will have to provide a link to receive callbacks from Mandarin.
 MandarinApi.process_callback takes as arguments body of a callback serialized
 to hash with symbolized keys and an instance with `#success` and `#failure` methods,

data/lib/mandarin_api.rb

@@ -5,33 +5,35 @@ module MandarinApi
     attr_accessor :config
   end
 
-  def self.assign_card(user)
-    MandarinApi::CardManager.new.assign_card user
+  def self.assign_card(user, urls = {})
+    MandarinApi::CardManager.new.assign_card user, urls
   end
 
   def self.oneway_assign_card(user, card)
     MandarinApi::CardManager.new.one_side_assign_card user, card
   end
 
-  def self.charge(order_id, amount, user)
+  def self.charge(order_id, amount, user, extra = {})
     params = {
-      order_id: order_id, amount: amount, email: user.email, phone: user.phone
+      order_id: order_id, amount: amount, email: user.email, phone: user.phone,
+      urls: extra[:urls], custom_values: extra[:visible],
+      extra: extra[:invisible]
     }
     MandarinApi::PaymentManager.new.perform_charge params
   end
 
-  def self.pay(order_id, amount, assigned_card_uuid)
+  def self.pay(order_id, amount, assigned_card_uuid, extra = {})
     params = {
-      order_id: order_id, amount: amount,
+      order_id: order_id, amount: amount, extra: extra,
       assigned_card_uuid: assigned_card_uuid
     }
     MandarinApi::PaymentManager.new.perform_payment params
   end
 
-  def self.payout(order_id, amount, assigned_card_uuid)
+  def self.payout(order_id, amount, assigned_card_uuid, extra = {})
     params = {
       order_id: order_id, amount: amount,
-      assigned_card_uuid: assigned_card_uuid
+      assigned_card_uuid: assigned_card_uuid, extra: extra
     }
     MandarinApi::PaymentManager.new.perform_payout params
   end
@@ -43,8 +45,7 @@ module MandarinApi
 
   def self.rebill(order_id, amount, transaction_uuid)
     params = {
-      order_id: order_id, amount: amount,
-      transaction_uuid: transaction_uuid
+      order_id: order_id, amount: amount, transaction_uuid: transaction_uuid
     }
     MandarinApi::PaymentManager.new.perform_rebill params
   end

data/lib/mandarin_api/card_manager.rb

@@ -2,8 +2,9 @@
 module MandarinApi
   # Manages cards assignment
   class CardManager
-    def assign_card(user)
+    def assign_card(user, urls)
       params = { customer_info: { email: user.email, phone: phone(user) } }
+      params[:urls] = urls unless urls.empty?
       MandarinApi::Wrapper.new(merchant_id: MandarinApi.config.merchant_id,
                                secret: MandarinApi.config.secret)
                           .request('/api/card-bindings', params)

data/lib/mandarin_api/payment_manager.rb

@@ -32,18 +32,23 @@ module MandarinApi
     end
 
     def normal_request_body(params, action)
-      {
+      body = {
         payment: payment(params, action),
-        target: { card: params[:assigned_card_uuid] }
+        target: { card: params[:assigned_card_uuid] },
       }
+      body[:extra] = systemize(params[:extra]) unless params[:extra].empty?
+      body
     end
 
     def charge_request_body(params, action)
-      {
+      body = {
         payment: payment(params, action),
-        customer_info: { email: params[:email], phone: phone(params[:phone]) },
-        custom_values: []
+        customer_info: { email: params[:email], phone: phone(params[:phone]) }
       }
+      body[:custom_values] = systemize(params[:custom_values]) if params[:custom_values]
+      body[:urls] = params[:urls] if params[:urls]
+      body[:extra] = systemize(params[:extra]) if params[:extra]
+      body
     end
 
     def refund_request_body(params, action)
@@ -64,6 +69,14 @@ module MandarinApi
       { order_id: params[:order_id], action: action, price: params[:amount] }
     end
 
+    def systemize(options)
+      result = []
+      options.each do |key, value|
+        result << { name: key.to_s, value: value }
+      end
+      result
+    end
+
     def phone(phone)
       if phone.nil?
         '+70000000000'

data/lib/mandarin_api/wrapper.rb

@@ -45,6 +45,8 @@ module MandarinApi
       hash.keys.each do |key|
         new_hash[camelize(key.to_s)] = if hash[key].class == Hash
                                          key_transform hash[key]
+                                       elsif hash[key].class == Array
+                                         hash[key].map { |e| key_transform e }
                                        else
                                          hash[key]
                                        end

data/mandarin-api.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |s|
   s.name = 'mandarin-api'
-  s.version = '0.1.1'
+  s.version = '0.2.0'
   s.authors = ['Vladimir Bogaevsky']
   s.email = 'gitvbogaevsky@gmail.com'
   s.licenses = ['MIT']

data/spec/lib/mandarin_api/card_manager_spec.rb

@@ -3,11 +3,22 @@ RSpec.describe MandarinApi::CardManager do
   let(:merchant_id) { 234 }
   let(:secret) { 'secret' }
   let(:user) { User.new('ololo@gmail.com', '8-909-999-88-77') }
+  let(:urls) do
+    {
+      return: 'https://www.ololol.com',
+      callback: 'https://www.ololol.com/callbacks'
+    }
+  end
 
   User = Struct.new('User', :email, :phone)
   describe 'assign_card' do
     let(:params) do
-      { customer_info: { email: 'ololo@gmail.com', phone: '+79099998877' } }
+      { customer_info: { email: 'ololo@gmail.com', phone: '+79099998877' },
+        urls: {
+          return: 'https://www.ololol.com',
+          callback: 'https://www.ololol.com/callbacks'
+        }
+      }
     end
     it 'calls wrapper instance with args' do
       allow(MandarinApi).to \
@@ -18,7 +29,7 @@ RSpec.describe MandarinApi::CardManager do
         .with('/api/card-bindings', params)
       expect_any_instance_of(MandarinApi::Wrapper).to receive(:request)
         .with('/api/card-bindings', params)
-      card_manager.assign_card user
+      card_manager.assign_card user, urls
     end
   end
 

data/spec/lib/mandarin_api/payment_manager_spec.rb

@@ -6,30 +6,36 @@ RSpec.describe MandarinApi::PaymentManager do
   let(:params) do
     {
       order_id: 123_321, amount: 35_000,
-      assigned_card_uuid: '0eb51e74-e704-4c36-b5cb-8f0227621518'
+      assigned_card_uuid: '0eb51e74-e704-4c36-b5cb-8f0227621518',
+      extra: { a: 'A', b: 'B' }
     }
   end
   let(:normal_request_body) do
     {
       payment: { order_id: 123_321, action: action, price: 35_000 },
-      target: { card: '0eb51e74-e704-4c36-b5cb-8f0227621518' }
+      target: { card: '0eb51e74-e704-4c36-b5cb-8f0227621518' },
+      extra: [{ name: 'a', value: 'A' }, { name: 'b', value: 'B' }]
     }
   end
   let(:charge_request_body) do
     {
       payment: { order_id: 123_321, action: action, price: 35_000 },
       customer_info: { email: email, phone: phone },
-      custom_values: []
+      custom_values: [{ name: 'a', value: 'A'}, { name: 'b', value: 'B' }],
+      extra: [{ name: 'one', value: 'One'}, { name: 'two', value: 'Two' }],
+      urls: { callback: 'callback', return: 'return' }
     }
   end
+
   describe '#perform_charge' do
     let(:email) { Faker::Internet.free_email }
     let(:phone) { "+7#{Faker::Number.between(100_000_000, 999_999_999)}" }
     let(:action) { 'pay' }
     let(:params) do
       {
-        order_id: 123_321, amount: 35_000,
-        email: email, phone: phone, custom_values: []
+        order_id: 123_321, amount: 35_000, email: email, phone: phone,
+        custom_values: { a: 'A', b: 'B' }, extra: { one: 'One', two: 'Two' },
+        urls: { callback: 'callback', return: 'return' }
       }
     end
     it 'calls wrapper instance with args' do

data/spec/lib/mandarin_api/wrapper_spec.rb

@@ -46,7 +46,8 @@ RSpec.describe MandarinApi::Wrapper do
         },
         big_key_two: {
           key_a: 'a', key_b: 'b'
-        }
+        },
+        a_r_r_a_y: [{ name: 'a_key', value: 'a' }]
       }
     end
     let(:output) do
@@ -56,7 +57,8 @@ RSpec.describe MandarinApi::Wrapper do
         },
         'bigKeyTwo' => {
           'keyA' => 'a', 'keyB' => 'b'
-        }
+        },
+        'aRRAY' => [{ 'name' => 'a_key', 'value' => 'a' }]
       }
     end
     it 'input: multilevel hash with underscored keys-symbols, ' \

data/spec/mocks.rb

@@ -9,7 +9,8 @@ RSpec.shared_context 'mocks', shared_contex: :metadata do
     payout_body =
       JSON.generate(
         payment: { orderId: 123_321, action: 'payout', price: 35_000 },
-        target: { card: '0eb51e74-e704-4c36-b5cb-8f0227621518' }
+        target: { card: '0eb51e74-e704-4c36-b5cb-8f0227621518' },
+        customValues: [{ name: 'a', value: 'A' }, {name: 'b', value: 'B' }]
       )
     header = {
       'Accept' => '*/*', 'Accept-Encoding' => 'gzip, deflate',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandarin-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladimir Bogaevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock