mangopay-v4 4.0.0

data/spec/mangopay/events_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../../lib/mangopay/api/service/events'
+require_relative '../../lib/mangopay/common/sort_field'
+require_relative '../../lib/mangopay/common/sort_direction'
+
+describe MangoApi::Events do
+
+  describe '.all' do
+
+    context 'from a correctly-configured environment' do
+      context 'not having specified filters' do
+        default_per_page = 10
+
+        it 'retrieves list with default parameters' do
+          results = MangoApi::Events.all
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq default_per_page
+          results.each do |result|
+            expect(result).to be_kind_of MangoModel::Event
+            expect(result.resource_id).not_to be_nil
+          end
+        end
+      end
+
+      context 'having specified filters' do
+        per_page = 13
+
+        it 'retrieves list with specified parameters' do
+          results = MangoApi::Events.all do |filter|
+            filter.page = 1
+            filter.per_page = per_page
+            filter.sort_field = MangoPay::SortField::DATE
+            filter.sort_direction = MangoPay::SortDirection::DESC
+          end
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::Event
+            expect(result.resource_id).not_to be_nil
+            next if index == results.length - 1
+            first_date = result.date
+            second_date = results[index + 1].date
+            expect(first_date >= second_date).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/mangopay/hooks_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../context/hook_context'
+require_relative '../../lib/mangopay/api/service/hooks'
+require_relative '../../lib/mangopay/model/enum/hook_status'
+require_relative '../../lib/mangopay/common/sort_field'
+require_relative '../../lib/mangopay/common/sort_direction'
+
+describe MangoApi::Hooks do
+  include_context 'hook_context'
+
+
+  describe '.create' do
+
+    context 'given a valid object' do
+      hook = HOOK_DATA
+
+      it 'creates the hook entity' do
+        expect { MangoApi::Hooks.create hook }.to raise_error(MangoPay::ResponseError, /already.+registered/)
+      end
+    end
+  end
+
+  describe '.update' do
+
+    context 'given a valid object' do
+      url = 'https://www.hello.com/hook'
+      status = MangoModel::HookStatus::DISABLED
+      created = HOOK_PERSISTED
+      created.url = url
+      created.status = status
+
+      it 'updates the corresponding entity' do
+        updated = MangoApi::Hooks.update created
+
+        expect(updated).to be_kind_of MangoModel::Hook
+        expect(updated.id).to eq created.id
+        expect(updated.url).to eq url
+        expect(updated.status).to be status
+      end
+    end
+  end
+
+  describe '.get' do
+
+    context "given an existing entity's ID" do
+      id = HOOK_PERSISTED.id
+
+      it 'retrieves the corresponding entity' do
+        retrieved = MangoApi::Hooks.get id
+
+        expect(retrieved).to be_kind_of MangoModel::Hook
+        expect(retrieved.id).to eq id
+      end
+    end
+  end
+
+  describe '.all' do
+
+    context 'not having specified filters' do
+
+      it 'retrieves list of all events' do
+        results = MangoApi::Hooks.all
+
+        expect(results).to be_kind_of Array
+        results.each do |result|
+          expect(result).to be_kind_of MangoModel::Hook
+          expect(result.id).not_to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/mangopay/kyc_documents_spec.rb

@@ -0,0 +1,180 @@
+require_relative '../context/kyc_document_context'
+require_relative '../../lib/mangopay/api/service/kyc_documents'
+require_relative '../../lib/mangopay/model/document_page_consult'
+require_relative '../../lib/mangopay/model/entity/kyc_document'
+require_relative '../../lib/mangopay/common/sort_field'
+require_relative '../../lib/mangopay/common/sort_direction'
+
+describe MangoApi::KycDocuments do
+  include_context 'kyc_document_context'
+
+  describe '.create' do
+
+    context 'given a valid object' do
+      kyc_doc = MangoModel::KycDocument.new
+      kyc_doc.type = MangoModel::KycDocumentType::IDENTITY_PROOF
+
+      it 'creates the kyc document entity' do
+        created = MangoApi::KycDocuments.create kyc_doc, NATURAL_USER_PERSISTED.id
+
+        expect(created).to be_kind_of MangoModel::KycDocument
+        expect(created.id).not_to be_nil
+        expect(created.status).to be MangoModel::DocumentStatus::CREATED
+        expect(its_the_same_kyc_doc(kyc_doc, created)).to be_truthy
+      end
+    end
+  end
+
+  describe '.upload_page' do
+
+    context "given a valid file's path" do
+      path = File.join(File.dirname(__FILE__), '..', 'resources', 'test_pdf.pdf')
+
+      it "uploads the file as one of the KYC document's pages" do
+        response = MangoApi::KycDocuments.upload_page KYC_DOCUMENT_PERSISTED.id,
+                                                      NATURAL_USER_PERSISTED.id,
+                                                      path
+        expect(response).to be_nil
+      end
+    end
+  end
+
+  describe '.submit' do
+
+    context "given an existing entity's ID" do
+      created = KYC_DOCUMENT_PERSISTED
+      id = created.id
+      # upload a page to allow submission
+      path = File.join(File.dirname(__FILE__), '..', 'resources', 'test_pdf.pdf')
+      MangoApi::KycDocuments.upload_page KYC_DOCUMENT_PERSISTED.id,
+                                         NATURAL_USER_PERSISTED.id,
+                                         path
+
+      it 'submits the corresponding entity for approval' do
+        submitted = MangoApi::KycDocuments.submit id, NATURAL_USER_PERSISTED.id
+
+        expect(submitted).to be_kind_of MangoModel::KycDocument
+        expect(submitted.id).to eq id
+        expect(submitted.status).to be MangoModel::DocumentStatus::VALIDATION_ASKED
+        expect(its_the_same_kyc_doc(created, submitted)).to be_truthy
+      end
+    end
+  end
+
+  describe '.of_user' do
+
+    context "given an existing user entity's ID" do
+      id = NATURAL_USER_PERSISTED.id
+      # prepare some test data
+      10.times do
+        persist_kyc_doc KYC_DOCUMENT_DATA
+      end
+
+      context 'not having specified filters' do
+        default_per_page = 10
+
+        it 'retrieves list with default parameters' do
+          results = MangoApi::KycDocuments.of_user id
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq default_per_page
+          results.each do |result|
+            expect(result).to be_kind_of MangoModel::KycDocument
+            expect(result.id).not_to be_nil
+            expect(result.user_id).to eq id
+          end
+        end
+      end
+
+      context 'having specified filters' do
+        per_page = 11
+
+        it 'retrieves list with specified parameters' do
+          results = MangoApi::KycDocuments.of_user id do |filter|
+            filter.page = 1
+            filter.per_page = per_page
+            filter.sort_field = MangoPay::SortField::CREATION_DATE
+            filter.sort_direction = MangoPay::SortDirection::ASC
+          end
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::KycDocument
+            expect(result.id).not_to be_nil
+            expect(result.user_id).to eq id
+            next if index == results.length - 1
+            first_date = result.creation_date
+            second_date = results[index + 1].creation_date
+            expect(first_date <= second_date).to be_truthy
+          end
+        end
+      end
+    end
+  end
+
+  describe '.all' do
+
+    context 'from a correctly-configured environment' do
+      # prepare some test data
+      10.times do
+        persist_kyc_doc KYC_DOCUMENT_DATA
+      end
+
+      context 'not having specified filters' do
+        default_per_page = 10
+
+        it 'retrieves list with default parameters' do
+          results = MangoApi::KycDocuments.all
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq default_per_page
+          results.each do |result|
+            expect(result).to be_kind_of MangoModel::KycDocument
+            expect(result.id).not_to be_nil
+          end
+        end
+      end
+
+      context 'having specified filters' do
+        per_page = 11
+
+        it 'retrieves list with specified parameters' do
+          results = MangoApi::KycDocuments.all do |filter|
+            filter.page = 1
+            filter.per_page = per_page
+            filter.sort_field = MangoPay::SortField::CREATION_DATE
+            filter.sort_direction = MangoPay::SortDirection::ASC
+          end
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::KycDocument
+            expect(result.id).not_to be_nil
+            next if index == results.length - 1
+            first_date = result.creation_date
+            second_date = results[index + 1].creation_date
+            expect(first_date <= second_date).to be_truthy
+          end
+        end
+      end
+    end
+  end
+
+  describe '.consult' do
+
+    context "given an existing entity's ID" do
+      id = KYC_DOCUMENT_PERSISTED.id
+
+      it 'creates the document page consult entities' do
+        results = MangoApi::KycDocuments.consult id
+
+        expect(results).to be_kind_of Array
+        results.each do |result|
+          expect(result).to be_kind_of MangoModel::DocumentPageConsult
+        end
+      end
+    end
+  end
+end

data/spec/mangopay/mandates_spec.rb

@@ -0,0 +1,219 @@
+require_relative '../../lib/mangopay/api/service/mandates'
+require_relative '../../spec/context/mandate_context'
+require_relative '../../lib/mangopay/common/sort_field'
+require_relative '../../lib/mangopay/common/sort_direction'
+
+describe MangoApi::Mandates do
+  include_context 'mandate_context'
+
+  describe '.create' do
+
+    context 'given a valid object' do
+      mandate = MANDATE_DATA
+
+      it 'creates the mandate entity' do
+        created = MangoApi::Mandates.create mandate
+
+        expect(created).to be_kind_of MangoModel::Mandate
+        expect(created.id).not_to be_nil
+        expect(created.document_url).not_to be_nil
+        expect(created.execution_type).to be MangoModel::MandateExecutionType::WEB
+        expect(created.mandate_type).to be MangoModel::MandateType::DIRECT_DEBIT
+        expect(created.redirect_url).not_to be_nil
+        expect(created.return_url).not_to be_nil
+        expect(created.status).to be MangoModel::MandateStatus::CREATED
+        expect(created.user_id).not_to be_nil
+        expect(its_the_same_mandate(mandate, created)).to be_truthy
+      end
+    end
+  end
+
+  describe '.get' do
+
+    context "given an existing entity's ID" do
+      mandate = MANDATE_PERSISTED
+      id = mandate.id
+
+      it 'retrieves the corresponding entity' do
+        retrieved = MangoApi::Mandates.get id
+
+        expect(retrieved).to be_kind_of MangoModel::Mandate
+        expect(retrieved.id).to eq id
+        expect(its_the_same_mandate(mandate, retrieved)).to be_truthy
+      end
+    end
+  end
+
+  # describe '.cancel' do
+  #
+  #   context "given an existing entity's ID" do
+  #     mandate = MangoModel::Mandate.new
+  #     mandate.bank_account_id = GB_ACCOUNT_PERSISTED.id
+  #     mandate.culture = MangoModel::MandateCultureCode::EN
+  #     mandate.return_url = 'http://www.my-site.com/returnURL/'
+  #     created = MangoApi::Mandates.create mandate
+  #     id = created.id
+  #
+  #     it 'cancels the corresponding entity' do
+  #
+  #       # Attention
+  #       #
+  #       # To make this test pass, you must pause execution with a breakpoint on
+  #       # the following line, and use your browser to open the page received
+  #       # in the +created.redirect_url+ property and click the Confirm button
+  #       # before continuing.
+  #       canceled = MangoApi::Mandates.cancel id # Place breakpoint here
+  #
+  #       expect(canceled).to be_kind_of MangoModel::Mandate
+  #       expect(canceled.id).to eq id
+  #       expect(canceled.status).to be MangoModel::MandateStatus::FAILED
+  #       expect(canceled.result_code).to eq '001806' # cancelled
+  #     end
+  #   end
+  # end
+
+  describe '.all' do
+
+    context 'not having specified filters' do
+      default_per_page = 10
+
+      it 'retrieves a list with default parameters' do
+        results = MangoApi::Mandates.all
+
+        expect(results).to be_kind_of Array
+        expect(results.length).to eq default_per_page
+        results.each do |result|
+          expect(result).to be_kind_of MangoModel::Mandate
+          expect(result.id).not_to be_nil
+        end
+      end
+    end
+
+    context 'having specified filters' do
+      per_page = 11
+
+      it 'retrieves a list with specified parameters' do
+        results = MangoApi::Mandates.all do |filter|
+          filter.page = 1
+          filter.per_page = per_page
+          filter.sort_field = MangoPay::SortField::CREATION_DATE
+          filter.sort_direction = MangoPay::SortDirection::ASC
+        end
+
+        expect(results).to be_kind_of Array
+        expect(results.length).to be per_page
+        results.each.with_index do |result, index|
+          expect(result).to be_kind_of MangoModel::Mandate
+          expect(result.id).not_to be_nil
+          next if index == results.length - 1
+          first_date = result.creation_date
+          second_date = results[index + 1].creation_date
+          expect(first_date < second_date).to be_truthy
+        end
+      end
+    end
+  end
+
+  describe '.of_user' do
+    # prepare test data
+    10.times do
+      persist_mandate build_mandate
+    end
+
+    describe "given an existing user entity's ID" do
+      id = NATURAL_USER_PERSISTED.id
+
+      context 'not having specified filters' do
+        default_per_page = 10
+
+        it 'retrieves a list with default parameters' do
+          results = MangoApi::Mandates.of_user id
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq default_per_page
+          results.each do |result|
+            expect(result).to be_kind_of MangoModel::Mandate
+            expect(result.id).not_to be_nil
+            expect(result.user_id).to eq id
+          end
+        end
+      end
+
+      context 'having specified filters' do
+        per_page = 8
+
+        it 'retrieves a list with specified parameters' do
+          results = MangoApi::Mandates.of_user id do |filter|
+            filter.page = 1
+            filter.per_page = per_page
+            filter.sort_field = MangoPay::SortField::CREATION_DATE
+            filter.sort_direction = MangoPay::SortDirection::ASC
+          end
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to be per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::Mandate
+            expect(result.id).not_to be_nil
+            expect(result.user_id).to eq id
+            next if index == results.length - 1
+            first_date = result.creation_date
+            second_date = results[index + 1].creation_date
+            expect(first_date <= second_date).to be_truthy
+          end
+        end
+      end
+    end
+  end
+
+  describe '.of_bank_account' do
+
+    context "given an existing bank account entity's ID" do
+      user_id = NATURAL_USER_PERSISTED.id
+      account_id = IBAN_ACCOUNT_PERSISTED.id
+
+      context 'not having specified filters' do
+        default_per_page = 10
+
+        it 'retrieves a list with default parameters' do
+          results = MangoApi::Mandates.of_bank_account(user_id, account_id)
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq default_per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::Mandate
+            expect(result.id).not_to be_nil
+            next if index == results.length - 1
+            first_date = result.creation_date
+            second_date = results[index + 1].creation_date
+            expect(first_date <= second_date).to be_truthy
+          end
+        end
+      end
+
+      context 'having specified filters' do
+        per_page = 3
+
+        it 'retrieves a list according to specified parameters' do
+          results = MangoApi::Mandates.of_bank_account(user_id, account_id) do |filter|
+            filter.page = 1
+            filter.per_page = per_page
+            filter.sort_field = MangoPay::SortField::CREATION_DATE
+            filter.sort_direction = MangoPay::SortDirection::ASC
+          end
+
+          expect(results).to be_kind_of Array
+          expect(results.length).to eq per_page
+          results.each.with_index do |result, index|
+            expect(result).to be_kind_of MangoModel::Mandate
+            expect(result.id).not_to be_nil
+            next if index == results.length - 1
+            first_date = result.creation_date
+            second_date = results[index + 1].creation_date
+            expect(first_date <= second_date).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end