mangopay 3.0.19 → 3.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b83a705cc7f7ea7dd6954de6b6b0ff58f44c5170
-  data.tar.gz: 3d8eaabef7fce1e401810458ec9010366a5832c3
+  metadata.gz: 59eb15c892bf9c2910edac5e22503bfcf6b9dcac
+  data.tar.gz: 8457994e7e6dc82e85c826846b2f5406a484e729
 SHA512:
-  metadata.gz: 1bf56bfe55dfdec69bd83df86a5fe9be1d758af762d5f2c96674b0dd988242ecd85058493013ee8c584b4648311c3aa610bec1304d8da1856139b2167aacb4b4
-  data.tar.gz: 5426a2cbec6a3191a4db3253e52dc54f5b3ba5f0f9c8541be07479285d13db7ad421477ec5ebad2a56fa00062b4907471b465d7783f9936f7d821c7f6eb5d10b
+  metadata.gz: 3722786d484342d20e913a2b3836b38b5239603c53225e2816d90995b60c61ef1d8409fd91528cbf98ae0eb7b96446f6070f7c4fef58747c226c2e157042eeb1
+  data.tar.gz: c49c240cf33683a926ee11525c5c20d162c28cf494880feff76cbe57a611e51478708791ee4a8eeda6f7fc63c243d11417f8b841b8491ac6483187b304608ba8

data/lib/mangopay.rb

@@ -74,15 +74,22 @@ module MangoPay
     # - +url+: the part after Configuration#root_url
     # - +params+: hash; entity data for creation, update etc.; will dump it by JSON and assign to Net::HTTPRequest#body
     # - +filters+: hash; pagination params etc.; will encode it by URI and assign to URI#query
-    # - +headers+: hash; request_headers by default
+    # - +headers_or_idempotency_key+: hash of headers; or replaced by request_headers if nil; or added to request_headers as idempotency key otherwise (see https://docs.mangopay.com/api-references/idempotency-support/)
     # - +before_request_proc+: optional proc; will call it passing the Net::HTTPRequest instance just before Net::HTTPRequest#request
     #
     # Raises MangoPay::ResponseError if response code != 200.
     #
-    def request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
+    def request(method, url, params={}, filters={}, headers_or_idempotency_key = nil, before_request_proc = nil)
       uri = api_uri(url)
       uri.query = URI.encode_www_form(filters) unless filters.empty?
 
+      if headers_or_idempotency_key.is_a?(Hash)
+        headers = headers_or_idempotency_key
+      else
+        headers = request_headers
+        headers['Idempotency-Key'] = headers_or_idempotency_key if headers_or_idempotency_key != nil
+      end
+
       res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
         req.body = JSON.dump(params)
@@ -93,7 +100,6 @@ module MangoPay
       # decode json data
       data = JSON.load(res.body.to_s) rescue {}
 
-
       unless res.is_a?(Net::HTTPOK)
         raise MangoPay::ResponseError.new(uri, res.code, data)
       end
@@ -106,6 +112,13 @@ module MangoPay
       data
     end
 
+    # Retrieve a previous response by idempotency_key
+    # See https://docs.mangopay.com/api-references/idempotency-support/
+    def fetch_response(idempotency_key)
+      url = "#{api_path}/responses/#{idempotency_key}"
+      request(:get, url)
+    end
+
     private
 
     def user_agent

data/lib/mangopay/bank_account.rb

@@ -4,9 +4,9 @@ module MangoPay
   class BankAccount < Resource
     include HTTPCalls::Fetch
     class << self
-      def create(user_id, params)
+      def create(user_id, params, idempotency_key = nil)
         type = params.fetch(:Type) { |no_symbol_key| params.fetch('Type') }
-        MangoPay.request(:post, "#{url(user_id)}/#{type}", params)
+        MangoPay.request(:post, "#{url(user_id)}/#{type}", params, {}, idempotency_key)
       end
 
       # Fetches:

data/lib/mangopay/dispute.rb

@@ -51,9 +51,9 @@ module MangoPay
       end
 
       # +params+: hash; see https://docs.mangopay.com/api-references/disputes/settlement-transfers/
-      def create_settlement_transfer(repudiation_id, params)
+      def create_settlement_transfer(repudiation_id, params, idempotency_key = nil)
         url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}/settlementtransfer/"
-        MangoPay.request(:post, url, params)
+        MangoPay.request(:post, url, params, {}, idempotency_key)
       end
       
       #####################################################
@@ -61,9 +61,9 @@ module MangoPay
       #####################################################
 
       # +params+: hash; see https://docs.mangopay.com/api-references/disputes/dispute-documents/
-      def create_document(dispute_id, params)
+      def create_document(dispute_id, params, idempotency_key = nil)
         url = url(dispute_id) + "/documents/"
-        MangoPay.request(:post, url, params)
+        MangoPay.request(:post, url, params, {}, idempotency_key)
       end
 
       def fetch_document(document_id)
@@ -105,7 +105,7 @@ module MangoPay
       # - Base64 encoded file content
       # - or nil: in this case pass the file path in the next param
       #
-      def create_document_page(dispute_id, document_id, file_content_base64, file_path = nil)
+      def create_document_page(dispute_id, document_id, file_content_base64, file_path = nil, idempotency_key = nil)
         if file_content_base64.nil? && !file_path.nil?
           bts = File.open(file_path, 'rb') { |f| f.read }
           file_content_base64 = Base64.encode64(bts)
@@ -113,7 +113,7 @@ module MangoPay
         # normally it returns 204 HTTP code on success
         begin
           url = url(dispute_id) + "/documents/#{document_id}/pages"
-          MangoPay.request(:post, url, {'File' => file_content_base64})
+          MangoPay.request(:post, url, {'File' => file_content_base64}, {}, idempotency_key)
         rescue ResponseError => ex
           raise ex unless ex.code == '204'
         end

data/lib/mangopay/http_calls.rb

@@ -3,9 +3,14 @@ module MangoPay
     module Create
       module ClassMethods
 
-        def create(*id, params)
-          id = id.empty? ? nil : id[0]
-          MangoPay.request(:post, url(id), params)
+        def create(params, id = nil, idempotency_key = nil)
+          # LEGACY SUPPORT FOR OLD SIGNATURE: def create(*id, params)
+          if !params.is_a?(Hash) && id.is_a?(Hash)
+            temp = params
+            params = id
+            id = temp
+          end
+          MangoPay.request(:post, url(id), params, {}, idempotency_key)
         end
       end
 
@@ -67,8 +72,8 @@ module MangoPay
 
         # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-pay-in/
         # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-transfer/
-        def refund(id = nil, params = {})
-          MangoPay.request(:post, url(id) + '/refunds', params)
+        def refund(id = nil, params = {}, idempotency_key = nil)
+          MangoPay.request(:post, url(id) + '/refunds', params, {}, idempotency_key)
         end
       end
 

data/lib/mangopay/kyc_document.rb

@@ -5,8 +5,8 @@ module MangoPay
   # See http://docs.mangopay.com/api-references/kyc/documents/
   class KycDocument < Resource
     class << self
-      def create(user_id, params)
-        MangoPay.request(:post, url(user_id), params)
+      def create(user_id, params, idempotency_key = nil)
+        MangoPay.request(:post, url(user_id), params, {}, idempotency_key)
       end
 
       def update(user_id, document_id, params = {})
@@ -44,14 +44,14 @@ module MangoPay
       # - Base64 encoded file content
       # - or nil: in this case pass the file path in the next param
       #
-      def create_page(user_id, document_id, file_content_base64, file_path = nil)
+      def create_page(user_id, document_id, file_content_base64, file_path = nil, idempotency_key = nil)
         if file_content_base64.nil? && !file_path.nil?
           bts = File.open(file_path, 'rb') { |f| f.read }
           file_content_base64 = Base64.encode64(bts)
         end
         # normally it returns 204 HTTP code on success
         begin
-          MangoPay.request(:post, url(user_id, document_id) + '/pages', {'File' => file_content_base64})
+          MangoPay.request(:post, url(user_id, document_id) + '/pages', {'File' => file_content_base64}, {}, idempotency_key)
         rescue ResponseError => ex
           raise ex unless ex.code == '204'
         end

data/lib/mangopay/pre_authorization.rb

@@ -5,8 +5,8 @@ module MangoPay
     include HTTPCalls::Update
     include HTTPCalls::Fetch
 
-    def self.create(params)
-      MangoPay.request(:post, "#{url}/card/direct", params)
+    def self.create(params, idempotency_key = nil)
+      MangoPay.request(:post, "#{url}/card/direct", params, {}, idempotency_key)
     end
 
   end

data/lib/mangopay/temp.rb

@@ -57,9 +57,9 @@ module MangoPay
       # Received data:
       # Normal card web payin transaction, with the addition of:
       # - PaymentCardId e.g. "322311"
-      def self.immediate_payin(params)
+      def self.immediate_payin(params, idempotency_key = nil)
         url = "#{MangoPay.api_path}/temp/immediate-payins"
-        MangoPay.request(:post, url, params)
+        MangoPay.request(:post, url, params, {}, idempotency_key)
       end
 
       def self.url(id = nil)

data/lib/mangopay/transaction.rb

@@ -9,7 +9,6 @@ module MangoPay
       # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
       # - +Type+: TransactionType {PAYIN, PAYOUT, TRANSFER}
       # - +Nature+: TransactionNature {NORMAL, REFUND, REPUDIATION}
-      # - +Direction+: TransactionDirection {DEBIT, CREDIT}
       # - +BeforeDate+ (timestamp): filters transactions with CreationDate _before_ this date
       # - +AfterDate+ (timestamp): filters transactions with CreationDate _after_ this date
       def fetch(wallet_id, filters={})

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.0.19' # disputes
+  VERSION = '3.0.20' # idempotency support
 end

data/spec/mangopay/idempotency_spec

@@ -0,0 +1,41 @@
+describe MangoPay do
+
+  # see https://docs.mangopay.com/api-references/idempotency-support/
+
+  include_context 'users'
+  require 'securerandom'
+
+  describe 'post requests' do
+
+    it 'if called with no idempotency key, act independently' do
+      u = define_new_natural_user
+      u1 = MangoPay::NaturalUser.create(u)
+      u2 = MangoPay::NaturalUser.create(u)
+      expect(u2['Id']).to be > u1['Id']
+    end
+
+    it 'if called with same idempotency key, the 2nd call is blocked' do
+      idempotency_key = SecureRandom.uuid
+      u = define_new_natural_user
+      u1 = MangoPay::NaturalUser.create(u, nil, idempotency_key)
+      expect {
+        u2 = MangoPay::NaturalUser.create(u, nil, idempotency_key)
+      }.to raise_error(MangoPay::ResponseError)
+    end
+
+    it 'if called with different idempotency key, act independently and responses may be retreived later' do
+      idempotency_key1 = SecureRandom.uuid
+      idempotency_key2 = SecureRandom.uuid
+      u = define_new_natural_user
+      u1 = MangoPay::NaturalUser.create(u, nil, idempotency_key1)
+      u2 = MangoPay::NaturalUser.create(u, nil, idempotency_key2)
+      expect(u2['Id']).to be > u1['Id']
+
+      resp1 = MangoPay.fetch_response(idempotency_key1)
+      resp2 = MangoPay.fetch_response(idempotency_key2)
+      expect(resp1['Resource']['Id']).to eq u1['Id']
+      expect(resp2['Resource']['Id']).to eq u2['Id']
+    end
+
+  end
+end

data/spec/mangopay/shared_resources.rb

@@ -34,8 +34,8 @@ shared_context 'users' do
 ###############################################
 
   let(:new_natural_user) { create_new_natural_user }
-  def create_new_natural_user
-    MangoPay::NaturalUser.create({
+  def define_new_natural_user
+    {
       Tag: 'Test natural user',
       Email: 'my@email.com',
       FirstName: 'John',
@@ -54,7 +54,10 @@ shared_context 'users' do
       CountryOfResidence: 'FR',
       Occupation: 'Worker',
       IncomeRange: 1
-    })
+    }
+  end
+  def create_new_natural_user
+    MangoPay::NaturalUser.create(define_new_natural_user)
   end
 
   let(:new_legal_user) {

data/spec/mangopay/transaction_spec.rb

@@ -48,13 +48,6 @@ describe MangoPay::Transaction do
       expect(by_type_pyout.count).to eq 1
       expect(by_type_pyin.first['Id']).to eq payin['Id']
       expect(by_type_pyout.first['Id']).to eq payout['Id']
-
-      by_dir_cred = MangoPay::Transaction.fetch(wallet_id, {'Direction' => 'CREDIT'})
-      by_dir_debt = MangoPay::Transaction.fetch(wallet_id, {'Direction' => 'DEBIT'})
-      expect(by_dir_cred.count).to eq 1
-      expect(by_dir_debt.count).to eq 1
-      expect(by_dir_cred.first['Id']).to eq payin['Id']
-      expect(by_dir_debt.first['Id']).to eq payout['Id']
     end
 
   end

data/spec/mangopay/wallet_spec.rb

@@ -74,13 +74,6 @@ describe MangoPay::Wallet do
       expect(by_type_pyout.count).to eq 1
       expect(by_type_pyin.first['Id']).to eq payin['Id']
       expect(by_type_pyout.first['Id']).to eq payout['Id']
-
-      by_dir_cred = MangoPay::Wallet.transactions(wallet_id, {'Direction' => 'CREDIT'})
-      by_dir_debt = MangoPay::Wallet.transactions(wallet_id, {'Direction' => 'DEBIT'})
-      expect(by_dir_cred.count).to eq 1
-      expect(by_dir_debt.count).to eq 1
-      expect(by_dir_cred.first['Id']).to eq payin['Id']
-      expect(by_dir_debt.first['Id']).to eq payout['Id']
     end
 
   end

data/spec/spec_helper.rb

@@ -8,7 +8,15 @@ def reset_mangopay_configuration
   MangoPay.configure do |c|
     c.preproduction = true
     c.client_id = 'sdk-unit-tests'
-    c.client_passphrase = 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+
+    # sandbox environment:
+    # c.root_url = 'https://api.sandbox.mangopay.com'
+    # c.client_passphrase = 'cqFfFrWfCcb7UadHNxx2C9Lo6Djw8ZduLi7J9USTmu8bhxxpju'
+
+    # test environment:
+    c.root_url = 'https://api-test.mangopay.com'
+    c.client_passphrase = '9RMGpwVUwFLK0SurxObJ2yaadDcO0zeKFKxWmthjB93SQjFzy0'
+
     c.temp_dir = File.expand_path('../tmp', __FILE__)
     require 'fileutils'
     FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
@@ -19,8 +27,8 @@ reset_mangopay_configuration
 
 ################################################################################
 # uncomment it for logging all http calls in tests
-#require 'http_logger'
-#require 'logger'
-#HttpLogger.logger            = Logger.new(STDOUT)
-#HttpLogger.colorize          = true
-#HttpLogger.log_headers       = false
+# require 'http_logger'
+# require 'logger'
+# HttpLogger.logger            = Logger.new(STDOUT)
+# HttpLogger.colorize          = true
+# HttpLogger.log_headers       = true # false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.0.19
+  version: 3.0.20
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,48 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: |2
@@ -63,8 +63,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -108,6 +108,7 @@ files:
 - spec/mangopay/event_spec.rb
 - spec/mangopay/fetch_filters_spec.rb
 - spec/mangopay/hook_spec.rb
+- spec/mangopay/idempotency_spec
 - spec/mangopay/kyc_document_spec.png
 - spec/mangopay/kyc_document_spec.rb
 - spec/mangopay/payin_bankwire_direct_spec.rb
@@ -136,17 +137,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the version 2 of the MangoPay API
@@ -161,6 +162,7 @@ test_files:
 - spec/mangopay/event_spec.rb
 - spec/mangopay/fetch_filters_spec.rb
 - spec/mangopay/hook_spec.rb
+- spec/mangopay/idempotency_spec
 - spec/mangopay/kyc_document_spec.png
 - spec/mangopay/kyc_document_spec.rb
 - spec/mangopay/payin_bankwire_direct_spec.rb