emites-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 042560570f5b968a041ed46992d2dbd828e35e6d
-  data.tar.gz: 9c948866300c115f656930ca0f5bdee24ea16701
+  metadata.gz: 35ee5886f9670b36b13c739e52fe97eb6fd55083
+  data.tar.gz: 55f09d9701274a1fe515a5497a81192f8c5d6fcd
 SHA512:
-  metadata.gz: f93a4874a947fa979fef39bd232a1eff881633e015313ac4ff9cba8aacfad38fee79a1d2edc6907c1f227e962123bb219f18bc215bd65c7eb9782aff1b1d1fab
-  data.tar.gz: f5d7cbdeff9686490badf85ce937fd5151475a21b87d9689138c81a0fa73c35969e1211192b999e740b7c32d081be7186175d6d5e3d437eb08bc6a2ca4e1d1a4
+  metadata.gz: d3462da3bb29c13edb6034082a7cb1af64ab81f4f2ce3006abc7ae53c668ef3e3695ca70de4a47f7d1eed3c19eb8a39159b53c4dca1eca1c473faa4410ab227e
+  data.tar.gz: a21b28b99a7f8ed3e96c5739b3ed23162d03a026db6593d87679b154132d6a946c39ac1f0d78c4d9dff53aeba77798c1bbf3cfba301f8dfbda5974ddefb09b4f

data/.gitignore

@@ -28,4 +28,6 @@ mkmf.log
 *~
 .ruby-gemset
 .ruby-version
+.rvmrc
+.idea/
 doc

data/README.md

@@ -47,6 +47,8 @@ client = Emites.client("YOUR_TOKEN_HERE")
 ##### Now you have access to every API endpoint:
 
 * [Emitters API](http://myfreecomm.github.io/emites/sandbox/v1/modules/emitter.html) as `client.emitters`
+* [Takers API](http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html) as `client.takers`
+* [Services API](http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html) as `client.services`
 * [Webhooks API](http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html) as `client.webhooks`
 * [NFSe API](http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html) as `client.nfse`
 
@@ -117,6 +119,136 @@ client = Emites.client("YOUR_TOKEN_HERE")
     </tr>
 </table>
 
+#### [Takers](http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html)
+
+<table>
+    <tr>
+        <th>HTTP method</th>
+        <th>Endpoint</th>
+        <th>Client method</th>
+    </tr>
+    <tr>
+        <td><code>POST</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#criacao" target="_blank">
+                /api/v1/takers
+            </a>
+        </td>
+        <td>
+            <code>client.takers.create</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#listagem" target="_blank">
+                /api/v1/takers
+            </a>
+        </td>
+        <td>
+            <code>client.takers.list</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#detalhes" target="_blank">
+                /api/v1/takers/:id
+            </a>
+        </td>
+        <td>
+            <code>client.takers.info</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#filtros" target="_blank">
+                /api/v1/takers?cnpj=:cnpj
+            </a>
+        </td>
+        <td>
+            <code>client.takers.search</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>DELETE</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#remocao" target="_blank">
+                /api/v1/takers/:id
+            </a>
+        </td>
+        <td>
+            <code>client.takers.destroy</code>
+        </td>
+    </tr>
+</table>
+
+#### [Services](http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html)
+
+<table>
+    <tr>
+        <th>HTTP method</th>
+        <th>Endpoint</th>
+        <th>Client method</th>
+    </tr>
+    <tr>
+        <td><code>POST</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#criacao" target="_blank">
+                /api/v1/service-values
+            </a>
+        </td>
+        <td>
+            <code>client.services.create</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#listagem" target="_blank">
+                /api/v1/service-values
+            </a>
+        </td>
+        <td>
+            <code>client.services.list</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#detalhes" target="_blank">
+                /api/v1/service-values/:id
+            </a>
+        </td>
+        <td>
+            <code>client.services.info</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#filtros" target="_blank">
+                /api/v1/service-values?name=:name
+            </a>
+        </td>
+        <td>
+            <code>client.services.search</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>DELETE</code></td>
+        <td>
+            <a href="http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#remocao" target="_blank">
+                /api/v1/service-values/:id
+            </a>
+        </td>
+        <td>
+            <code>client.services.destroy</code>
+        </td>
+    </tr>
+</table>
+
 #### [Webhooks](http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html)
 
 <table>
@@ -338,6 +470,20 @@ When you call `client.emitters.destroy(1)`, an event `emites.emitters.destroy` w
           <code>emites.emitters.destroy</code>
         </td>
     </tr>
+    <tr>
+        <td><code>takers</code></td>
+        <td>
+          <code>emites.takers.create</code><br />
+          <code>emites.takers.destroy</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>services</code></td>
+        <td>
+          <code>emites.services.create</code><br />
+          <code>emites.services.destroy</code>
+        </td>
+    </tr>
     <tr>
         <td><code>webhooks</code></td>
         <td>

data/emites-client.gemspec

@@ -7,8 +7,8 @@ require "emites/version"
 Gem::Specification.new do |spec|
   spec.name          = "emites-client"
   spec.version       = Emites::VERSION
-  spec.authors       = ["Leandro Thimóteo", "Rodrigo Tassinari", "Vagner Zampieri", "Wanderson Policarpo"]
-  spec.email         = %w(leandro.thimoteo rodrigo.tassinari vagner.zampieri wanderson.policarpo).map { |nick| "#{nick}@myfreecomm.com.br" }
+  spec.authors       = ["Leandro Thimóteo", "Marcos Tagomori", "Rodrigo Tassinari", "Vagner Zampieri", "Wanderson Policarpo"]
+  spec.email         = %w(leandro.thimoteo marcos.tagomori rodrigo.tassinari vagner.zampieri wanderson.policarpo).map { |nick| "#{nick}@myfreecomm.com.br" }
   spec.summary       = %q{Official Ruby client for the Emites API.}
   spec.description   = %q{Official Ruby client for the Emites API. Emites is a system for creating "notas fiscais eletrônicas" (NFe / NFSe) in Brazil.}
   spec.homepage      = "https://github.com/myfreecomm/emites-client-ruby"

data/lib/emites.rb

@@ -19,11 +19,14 @@ require "emites/entities/nfse_status_transition"
 require "emites/entities/nfse_values"
 require "emites/entities/nfse"
 require "emites/entities/webhook"
+require "emites/entities/service"
 
 require "emites/resources/base"
 require "emites/resources/emitter"
 require "emites/resources/webhook"
 require "emites/resources/nfse"
+require "emites/resources/taker"
+require "emites/resources/service"
 
 module Emites
   def self.configuration

data/lib/emites/client.rb

@@ -26,5 +26,13 @@ module Emites
     def nfse
       Resources::Nfse.new(http)
     end
+
+    def takers
+      Resources::Taker.new(http)
+    end
+
+    def services
+      Resources::Service.new(http)
+    end
   end
 end

data/lib/emites/entities/service.rb

@@ -0,0 +1,29 @@
+module Emites
+  module Entities
+    class Service < Base
+      attribute :id,                                Integer
+      attribute :emitter_id,                        Integer
+      attribute :name,                              String
+      attribute :service_amount,                    Decimal, precision: 16, scale: 2
+      attribute :calculation_base,                  Decimal, precision: 16, scale: 2
+      attribute :deduction_percentage,              Decimal, precision: 5, scale: 2
+      attribute :retained_iss,                      Boolean
+      attribute :iss_percentage,                    Decimal, precision: 5, scale: 2
+      attribute :pis_percentage,                    Decimal, precision: 5, scale: 2
+      attribute :cofins_percentage,                 Decimal, precision: 5, scale: 2
+      attribute :inss_percentage,                   Decimal, precision: 5, scale: 2
+      attribute :ir_percentage,                     Decimal, precision: 5, scale: 2
+      attribute :csll_percentage,                   Decimal, precision: 5, scale: 2
+      attribute :discount_conditioning_percentage,  Decimal, precision: 5, scale: 2
+      attribute :service_item_code,                 String
+      attribute :city_tax_code,                     String
+      attribute :cnae_code,                         Integer
+      attribute :description,                       String
+      attribute :city_code,                         Integer
+      attribute :nfse_liquid_amount,                Decimal, precision: 16, scale: 2
+      attribute :other_retentions_percentage,       Decimal, precision: 5, scale: 2
+      attribute :retained_iss_percentage,           Decimal, precision: 5, scale: 2
+      attribute :unconditioned_discount_percentage, Decimal, precision: 5, scale: 2
+    end
+  end
+end

data/lib/emites/resources/service.rb

@@ -0,0 +1,98 @@
+module Emites
+  module Resources
+
+    # A wrapper to Emites services API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html
+    #
+    # @example Listing all services:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.services.list
+    #
+    # @example Creating a service:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.services.create({emitter_id: 1, name: "Serviço"})
+    #
+    # @see Emites.client
+    class Service < Base
+
+      # Creates a Service related to the Account
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/service-values</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#criacao
+      #
+      # @param params [Hash] a hash with Service attributes
+      # @return [Emites::Entities::Service] the created Service
+      def create(params)
+        http.post("/service-values", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Retrieves a Service by it's id
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/service-values/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#detalhes
+      #
+      # @param id [Integer] the Service id
+      # @return [Emites::Entities::Service] the Service by it's id
+      def info(id)
+        http.get("/service-values/#{id}") do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Lists all services related to the account
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/service-values</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#listagem
+      #
+      # @return [Array] an array of Service
+      def list
+        http.get("/service-values") do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Lists all services related to the account matching search results
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/service-values?name=:name</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#filtros
+      #
+      # @param params [Hash] a hash with Service attributes
+      # @return [Array] an array of Service
+      def search(params)
+        http.get("/service-values", { params: params }) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Deletes a Service by it's id. Returns <tt>true</true> if deletion performed well, otherwise,
+      # returns <tt>false</tt>.
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/service-values/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/service_values.html#remocao
+      #
+      # @param id [Integer] the Service id
+      # @return [Boolean] whether deletion was performed or not
+      def destroy(id)
+        http.delete("/service-values/#{id}") do |response|
+          response.code == 204
+        end
+      end
+
+      notify :create, :destroy
+    end
+  end
+end

data/lib/emites/resources/taker.rb

@@ -0,0 +1,98 @@
+module Emites
+  module Resources
+
+    # A wrapper to Emites takers API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html
+    #
+    # @example Listing all takers:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.takers.list
+    #
+    # @example Creating an taker:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.takers.create({cnpj: "01001001000113"})
+    #
+    # @see Emites.client
+    class Taker < Base
+
+      # Creates a Taker related to the Account
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/takers</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#criacao
+      #
+      # @param params [Hash] a hash with Taker attributes
+      # @return [Emites::Entities::Taker] the created Taker
+      def create(params)
+        http.post("/takers", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Retrieves a Taker by it's id
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/takers/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#detalhes
+      #
+      # @param id [Integer] the Taker id
+      # @return [Emites::Entities::Taker] the Taker by it's id
+      def info(id)
+        http.get("/takers/#{id}") do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Lists all takers related to the account
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/takers</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#listagem
+      #
+      # @return [Array] an array of Taker
+      def list
+        http.get("/takers") do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Lists all takers related to the account matching search results
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/takers?cnpj=:cnpj</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#filtros
+      #
+      # @param params [Hash] a hash with Taker attributes
+      # @return [Array] an array of Taker
+      def search(params)
+        http.get("/takers", { params: params }) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Deletes a Taker by it's id. Returns <tt>true</true> if deletion performed well, otherwise,
+      # returns <tt>false</tt>.
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/takers/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/taker.html#remocao
+      #
+      # @param id [Integer] the Taker id
+      # @return [Boolean] whether deletion was performed or not
+      def destroy(id)
+        http.delete("/takers/#{id}") do |response|
+          response.code == 204
+        end
+      end
+
+      notify :create, :destroy
+    end
+  end
+end