myfinance 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a816590d9795f867bf791715ad87a56057513e6
-  data.tar.gz: 9ae9263ed7af1f079ca7483bd95a2351055cd8ca
+  metadata.gz: 47ca29c0b8c050bba8b6fcc65b54cc8f592a2f33
+  data.tar.gz: 95ece995c6429e18820a00a81b8854d0d57aad85
 SHA512:
-  metadata.gz: 42164b2bd9722065052b6199cdde3d29adf4cc6a1e40f993491e8f9a4689c2f844768d40466c1ecb0c926f54a7cda35ecfdef1dd56e8a764fbebe50dcb70dfb1
-  data.tar.gz: 7cae9bd220cf606c5ba66bc48639ea58d35d5830c9d9803f3d604bdac957de9fd181d3b6738d8b283cc50606dc1bb19fed7cca91d32238cc51a69b7f1303ce0e
+  metadata.gz: 347563b3d92b6e1a97b0930e7365889aab4be10896545cd7a59b4c8760f9aec220e744493f87af26fcd47f857e6142084b0e17a071cb1e37a119a00988326363
+  data.tar.gz: 93a52bc881d017a0abb9587ddd2518d14b3eedc48a124e8082e41c13b3bd97665f3bb2319bc896ac137e497c15d1a76f628c643d64dbc3b0bd091539fc6b0bc1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myfinance (0.2.0)
+    myfinance (0.3.0)
       multi_json (~> 1.9.0)
       typhoeus (~> 0.7.1)
       virtus (~> 1.0.5)

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby client for the [Myfinance](http://www.myfinance.com.br) REST API
 
-[![Gem version](https://badge.fury.io/rb/myfinance-client.png)](https://rubygems.org/gems/myfinance-client)
+[![Gem version](https://badge.fury.io/rb/myfinance.png)](https://rubygems.org/gems/myfinance)
 [![Build status](https://travis-ci.org/myfreecomm/myfinance-client-ruby.png?branch=master)](https://travis-ci.org/myfreecomm/myfinance-client-ruby)
 [![Test coverage](https://codeclimate.com/github/myfreecomm/myfinance-client-ruby/badges/coverage.svg)](https://codeclimate.com/github/myfreecomm/myfinance-client-ruby)
 [![Code Climate grade](https://codeclimate.com/github/myfreecomm/myfinance-client-ruby.png)](https://codeclimate.com/github/myfreecomm/myfinance-client-ruby)
@@ -214,6 +214,26 @@ Myfinance.configure do |m|
 end
 ```
 
+### Multiple accounts
+
+When an account has multiple accounts, an `ACCOUNT_ID` header is required for the requests. To instantiate a new client with an `ACCOUNT_ID` header:
+
+```ruby
+client = Myfinance.client("YOUR_TOKEN_HERE", ACCOUNT_ID) # where ACCOUNT_ID is the ID of the account
+```
+
+If you instantiate a new client without an `account_id` and the user has more than one account, the lib will raise a [`Myfinance::RequestError`](https://github.com/myfreecomm/myfinance-client-ruby/blob/master/lib/myfinance/response.rb#L33) error. The list of available accounts will be in the body of the object.
+
+```ruby
+begin
+  client.entities.find_all
+rescue Myfinance::RequestError => e
+  e.body # { "error" => "O cabeçalho da requisição não possui o atributo ACCOUNT_ID.", "accounts" => [{"account" => { "id" => 3, .. } }, { ... }] }
+  e.message # O cabeçalho da requisição não possui o atributo ACCOUNT_ID.
+  e.code # 422
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/myfinance/client.rb

@@ -5,8 +5,8 @@ module Myfinance
   class Client
     attr_reader :http
 
-    def initialize(token)
-      @http = Http.new(token)
+    def initialize(token, account_id = nil)
+      @http = Http.new(token, account_id)
     end
 
     def authenticated?

data/lib/myfinance/http.rb

@@ -3,10 +3,11 @@ require "myfinance/response"
 
 module Myfinance
   class Http
-    attr_reader :token
+    attr_reader :token, :account_id
 
-    def initialize(token)
+    def initialize(token, account_id = nil)
       @token = token
+      @account_id = account_id
     end
 
     %w[get post delete put].each do |m|
@@ -22,7 +23,8 @@ module Myfinance
         method: method,
         token: token,
         url: "#{Myfinance.configuration.url}#{path}",
-        user_agent: Myfinance.configuration.user_agent
+        user_agent: Myfinance.configuration.user_agent,
+        account_id: account_id
       }))
 
       response = Response.new(request.run)

data/lib/myfinance/request.rb

@@ -35,8 +35,9 @@ module Myfinance
         "Accept"         => "application/json",
         "Content-Type"   => "application/json",
         "User-Agent"     => args[:user_agent],
-        "Authorization" => "Basic #{authorization_hash}"
-      }.merge(headers)
+        "Authorization"  => "Basic #{authorization_hash}",
+        "ACCOUNT_ID"     => args[:account_id]
+      }.merge(headers).delete_if { |_,v| v.nil? || v.to_s.empty? }
     end
 
     def body

data/lib/myfinance/response.rb

@@ -32,10 +32,14 @@ module Myfinance
     def error!
       raise RequestError.new(
         code:    code,
-        message: status_message,
-        body:    body
+        message: request_error_message,
+        body:    parsed_body
       )
     end
 
+    def request_error_message
+      return status_message if !status_message.nil? && status_message != ""
+      parsed_body["error"] || ""
+    end
   end
 end

data/lib/myfinance/version.rb

@@ -1,3 +1,3 @@
 module Myfinance
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/myfinance/client_spec.rb

@@ -5,9 +5,16 @@ describe Myfinance::Client do
 
   describe "#initialize" do
     it "instantiates a new Myfinance::Http object" do
-      expect(Myfinance::Http).to receive(:new).with("abc")
+      expect(Myfinance::Http).to receive(:new).with("abc", nil)
       Myfinance::Client.new("abc")
     end
+
+    context "when account_id is present" do
+      it "instantiates a new Myfinance::Http object" do
+        expect(Myfinance::Http).to receive(:new).with("abc", 123)
+        Myfinance::Client.new("abc", 123)
+      end
+    end
   end
 
   describe "#authenticated?" do

data/spec/lib/myfinance/http_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe Myfinance::Http do
-  subject { Myfinance::Http.new('b552dd5a8598ca089b91c5e355a83b86e4696aefac9eaa05') }
+  let(:account_id) { 12 }
+  subject { Myfinance::Http.new('b552dd5a8598ca089b91c5e355a83b86e4696aefac9eaa05', account_id) }
 
   describe '#get' do
     let(:http_method) { :get }

data/spec/lib/myfinance/request_spec.rb

@@ -20,10 +20,37 @@ describe Myfinance::Request do
       subject.run
     end
 
-    it 'generates the base 64 of the user token' do
+    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
+
+    context "when account_id is empty" do
+      subject { described_class.new({ method: 'post', params: {}, url: Myfinance.configuration.url, user_agent: 'My Test User-Agent', token: 'my-auth-hash', account_id: "" }) }
+
+      it "does not add ACCOUNT_ID on headers" 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
+    end
+
+    context "when account_id is nil" do
+      subject { described_class.new({ method: 'post', params: {}, url: Myfinance.configuration.url, user_agent: 'My Test User-Agent', token: 'my-auth-hash', account_id: nil }) }
+
+      it "does not add ACCOUNT_ID on headers" 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
+    end
+
+    context "when account_id is present" do
+      subject { described_class.new({ method: 'post', params: {}, url: Myfinance.configuration.url, user_agent: 'My Test User-Agent', token: 'my-auth-hash', account_id: 12 }) }
+
+      it "does not add ACCOUNT_ID on headers" 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=", "ACCOUNT_ID" => 12 }, accept_encoding: "gzip" }).and_return(double(run: true, response: true))
+        subject.run
+      end
+    end
   end
 end

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

@@ -66,7 +66,7 @@ describe Myfinance::Resources::PayableAccount do
       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(Myfinance::RequestError).to receive(:new).with(code: 422, message: "", body: { "competency_month" => ["não pode ser vazio"], "due_date" => ["não é uma data válida"] }).and_call_original
         expect { subject }.to raise_error(Myfinance::RequestError)
       end
     end
@@ -79,7 +79,7 @@ describe Myfinance::Resources::PayableAccount do
       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(Myfinance::RequestError).to receive(:new).with(code: 403, message: "Forbidden", body: {"error" => "Você não tem permissão para acessar este recurso." }).and_call_original
         expect { subject }.to raise_error(Myfinance::RequestError)
       end
     end

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

@@ -66,7 +66,7 @@ describe Myfinance::Resources::ReceivableAccount do
       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(Myfinance::RequestError).to receive(:new).with(code: 422, message: "", body: { "competency_month" => ["não pode ser vazio"], "due_date" => ["não é uma data válida"] }).and_call_original
         expect { subject }.to raise_error(Myfinance::RequestError)
       end
     end
@@ -79,7 +79,7 @@ describe Myfinance::Resources::ReceivableAccount do
       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(Myfinance::RequestError).to receive(:new).with(code: 403, message: "Forbidden", body: { "error" => "Você não tem permissão para acessar este recurso." }).and_call_original
         expect { subject }.to raise_error(Myfinance::RequestError)
       end
     end

data/spec/lib/myfinance/response_spec.rb

@@ -32,12 +32,45 @@ describe Myfinance::Response 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)
+        expect { subject.resolve! }.to raise_error do |error|
+          expect(error).to be_a(Myfinance::RequestError)
+          expect(error.code).to eq(301)
+          expect(error.message).to eq("Moved Permanently")
+          expect(error.body).to eq({})
+        end
+      end
+
+      context "when status_message is empty" do
+        context "when body has an 'error' key" do
+          let(:response) { double(success?: false, timed_out?: false, code: 301, status_message: '', body: '{"error": "My custom error message"}') }
+
+          it "raises RequestError with custom message" do
+            expect { subject.resolve! }.to raise_error do |error|
+              expect(error).to be_a(Myfinance::RequestError)
+              expect(error.code).to eq(301)
+              expect(error.message).to eq("My custom error message")
+              expect(error.body).to eq({ "error" => "My custom error message" })
+            end
+          end
+        end
+
+        context "when body has an 'error' key" do
+          let(:response) { double(success?: false, timed_out?: false, code: 301, status_message: '', body: '') }
+
+          it "raises RequestError with empty message" do
+            expect { subject.resolve! }.to raise_error do |error|
+              expect(error).to be_a(Myfinance::RequestError)
+              expect(error.code).to eq(301)
+              expect(error.message).to eq("")
+              expect(error.body).to eq({})
+            end
+          end
+        end
       end
     end
   end
 
-  describe "#parsed_body" do
+  describe "#body" do
     let(:response) { double(success?: true) }
 
     context "when JSON is invalid" do

data/spec/support/shared_examples/http_request_methods.rb

@@ -1,7 +1,7 @@
 shared_examples 'available http request methods' do
   it "instantiates a new Request object" do
     VCR.use_cassette("client/#{http_method}/request") do
-      expect(Myfinance::Request).to receive(:new).and_call_original
+      expect(Myfinance::Request).to receive(:new).with({ body: params, method: http_method, token: "b552dd5a8598ca089b91c5e355a83b86e4696aefac9eaa05", url: "#{Myfinance.configuration.url}#{url}", user_agent: "Myfinance Ruby Client v#{Myfinance::VERSION}", account_id: account_id }).and_call_original
       subject.send(http_method, url, body: params)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myfinance
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eduardo Hertz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus