mangopay 3.0.12 → 3.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a5f31ff878a4a9988ae5bbbeec2bd486f12c9a
-  data.tar.gz: b6f9ade3a53e81ed24050cda7ed5af6ba44af521
+  metadata.gz: 399bb23725d407dca5bdc8650e2f98aaeb64ebc5
+  data.tar.gz: 6fa52ebd8674dd692694325d056b4f55522c2cb7
 SHA512:
-  metadata.gz: f41b043ef15a410cb45269d7f244176d75f10744ad565f2601032e22ea97be59e6d5beddc5fc933f45ce937a6ce80e4302d29e02554c73688645b1d115043017
-  data.tar.gz: 3a32c7cf5bd666e30a54cfb0e789f09b0d09a14b9cdb4d03094b31198f78a566e76925db4c2b3755c5be1067ecd4f6890345efb3a95bc6a300894191e30c4f72
+  metadata.gz: e2606747f1f0643e35634af72448ae872bcffc49afdef3a29f086326bce0e5d48a33e9b20ccc6368208a63780966faab469fb71a163b49bceb26204f667d5ae7
+  data.tar.gz: 39f1b1c4a851e162c69a6ee3b405e14a1940b6e64d68361812fa1ff5474985cf4c206512002d308de5655e05050c061b356c0adfa9c91d5749c171e63a3f1adb

data/lib/mangopay/authorization_token.rb

@@ -1,6 +1,7 @@
 module MangoPay
   module AuthorizationToken
 
+    # See http://docs.mangopay.com/api-references/authenticating/
     class Manager
 
       class << self

data/lib/mangopay/bank_account.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/bank-accounts/
   class BankAccount < Resource
     include HTTPCalls::Fetch
     class << self
@@ -11,8 +13,8 @@ module MangoPay
       # - list of bank accounts belonging to the given +user_id+
       # - or single bank account belonging to the given +user_id+ with the given +bank_account_id+.
       #
-      # In case of list query, optional +filters+ is a hash accepting pagination params
-      # (+page+, +per_page+; see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # In case of list query, optional +filters+ is a hash accepting pagination and sorting params
+      # (+page+, +per_page+, +sort+; see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       #
       def fetch(user_id, bank_account_id_or_filters={})
         bank_account_id, filters = HTTPCalls::Fetch.parse_id_or_filters(bank_account_id_or_filters)

data/lib/mangopay/card.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/card/
   class Card < Resource
     include HTTPCalls::Fetch
     include HTTPCalls::Update

data/lib/mangopay/card_registration.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/card-registration/
   class CardRegistration < Resource
     include HTTPCalls::Create
     include HTTPCalls::Update

data/lib/mangopay/errors.rb

@@ -6,6 +6,9 @@ module MangoPay
   class Error < StandardError
   end
 
+  # See http://docs.mangopay.com/api-references/response-codes-rules/
+  # and http://docs.mangopay.com/api-references/error-codes/
+  # 
   # Thrown from any MangoPay API call whenever
   # it returns response with HTTP code != 200.
   # Check @details hash for further info.

data/lib/mangopay/event.rb

@@ -1,10 +1,12 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/events/
   class Event < Resource
 
     # Fetches list of events (PayIns, PayOuts, Transfers).
     # 
     # Optional +filters+ is a hash accepting following keys:
-    # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
     # - +EventType+: {PAYIN_NORMAL_CREATED, PAYIN_NORMAL_SUCCEEDED, PAYIN_NORMAL_FAILED etc...} (see http://docs.mangopay.com/api-references/events/)
     # - +BeforeDate+ (timestamp): filters events with Date _before_ this date
     # - +AfterDate+ (timestamp): filters events with Date _after_ this date

data/lib/mangopay/hook.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/notifications/
   class Hook < Resource
     include HTTPCalls::Create
     include HTTPCalls::Update

data/lib/mangopay/http_calls.rb

@@ -29,16 +29,18 @@ module MangoPay
     module Fetch
       module ClassMethods
 
-        # - Fetching single entity by +id+:
+        # - Fetching _single_entity_ by +id+:
         # 
         #   MangoPay::User.fetch("user-id") # => {"FirstName"=>"Mango", "LastName"=>"Pay", ...}
         # 
-        # - Fetching multiple entities with _optional_ +filters+ hash,
-        #   including _pagination_ params
-        #   (+page+, +per_page+; see http://docs.mangopay.com/api-references/pagination/):
+        # - or fetching _multiple_entities_ with _optional_ +filters+ hash,
+        #   including _pagination_ and _sorting_ params
+        #   +page+, +per_page+, +sort+ (see http://docs.mangopay.com/api-references/pagination/):
         #   
         #   MangoPay::User.fetch() # => [{...}, ...]: list of user data hashes (10 per page by default)
         #   MangoPay::User.fetch({'page' => 2, 'per_page' => 3}) # => list of 3 hashes from 2nd page
+        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc'}) # => bank accounts by user, sorting by date descending (with default pagination)
+        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc', 'page' => 2, 'per_page' => 3}) # both sorting and pagination params provided
         # 
         # - For paginated queries the +filters+ param will be supplemented by +total_pages+ and +total_items+ info:
         #   
@@ -62,6 +64,9 @@ module MangoPay
 
     module Refund
       module ClassMethods
+
+        # 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)
         end

data/lib/mangopay/kyc_document.rb

@@ -1,6 +1,8 @@
 require 'base64'
 
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/kyc/documents/
   class KycDocument < Resource
     class << self
       def create(user_id, params)
@@ -11,10 +13,26 @@ module MangoPay
         MangoPay.request(:put, url(user_id, document_id), params)
       end
 
+      # Fetches the KYC document belonging to the given +user_id+, with the given +document_id+.
       def fetch(user_id, document_id)
         MangoPay.request(:get, url(user_id, document_id))
       end
 
+      # Fetches list of KYC documents:
+      # - for the particular user if +user_id+ is provided (not nil)
+      # - or for all users otherwise.
+      # 
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - filters such as +Type+ (e.g. 'IDENTITY_PROOF') and +Status+ (e.g. 'VALIDATED')
+      # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
+      # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
+      #
+      def fetch_all(user_id = nil, filters = {})
+        url = (user_id) ? url(user_id) : "#{MangoPay.api_path}/KYC/documents"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
       # Adds the file page (attachment) to the given document.
       # 
       # See http://docs.mangopay.com/api-references/kyc/pages/ :

data/lib/mangopay/legal_user.rb

@@ -1,4 +1,7 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/users/legal-users/
+  # See also parent class MangoPay::User
   class LegalUser < User
 
     def self.url(id = nil)

data/lib/mangopay/natural_user.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/users/natural-users/
   class NaturalUser < User
 
     def self.url(id = nil)

data/lib/mangopay/pay_in.rb

@@ -1,10 +1,13 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/payins/
   class PayIn < Resource
     include HTTPCalls::Fetch
     include HTTPCalls::Refund
 
     module Card
 
+      # See http://docs.mangopay.com/api-references/payins/payins-card-web/
       class Web < Resource
         include HTTPCalls::Create
         def self.url(*)
@@ -12,6 +15,7 @@ module MangoPay
         end
       end
 
+      # See http://docs.mangopay.com/api-references/payins/payindirectcard/
       class Direct < Resource
         include HTTPCalls::Create
         def self.url(*)
@@ -23,6 +27,7 @@ module MangoPay
 
     module PreAuthorized
 
+      # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
       class Direct < Resource
         include HTTPCalls::Create
         def self.url(*)
@@ -34,6 +39,7 @@ module MangoPay
 
     module BankWire
 
+      # See http://docs.mangopay.com/api-references/payins/payinbankwire/
       class Direct < Resource
         include HTTPCalls::Create
         def self.url(*)
@@ -43,5 +49,17 @@ module MangoPay
 
     end
 
+    module DirectDebit
+
+      # See http://docs.mangopay.com/api-references/payins/direct-debit-pay-in-web/
+      class Web < Resource
+        include HTTPCalls::Create
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/directdebit/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+
+    end
+
   end
 end

data/lib/mangopay/pay_out.rb

@@ -2,6 +2,7 @@ module MangoPay
   class PayOut < Resource
     include HTTPCalls::Fetch
 
+    # See http://docs.mangopay.com/api-references/pay-out-bank-wire/
     class BankWire < Resource
       include HTTPCalls::Create
 

data/lib/mangopay/pre_authorization.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
   class PreAuthorization < Resource
     include HTTPCalls::Update
     include HTTPCalls::Fetch

data/lib/mangopay/refund.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/refund/
   class Refund < Resource
     include HTTPCalls::Fetch
   end

data/lib/mangopay/transaction.rb

@@ -2,16 +2,16 @@ module MangoPay
   class Transaction < Resource
     class << self
       # Fetches list of transactions belonging to the given +wallet_id+.
+      # See also transactions for user: MangoPay::User#transactions
       # 
       # Optional +filters+ is a hash accepting following keys:
-      # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - +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={})
         MangoPay.request(:get, url(wallet_id), {}, filters)
       end

data/lib/mangopay/transfer.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/transfers/
   class Transfer < Resource
     include HTTPCalls::Create
     include HTTPCalls::Fetch

data/lib/mangopay/user.rb

@@ -1,4 +1,9 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/users/
+  # See also children classes:
+  # - MangoPay::NaturalUser
+  # - MangoPay::LegalUser
   class User < Resource
     include HTTPCalls::Create
     include HTTPCalls::Update
@@ -6,22 +11,22 @@ module MangoPay
     class << self
       # Fetches list of wallets belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
-      # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      # - other keys specific for transactions filtering (see MangoPay::Transaction.fetch)
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       def wallets(user_id, filters={})
         MangoPay.request(:get, url(user_id) + '/wallets', {}, filters)
       end
 
       # Fetches list of cards belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
-      # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       def cards(user_id, filters={})
         MangoPay.request(:get, url(user_id) + '/cards', {}, filters)
       end
 
       # Fetches list of transactions belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
-      # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - other keys specific for transactions filtering (see MangoPay::Transaction#fetch)
       def transactions(user_id, filters={})
         MangoPay.request(:get, url(user_id) + '/transactions', {}, filters)
       end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.0.12'
+  VERSION = '3.0.13'
 end

data/lib/mangopay/wallet.rb

@@ -1,4 +1,6 @@
 module MangoPay
+
+  # See http://docs.mangopay.com/api-references/wallets/
   class Wallet < Resource
     include HTTPCalls::Create
     include HTTPCalls::Update
@@ -6,7 +8,7 @@ module MangoPay
 
     # Fetches list of transactions belonging to the given +wallet_id+.
     # Optional +filters+ is a hash accepting following keys:
-    # - +page+, +per_page+: pagination params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
     # - other keys specific for transactions filtering (see MangoPay::Transaction.fetch)
     def self.transactions(wallet_id, filters = {})
       Transaction.fetch(wallet_id, filters)

data/spec/mangopay/kyc_document_spec.rb

@@ -28,6 +28,44 @@ describe MangoPay::KycDocument do
     end
   end
 
+  describe 'FETCH ALL' do
+    it 'fetches a list of documents' do
+      usr1 = create_new_natural_user()
+      usr2 = create_new_natural_user()
+      doc1 = create_new_document(usr1)
+      doc2 = create_new_document(usr1)
+      doc3 = create_new_document(usr2)
+
+      # fetch all docs for user 1
+      docs = MangoPay::KycDocument.fetch_all(usr1['Id'])
+      expect(docs).to be_kind_of(Array)
+      expect(docs.count).to eq 2
+      expect(docs[0]['Id']).to eq doc1['Id']
+      expect(docs[1]['Id']).to eq doc2['Id']
+
+      # fetch all docs for user 2
+      docs = MangoPay::KycDocument.fetch_all(usr2['Id'])
+      expect(docs).to be_kind_of(Array)
+      expect(docs.count).to eq 1
+      expect(docs[0]['Id']).to eq doc3['Id']
+
+      # fetch all docs ever
+      docs = MangoPay::KycDocument.fetch_all()
+      expect(docs).to be_kind_of(Array)
+      expect(docs.count).to be >= 3 # at least last 3 docs, but probably many more
+
+      # fetch last 3 docs (sorting by date descending)
+      docs = MangoPay::KycDocument.fetch_all(nil, filter = {'page' => 1, 'per_page' => 3, 'sort' => 'CreationDate:desc'})
+      expect(docs).to be_kind_of(Array)
+      expect(docs.count).to eq 3
+      # all 3 are at top as lastly created
+      # but may share the same CreationDate
+      # so the order between them is undetermined
+      expect(docs).to include(doc1, doc2, doc3)
+
+    end
+  end
+
   describe 'CREATE PAGE' do
 
     def create_page(file)

data/spec/mangopay/payin_card_web_spec.rb

@@ -35,20 +35,4 @@ describe MangoPay::PayIn::Card::Web, type: :feature do
     end
   end
 
-  describe 'REFUND' do
-    it 'refunds a payin' do
-      payin = new_payin_card_web
-      refund = MangoPay::PayIn.refund(payin['Id'], {AuthorId: payin['AuthorId']})
-      expect(refund['Id']).not_to be_nil
-      expect(refund['Type']).to eq('PAYOUT')
-      expect(refund['Nature']).to eq('REFUND')
-      expect(refund['InitialTransactionType']).to eq('PAYIN')
-      expect(refund['InitialTransactionId']).to eq(payin['Id'])
-      expect(refund['DebitedWalletId']).to eq(payin['CreditedWalletId'])
-      expect(refund['Status']).to eq('FAILED')
-      expect(refund['ResultCode']).to eq('001001')
-      expect(refund['ResultMessage']).to eq('Unsufficient wallet balance')
-    end
-  end
-
 end

data/spec/mangopay/payin_directdebit_web_spec.rb

@@ -0,0 +1,38 @@
+describe MangoPay::PayIn::DirectDebit::Web, type: :feature do
+  include_context 'payins'
+
+  def check_type_and_status(payin)
+    expect(payin['Type']).to eq('PAYIN')
+    expect(payin['Nature']).to eq('REGULAR')
+    expect(payin['PaymentType']).to eq('DIRECT_DEBIT')
+    expect(payin['ExecutionType']).to eq('WEB')
+
+    # not SUCCEEDED yet: waiting for processing
+    expect(payin['Status']).to eq('CREATED')
+    expect(payin['ResultCode']).to be_nil
+    expect(payin['ResultMessage']).to be_nil
+    expect(payin['ExecutionDate']).to be_nil
+  end
+  
+  describe 'CREATE' do
+    it 'creates a directdebit web payin' do
+      created = new_payin_directdebit_web
+      expect(created['Id']).not_to be_nil
+      check_type_and_status(created)
+    end
+  end
+
+  describe 'FETCH' do
+    it 'fetches a payin' do
+      created = new_payin_directdebit_web
+      fetched = MangoPay::PayIn.fetch(created['Id'])
+      expect(fetched['Id']).to eq(created['Id'])
+      expect(fetched['CreationDate']).to eq(created['CreationDate'])
+      expect(fetched['CreditedFunds']).to eq(created['CreditedFunds'])
+      expect(fetched['CreditedWalletId']).to eq(created['CreditedWalletId'])
+      check_type_and_status(created)
+      check_type_and_status(fetched)
+    end
+  end
+
+end

data/spec/mangopay/shared_resources.rb

@@ -33,7 +33,8 @@ end
 shared_context 'users' do
 ###############################################
 
-  let(:new_natural_user) {
+  let(:new_natural_user) { create_new_natural_user }
+  def create_new_natural_user
     MangoPay::NaturalUser.create({
       Tag: 'Test natural user',
       Email: 'my@email.com',
@@ -47,7 +48,7 @@ shared_context 'users' do
       Occupation: 'Worker',
       IncomeRange: 1
     })
-  }
+  end
 
   let(:new_legal_user) {
     MangoPay::LegalUser.create({
@@ -119,12 +120,13 @@ shared_context 'kyc_documents' do
 ###############################################
   include_context 'users'
 
-  let(:new_document) {
-    MangoPay::KycDocument.create(new_natural_user['Id'], {
+  let(:new_document) { create_new_document(new_natural_user) }
+  def create_new_document(user)
+    MangoPay::KycDocument.create(user['Id'], {
       Type: 'IDENTITY_PROOF',
       Tag: 'Test document'
     })
-  }
+  end
 end
 
 ###############################################
@@ -133,6 +135,24 @@ shared_context 'payins' do
   include_context 'users'
   include_context 'wallets'
 
+  ###############################################
+  # directdebit/web
+  ###############################################
+
+  let(:new_payin_directdebit_web) {
+    MangoPay::PayIn::DirectDebit::Web.create({
+      AuthorId: new_natural_user['Id'],
+      CreditedUserId: new_wallet['Owners'][0],
+      CreditedWalletId: new_wallet['Id'],
+      DebitedFunds: { Currency: 'EUR', Amount: 1000 },
+      Fees: { Currency: 'EUR', Amount: 0 },
+      DirectDebitType: 'GIROPAY',
+      ReturnURL: MangoPay.configuration.root_url,
+      Culture: 'FR',
+      Tag: 'Test PayIn/DirectDebit/Web'
+    })
+  }
+
   ###############################################
   # card/web
   ###############################################

data/spec/spec_helper.rb

@@ -24,5 +24,3 @@ reset_mangopay_configuration
 #HttpLogger.logger            = Logger.new(STDOUT)
 #HttpLogger.colorize          = true
 #HttpLogger.log_headers       = false
-#HttpLogger.log_request_body  = true
-#HttpLogger.log_response_body = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.0.12
+  version: 3.0.13
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -108,6 +108,7 @@ files:
 - spec/mangopay/payin_bankwire_direct_spec.rb
 - spec/mangopay/payin_card_direct_spec.rb
 - spec/mangopay/payin_card_web_spec.rb
+- spec/mangopay/payin_directdebit_web_spec.rb
 - spec/mangopay/payin_preauthorized_direct_spec.rb
 - spec/mangopay/payout_bankwire_spec.rb
 - spec/mangopay/preauthorization_spec.rb
@@ -156,6 +157,7 @@ test_files:
 - spec/mangopay/payin_bankwire_direct_spec.rb
 - spec/mangopay/payin_card_direct_spec.rb
 - spec/mangopay/payin_card_web_spec.rb
+- spec/mangopay/payin_directdebit_web_spec.rb
 - spec/mangopay/payin_preauthorized_direct_spec.rb
 - spec/mangopay/payout_bankwire_spec.rb
 - spec/mangopay/preauthorization_spec.rb