emites-client 0.0.2

data/lib/emites/resources/base.rb

@@ -0,0 +1,45 @@
+require "emites/resources/hooks"
+
+module Emites
+  module Resources
+    class Base
+      include Wisper::Publisher
+      extend Hooks
+
+      attr_accessor :http
+
+      def initialize(http)
+        @http = http
+      end
+
+      def parsed_body(response)
+        MultiJson.load(response.body)
+      rescue MultiJson::ParseError
+        {}
+      end
+
+      protected
+
+      def respond_with_collection(response, naked_klass = entity_klass)
+        hash = parsed_body(response)
+        hash["collection"].map do |item|
+          naked_klass.new(item)
+        end
+      end
+
+      def respond_with_entity(response, naked_klass = entity_klass)
+        item = parsed_body(response)
+        naked_klass.new(item)
+      end
+
+      def base_klass
+        @base_klass ||= self.class.name.split("::").last
+      end
+
+      def entity_klass
+        @entity_klass ||= Emites::Entities.const_get(base_klass.to_sym)
+      end
+
+    end
+  end
+end

data/lib/emites/resources/emitter.rb

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

data/lib/emites/resources/hooks.rb

@@ -0,0 +1,25 @@
+module Emites
+  module Resources
+    module Hooks
+
+      def notify(*hooked_methods)
+        apply_hooks(hooked_methods.flatten)
+      end
+
+      private
+
+      def apply_hooks(hooked_methods)
+        hooked_methods.each do |method|
+          alias_method "#{method}_without_notifier", method
+
+          define_method method do |*args|
+            result = send("#{method}_without_notifier", *args)
+            publish("emites.#{base_klass.downcase}.#{method}", result, args.flatten)
+            result
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/emites/resources/nfse.rb

@@ -0,0 +1,173 @@
+module Emites
+  module Resources
+
+    # A wrapper to Emites NFSes API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/emites/v1/modules/nfse.html
+    #
+    # @example Listing all NFSe:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.nfse.list
+    #
+    # @example Creating a NFSe:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.nfse.create({emitter_id: 1, serie: "a", ...)
+    #
+    # @see Emites.client
+    class Nfse < Base
+
+      # Lists all NFSes
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/v1/modules/nfse.html#listagem
+      #
+      # @return [Array] an array of Webhook
+      def list
+        http.get("/nfse") do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Retrieves a Nfse by it's id
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#detalhes
+      #
+      # @param id [Integer] the Nfse id
+      # @return [Emites::Entities::Nfse] the Nfse by it's id
+      def info(id)
+        http.get("/nfse/#{id}") do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Retrieves a Nfse status by it's id
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse/:id/status</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#status
+      #
+      # @param id [Integer] the Nfse id
+      # @return [Emites::Entities::NfseStatus] the NfseStatus by it's id
+      def status(id)
+        http.get("/nfse/#{id}/status") do |response|
+          respond_with_entity(response, Entities::NfseStatus)
+        end
+      end
+
+      # Retrieves the entire Nfse status history by it's id
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse/:id/history</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#historico
+      #
+      # @param id [Integer] the Nfse id
+      # @return [Array] an array of Emites::Entities::NfseStatusTransition
+      def history(id)
+        http.get("/nfse/#{id}/history") do |response|
+          respond_with_collection(response, Entities::NfseStatusTransition)
+        end
+      end
+
+      # Retrieves Nfse PDF url
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse/:id/pdf</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#pdf
+      #
+      # @param id [Integer] the Nfse id
+      # @return [String] the url to redirect or an empty string if an error occurred
+      def pdf(id)
+        http.get("/nfse/#{id}/pdf") do |response|
+          response.headers.fetch("Location") { "" }
+        end
+      end
+
+      # Retrieves Nfse XML url
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse/:id/xml</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#xml
+      #
+      # @param id [Integer] the Nfse id
+      # @return [String] the url to redirect or an empty string if an error occurred
+      def xml(id)
+        http.get("/nfse/#{id}/xml") do |response|
+          response.headers.fetch("Location") { "" }
+        end
+      end
+
+      # Cancels a Nfse by it's id
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/nfse/:id/cancel</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#cancelamento
+      #
+      # @param id [Integer] the Nfse id
+      # @return [Emites::Entities::NfseStatus] the NfseStatus by it's id
+      def cancel(id)
+        http.post("/nfse/#{id}/cancel") do |response|
+          respond_with_entity(response, Entities::NfseStatus)
+        end
+      end
+
+      # Deletes a Nfse by it's id
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/nfse/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#remocao
+      #
+      # @param id [Integer] the Nfse id
+      # @return [Boolean] whether deletion was performed or not
+      def destroy(id)
+        http.delete("/nfse/#{id}") do |response|
+          response.code == 204
+        end
+      end
+
+      # Creates an Nfse
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/nfse</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#criacao
+      #
+      # @param params [Hash] a hash with Nfse attributes
+      # @return [Emites::Entities::Nfse] the created Nfse
+      def create(params)
+        http.post("/nfse", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Updates an Nfse
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/nfse.html#atualizacao-parcial-e-completa
+      #
+      # @param id [Integer] the Nfse id
+      # @param params [Hash] a hash with Nfse attributes
+      # @return [Emites::Entities::Nfse] the created Nfse
+      def update(id, params)
+        http.put("/nfse/#{id}", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      notify :create, :update, :cancel, :destroy
+    end
+  end
+end

data/lib/emites/resources/webhook.rb

@@ -0,0 +1,84 @@
+module Emites
+  module Resources
+
+    # A wrapper to Emites webhooks API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html
+    #
+    # @example Listing all webhooks:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.webhooks.list
+    #
+    # @example Creating an webhook:
+    #   client = Emites.client("MY_SECRET_TOKEN")
+    #   client.webhooks.create({name: "My Fake Web Hook", url: "http://web.hook")
+    #
+    # @see Emites.client
+    class Webhook < Base
+
+      # Lists all Webhooks related to the account
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/webhooks</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html#listagem
+      #
+      # @return [Array] an array of Webhook
+      def list
+        http.get("/webhooks") do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      # Updates an Webhook identified by <tt>id</tt>
+      #
+      # [API]
+      #   Method: <tt>PUT /api/v1/webhooks/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html#atualizacao
+      #
+      # @param id [Integer] the webhook id
+      # @param params [Hash] a hash with new data
+      # @return [Array] an array of Webhook
+      def update(id, params)
+        http.put("/webhooks/#{id}", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      # Deletes an Webhook by it's id. Returns <tt>true</true> if deletion performed well, otherwise,
+      # returns <tt>false</tt>.
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/v1/webhooks/:id</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html#remocao
+      #
+      # @param id [Integer] the Wehook id
+      # @return [Boolean] whether deletion was performed or not
+      def destroy(id)
+        http.delete("/webhooks/#{id}") do |response|
+          response.code == 204
+        end
+      end
+
+      # Creates an Webhook
+      #
+      # [API]
+      #   Method: <tt>POST /api/v1/webhooks</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/sandbox/v1/modules/webhooks.html#criacao
+      #
+      # @param params [Hash] a hash with Webhook attributes
+      # @return [Emites::Entities::Webhook] the created Webhook
+      def create(params)
+        http.post("/webhooks", { body: params }) do |response|
+          respond_with_entity(response)
+        end
+      end
+
+      notify :create, :destroy, :update
+    end
+  end
+end

data/lib/emites/response.rb

@@ -0,0 +1,38 @@
+require "emites/exception"
+
+module Emites
+  RequestTimeout = Class.new(Exception)
+  RequestError   = Class.new(Exception)
+
+  class Response < SimpleDelegator
+
+    def resolve!(&block)
+      if success? || redirected?
+        block_given? ? yield(self) : self
+      elsif timed_out?
+        timeout!
+      else
+        error!
+      end
+    end
+
+    def redirected?
+      response_code && response_code >= 300 && response_code < 400
+    end
+
+    private
+
+    def timeout!
+      raise RequestTimeout
+    end
+
+    def error!
+      raise RequestError.new(
+        code:    code,
+        message: status_message,
+        body:    (MultiJson.load(body) rescue {})
+      )
+    end
+
+  end
+end