myfinance 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7d232896f250a7b2c78111a9fd498491e38be7e
-  data.tar.gz: 6ea40361789ab7210fae8e0fda62e2f04fe3d0b1
+  metadata.gz: d1eefa221205c3ed3d67d74d90c709f80dca6f4c
+  data.tar.gz: a4910d9b8d7af6d4c0f439a1f4a028557937b2cd
 SHA512:
-  metadata.gz: 7d4096f7fd67ec4da65075b7f6e76bc93ef2bfb4495e46140a6a91d99550a82c398bf6fd1445cf172804bcc82fc6cff09cbe9d5e26f9587fb6c664607b05cda4
-  data.tar.gz: 1d72e21517c1aabc1030c77c0486776d36a1ac8c394fa100e5714e37c1cf1001b93f8343f8402666b7f8b9d2839399b46ee6f4930a4f9c801c97bfe7a7979ae6
+  metadata.gz: 38adecf14ed9cb00370f632ad44479be2f87b24147a91da63cc08e0c0843d9366c2dbaf9e0a0266adb726d957d1cb251faa37f632ee2b075ea57f46fc5fa0414
+  data.tar.gz: d55d18de0c4a758f2d2b5057e20f03483824fb3050251f423b31f97e5f688474133c84fb5af261469104f0ba80037de14d340bd6d88670e39afd0ce6905ce341

data/Gemfile.lock

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

data/README.md

@@ -97,6 +97,18 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
       <code>client.entities.find</code>
     </td>
   </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/entities#get_show" target="_blank">
+        /entities
+      </a>
+    </td>
+    <td>
+      <code>client.entities.find_by</code>
+    </td>
+  </tr>
+
 </table>
 
 #### [FinancialTransactions](https://app.myfinance.com.br/docs/api/financial_transactions)
@@ -503,6 +515,17 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
       <code>client.deposit_accounts.find</code>
     </td>
   </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/deposit_accounts#get_show" target="_blank">
+        /entities/:entity_id/deposit_accounts
+      </a>
+    </td>
+    <td>
+      <code>client.deposit_accounts.find_by</code>
+    </td>
+  </tr>
   <tr>
     <td><code>POST</code></td>
     <td>
@@ -1083,6 +1106,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version, update the version number in `lib/myfinance/version.rb`, run `bundle install` and commit & push the changes to the repository. Then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). Make sure you have publishing rights for the gem on RubyGems beforehand, though.
 
+After publishing the new version, add a comment to each pull request that was included in this release like this:
+
+```
+:shipit: released on [version x.y.z](https://rubygems.org/gems/myfinance/versions/x.y.z)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/myfreecomm/myfinance-client-ruby. This project is intended to be a safe and welcoming space for collaboration.

data/lib/myfinance/resources/deposit_account.rb

@@ -16,9 +16,7 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/deposit_accounts#get_index
       #
       def find_all(entity_id)
-        http.get(
-          "/entities/#{entity_id}/deposit_accounts", body: {}
-        ) do |response|
+        http.get("/entities/#{entity_id}/deposit_accounts", body: {}) do |response|
           respond_with_collection(response)
         end
       end
@@ -32,13 +30,20 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/deposit_accounts#get_show
       #
       def find(entity_id, id)
-        http.get(
-          "/entities/#{entity_id}/deposit_accounts/#{id}", body: {}
-        ) do |response|
+        http.get("/entities/#{entity_id}/deposit_accounts/#{id}", body: {}) do |response|
           respond_with_object(response, "deposit_account")
         end
       end
 
+      def find_by(entity_id, params = {})
+        sanitized_params = search_params(params) 
+        endpoint = encode_endpoint(entity_id, sanitized_params)
+
+        http.get(endpoint, body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
       #
       # Creates a deposit account of entity
       #
@@ -48,10 +53,7 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/deposit_accounts#post_create
       #
       def create(entity_id, params = {})
-        http.post(
-          "/entities/#{entity_id}/deposit_accounts",
-          body: { deposit_account: params }
-        ) do |response|
+        http.post("/entities/#{entity_id}/deposit_accounts", body: { deposit_account: params }) do |response|
           respond_with_object(response, "deposit_account")
         end
       end
@@ -65,10 +67,7 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/deposit_accounts#put_update
       #
       def update(entity_id, id, params = {})
-        http.put(
-          "/entities/#{entity_id}/deposit_accounts/#{id}",
-          body: { deposit_account: params }
-        ) do |response|
+        http.put("/entities/#{entity_id}/deposit_accounts/#{id}", body: { deposit_account: params }) do |response|
           respond_with_object(response, "deposit_account")
         end
       end
@@ -82,12 +81,20 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/deposit_accounts#delete_destroy
       #
       def destroy(entity_id, id)
-        http.delete(
-          "/entities/#{entity_id}/deposit_accounts/#{id}", body: {}
-        ) do |response|
+        http.delete("/entities/#{entity_id}/deposit_accounts/#{id}", body: {}) do |response|
           respond_with_object(response, "deposit_account")
         end
       end
+
+      private
+
+      def search_params(params)
+        params.map { |key, value| "search[#{key}]=#{value}" }.join("&")
+      end
+
+      def encode_endpoint(entity_id, path)
+        URI.encode("/entities/#{entity_id}/deposit_accounts?#{path}")
+      end
     end
   end
 end

data/lib/myfinance/resources/entity.rb

@@ -34,6 +34,25 @@ module Myfinance
           respond_with_object(response, 'entity')
         end
       end
+
+      def find_by(params = {})
+        sanitized_params = search_params(params)
+        endpoint = encode_endpoint(sanitized_params)
+
+        http.get(endpoint, body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      private
+
+      def search_params(params)
+        params.map { |key, value| "search[#{key}]=#{value}" }.join("&")
+      end
+
+      def encode_endpoint(path)
+        URI.encode("/entities?#{path}")
+      end
     end
   end
 end

data/lib/myfinance/version.rb

@@ -1,3 +1,3 @@
 module Myfinance
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

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

@@ -2,10 +2,11 @@ require "spec_helper"
 
 describe Myfinance::Resources::DepositAccount, vcr: true do
   let(:entity_klass) { Myfinance::Entities::DepositAccount }
+  let(:entity_id) { 3798 }
 
   describe "#find_all" do
     context "when success" do
-      subject { client.deposit_accounts.find_all(3798) }
+      subject { client.deposit_accounts.find_all(entity_id) }
 
       it "show all deposit accounts" do
         subject.build
@@ -20,7 +21,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
 
       it "raises Myfinance::RequestError with 401 status code" do
         expect {
-          client.deposit_accounts.find_all(3798)
+          client.deposit_accounts.find_all(entity_id)
         }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eq(401)
         end
@@ -31,7 +32,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
   describe "#find" do
     context "when success" do
       it "show a deposit account successfully" do
-        result = client.deposit_accounts.find(3798, 14268)
+        result = client.deposit_accounts.find(entity_id, 14268)
         expect(result).to be_a(entity_klass)
         expect(result.name).to eq("Carteira")
       end
@@ -40,7 +41,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
     context "when error" do
       it "raises Myfinance::RequestError with 404 status code" do
         expect {
-          client.deposit_accounts.find(3798, 888888)
+          client.deposit_accounts.find(entity_id, 888888)
         }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eq(404)
         end
@@ -48,6 +49,33 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
     end
   end
 
+  describe "#find_by" do
+    context "when succesful"  do
+      subject { client.deposit_accounts.find_by(entity_id, name: "Carteira") }
+
+      it "returns a collection of DepositAccounts" do
+        expect(subject).to be_a(Myfinance::Entities::DepositAccountCollection)
+      end
+
+      it "returns matched DepositAccount" do
+        da = subject.collection.first
+        expect(da.name).to eq("Carteira")
+      end
+
+      it "does not match other DepositAccounts" do
+        expect(subject.collection.size).to eq(1)
+      end
+
+      context "when not found"  do
+        subject { client.deposit_accounts.find_by(entity_id, name: "NAO_EXISTE_ESSA_DEPOSIT_ACCOUNT_42") }
+
+        it "returns an empty collection" do
+          expect(subject.collection).to be_empty
+        end
+      end
+    end
+  end
+
   describe "#create" do
     context "when success" do
       let(:params) do
@@ -57,7 +85,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
           currency_id: 1,
           deposit_account_type_id: 2,
           description: "Deposit account test",
-          entity_id: 3798,
+          entity_id: entity_id,
           force_destroy: false,
           imported_from_sync: false,
           name: "Caixa 18",
@@ -67,7 +95,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
       end
 
       it "creates a deposit account successfully" do
-        result = client.deposit_accounts.create(3798, params)
+        result = client.deposit_accounts.create(entity_id, params)
         expect(result).to be_a(entity_klass)
       end
     end
@@ -75,7 +103,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
     context "when error" do
       it "raises Myfinance::RequestError with 422 status code" do
         expect {
-          client.deposit_accounts.create(3798, {})
+          client.deposit_accounts.create(entity_id, {})
         }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eq(422)
         end
@@ -87,7 +115,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
     context "when success" do
       it "updates a deposit account successfully" do
         expect(
-          client.deposit_accounts.update(3798, 14820, { name: "Name" })
+          client.deposit_accounts.update(entity_id, 14820, { name: "Name" })
         ).to be_a(entity_klass)
       end
     end
@@ -95,7 +123,7 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
     context "when invalid" do
       it "raises Myfinance::RequestError with 422 status code" do
         expect {
-          client.deposit_accounts.update(3798, 14820, { name: "" })
+          client.deposit_accounts.update(entity_id, 14820, { name: "" })
         }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eq(422)
         end
@@ -106,14 +134,14 @@ describe Myfinance::Resources::DepositAccount, vcr: true do
   describe "#delete" do
     context "when success" do
       it "destroy a deposit account successfully" do
-        expect(client.deposit_accounts.destroy(3798, 14820)).to be_truthy
+        expect(client.deposit_accounts.destroy(entity_id, 14820)).to be_truthy
       end
     end
 
     context "when error" do
       it "raises Myfinance::RequestError with 404 status code" do
         expect {
-          client.deposit_accounts.destroy(3798, 888888)
+          client.deposit_accounts.destroy(entity_id, 888888)
         }.to raise_error(Myfinance::RequestError) do |error|
           expect(error.code).to eq(404)
         end

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

@@ -60,4 +60,29 @@ describe Myfinance::Resources::Entity do
       end
     end
   end
+
+  describe "#find_by", vcr: true do
+    context "when successful" do
+      subject { client.entities.find_by(name_contains: "Minhas") }
+
+      it "returns a collection of Entities" do
+        expect(subject).to be_a(Myfinance::Entities::EntityCollection)
+      end
+
+      it "returns Entity that matches search params" do
+        entity = subject.collection.first
+
+        expect(entity.id).to eq(3798)
+        expect(entity.name).to eq("Minhas Finanças")
+      end
+    end
+
+    context "when not found" do
+      subject { client.entities.find_by(name: "ENTIDADE_QUE_NAO_EXISTE_42") }
+
+      it "returns an empty colleciton" do
+        expect(subject.collection).to be_empty
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myfinance
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eduardo Hertz
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus