myfinance 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 024112106d480588060a462d76f92aeaeddd212d
-  data.tar.gz: cbe82bdb2fc21cedc4217c2621be49d2dacc6aac
+  metadata.gz: ecda9fc35e75861ba16e84234727cfa22b373195
+  data.tar.gz: 9b84355ad4ecfba37229a672881990f14392629f
 SHA512:
-  metadata.gz: 3c07ad4ba4f8b1e77f7b033a4fc69836980a017ff3b3e3e75c826c97fe8cf932704ae39e89f33a9e30c5b4282df419635920a3ded9998563de04271d9e572439
-  data.tar.gz: cbb731593e6744ba20f7bb5ad8e18b1dbf7813778c9893b8f0a5beab681003296c0b3d6516881f59a70f6f85ad5057e7a051fc48732b1a5cad1eabf83c074550
+  metadata.gz: 8e0a5874346c8d48b939caa538e287aa421774b58eac2d9f175abcd2330f5f9e2d2bb0f3197fc031f8f391376c37a93dfddf0aa6f078541d651164a384906b8f
+  data.tar.gz: 989b52db753b0bf88c121001ea05090a8185b710a3de13213ae63aa6c8a1ea4fc22035e6019599aa7ec6c9761627faa0cc0bd786532158ad056937233655d028

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myfinance (0.5.0)
+    myfinance (0.6.0)
       mime-types (~> 2.99)
       multi_json (~> 1.11)
       typhoeus (~> 0.8)

data/README.md

@@ -44,6 +44,8 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
 * [Categories API](https://app.myfinance.com.br/docs/api/categories) as `client.categories`
 * [ClassificationCenters API](https://app.myfinance.com.br/docs/api/classification_centers) as `client.classification_centers`
 * [People API](https://app.myfinance.com.br/docs/api/people) as `client.people`
+* [Webhooks API](https://app.myfinance.com.br/docs/api/webhooks) as `client.webhooks`
+* [Taxes API](https://app.myfinance.com.br/docs/api/taxes) as `client.taxes`
 
 ### Endpoints
 
@@ -360,7 +362,6 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   <tr>
     <td><code>GET</code></td>
     <td>
-
       <a href="https://app.myfinance.com.br/docs/api/categories#get_index" target="_blank">
         /categories
       </a>
@@ -567,6 +568,103 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   </tr>
 </table>
 
+#### [Webhooks](https://app.myfinance.com.br/docs/api/webhooks)
+
+<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/webhooks#get_index" target="_blank">
+        /integrations/webhooks
+      </a>
+    </td>
+    <td>
+      <code>client.webhooks.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/webhooks#get_show" target="_blank">
+        /integrations/webhooks/:id
+      </a>
+    </td>
+    <td>
+      <code>client.webhooks.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/webhooks#post_create" target="_blank">
+        /integrations/webhooks
+      </a>
+    </td>
+    <td>
+      <code>client.webhooks.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/webhooks#put_update" target="_blank">
+        /integrations/webhooks/:id
+      </a>
+    </td>
+    <td>
+      <code>client.webhooks.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/webhooks#delete_destroy" target="_blank">
+        /integrations/webhooks/:id
+      </a>
+    </td>
+    <td>
+      <code>client.webhooks.destroy</code>
+    </td>
+  </tr>
+</table>
+
+#### [Taxes](https://app.myfinance.com.br/docs/api/taxes)
+
+<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/taxes#get_index" target="_blank">
+        /taxes
+      </a>
+    </td>
+    <td>
+      <code>client.taxes.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/taxes#get_show" target="_blank">
+        /taxes/:id
+      </a>
+    </td>
+    <td>
+      <code>client.taxes.find</code>
+    </td>
+  </tr>
+</table>
+
 ### Configuration
 
 ```ruby

data/lib/myfinance.rb

@@ -26,6 +26,10 @@ require "myfinance/entities/deposit_account"
 require "myfinance/entities/deposit_account_collection"
 require "myfinance/entities/person"
 require "myfinance/entities/person_collection"
+require "myfinance/entities/webhook"
+require "myfinance/entities/webhook_collection"
+require "myfinance/entities/tax"
+require "myfinance/entities/tax_collection"
 
 require "myfinance/resources/base"
 require "myfinance/resources/entity"
@@ -38,6 +42,8 @@ require "myfinance/resources/category"
 require "myfinance/resources/account"
 require "myfinance/resources/deposit_account"
 require "myfinance/resources/person"
+require "myfinance/resources/webhook"
+require "myfinance/resources/tax"
 
 module Myfinance
   def self.configuration

data/lib/myfinance/client.rb

@@ -50,6 +50,14 @@ module Myfinance
 
     def people
       Myfinance::Resources::Person.new(http)
+    end      
+
+    def webhooks
+      Myfinance::Resources::Webhook.new(http)
+    end
+
+    def taxes
+      Myfinance::Resources::Tax.new(http)
     end
   end
 end

data/lib/myfinance/entities/tax.rb

@@ -0,0 +1,10 @@
+module Myfinance
+  module Entities
+    class Tax < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/tax_collection.rb

@@ -0,0 +1,18 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance classification center
+    #
+    class TaxCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(
+            Myfinance::Entities::Tax.new(
+              attributes["tax"]
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/webhook.rb

@@ -0,0 +1,14 @@
+module Myfinance
+  module Entities
+    class Webhook < Base
+      attribute :account_id, Integer
+      attribute :created_at, DateTime
+      attribute :description, String
+      attribute :entity_id, Integer
+      attribute :healthy_check_code, String
+      attribute :id, Integer
+      attribute :updated_at, DateTime
+      attribute :url, String
+    end
+  end
+end

data/lib/myfinance/entities/webhook_collection.rb

@@ -0,0 +1,16 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance webhook collection
+    #
+    class WebhookCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(
+            Myfinance::Entities::Webhook.new(attributes["webhook"])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/tax.rb

@@ -0,0 +1,39 @@
+module Myfinance
+  module Resources
+    #
+    # A wrapper to Myfinance taxes API
+    #
+    # [API]
+    #   Documentation: https://app.myfinance.com.br/docs/api/taxes
+    #
+    class Tax < Base
+      #
+      # List all taxes
+      #
+      # [API]
+      #   Method: <tt>GET /taxes</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/taxes#get_index
+      #
+      def find_all
+        http.get("/taxes", body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Show a tax
+      #
+      # [API]
+      #   Method: <tt>GET /taxes/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/taxes#get_show
+      #
+      def find(id)
+        http.get("/taxes/#{id}", body: {}) do |response|
+          respond_with_object(response, "tax")
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/webhook.rb

@@ -0,0 +1,83 @@
+module Myfinance
+  module Resources
+    #
+    # A wrapper to Myfinance Webhooks API
+    #
+    # [API]
+    #   Documentation: https://app.myfinance.com.br/docs/api/webhooks
+    #
+    class Webhook < Base
+      #
+      # List all webhooks
+      #
+      # [API]
+      #   Method: <tt>GET /integrations/webhooks</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/webhooks#get_index
+      #
+      def find_all
+        http.get("/integrations/webhooks", body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # List a webhook
+      #
+      # [API]
+      #   Method: <tt>GET /integrations/webhooks/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/webhooks#get_show
+      #
+      def find(id)
+        http.get("/integrations/webhooks/#{id}", body: {}) do |response|
+          respond_with_object response, "webhook"
+        end
+      end
+
+      #
+      # Create a webhook
+      #
+      # [API]
+      #   Method: <tt>POST /integrations/webhooks</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/webhooks#post_create
+      #
+      def create(params)
+        http.post("/integrations/webhooks", body: { webhook: params }) do |response|
+          respond_with_object(response, "webhook")
+        end
+      end
+
+      #
+      # Updates a webhook
+      #
+      # [API]
+      #   Method: <tt>PUT /integrations/webhooks/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/webhooks#put_update
+      #
+      def update(id, params = {})
+        http.put(
+          "/integrations/webhooks/#{id}", body: { webhook: params }
+        ) do |response|
+          respond_with_object(response, "webhook")
+        end
+      end
+
+      #
+      # Destroy a webhook
+      #
+      # [API]
+      #   Method: <tt>DELETE /integrations/webhooks/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/webhooks#delete_destroy
+      #
+      def destroy(id)
+        http.delete("/integrations/webhooks/#{id}", body: {}) do |response|
+          respond_with_object(response, "webhook")
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/version.rb

@@ -1,3 +1,3 @@
 module Myfinance
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/lib/myfinance/client_spec.rb

@@ -100,4 +100,18 @@ describe Myfinance::Client do
       subject.people
     end
   end
+
+  describe "#webhooks" do
+    it "instantiates a new Myfinance::Resources::Webhook" do
+      expect(Myfinance::Resources::Webhook).to receive(:new).with(subject.http)
+      subject.webhooks
+    end
+  end
+
+  describe "#taxes" do
+    it "instantiates a new Myfinance::Resources::Tax" do
+      expect(Myfinance::Resources::Tax).to receive(:new).with(subject.http)
+      subject.taxes
+    end
+  end
 end

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

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Myfinance::Entities::TaxCollection 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::Tax)
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Myfinance::Entities::Tax do
+  it_behaves_like "entity_attributes", [:created_at, :id, :name, :updated_at]
+end

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

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Myfinance::Entities::WebhookCollection do
+  let(:response) do
+    double(
+      headers: {},
+      parsed_body: [
+        {
+          "webhook" => {
+            "account_id" => 3613,
+            "created_at" => "2015-09-21T15:41:05-03:00",
+            "description" => "Webhook test",
+            "entity_id" => 3798,
+            "healthy_check_code" => "200",
+            "id" => 76,
+            "updated_at" => "2015-09-21T16:08:48-03:00",
+            "url" => "https://sandbox.myfinance.com.br/docs/api/webhooks"
+          }
+        },{
+          "webhook" => {
+            "account_id" => 3613,
+            "created_at" => "2015-09-21T16:15:22-03:00",
+            "description" => "Webhook 1",
+            "entity_id" => 3798,
+            "healthy_check_code" => "200",
+            "id" => 77,
+            "updated_at" => "2015-09-21T16:15:35-03:00",
+            "url" => "https://sandbox.myfinance.com.br/docs/api/webhooks"
+          }
+        }
+      ]
+    )
+  end
+
+  subject { Myfinance::Entities::WebhookCollection.new(response) }
+
+  describe "#build" do
+    it "returns order collection" do
+      expect(subject.build).to be_a(Myfinance::Entities::WebhookCollection)
+    end
+
+    it "returns order" do
+      subject.build
+      expect(subject.collection.count).to eq(2)
+      expect(subject.collection.first).to be_a(Myfinance::Entities::Webhook)
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe Myfinance::Entities::Webhook do
+  subject { described_class.new({}) }
+
+  it_behaves_like "entity_attributes", [
+                    :account_id, :created_at, :description, :entity_id,
+                    :healthy_check_code, :id, :updated_at, :url
+                  ]
+end

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

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Myfinance::Resources::Tax, vcr: true do
+  let(:klass) { Myfinance::Entities::Tax }
+
+  let(:collection) do
+    Myfinance::Entities::TaxCollection
+  end
+
+  describe "#find_all" do
+    context "when success" do
+      subject { client.taxes.find_all }
+
+      it "show all taxes" do
+        expect(subject).to be_a(collection)
+        expect(subject.collection.first).to be_a(klass)
+        expect(subject.collection.first.name).to eq("Outros")
+      end
+    end
+
+    context "when error" do
+      let(:client) { Myfinance.client("") }
+
+      it "raises Myfinance::RequestError with 401 status code" do
+        expect { client.taxes.find_all }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(401)
+        end
+      end
+    end
+  end
+
+  describe "#find" do
+    context "when success" do
+      subject { client.taxes.find(1) }
+
+      it "show a tax successfully" do
+        expect(subject).to be_a(klass)
+        expect(subject.name).to eq("Outros")
+      end
+    end
+
+    context "when error" do
+      it "raises Myfinance::RequestError with 404 status code" do
+        expect { client.taxes.find(42424242) }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(404)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+require "spec_helper"
+
+describe Myfinance::Resources::Webhook, vcr: true do
+  let(:entity_klass) { Myfinance::Entities::Webhook }
+
+  describe "#find_all" do
+    context "when success" do
+      subject { client.webhooks.find_all }
+
+      it "show all webhooks successfully" do
+        expect(subject.class).to eq(Myfinance::Entities::WebhookCollection)
+        expect(subject.collection.first.description).to eq("Webhook test")
+        expect(subject.collection.first.id).to eq(76)
+      end
+    end
+
+    context "when error" do
+      let(:client) { Myfinance.client("") }
+
+      it "raises Myfinance::RequestError with 401 status code" do
+        expect {
+          client.webhooks.find_all
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(401)
+        end
+      end
+    end
+  end
+
+  describe "#find" do
+    context "when success" do
+      subject { client.webhooks.find(76) }
+
+      it "find a webhook successfully" do
+        expect(subject).to be_a(entity_klass)
+        expect(subject.id).to eq(76)
+        expect(subject.description).to eq("Webhook test")
+      end
+    end
+
+    context "when error" do
+      it "raises Myfinance::RequestError with 404 status code" do
+        expect {
+          client.webhooks.find(888888)
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(404)
+        end
+      end
+    end
+  end
+
+  describe "#create" do
+    context "when success" do
+      let(:params) do
+        {
+          entity_id: 3798,
+          description: "Webhook 2",
+          url: "https://sandbox.myfinance.com.br/docs/api/webhooks#get_show",
+          format: "json"
+        }
+      end
+
+      it "creates a webhook successfully" do
+        result = client.webhooks.create(params)
+        expect(result).to be_a(entity_klass)
+        expect(result.description).to eq("Webhook 2")
+      end
+    end
+
+    context "when error" do
+      it "raises Myfinance::RequestError with 422 status code" do
+        expect {
+          client.webhooks.create({ description: "" })
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(422)
+        end
+      end
+    end
+  end
+
+  describe "#update" do
+    context "when success" do
+      let(:params) { { description: "Description updated" } }
+
+      it "updates a webhook successfully" do
+        result = client.webhooks.update(76, params)
+        expect(result).to be_a(entity_klass)
+        expect(result.description).to eq("Description updated")
+      end
+    end
+
+    context "when error" do
+      it "raises Myfinance::RequestError with 422 status code" do
+        expect {
+          client.webhooks.update(76, { url: "" })
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(422)
+        end
+      end
+    end
+  end
+
+  describe "#destroy" do
+    context "when success" do
+      it "destroy a webhook successfully" do
+        expect(client.webhooks.destroy(77)).to be_truthy
+      end
+    end
+
+    context "when error" do
+      it "raises Myfinance::RequestError with 404 status code" do
+        expect {
+          client.webhooks.destroy(888888)
+        }.to raise_error(Myfinance::RequestError) do |error|
+          expect(error.code).to eq(404)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myfinance
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eduardo Hertz
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -257,6 +257,10 @@ files:
 - lib/myfinance/entities/person.rb
 - lib/myfinance/entities/person_collection.rb
 - lib/myfinance/entities/receivable_account.rb
+- lib/myfinance/entities/tax.rb
+- lib/myfinance/entities/tax_collection.rb
+- lib/myfinance/entities/webhook.rb
+- lib/myfinance/entities/webhook_collection.rb
 - lib/myfinance/exception.rb
 - lib/myfinance/http.rb
 - lib/myfinance/request.rb
@@ -271,6 +275,8 @@ files:
 - lib/myfinance/resources/payable_account.rb
 - lib/myfinance/resources/person.rb
 - lib/myfinance/resources/receivable_account.rb
+- lib/myfinance/resources/tax.rb
+- lib/myfinance/resources/webhook.rb
 - lib/myfinance/response.rb
 - lib/myfinance/version.rb
 - myfinance.gemspec
@@ -294,6 +300,10 @@ files:
 - spec/lib/myfinance/entities/person_collection_spec.rb
 - spec/lib/myfinance/entities/person_spec.rb
 - spec/lib/myfinance/entities/receivable_account_spec.rb
+- spec/lib/myfinance/entities/tax_collection_spec.rb
+- spec/lib/myfinance/entities/tax_spec.rb
+- spec/lib/myfinance/entities/webhook_collection_spec.rb
+- spec/lib/myfinance/entities/webhook_spec.rb
 - spec/lib/myfinance/http_spec.rb
 - spec/lib/myfinance/request_spec.rb
 - spec/lib/myfinance/resources/account_spec.rb
@@ -305,6 +315,8 @@ files:
 - spec/lib/myfinance/resources/payable_account_spec.rb
 - spec/lib/myfinance/resources/person_spec.rb
 - spec/lib/myfinance/resources/receivable_account_spec.rb
+- spec/lib/myfinance/resources/tax_spec.rb
+- spec/lib/myfinance/resources/webhook_spec.rb
 - spec/lib/myfinance/response_spec.rb
 - spec/lib/myfinance_spec.rb
 - spec/spec_helper.rb
@@ -360,6 +372,10 @@ test_files:
 - spec/lib/myfinance/entities/person_collection_spec.rb
 - spec/lib/myfinance/entities/person_spec.rb
 - spec/lib/myfinance/entities/receivable_account_spec.rb
+- spec/lib/myfinance/entities/tax_collection_spec.rb
+- spec/lib/myfinance/entities/tax_spec.rb
+- spec/lib/myfinance/entities/webhook_collection_spec.rb
+- spec/lib/myfinance/entities/webhook_spec.rb
 - spec/lib/myfinance/http_spec.rb
 - spec/lib/myfinance/request_spec.rb
 - spec/lib/myfinance/resources/account_spec.rb
@@ -371,6 +387,8 @@ test_files:
 - spec/lib/myfinance/resources/payable_account_spec.rb
 - spec/lib/myfinance/resources/person_spec.rb
 - spec/lib/myfinance/resources/receivable_account_spec.rb
+- spec/lib/myfinance/resources/tax_spec.rb
+- spec/lib/myfinance/resources/webhook_spec.rb
 - spec/lib/myfinance/response_spec.rb
 - spec/lib/myfinance_spec.rb
 - spec/spec_helper.rb