myfinance 0.1.0

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

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe Myfinance::Resources::PayableAccount do
+  let(:entity_id) { 3798 }
+
+  describe "#create", vcr: true do
+    let(:params) { { due_date: '2015-08-15', amount: 150.99 } }
+    subject { client.payable_accounts.create(entity_id, params) }
+
+    context "with success" do
+      it "creates a new object" do
+        expect(subject.id).to eq(1215631)
+        expect(subject.due_date).to eq(Date.new(2015, 8, 15))
+        expect(subject.entity_id).to eq(entity_id)
+        expect(subject.status).to eq(1)
+        expect(subject.status_name).to eq('unpaid')
+        expect(subject.occurred_at).to be_nil
+        expect(subject.amount).to eq(150.99)
+        expect(subject.ticket_amount).to be_nil
+        expect(subject.interest_amount).to be_nil
+        expect(subject.discount_amount).to be_nil
+        expect(subject.total_amount).to be_nil
+        expect(subject.description).to be_nil
+        expect(subject.document).to be_nil
+        expect(subject.document_emission_date).to be_nil
+        expect(subject.observation).to be_nil
+        expect(subject.remind).to be_falsy
+        expect(subject.reminded_at).to be_nil
+        expect(subject.income_tax_relevant).to be_falsy
+        expect(subject.category_id).to be_nil
+        expect(subject.classification_center_id).to be_nil
+        expect(subject.expected_deposit_account_id).to be_nil
+        expect(subject.recurrence_id).to be_nil
+        expect(subject.person_id).to be_nil
+        expect(subject.created_at).to eq(DateTime.parse("2015-08-05T10:31:28-03:00"))
+        expect(subject.updated_at).to eq(DateTime.parse("2015-08-05T10:31:28-03:00"))
+        expect(subject.recurrent).to be_falsy
+        expect(subject.parcelled).to be_falsy
+        expect(subject.recurrence_period).to be_nil
+        expect(subject.number_of_parcels).to be_nil
+        expect(subject.current_parcel).to be_nil
+        expect(subject.competency_month).to eq("2015-08")
+        expect(subject.financial_account_taxes_attributes).to be_empty
+      end
+
+      context "when the payable_account has occurred_at value defined" do
+        let(:params) { { due_date: '2015-08-01', amount: 150.99, occurred_at: '2015-08-05', total_amount: 150.99 } }
+
+        it "creates a new payable_account as paid" do
+          expect(subject.id).to eq(1215632)
+          expect(subject.due_date).to eq(Date.new(2015, 8, 1))
+          expect(subject.occurred_at).to eq(Date.new(2015, 8, 5))
+          expect(subject.amount).to eq(150.99)
+          expect(subject.total_amount).to eq(150.99)
+          expect(subject.status).to eq(2)
+          expect(subject.status_name).to eq('paid')
+        end
+      end
+    end
+
+    context "when any data is invalid" do
+      let(:params) { { due_date: '', amount: 150.99 } }
+
+      it "raises Myfinance::RequestError" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+
+      it "adds information on request error object" do
+        expect(Myfinance::RequestError).to receive(:new).with(code: 422, message: "", body: "{\"competency_month\":[\"n\\u00e3o pode ser vazio\"],\"due_date\":[\"n\\u00e3o \\u00e9 uma data v\\u00e1lida\"]}").and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+
+    context "when entity does not exist" do
+      subject { client.payable_accounts.create(555, params) }
+
+      it "raises Myfinance::RequestError" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+
+      it "adds information on request error object" do
+        expect(Myfinance::RequestError).to receive(:new).with(code: 403, message: "Forbidden", body: "{\"error\":\"Voc\\u00ea n\\u00e3o tem permiss\\u00e3o para acessar este recurso.\"}").and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#pay", vcr: true do
+    let(:params) { { total_amount: 150.99, occurred_at: '2015-08-05', amount: 150.99 } }
+    subject { client.payable_accounts.pay(1215631, entity_id, params) }
+
+    context "with success" do
+      it "pays payable account" do
+        expect(subject.id).to eq(1215631)
+        expect(subject.status).to eq(2)
+        expect(subject.status_name).to eq('paid')
+        expect(subject.amount).to eq(150.99)
+        expect(subject.total_amount).to eq(150.99)
+        expect(subject.ticket_amount).to be_nil
+        expect(subject.interest_amount).to be_nil
+        expect(subject.discount_amount).to be_nil
+      end
+    end
+
+    context "when any parameter is invalid" do
+      let(:params) { { total_amount: nil, occurred_at: '2015-08-05', amount: 150.99 } }
+
+      it "raises request error" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#undo_payment", vcr: true do
+    subject { client.payable_accounts.undo_payment(1215631, entity_id) }
+
+    it "undoes receivement of the receivable account" do
+      expect(subject.id).to eq(1215631)
+      expect(subject.status).to eq(1)
+      expect(subject.status_name).to eq('unpaid')
+      expect(subject.amount).to eq(150.99)
+      expect(subject.total_amount).to be_nil
+      expect(subject.ticket_amount).to be_nil
+      expect(subject.interest_amount).to be_nil
+      expect(subject.discount_amount).to be_nil
+    end
+  end
+
+  describe "#destroy", vcr: true do
+    subject { client.payable_accounts.destroy(1215631, entity_id) }
+
+    context "when payable account exists" do
+      it "returns true" do
+        expect(subject).to be_truthy
+      end
+    end
+
+    context "when payable account does not exist" do
+      subject { client.payable_accounts.destroy(1215631099, entity_id) }
+
+      it "raises request error" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe Myfinance::Resources::ReceivableAccount do
+  let(:entity_id) { 3798 }
+
+  describe "#create", vcr: true do
+    let(:params) { { due_date: '2015-08-15', amount: 150.99 } }
+    subject { client.receivable_accounts.create(entity_id, params) }
+
+    context "with success" do
+      it "creates a new object" do
+        expect(subject.id).to eq(1215634)
+        expect(subject.due_date).to eq(Date.new(2015, 8, 15))
+        expect(subject.entity_id).to eq(entity_id)
+        expect(subject.status).to eq(1)
+        expect(subject.status_name).to eq('unreceived')
+        expect(subject.occurred_at).to be_nil
+        expect(subject.amount).to eq(150.99)
+        expect(subject.ticket_amount).to be_nil
+        expect(subject.interest_amount).to be_nil
+        expect(subject.discount_amount).to be_nil
+        expect(subject.total_amount).to be_nil
+        expect(subject.description).to be_nil
+        expect(subject.document).to be_nil
+        expect(subject.document_emission_date).to be_nil
+        expect(subject.observation).to be_nil
+        expect(subject.remind).to be_falsy
+        expect(subject.reminded_at).to be_nil
+        expect(subject.income_tax_relevant).to be_falsy
+        expect(subject.category_id).to be_nil
+        expect(subject.classification_center_id).to be_nil
+        expect(subject.expected_deposit_account_id).to be_nil
+        expect(subject.recurrence_id).to be_nil
+        expect(subject.person_id).to be_nil
+        expect(subject.created_at).to eq(DateTime.parse("2015-08-05T11:59:05-03:00"))
+        expect(subject.updated_at).to eq(DateTime.parse("2015-08-05T11:59:05-03:00"))
+        expect(subject.recurrent).to be_falsy
+        expect(subject.parcelled).to be_falsy
+        expect(subject.recurrence_period).to be_nil
+        expect(subject.number_of_parcels).to be_nil
+        expect(subject.current_parcel).to be_nil
+        expect(subject.competency_month).to eq("2015-08")
+        expect(subject.financial_account_taxes_attributes).to be_empty
+      end
+
+      context "when the receivable_account has occurred_at value defined" do
+        let(:params) { { due_date: '2015-08-01', amount: 150.99, occurred_at: '2015-08-05', total_amount: 150.99 } }
+
+        it "creates a new receivable_account as paid" do
+          expect(subject.id).to eq(1215635)
+          expect(subject.due_date).to eq(Date.new(2015, 8, 1))
+          expect(subject.occurred_at).to eq(Date.new(2015, 8, 5))
+          expect(subject.amount).to eq(150.99)
+          expect(subject.total_amount).to eq(150.99)
+          expect(subject.status).to eq(2)
+          expect(subject.status_name).to eq('received')
+        end
+      end
+    end
+
+    context "when any data is invalid" do
+      let(:params) { { due_date: '', amount: 150.99 } }
+
+      it "raises Myfinance::RequestError" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+
+      it "adds information on request error object" do
+        expect(Myfinance::RequestError).to receive(:new).with(code: 422, message: "", body: "{\"competency_month\":[\"n\\u00e3o pode ser vazio\"],\"due_date\":[\"n\\u00e3o \\u00e9 uma data v\\u00e1lida\"]}").and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+
+    context "when entity does not exist" do
+      subject { client.receivable_accounts.create(555, params) }
+
+      it "raises Myfinance::RequestError" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+
+      it "adds information on request error object" do
+        expect(Myfinance::RequestError).to receive(:new).with(code: 403, message: "Forbidden", body: "{\"error\":\"Voc\\u00ea n\\u00e3o tem permiss\\u00e3o para acessar este recurso.\"}").and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#receive", vcr: true do
+    let(:params) { { total_amount: 150.99, occurred_at: '2015-08-05', amount: 150.99 } }
+    subject { client.receivable_accounts.receive(1215634, entity_id, params) }
+
+    context "with success" do
+      it "receives the receivable account" do
+        expect(subject.id).to eq(1215634)
+        expect(subject.status).to eq(2)
+        expect(subject.status_name).to eq('received')
+        expect(subject.amount).to eq(150.99)
+        expect(subject.total_amount).to eq(150.99)
+        expect(subject.ticket_amount).to be_nil
+        expect(subject.interest_amount).to be_nil
+        expect(subject.discount_amount).to be_nil
+      end
+    end
+
+    context "when any parameter is invalid" do
+      let(:params) { { total_amount: nil, occurred_at: '2015-08-05', amount: 150.99 } }
+
+      it "raises request error" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#undo_receivement", vcr: true do
+    subject { client.receivable_accounts.undo_receivement(1215634, entity_id) }
+
+    it "undoes receivement of the receivable account" do
+      expect(subject.id).to eq(1215634)
+      expect(subject.status).to eq(1)
+      expect(subject.status_name).to eq('unreceived')
+      expect(subject.amount).to eq(150.99)
+      expect(subject.total_amount).to be_nil
+      expect(subject.ticket_amount).to be_nil
+      expect(subject.interest_amount).to be_nil
+      expect(subject.discount_amount).to be_nil
+    end
+  end
+
+  describe "#destroy", vcr: true do
+    subject { client.receivable_accounts.destroy(1215634, entity_id) }
+
+    context "when receivable account exists" do
+      it "returns true" do
+        expect(subject).to be_truthy
+      end
+    end
+
+    context "when receivable account does not exist" do
+      subject { client.receivable_accounts.destroy(1215631099, entity_id) }
+
+      it "raises request error" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+end

data/spec/lib/myfinance/response_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Myfinance::Response do
+  subject { described_class.new(response) }
+
+  describe "#resolve!" do
+    context 'when success' do
+      let(:response) { double(success?: true) }
+
+      it 'returns self' do
+        expect(subject.resolve!).to eq(response)
+      end
+
+      context 'when block given' do
+        let(:response) { double(success?: true) }
+
+        it 'returns block' do
+          expect(subject.resolve!{ response }).to eq(response)
+        end
+      end
+    end
+
+    context 'when timeout' do
+      let(:response) { double(success?: false, timed_out?: true) }
+
+      it 'raises RequestTimeout' do
+        expect { subject.resolve! }.to raise_error(Myfinance::RequestTimeout)
+      end
+    end
+
+    context 'when not success neither timeout' do
+      let(:response) { double(success?: false, timed_out?: false, code: 301, status_message: 'Moved Permanently', body: '') }
+
+      it 'raises RequestError' do
+        expect { subject.resolve! }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#parsed_body" do
+    let(:response) { double(success?: true) }
+
+    context "when JSON is invalid" do
+      it "returns empty hash" do
+        allow(subject).to receive(:body).and_return("{\"key\": ")
+        expect(subject.parsed_body).to eq({})
+      end
+    end
+
+    context "when JSON is valid" do
+      it "returns empty hash" do
+        allow(subject).to receive(:body).and_return("{\"key\": \"value\"}")
+        expect(MultiJson).to receive(:load).with("{\"key\": \"value\"}").and_call_original
+        expect(subject.parsed_body).to eq({ "key" => "value" })
+      end
+    end
+  end
+end

data/spec/myfinance_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Myfinance do
+  it 'has a version number' do
+    expect(Myfinance::VERSION).to_not be_nil
+  end
+
+  describe 'configuration' do
+    it 'should be done via block initialization' do
+      Myfinance.configure do |c|
+        c.user_agent = "My App v1.0"
+        c.url = "https://sandbox.myfinance.com.br"
+      end
+
+      expect(Myfinance.configuration.user_agent).to eq("My App v1.0")
+      expect(Myfinance.configuration.url).to eq("https://sandbox.myfinance.com.br")
+    end
+
+    it 'uses a singleton object for the configuration values' do
+      config1 = Myfinance.configuration
+      config2 = Myfinance.configuration
+      expect(config1).to eq(config2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require "codeclimate-test-reporter"
+require "simplecov"
+
+CodeClimate::TestReporter.start
+
+SimpleCov.start do
+  SimpleCov.maximum_coverage_drop 0.2
+
+  SimpleCov.start do
+    add_group  "Resources", "lib/myfinance/resources"
+    add_group  "Entities",  "lib/myfinance/entities"
+    add_filter "vendor"
+  end
+end
+
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "myfinance"
+require "pry"
+require "vcr"
+
+
+Dir["spec/support/**/*.rb"].each { |f| load f }
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/vcr_cassettes"
+  config.hook_into :typhoeus
+  config.ignore_hosts "codeclimate.com"
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    Myfinance.configuration.url = "https://sandbox.myfinance.com.br"
+    Typhoeus::Expectation.clear
+  end
+end
+

data/spec/support/client.rb

@@ -0,0 +1,3 @@
+def client
+  Myfinance.client('b552dd5a8598ca089b91c5e355a83b86e4696aefac9eaa05')
+end

data/spec/support/matchers/have_attr_accessor.rb

@@ -0,0 +1,18 @@
+RSpec::Matchers.define :have_attr_accessor do |field|
+  match do |object_instance|
+    object_instance.respond_to?(field) &&
+      object_instance.respond_to?("#{field}=")
+  end
+
+  failure_message do |object_instance|
+    "expected attr_accessor for #{field} on #{object_instance}"
+  end
+
+  failure_message_when_negated do |object_instance|
+    "expected attr_accessor for #{field} not to be defined on #{object_instance}"
+  end
+
+  description do
+    "checks to see if there is an attr accessor on the supplied object"
+  end
+end

data/spec/support/shared_examples/entity_attributes.rb

@@ -0,0 +1,9 @@
+shared_examples "entity_attributes" do |attrs|
+  attrs.each do |attr|
+    it { is_expected.to have_attr_accessor(attr) }
+  end
+
+  it "expect to cover all attributes" do
+    expect(subject.attributes.keys).to match_array(attrs)
+  end
+end