myfinance 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15567af21e2f9346ecca8476739e0941e73fe0c2
-  data.tar.gz: 424baecb3d29385ed5f087fafb2dac3211c36fcb
+  metadata.gz: 424d6b9f9c5e9b92218406695fc5123b74a5eb83
+  data.tar.gz: 590a80f04ef75b7f3d2e8267240cca236a3f14eb
 SHA512:
-  metadata.gz: b96eae20ad77abf42c2c4f17a91e6f8d40df0a9963cd999385a3450d46013ec8d064810a1fecc4a2180674446322b20233fc68bcddf90d60ac976c054626c74c
-  data.tar.gz: 08c4b2552c46957593ebb4f252dc2d54619b240a4c167fddc5eff634ebb1a00f416a26b03828f6d9cdf9827ab401f851dbd25638db8799eaa7a67ceb4007ce1a
+  metadata.gz: 12219c212fac0258f999773a8ad9b4ff1c152a9500d3511d390de1e1f369e14c3ed742f5ed9a231981a3bb72892ed4e138f2ded2f88f4cb777d689ad69048055
+  data.tar.gz: 086cc0d0389d02a0aaf8734f3170ea3d5edf6279b566a2f9b607f8e1bf0d8f8dbb31c500812774f9396ce208bd93b71272ecc478eadf0f0a37c85de79165b280

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    myfinance (0.3.3)
+    myfinance (0.4.0)
+      mime-types (~> 2.99)
       multi_json (~> 1.11)
       typhoeus (~> 0.8)
       virtus (~> 1.0.5)
@@ -15,9 +16,9 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    codeclimate-test-reporter (0.4.8)
+    codeclimate-test-reporter (0.5.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
+    coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     crack (0.4.3)
@@ -27,12 +28,13 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     equalizer (0.0.11)
-    ethon (0.8.0)
+    ethon (0.8.1)
       ffi (>= 1.3.0)
     ffi (1.9.10)
-    ice_nine (0.11.1)
+    ice_nine (0.11.2)
     json (1.8.3)
     method_source (0.8.2)
+    mime-types (2.99.1)
     multi_json (1.11.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -40,22 +42,22 @@ GEM
       slop (~> 3.4)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
-    rake (10.4.2)
+    rake (10.5.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
+    rspec-core (3.4.3)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
     safe_yaml (1.0.4)
-    simplecov (0.11.1)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -91,4 +93,4 @@ DEPENDENCIES
   webmock (~> 1.9.3)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -38,6 +38,7 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
 * [Entities API](https://app.myfinance.com.br/docs/api/entities) as `client.entities`
 * [PayableAccounts API](https://app.myfinance.com.br/docs/api/payable_accounts) as `client.payable_accounts`
 * [ReceivableAccounts API](https://app.myfinance.com.br/docs/api/receivable_accounts) as `client.receivable_accounts`
+* [Attachments API](https://app.myfinance.com.br/docs/api/attachments) as `client.attachments`
 
 ### Endpoints
 
@@ -203,6 +204,60 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   </tr>
 </table>
 
+#### [Attachments](https://app.myfinance.com.br/docs/api/attachments)
+
+<table>
+  <tr>
+    <th>HTTP method</th>
+    <th>Endpoint</th>
+    <th>Client method</th>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/attachments#get_index" target="_blank">
+        /entities/:entity_id/attachments
+      </a>
+    </td>
+    <td>
+      <code>client.attachments.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/attachments#get_show" target="_blank">
+        /entities/:entity_id/attachments/:id
+      </a>
+    </td>
+    <td>
+      <code>client.attachments.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/attachments#post_create" target="_blank">
+        /entities/:entity_id/attachments
+      </a>
+    </td>
+    <td>
+      <code>client.attachments.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/attachments#delete_destroy" target="_blank">
+        /entities/:entity_id/attachments/:id
+      </a>
+    </td>
+    <td>
+      <code>client.attachments.destroy</code>
+    </td>
+  </tr>
+</table>
+
 ### Configuration
 
 ```ruby

data/lib/myfinance.rb

@@ -1,5 +1,6 @@
 require "typhoeus"
 require "multi_json"
+require 'mime/types'
 
 require "myfinance/version"
 require "myfinance/configuration"
@@ -10,15 +11,18 @@ require "myfinance/entities/base"
 require "myfinance/entities/collection"
 require "myfinance/entities/entity"
 require "myfinance/entities/entity_collection"
+require "myfinance/entities/attachment_collection"
 require "myfinance/entities/financial_account"
 require "myfinance/entities/payable_account"
 require "myfinance/entities/receivable_account"
+require "myfinance/entities/attachment"
 
 require "myfinance/resources/base"
 require "myfinance/resources/entity"
 require "myfinance/resources/financial_account"
 require "myfinance/resources/payable_account"
 require "myfinance/resources/receivable_account"
+require "myfinance/resources/attachment"
 
 module Myfinance
   def self.configuration

data/lib/myfinance/client.rb

@@ -27,5 +27,9 @@ module Myfinance
     def receivable_accounts
       Myfinance::Resources::ReceivableAccount.new(http)
     end
+
+    def attachments
+      Myfinance::Resources::Attachment.new(http)
+    end
   end
 end

data/lib/myfinance/entities/attachment.rb

@@ -0,0 +1,15 @@
+module Myfinance
+  module Entities
+    class Attachment < Base
+      [:id, :entity_id, :attachment_file_size].each { |k| attribute k, Integer }
+
+      [:title, :attachment_file_name, :download_url,
+       :attachment_content_type].each { |k| attribute k, String }
+
+      [:created_at, :updated_at].each { |k| attribute k, DateTime }
+
+      attribute :attachables, Array[Hash]
+      attribute :links, Array[Hash[String => String]]
+    end
+  end
+end

data/lib/myfinance/entities/attachment_collection.rb

@@ -0,0 +1,14 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance attachments collection
+    #
+    class AttachmentCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::Attachment.new(attributes['attachment']))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/request.rb

@@ -25,7 +25,7 @@ module Myfinance
         body:             body,
         headers:          headers,
         accept_encoding:  "gzip"
-      }.reject {|k,v| v.nil?}
+      }.reject { |k,v| v.nil? }
     end
 
     def headers
@@ -33,7 +33,7 @@ module Myfinance
 
       {
         "Accept"         => "application/json",
-        "Content-Type"   => "application/json",
+        "Content-Type"   => content_type,
         "User-Agent"     => args[:user_agent],
         "Authorization"  => "Basic #{authorization_hash}",
         "ACCOUNT_ID"     => args[:account_id]
@@ -42,7 +42,7 @@ module Myfinance
 
     def body
       body = args[:body]
-      body = MultiJson.dump(body) if body.is_a?(Hash)
+      body = MultiJson.dump(body) if body.is_a?(Hash) && !args[:multipart]
       body
     end
 
@@ -50,5 +50,8 @@ module Myfinance
       ::Base64.strict_encode64("#{args[:token]}:X")
     end
 
+    def content_type
+      args[:multipart] ? nil : "application/json"
+    end
   end
 end

data/lib/myfinance/resources/attachment.rb

@@ -0,0 +1,60 @@
+module Myfinance
+  module Resources
+    class Attachment < Base
+      #
+      # List all attachments of the entity
+      #
+      # [API]
+      #   Method: <tt>GET /entities/:entity_id/attachments</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/attachments#get_index
+      #
+      def find_all(entity_id, params = { page: 1 })
+        http.get("/entities/#{entity_id}/attachments", body: params) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Show attachment details
+      #
+      # [API]
+      #   Method: <tt>GET /entities/:entity_id/attachments/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/attachments#get_show
+      #
+      def find(entity_id, attachment_id)
+        http.get("/entities/#{entity_id}/attachments/#{attachment_id}") do |response|
+          respond_with_object(response, 'attachment')
+        end
+      end
+
+      #
+      # Create an attachment
+      #
+      # [API]
+      #   Method: <tt>POST /entities/:entity_id/attachments</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/attachments#post_create
+      #
+      def create(entity_id, file, params = {})
+        params.merge!(attachment: file)
+        http.post("/entities/#{entity_id}/attachments", { body: { attachment: params }, multipart: true }) do |response|
+          respond_with_object(response, 'attachment')
+        end
+      end
+
+      #
+      # Destroy an attachment
+      #
+      # [API]
+      #   Method: <tt>DELETE /entities/:entity_id/attachments/:attachment_id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/attachments#delete_destroy
+      #
+      def destroy(entity_id, attachment_id)
+        http.delete("/entities/#{entity_id}/attachments/#{attachment_id}")
+      end
+    end
+  end
+end

data/lib/myfinance/version.rb

@@ -1,3 +1,3 @@
 module Myfinance
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/myfinance.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "typhoeus", "~> 0.8"
   spec.add_dependency "multi_json", "~> 1.11"
   spec.add_dependency "virtus", '~> 1.0.5'
+  spec.add_dependency "mime-types", '~> 2.99'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/lib/myfinance/client_spec.rb

@@ -53,4 +53,11 @@ describe Myfinance::Client do
       subject.receivable_accounts
     end
   end
+
+  describe "#attachments" do
+    it "instantiates a new Myfinance::Resources::Attachment" do
+      expect(Myfinance::Resources::Attachment).to receive(:new).with(subject.http)
+      subject.attachments
+    end
+  end
 end

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

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::AttachmentCollection 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: [{"attachment" => {"id" => 12,"entity_id" => 1,"title" => "","attachment_file_name" => "extratoPoup.ofx","attachment_content_type" => "application/octet-stream","attachment_file_size" => 5517,"created_at" => "2011-11-10T15:52:59-02:00","updated_at" => "2011-11-10T15:52:59-02:00","download_url" => "https://app.myfinance.com.br/entities/1/attachments/12/download","attachables" => [],"links" => []}}]) }
+
+  subject { Myfinance::Entities::AttachmentCollection.new(response) }
+
+  describe '#build' do
+    it 'returns order collection' do
+      expect(subject.build.class).to eq(Myfinance::Entities::AttachmentCollection)
+    end
+
+    it "returns orders" do
+      subject.build
+      expect(subject.collection.count).to eq(1)
+      expect(subject.collection.first.class).to eq(Myfinance::Entities::Attachment)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Myfinance::Entities::Attachment do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+    :id, :entity_id, :attachment_file_size, :created_at, :updated_at,
+    :title, :attachment_file_name, :download_url, :attachment_content_type,
+    :attachables, :links
+  ]
+end

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

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Myfinance::Resources::Attachment, vcr: true do
+  let!(:entity_id) { 3798 }
+  let(:file) { File.open('spec/support/attachments/attachment.png', 'r') }
+
+  describe "#find_all" do
+    context "when success" do
+      subject { client.attachments.find_all(3798) }
+
+      it "returns a list of attachments" do
+        expect(subject.class).to eq(Myfinance::Entities::AttachmentCollection)
+        expect(subject.collection.count).to eq(2)
+        expect(subject.collection.first.class).to eq(Myfinance::Entities::Attachment)
+        expect(subject.collection.first.id).to eq(1305)
+        expect(subject.collection.first.attachment_content_type).to eq("application/octet-stream")
+        expect(subject.collection.first.attachment_file_name).to eq("Mensalidade_MyFinance_15-07-2015.oxps")
+        expect(subject.collection.first.attachment_file_size).to eq(135328)
+        expect(subject.collection.first.download_url).to eq("https://sandbox.myfinance.com.br/entities/3798/attachments/1305/download")
+        expect(subject.collection.first.title).to be_nil
+        expect(subject.collection.first.created_at).to eq(DateTime.parse("2015-11-11T11:04:15-02:00"))
+        expect(subject.collection.first.updated_at).to eq(DateTime.parse("2015-11-11T11:04:15-02:00"))
+      end
+    end
+
+    context "when not found" do
+      let(:client) { Myfinance.client('') }
+      subject { client.attachments.find_all(3798) }
+
+      it "raises NotFound" do
+        expect{ subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#find" do
+    context "when success" do
+      subject { client.attachments.find(3798, 1305) }
+
+      it "returns a list of attachments" do
+        expect(subject.class).to eq(Myfinance::Entities::Attachment)
+        expect(subject.class).to eq(Myfinance::Entities::Attachment)
+        expect(subject.id).to eq(1305)
+        expect(subject.attachment_content_type).to eq("application/octet-stream")
+        expect(subject.attachment_file_name).to eq("Mensalidade_MyFinance_15-07-2015.oxps")
+        expect(subject.attachment_file_size).to eq(135328)
+        expect(subject.download_url).to eq("https://sandbox.myfinance.com.br/entities/3798/attachments/1305/download")
+        expect(subject.title).to be_nil
+        expect(subject.created_at).to eq(DateTime.parse("2015-11-11T11:04:15-02:00"))
+        expect(subject.updated_at).to eq(DateTime.parse("2015-11-11T11:04:15-02:00"))
+      end
+    end
+
+    context "when not found" do
+      let(:client) { Myfinance.client('') }
+      subject { client.attachments.find(3798, 1305) }
+
+      it "raises NotFound" do
+        expect{ subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#create" do
+    let(:params) { { title: 'My first attachment' } }
+    subject { client.attachments.create(entity_id, file, params) }
+
+    context "with success" do
+      it "creates a new object" do
+        expect(subject.id).to eq(1585)
+        expect(subject.entity_id).to eq(entity_id)
+        expect(subject.attachment_file_size).to eq(6115)
+        expect(subject.title).to eq(params[:title])
+        expect(subject.attachment_file_name).to eq('attachment.png')
+        expect(subject.download_url).to eq("https://sandbox.myfinance.com.br/entities/3798/attachments/1585/download")
+        expect(subject.attachment_content_type).to eq("image/png")
+        expect(subject.created_at).to eq(DateTime.parse("2016-03-01T15:42:30-03:00"))
+        expect(subject.updated_at).to eq(DateTime.parse("2016-03-01T15:42:30-03:00"))
+        expect(subject.attachables).to be_empty
+        expect(subject.links).to eq([{ "rel" => "self", "href" => "https://sandbox.myfinance.com.br/entities/3798/attachments/1585", "method" => "get" }, { "rel" => "download", "href" => "https://sandbox.myfinance.com.br/entities/3798/attachments/1585/download", "method" => "get" }])
+      end
+    end
+
+    context "when any data is invalid" do
+      subject { client.attachments.create(entity_id, nil, 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: 422, message: "Unprocessable Entity", body: { "attachment" => ["não pode ser vazio."] }).and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+
+    context "when entity does not exist" do
+      subject { client.attachments.create(0, file, 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ê não tem permissão para acessar este recurso." }).and_call_original
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+
+  describe "#destroy", vcr: true do
+    let(:attachment_id) { 1585 }
+    subject { client.attachments.destroy(entity_id, attachment_id) }
+
+    context "when attachment exists" do
+      it { expect(subject.code).to eq(200) }
+    end
+
+    context "when payable account does not exist" do
+      subject { client.attachments.destroy(entity_id, attachment_id) }
+
+      it "raises request error" do
+        expect { subject }.to raise_error(Myfinance::RequestError)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myfinance
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Eduardo Hertz
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -55,6 +55,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +236,8 @@ files:
 - lib/myfinance.rb
 - lib/myfinance/client.rb
 - lib/myfinance/configuration.rb
+- lib/myfinance/entities/attachment.rb
+- lib/myfinance/entities/attachment_collection.rb
 - lib/myfinance/entities/base.rb
 - lib/myfinance/entities/collection.rb
 - lib/myfinance/entities/entity.rb
@@ -232,6 +248,7 @@ files:
 - lib/myfinance/exception.rb
 - lib/myfinance/http.rb
 - lib/myfinance/request.rb
+- lib/myfinance/resources/attachment.rb
 - lib/myfinance/resources/base.rb
 - lib/myfinance/resources/entity.rb
 - lib/myfinance/resources/financial_account.rb
@@ -242,6 +259,8 @@ files:
 - myfinance.gemspec
 - spec/lib/myfinance/client_spec.rb
 - spec/lib/myfinance/configuration_spec.rb
+- spec/lib/myfinance/entities/attachment_collection_spec.rb
+- spec/lib/myfinance/entities/attachment_spec.rb
 - spec/lib/myfinance/entities/base_spec.rb
 - spec/lib/myfinance/entities/collection_spec.rb
 - spec/lib/myfinance/entities/entity_collection_spec.rb
@@ -250,12 +269,14 @@ files:
 - spec/lib/myfinance/entities/receivable_account_spec.rb
 - spec/lib/myfinance/http_spec.rb
 - spec/lib/myfinance/request_spec.rb
+- spec/lib/myfinance/resources/attachment_spec.rb
 - spec/lib/myfinance/resources/entity_spec.rb
 - spec/lib/myfinance/resources/payable_account_spec.rb
 - spec/lib/myfinance/resources/receivable_account_spec.rb
 - spec/lib/myfinance/response_spec.rb
 - spec/lib/myfinance_spec.rb
 - spec/spec_helper.rb
+- spec/support/attachments/attachment.png
 - spec/support/client.rb
 - spec/support/matchers/have_attr_accessor.rb
 - spec/support/shared_examples/entity_attributes.rb
@@ -289,6 +310,8 @@ summary: A Ruby client for the Myfinance REST API
 test_files:
 - spec/lib/myfinance/client_spec.rb
 - spec/lib/myfinance/configuration_spec.rb
+- spec/lib/myfinance/entities/attachment_collection_spec.rb
+- spec/lib/myfinance/entities/attachment_spec.rb
 - spec/lib/myfinance/entities/base_spec.rb
 - spec/lib/myfinance/entities/collection_spec.rb
 - spec/lib/myfinance/entities/entity_collection_spec.rb
@@ -297,12 +320,14 @@ test_files:
 - spec/lib/myfinance/entities/receivable_account_spec.rb
 - spec/lib/myfinance/http_spec.rb
 - spec/lib/myfinance/request_spec.rb
+- spec/lib/myfinance/resources/attachment_spec.rb
 - spec/lib/myfinance/resources/entity_spec.rb
 - spec/lib/myfinance/resources/payable_account_spec.rb
 - spec/lib/myfinance/resources/receivable_account_spec.rb
 - spec/lib/myfinance/response_spec.rb
 - spec/lib/myfinance_spec.rb
 - spec/spec_helper.rb
+- spec/support/attachments/attachment.png
 - spec/support/client.rb
 - spec/support/matchers/have_attr_accessor.rb
 - spec/support/shared_examples/entity_attributes.rb