mangopay-v4 4.0.0 → 4.0.1

data/spec/mangopay/e_money_spec.rb

@@ -1,38 +1,58 @@
-require_relative '../context/user_context'
-require_relative '../../lib/mangopay/api/service/e_money'
-
-describe MangoApi::EMoney do
-  include_context 'user_context'
-
-  describe '.of_user' do
-
-    describe "given an existing user entity's ID" do
-      id = NATURAL_USER_PERSISTED.id
-
-      context 'not having specified currency' do
-        default_currency = MangoModel::CurrencyIso::EUR
-
-        it 'retrieves the corresponding e-money entity in default currency' do
-          retrieved = MangoApi::EMoney.of_user id
-
-          expect(retrieved).to be_kind_of MangoModel::EMoney
-          expect(retrieved.credited_e_money.currency).to be default_currency
-          expect(retrieved.debited_e_money.currency).to be default_currency
-        end
-      end
-
-      # TODO: Results always come in EUR
-      # context 'having specified currency' do
-      #   currency = MangoModel::CurrencyIso::GBP
-      #
-      #   it 'retrieves the corresponding e-money entity in specified currency' do
-      #     retrieved = MangoApi::EMoney.of_user id, currency
-      #
-      #     expect(retrieved).to be_kind_of MangoModel::EMoney
-      #     expect(retrieved.credited_e_money.currency).to be currency
-      #     expect(retrieved.debited_e_money.currency).to be currency
-      #   end
-      # end
-    end
-  end
+require_relative '../context/user_context'
+require_relative '../../lib/mangopay/api/service/e_money'
+
+describe MangoApi::EMoney do
+  include_context 'user_context'
+
+  describe '.of_user_year' do
+
+    describe "given an existing user entity's ID" do
+      id = NATURAL_USER_PERSISTED.id
+
+      context 'not having specified currency' do
+        default_currency = MangoModel::CurrencyIso::EUR
+        year = 2019
+        it "retrieves the corresponding e-money entity for year #{year} in default currency" do
+          retrieved = MangoApi::EMoney.of_user_year id, year
+          expect(retrieved).to be_kind_of MangoModel::EMoney
+          expect(retrieved.credited_e_money.currency).to be default_currency
+          expect(retrieved.debited_e_money.currency).to be default_currency
+        end
+      end
+
+      # TODO: Results always come in EUR
+      # context 'having specified currency' do
+      #   currency = MangoModel::CurrencyIso::GBP
+      #
+      #   it 'retrieves the corresponding e-money entity in specified currency' do
+      #     retrieved = MangoApi::EMoney.of_user id, currency
+      #
+      #     expect(retrieved).to be_kind_of MangoModel::EMoney
+      #     expect(retrieved.credited_e_money.currency).to gebe currency
+      #     expect(retrieved.debited_e_money.currency).to be currency
+      #   end
+      # end
+    end
+  end
+
+  describe '.of_user_month' do
+
+    describe "given an existing user entity's ID" do
+      id = NATURAL_USER_PERSISTED.id
+
+      context 'not having specified currency' do
+        default_currency = MangoModel::CurrencyIso::EUR
+
+        year = 2019
+        month = 4
+
+        it "retrieves the corresponding e-money entity for date #{year}/#{month} in default currency" do
+          retrieved = MangoApi::EMoney.of_user_month id, year, month
+          expect(retrieved).to be_kind_of MangoModel::EMoney
+          expect(retrieved.credited_e_money.currency).to be default_currency
+          expect(retrieved.debited_e_money.currency).to be default_currency
+        end
+      end
+    end
+  end
 end

data/spec/mangopay/events_spec.rb

@@ -1,50 +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
+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

@@ -1,71 +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
+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

@@ -1,180 +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
+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