myfinance 0.1.0

data/lib/myfinance/response.rb

@@ -0,0 +1,41 @@
+require "myfinance/exception"
+
+module Myfinance
+  RequestTimeout = Class.new(Exception)
+  RequestError   = Class.new(Exception)
+
+  class Response < SimpleDelegator
+
+    def resolve!(&block)
+      if success?
+        block_given? ? yield(self) : self
+      elsif timed_out?
+        timeout!
+      else
+        error!
+      end
+    end
+
+    def parsed_body(key=nil)
+      return MultiJson.load(self.body)[key] unless key.nil?
+      MultiJson.load(self.body)
+    rescue MultiJson::ParseError
+      {}
+    end
+
+    private
+
+    def timeout!
+      raise RequestTimeout
+    end
+
+    def error!
+      raise RequestError.new(
+        code:    code,
+        message: status_message,
+        body:    body
+      )
+    end
+
+  end
+end

data/lib/myfinance/version.rb

@@ -0,0 +1,3 @@
+module Myfinance
+  VERSION = "0.1.0"
+end

data/myfinance.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'myfinance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "myfinance"
+  spec.version       = Myfinance::VERSION
+  spec.authors       = ["Eduardo Hertz", "Rodrigo Tassinari"]
+  spec.email         = ["eduardohertz@gmail.com", "rodrigo@pittlandia.net"]
+
+  spec.summary       = %q{A Ruby client for the Myfinance REST API}
+  spec.description   = %q{A Ruby client for the Myfinance REST API: https://app.myfinance.com.br/docs/api}
+  spec.homepage      = "https://github.com/myfreecomm/myfinance-client-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files`.split($/).reject { |f| f =~ %r{(vcr_cassettes)/} }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "typhoeus", "~> 0.7.1"
+  spec.add_dependency "multi_json", "~> 1.9.0"
+  spec.add_dependency "virtus", '~> 1.0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr", "~> 2.4"
+  spec.add_development_dependency "webmock", "~> 1.9.3"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "awesome_print", "~> 1.1"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end

data/spec/lib/myfinance/client_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Myfinance::Client do
+  subject { client }
+
+  describe "#initialize" do
+    it "instantiates a new Myfinance::Http object" do
+      expect(Myfinance::Http).to receive(:new).with("abc")
+      Myfinance::Client.new("abc")
+    end
+  end
+
+  describe "#authenticated?" do
+    context "with a valid token" do
+      it "returns true" do
+        VCR.use_cassette("client/authenticated/true") { expect(subject.authenticated?).to be_truthy }
+      end
+    end
+
+    context "with an invalid token" do
+      subject { described_class.new("FAKE-TOKEN") }
+
+      it "returns false" do
+        VCR.use_cassette("client/authenticated/false") { expect(subject.authenticated?).to be_falsey }
+      end
+    end
+  end
+
+  describe "#entities" do
+    it "instantiates a new Myfinance::Resources::Entity" do
+      expect(Myfinance::Resources::Entity).to receive(:new).with(subject.http)
+      subject.entities
+    end
+  end
+
+  describe "#payable_accounts" do
+    it "instantiates a new Myfinance::Resources::PayableAccount" do
+      expect(Myfinance::Resources::PayableAccount).to receive(:new).with(subject.http)
+      subject.payable_accounts
+    end
+  end
+
+  describe "#receivable_accounts" do
+    it "instantiates a new Myfinance::Resources::ReceivableAccount" do
+      expect(Myfinance::Resources::ReceivableAccount).to receive(:new).with(subject.http)
+      subject.receivable_accounts
+    end
+  end
+end

data/spec/lib/myfinance/configuration_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Myfinance::Configuration do
+  subject { Myfinance::Configuration.new }
+
+  it "uses the production Myfinance URL by default" do
+    expect(subject.url).to eq("https://app.myfinance.com.br")
+  end
+
+  it "uses a default user agent" do
+    expect(subject.user_agent).to eq("Myfinance Ruby Client v#{Myfinance::VERSION}")
+  end
+
+  it 'allows setting the configuration parameters' do
+    subject.url = "https://sandbox.myfinance.com.br"
+    subject.user_agent = "My specific user agent"
+
+    expect(subject.url).to eq("https://sandbox.myfinance.com.br")
+    expect(subject.user_agent).to eq("My specific user agent")
+  end
+
+  it 'does not respond to #token' do
+    expect(subject).to_not respond_to(:token)
+  end
+end

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

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Myfinance::Entities::Base do
+
+  class DummyEntity < Myfinance::Entities::Base
+    attribute :property_1, String
+    attribute :property_2, String
+  end
+
+  let(:hash) { { property_1: 1, property_2: 2 } }
+  subject    { DummyEntity.new(hash) }
+
+  it "builds an object from a hash" do
+    expect(subject).to respond_to(:property_1)
+    expect(subject).to respond_to(:property_2)
+    expect(subject.property_1).to eq("1")
+    expect(subject.property_2).to eq("2")
+  end
+
+  describe "#attributes" do
+    it "returns a hash from object attributes" do
+      expect(subject.to_hash).to eq({
+        property_1: "1",
+        property_2: "2"
+      })
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::Collection do
+  let(:response) { double(headers: {"Link" => "<https://sandbox.myfinance.com.br/entities?page=3>; rel=next, <http://https://sandbox.myfinance.com.br/entities?page=1>; rel=prev, <http://https://sandbox.myfinance.com.br/entities?page=3>; rel=last, <http://https://sandbox.myfinance.com.br/entities?page=1>; rel=first" },
+                          body: "[{\"entity\":{\"account_id\":3613,\"charging_uuid\":null,\"created_at\":\"2015-07-29T11:04:45-03:00\",\"default_in_menu\":true,\"deleted_at\":null,\"federation_subscription_number\":\"\",\"force_destroy\":false,\"id\":3798,\"imported_from_sync_at\":null,\"name\":\"Minhas Finan\\u00e7as\",\"updated_at\":\"2015-07-29T14:30:36-03:00\"}}]") }
+
+  subject { described_class.new(response) }
+
+  describe '#build' do
+    it 'raises NotImplementedError' do
+      expect { subject.build }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns next page (3)' do
+      expect(subject.next_page).to eq(3)
+    end
+
+    context 'when there is no next page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.next_page).to be_nil
+      end
+    end
+  end
+
+  describe '#last_page' do
+    it 'returns last page (3)' do
+      expect(subject.last_page).to eq(3)
+    end
+
+    context 'when there is no last page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.last_page).to be_nil
+      end
+    end
+  end
+
+  describe '#previous_page' do
+    it 'returns previous page (3)' do
+      expect(subject.previous_page).to eq(1)
+    end
+
+    context 'when there is no previous page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.previous_page).to be_nil
+      end
+    end
+  end
+
+  describe '#first_page' do
+    it 'returns first page (3)' do
+      expect(subject.first_page).to eq(1)
+    end
+
+    context 'when there is no first page' do
+      let(:response) { double(headers: {"Link" => ""}, body: "") }
+
+      it 'returns nil' do
+        expect(subject.first_page).to be_nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::EntityCollection do
+  let(:response) { double(headers: { "Link" => "<https://sandbox.myfinance.com.br/entities?page=3>; rel=next, <http://https://sandbox.myfinance.com.br/entities?page=1>; rel=prev, <http://https://sandbox.myfinance.com.br/entities?page=3>; rel=last, <http://https://sandbox.myfinance.com.br/entities?page=1>; rel=first" },
+                          parsed_body: [{"entity" => {"account_id" => 3613,"charging_uuid" => nil,"created_at" => "2015-07-29T11:04:45-03:00","default_in_menu" => true,"deleted_at" => nil,"federation_subscription_number" => "","force_destroy" => false,"id" => 3798,"imported_from_sync_at" => nil,"name" => "Minhas Finan\\u00e7as","updated_at" => "2015-07-29T14:30:36-03:00"} }]) }
+
+  subject { Myfinance::Entities::EntityCollection.new(response) }
+
+  describe '#build' do
+    it 'returns order collection' do
+      expect(subject.build.class).to eq(Myfinance::Entities::EntityCollection)
+    end
+
+    it "returns orders" do
+      subject.build
+      expect(subject.collection.count).to eq(1)
+      expect(subject.collection.first.class).to eq(Myfinance::Entities::Entity)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::Entity do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :name, :account_id,:charging_uuid, :created_at,
+    :default_in_menu, :deleted_at, :federation_subscription_number,
+    :imported_from_sync_at, :updated_at
+  ]
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::PayableAccount do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :entity_id, :status, :status_name, :due_date, :occurred_at, :ticket_amount, :interest_amount, :amount,
+    :discount_amount, :total_amount, :description, :document, :document_emission_date, :observation, :remind,
+    :reminded_at, :income_tax_relevant, :category_id, :classification_center_id, :expected_deposit_account_id,
+    :recurrence_id, :person_id, :recurrent, :parcelled, :recurrence_period, :number_of_parcels, :current_parcel,
+    :competency_month, :financial_account_taxes_attributes, :reconciliations, :links, :created_at, :updated_at
+  ]
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::ReceivableAccount do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :entity_id, :status, :status_name, :due_date, :occurred_at, :ticket_amount, :interest_amount, :amount,
+    :discount_amount, :total_amount, :description, :document, :document_emission_date, :observation, :remind,
+    :reminded_at, :income_tax_relevant, :category_id, :classification_center_id, :expected_deposit_account_id,
+    :recurrence_id, :person_id, :recurrent, :parcelled, :recurrence_period, :number_of_parcels, :current_parcel,
+    :competency_month, :financial_account_taxes_attributes, :reconciliations, :links, :created_at, :updated_at
+  ]
+end

data/spec/lib/myfinance/http_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Myfinance::Http do
+  subject { Myfinance::Http.new('b552dd5a8598ca089b91c5e355a83b86e4696aefac9eaa05') }
+
+  describe '#get' do
+    let(:http_method) { :get }
+    let(:url) { '/accounts' }
+    let(:params) { {} }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#post' do
+    let(:http_method) { :post }
+    let(:url) { '/entities' }
+    let(:params) { { entity: { name: 'Second entity' } } }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#put' do
+    let(:http_method) { :put }
+    let(:url) { '/entities/3798' }
+    let(:params) { { entity: { name: 'Second updated entity' } } }
+
+    it_behaves_like 'available http request methods'
+  end
+
+  describe '#delete' do
+    let(:http_method) { :delete }
+    let(:url) { '/entities/3799' }
+    let(:params) { {} }
+
+    it_behaves_like 'available http request methods'
+  end
+end

data/spec/lib/myfinance/request_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Myfinance::Request do
+  describe "#run" do
+    subject { described_class.new({ method: 'post', params: {}, url: Myfinance.configuration.url, user_agent: 'My Test User-Agent', token: 'my-auth-hash' }) }
+
+    it "does a request using Typhoeus::Request" do
+      expect(Typhoeus::Request).to receive(:new).with("https://sandbox.myfinance.com.br", { method: "post", params: {}, headers: { "Accept" => "application/json", "Content-Type" => "application/json", "User-Agent" => "My Test User-Agent", "Authorization" => "Basic bXktYXV0aC1oYXNoOlg=" }, accept_encoding: "gzip" }).and_return(double(run: true, response: true))
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#run" do
+      expect_any_instance_of(Typhoeus::Request).to receive(:run)
+      subject.run
+    end
+
+    it "invokes Typhoeus::Request#response" do
+      allow_any_instance_of(Typhoeus::Request).to receive(:run)
+      expect_any_instance_of(Typhoeus::Request).to receive(:response)
+      subject.run
+    end
+
+    it 'generates the base 64 of the user token' do
+      allow_any_instance_of(Typhoeus::Request).to receive(:run)
+      expect(Base64).to receive(:strict_encode64).with("my-auth-hash:X").and_call_original
+      subject.run
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe Myfinance::Resources::Entity do
+  describe "#find_all", vcr: true do
+    context "when success" do
+      subject { client.entities.find_all }
+
+      it "returns a find_all of orders" do
+        expect(subject.class).to eq(Myfinance::Entities::EntityCollection)
+        expect(subject.collection.first.class).to eq(Myfinance::Entities::Entity)
+        expect(subject.collection.first.id).to eq(3798)
+        expect(subject.collection.first.name).to eq("Minhas Finanças")
+        expect(subject.collection.first.account_id).to eq(3613)
+        expect(subject.collection.first.charging_uuid).to be_nil
+        expect(subject.collection.first.created_at).to eq(DateTime.parse("2015-07-29T11:04:45-03:00"))
+        expect(subject.collection.first.default_in_menu).to be_truthy
+        expect(subject.collection.first.deleted_at).to be_nil
+        expect(subject.collection.first.federation_subscription_number).to eq("")
+        expect(subject.collection.first.imported_from_sync_at).to be_nil
+        expect(subject.collection.first.updated_at).to eq(DateTime.parse("2015-07-29T14:30:36-03:00"))
+        expect(subject.collection.count).to eq(1)
+      end
+    end
+
+    context "when not found" do
+      let(:client) { Myfinance.client('') }
+      subject { client.entities.find_all }
+
+      it "raises NotFound" do
+        expect{ subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#find", vcr: true do
+    context "when success" do
+      subject { client.entities.find(3798) }
+
+      it "returns a find_all of orders" do
+        expect(subject.class).to eq(Myfinance::Entities::Entity)
+        expect(subject.id).to eq(3798)
+        expect(subject.name).to eq("Minhas Finanças")
+        expect(subject.account_id).to eq(3613)
+        expect(subject.charging_uuid).to be_nil
+        expect(subject.created_at).to eq(DateTime.parse("2015-07-29T11:04:45-03:00"))
+        expect(subject.default_in_menu).to be_truthy
+        expect(subject.deleted_at).to be_nil
+        expect(subject.federation_subscription_number).to eq("")
+        expect(subject.imported_from_sync_at).to be_nil
+        expect(subject.updated_at).to eq(DateTime.parse("2015-07-29T14:30:36-03:00"))
+      end
+    end
+
+    context "when not found" do
+      let(:client) { Myfinance.client('') }
+      subject { client.entities.find(3798) }
+
+      it "raises NotFound" do
+        expect{ subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+end