myfinance 0.7.0 → 1.0.0

data/lib/myfinance/resources/person.rb

@@ -32,7 +32,7 @@ module Myfinance
       def find_by(params)
         values = params.map { |k,v| "search[#{k}]=#{v}" }.join("&")
 
-        http.get("/people?#{values}", body: {}) do |response|
+        http.get(URI.encode("/people?#{values}"), body: {}) do |response|
           respond_with_collection(response)
         end
       end

data/lib/myfinance/resources/reconcile.rb

@@ -0,0 +1,20 @@
+module Myfinance
+  module Resources
+    class Reconcile < Base
+      def reconcile(entity_id, financial_accounts_ids = [], financial_transactions_ids = [])
+        body = { selected_financial_account_ids: financial_accounts_ids,
+                 selected_financial_transaction_ids: financial_transactions_ids }
+
+        http.post(path(entity_id), body: body) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      private
+
+      def path(entity_id)
+        "/entities/#{entity_id}/reconciles"
+      end
+    end
+  end
+end

data/lib/myfinance/version.rb

@@ -1,3 +1,3 @@
 module Myfinance
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/spec/lib/myfinance/client_spec.rb

@@ -124,4 +124,25 @@ describe Myfinance::Client do
       subject.taxes
     end
   end
+
+  describe "#credit_cards" do
+    it "instantiates a new Myfinance::Resources::CreditCard" do
+      expect(Myfinance::Resources::CreditCard).to receive(:new).with(subject.http)
+      subject.credit_cards
+    end
+  end
+
+  describe "#credit_card_transactions" do
+    it "instantiates a new Myfinance::Resources::CreditCardTransaction" do
+      expect(Myfinance::Resources::CreditCardTransaction).to receive(:new).with(subject.http)
+      subject.credit_card_transactions
+    end
+  end
+
+  describe "#reconciles" do
+    it "instantiates a new Myfinance::Resources::Reconcile" do
+      expect(Myfinance::Resources::Reconcile).to receive(:new).with(subject.http)
+      subject.reconciles
+    end
+  end
 end

data/spec/lib/myfinance/entities/credit_card_collection_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Myfinance::Entities::CreditCardCollection do
+  let(:entity_klass) { described_class }
+
+  let(:params) { double(headers: {}, parsed_body: [{}]) }
+
+  subject { described_class.new(params) }
+
+  context "#build" do
+    it "returns order collection" do
+      expect(subject.build).to be_a(entity_klass)
+    end
+
+    it "returns order" do
+      subject.build
+      expect(subject.collection.count).to eq(1)
+      expect(
+        subject.collection.first
+      ).to be_a(Myfinance::Entities::CreditCard)
+    end
+  end
+end

data/spec/lib/myfinance/entities/credit_card_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Myfinance::Entities::CreditCard do
+  it_behaves_like "entity_attributes", [:created_at, :id, :name, :updated_at, :entity_id, :person_id, :flag,
+                                        :flag_image_url, :observation, :classification_center_id, :category_id,
+                                        :closing_day, :expiration_day]
+end

data/spec/lib/myfinance/entities/credit_card_transaction_collection_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Myfinance::Entities::CreditCardTransactionCollection do
+  let(:entity_klass) { described_class }
+
+  let(:params) { double(headers: {}, parsed_body: [{}]) }
+
+  subject { described_class.new(params) }
+
+  context "#build" do
+    it "returns order collection" do
+      expect(subject.build).to be_a(entity_klass)
+    end
+
+    it "returns order" do
+      subject.build
+      expect(subject.collection.count).to eq(1)
+      expect(subject.collection.first).to be_a(Myfinance::Entities::CreditCardTransaction)
+    end
+  end
+end

data/spec/lib/myfinance/entities/credit_card_transaction_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Myfinance::Entities::CreditCardTransaction do
+  it_behaves_like "entity_attributes", [:credit_card_invoice_id, :classification_center_id, :category_id, :amount,
+                                        :description, :occurred_at, :type, :document, :observation, :created_at,
+                                        :updated_at, :invoice_payment, :excel_import_id, :financial_account_id,
+                                        :person_id, :moved, :recurrence_id, :indexed_at, :credit_card_id, :id]
+end

data/spec/lib/myfinance/entities/reconcile_collection_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Myfinance::Entities::ReconcileCollection do
+  let(:entity_klass) { described_class }
+
+  let(:params) { double(headers: {}, parsed_body: [{}]) }
+
+  subject { described_class.new(params) }
+
+  context "#build" do
+    it "returns order collection" do
+      expect(subject.build).to be_a(entity_klass)
+    end
+
+    it "returns order" do
+      subject.build
+      expect(subject.collection.count).to eq(0)
+    end
+  end
+end

data/spec/lib/myfinance/resources/bank_statement_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Myfinance::Resources::BankStatement, vcr: true do
+  let(:entity_id) { 3_798 }
+  let(:deposit_account_id) { 14_268 }
+  let(:bank_statement_id) { 18_213 }
+  let(:bank_statement_klass) { Myfinance::Entities::BankStatement }
+  let(:file) { File.open("spec/support/bank_statements/#{file_name}", "r") }
+  let(:file_name) { "extrato.ofx" }
+  let(:request_error) { Myfinance::RequestError }
+
+  describe "#import" do
+    subject { client.bank_statements.import(entity_id, deposit_account_id, file) }
+
+    it "returns a BankStatement" do
+      expect(subject).to be_a(bank_statement_klass)
+    end
+
+    it "returns imported BankStatement" do
+      expect(subject.file_file_name).to eq(file_name)
+      expect(subject.created_at).not_to eq(nil)
+    end
+
+    context "with invalid file" do
+      subject { client.bank_statements.import(entity_id, deposit_account_id, "diretorio/que/nao/existe/arquivo.ofx") }
+
+      it "returns 500 error code" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(500)
+        end
+      end
+    end
+  end
+
+  describe "#status" do
+    subject { client.bank_statements.status(entity_id, deposit_account_id, bank_statement_id) }
+
+    it "returns a BankStatement" do
+      expect(subject).to be_a(bank_statement_klass)
+    end
+
+    context "when invalid ID" do
+      subject { client.bank_statements.status(entity_id, deposit_account_id, nil) }
+
+      it "returns 404 not found error" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+end

data/spec/lib/myfinance/resources/category_spec.rb

@@ -48,6 +48,29 @@ describe Myfinance::Resources::Category, vcr: true do
     end
   end
 
+  describe "#find_by" do
+    context "when success" do
+      it "find categories by attributes" do
+        result = client.categories.find_by({ name: "Alimentação" })
+        expect(result).to be_a(Myfinance::Entities::CategoryCollection)
+        expect(result.collection.first).to be_a(entity_klass)
+        expect(result.collection.first.name).to eql("Alimentação")
+      end
+    end
+
+    context "when error" do
+      let(:client) { Myfinance.client("") }
+
+      it "raises Myfinance::RequestError with 401 status code" do
+        expect {
+          client.categories.find_by({})
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eql(401)
+        end
+      end
+    end
+  end
+
   describe "#create" do
     let(:params) { { name: "Category 1" } }
 
@@ -89,9 +112,7 @@ describe Myfinance::Resources::Category, vcr: true do
       end
 
       it "raises Myfinance::RequestError with 422 status core" do
-        expect {
-          result = client.categories.update(548083, { name: "" })
-        }.to raise_error(Myfinance::RequestError) do |error|
+        expect { client.categories.update(548083, { name: "" }) }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eql(422)
         end
       end

data/spec/lib/myfinance/resources/classification_center_spec.rb

@@ -54,17 +54,24 @@ describe Myfinance::Resources::ClassificationCenter, vcr: true do
 
   describe "#find_by" do
     context "when success" do
-      let(:params) do
-        { entity_id_equals: 3798, name_equals: "Centro de Custo Tal" }
-      end
-
       it "find a classification centers by name successfully" do
-        result = client.classification_centers.find_by(params)
+        result = client.classification_centers.find_by(
+          { entity_id_equals: 3798, name_equals: "Centro de Custo Tal" }
+        )
         expect(result).to be_a(entity_collection)
         expect(result.collection.first).to be_a(entity_klass)
         expect(result.collection.first.name).to eq("Centro de Custo Tal")
       end
 
+      it "find a classification centers with special characters" do
+        result = client.classification_centers.find_by(
+          { entity_id_equals: 3798, name_equals: "Socialização 2" }
+        )
+        expect(result).to be_a(entity_collection)
+        expect(result.collection.first).to be_a(entity_klass)
+        expect(result.collection.first.name).to eq("Socialização 2")
+      end
+
       it "returns a empty classification center successfully" do
         result = client.classification_centers.find_by(
           { entity_id_equals: 3798, name_equals: "Any" }

data/spec/lib/myfinance/resources/credit_card_spec.rb

@@ -0,0 +1,142 @@
+require "spec_helper"
+
+describe Myfinance::Resources::CreditCard, vcr: true do
+  let(:cc_klass) { Myfinance::Entities::CreditCard }
+  let(:entity_id) { 3798 }
+  let(:cc_id) { 44 }
+  let(:credit_cards) { client.credit_cards }
+  let(:request_error) { Myfinance::RequestError }
+
+  describe "#find_all" do
+    context "when successful" do
+      subject { credit_cards.find_all(entity_id) }
+      before :each do
+        subject.build
+      end
+
+      it "returns a 200 OK response code" do
+        expect(subject.response.code).to eq(200)
+      end
+
+      it "returns a collection of CreditCards" do
+        expect(subject).to be_a(Myfinance::Entities::CreditCardCollection)
+      end
+
+      it "returns credit cards inside collection" do
+        expect(subject.collection.first).to be_a(cc_klass)
+      end
+    end
+
+    context "when supplying invalid IDs" do
+      subject { credit_cards.find_all(nil) }
+      it "raises not found error with 404" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+
+  describe "#find" do
+    context "when successful" do
+      subject { credit_cards.find(entity_id, cc_id) }
+
+      it "returns a CreditCard" do
+        expect(subject).to be_a(cc_klass)
+      end
+    end
+
+    context "when supplying invalid IDs" do
+      subject { credit_cards.find(nil, nil) }
+
+      it "raises not found error with 404" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+
+  describe "#create" do
+    context "when successful" do
+      let(:params) { { name: "Nubank", flag: "MasterCard", closing_day: 20, expiration_day: 02 } }
+      subject { credit_cards.create(entity_id, params) }
+
+      it "creates a CreditCard" do
+        expect(subject).to be_a(cc_klass)
+      end
+
+      it "contains given params" do
+        expect(subject).to have_attributes(params)
+      end
+    end
+
+    context "when given invalid params" do
+      let(:params) { { name: "Nubank", flag: "BandeiraDeWesteros", closing_day: 20, expiration_day: 02 } }
+      subject { credit_cards.create(entity_id, params) }
+
+      it "returns 422 Unprocessable Entity" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(422)
+          expect(e.message).to eq("Unprocessable Entity")
+        end
+      end
+    end
+  end
+
+  describe "#update" do
+    context "when successful" do
+      let(:params) { { name: "Neon", flag: "Visa", closing_day: 20, expiration_day: 02 } }
+      subject { credit_cards.update(entity_id, cc_id, params) }
+
+      it "updates a CreditCard" do
+        expect(subject).to be_a(cc_klass)
+      end
+
+      it "contains given params" do
+        expect(subject).to have_attributes(params)
+      end
+    end
+
+    context "when given invalid params" do
+      let(:params) { { name: "Nubank", flag: "BandeiraDeWesteros", closing_day: 20, expiration_day: 02 } }
+      subject { credit_cards.update(entity_id, cc_id, params) }
+
+      it "returns 422 Unprocessable Entity" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(422)
+          expect(e.message).to eq("Unprocessable Entity")
+        end
+      end
+    end
+  end
+
+  describe "#destroy" do
+    let(:params) { { name: "Nubank", flag: "MasterCard", closing_day: 20, expiration_day: 02 } }
+    let(:new_cc) { credit_cards.create(entity_id, params) }
+
+    context "when successful" do
+      before :each do
+        credit_cards.destroy(entity_id, new_cc.id)
+      end
+
+      it "does not find deleted CreditCard" do
+        expect { credit_cards.find(entity_id, new_cc.id) }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+
+    context "when given invalid ID" do
+      it "returns 404 Not Found" do
+        expect { credit_cards.destroy(entity_id, 424242) }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+end

data/spec/lib/myfinance/resources/credit_card_transaction_spec.rb

@@ -0,0 +1,162 @@
+require "spec_helper"
+
+describe Myfinance::Resources::CreditCardTransaction, vcr: true do
+  let(:cct_klass) { Myfinance::Entities::CreditCardTransaction }
+  let(:entity_id) { 3906 }
+  let(:cc_id) { 73 }
+  let(:cct_id) { 319529 }
+  let(:year) { "2017" }
+  let(:month) { "04" }
+  let(:credit_card_transactions) { client.credit_card_transactions }
+  let(:request_error) { Myfinance::RequestError }
+  let(:client) { Myfinance.client("0657bac70fdf5c06ce822719568f3636a9a07b87ba617ec7", 3682) }
+
+  describe "#find_all" do
+    context "when successful" do
+      subject { credit_card_transactions.find_all(entity_id, cc_id, year, month) }
+      before :each do
+        subject.build
+      end
+
+      it "returns a 200 OK response code" do
+        expect(subject.response.code).to eq(200)
+      end
+
+      it "returns a collection of CreditCardTransactions" do
+        expect(subject).to be_a(Myfinance::Entities::CreditCardTransactionCollection)
+      end
+
+      it "returns credit cards inside collection" do
+        expect(subject.collection.first).to be_a(cct_klass)
+      end
+    end
+
+    context "when supplying invalid IDs" do
+      subject { credit_card_transactions.find_all(nil, nil, 2017, "99") }
+      it "raises not found error with 404" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+
+  describe "#find" do
+    context "when successful" do
+      subject { credit_card_transactions.find(entity_id, cc_id, cct_id) }
+
+      it "returns a CreditCardTransaction" do
+        expect(subject).to be_a(cct_klass)
+      end
+    end
+
+    context "when supplying invalid IDs" do
+      subject { credit_card_transactions.find(nil, 666, 99999) }
+
+      it "raises not found error with 404" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+
+  describe "#create" do
+    context "when successful" do
+      let(:params) do
+        { amount: BigDecimal.new(199), occurred_at: Date.new(2017, 1, 1), description: "O Guia", credit_card_id: cc_id }
+      end
+      subject { credit_card_transactions.create(entity_id, cc_id, params) }
+
+      it "creates a CreditCardTransaction" do
+        expect(subject).to be_a(cct_klass)
+      end
+
+      it "contains given params" do
+        expect(subject).to have_attributes(params)
+      end
+    end
+
+    context "when given invalid params" do
+      let(:params) { { amount: BigDecimal.new(199), description: "O Guia" } }
+      subject { credit_card_transactions.create(entity_id, cc_id, params) }
+
+      it "returns 422 Unprocessable Entity" do
+        expect { subject }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(422)
+          expect(e.message).to eq("Unprocessable Entity")
+        end
+      end
+    end
+  end
+
+  describe "#update" do
+    let(:params) { { amount: BigDecimal.new(999), description: "O Guia Vol. II" } }
+    subject { credit_card_transactions.update(entity_id, cc_id, cct_id, params) }
+
+    it "updates a CreditCardTransaction" do
+      expect(subject).to be_a(cct_klass)
+    end
+
+    it "contains given params" do
+      expect(subject).to have_attributes(params)
+    end
+  end
+
+  describe "#destroy" do
+    let(:params) do
+      { amount: BigDecimal.new(199), occurred_at: Date.new(2017, 1, 1), description: "O Guia Obsoleto", credit_card_id: cc_id }
+    end
+    let(:new_cct) { credit_card_transactions.create(entity_id, cc_id, params) }
+
+    context "when successful" do
+      before :each do
+        credit_card_transactions.destroy(entity_id, cc_id, new_cct.id)
+      end
+
+      it "does not find deleted CreditCardTransaction" do
+        expect { credit_card_transactions.find(entity_id, cc_id, new_cct.id) }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+
+    context "when given invalid ID" do
+      it "returns 404 Not Found" do
+        expect { credit_card_transactions.destroy(entity_id, 6666, 424242) }.to raise_error(request_error) do |e|
+          expect(e.code).to eq(404)
+          expect(e.message).to eq("Not Found")
+        end
+      end
+    end
+  end
+
+  describe "#destroy_parcelled" do
+    let(:params) do
+      { amount: BigDecimal.new(199), occurred_at: Date.new(2017, 1, 1), number_of_parcels: 2, credit_card_id: cc_id }
+    end
+    let(:new_cct) { credit_card_transactions.create(entity_id, cc_id, params) }
+
+    before :each do
+      credit_card_transactions.destroy_parcelled(entity_id, cc_id, new_cct.id)
+    end
+
+    it "does not find first CreditCardTransaction" do
+      expect { credit_card_transactions.find(entity_id, cc_id, new_cct.id) }.to raise_error(request_error) do |e|
+        expect(e.code).to eq(404)
+        expect(e.message).to eq("Not Found")
+      end
+    end
+
+    it "does not find second CreditCardTransaction" do
+      expect { credit_card_transactions.find(entity_id, cc_id, new_cct.id + 1) }.to raise_error(request_error) do |e|
+        expect(e.code).to eq(404)
+        expect(e.message).to eq("Not Found")
+      end
+    end
+
+  end
+end