emites-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8552e2d06dc597aca23a6b974ed14f976ffb24ac
-  data.tar.gz: 7ec3f6ba1c62d9b89afc6a3af46143248c668c5b
+  metadata.gz: 8ab5dbafa9e33acea5e32432ceed77d93c22fdcc
+  data.tar.gz: f9a9cd095c8f57772e8d269bf6d1e66530a349eb
 SHA512:
-  metadata.gz: 87c8f32af751a2d4bb5e4576ebb94ddf7f71bf2d6d53dfebb1cf8292e53f4ad82be9944d69d3f47ca87348ac2b8736312bebb73599d7f7800c51a6b0bbf39e29
-  data.tar.gz: 1ddf8bef26a1a8dc7c3265335776b026386c84c01f9dab3f9036fff42a2fbbd3a3b29c054745f1eeeac1dcb83b7da914e0a26a5eb729d978d5eb834b579f4c71
+  metadata.gz: 6b975aa0fb8dbbd590c8d44b2e85c242252e87bcbe395dc84672faa0eb48b0786e50555e2da5863bc8e6645b98eb6e002cae314c704573300ad62b748c6d4cc8
+  data.tar.gz: 537c29b01418ae17db311c93ed6db3441e3eca30c667ea33816f455df4e176de41afa8a0fa10ad5cf19607728abad362039abc04a76edce56f595073f1c72da8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    emites-client (0.1.1)
+    emites-client (0.1.2)
       multi_json (~> 1.11)
       typhoeus (~> 0.8)
       virtus (~> 1.0)

data/Rakefile

@@ -7,3 +7,8 @@ begin
 rescue LoadError
   # no rspec available
 end
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh "irb -rubygems -I lib -r emites.rb"
+end

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", "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.authors       = ["Leandro Thimóteo", "Marcos Tagomori", "Rodrigo Tassinari", "Vagner Zampieri", "Wanderson Policarpo", "Luiz Carlos Buiatte"]
+  spec.email         = %w(leandro.thimoteo marcos.tagomori rodrigo.tassinari vagner.zampieri wanderson.policarpo luiz.buiatte).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

@@ -6,8 +6,10 @@ require "emites/version"
 require "emites/configuration"
 require "emites/http"
 require "emites/client"
+require "emites/params"
 
 require "emites/entities/base"
+require "emites/entities/collection"
 require "emites/entities/account"
 require "emites/entities/emitter"
 require "emites/entities/taker_address"

data/lib/emites/entities/collection.rb

@@ -0,0 +1,57 @@
+module Emites
+  module Entities
+
+    class Collection < Base
+      extend Forwardable
+
+      PAGE_REGEX = /page=(\d+)/
+
+      attr_reader :total
+      def_delegators :@collection, :first, :last, :each, :map, :count, :empty?, :any?
+
+      def initialize(response, entity_class)
+        @response = response
+        @entity_class = entity_class
+        @total = parsed_body['count'].to_i
+        @collection = []
+       end
+
+      def self.build(response, entity_class)
+        self.new(response, entity_class).build
+      end
+
+      def build
+        build_collection
+        self
+      end
+
+      def next_page
+        page_for('next')
+      end
+
+      def previous_page
+        page_for('previous')
+      end
+
+      def to_a
+        @collection.clone
+      end
+
+      private
+
+      def page_for(page_rel)
+        parsed_body[page_rel].match(PAGE_REGEX)[1].to_i rescue nil
+      end
+
+      def build_collection
+        parsed_body['collection'].each do |attributes|
+          @collection.push(@entity_class.new(attributes))
+        end
+      end
+
+      def parsed_body
+        @parsed_body ||= @response.parsed_body
+      end
+    end
+  end
+end

data/lib/emites/entities/nfse.rb

@@ -7,6 +7,7 @@ module Emites
       attribute :rps_situation,       Integer
       attribute :serie,               String
       attribute :number,              Integer
+      attribute :nfse_number,         Integer
       attribute :rps_type,            Integer
       attribute :emission_date,       DateTime
       attribute :emission_date_nfse,  DateTime
@@ -27,4 +28,4 @@ module Emites
       end
     end
   end
-end
+end

data/lib/emites/entities/nfse_status.rb

@@ -5,11 +5,11 @@ module Emites
       attribute :status,      String
       attribute :description, String
       attribute :nfse_key,    String
-      attribute :nfse_number, String
+      attribute :nfse_number, Integer
       attribute :number,      Integer
       attribute :mirror,      String
       attribute :xml,         String
       attribute :errors,      Array
     end
   end
-end
+end

data/lib/emites/params.rb

@@ -0,0 +1,20 @@
+module Emites
+
+  class Params
+    def initialize(attributes = {})
+      @attributes = symbolize_keys(attributes)
+    end
+
+    def permit(filters)
+      filters.map(&:to_sym).each_with_object(Hash.new) do |key, result|
+        result[key] = @attributes[key] if @attributes.has_key?(key)
+      end
+    end
+
+    private
+
+    def symbolize_keys(hash)
+      Hash[hash.map { |key,value| [key.to_sym, value] }]
+    end
+  end
+end

data/lib/emites/resources/base.rb

@@ -12,24 +12,14 @@ module Emites
         @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
+        Emites::Entities::Collection.build(response, naked_klass)
       end
 
       def respond_with_entity(response, naked_klass = entity_klass)
-        item = parsed_body(response)
-        naked_klass.new(item)
+        naked_klass.new(response.parsed_body)
       end
 
       def base_klass
@@ -42,4 +32,4 @@ module Emites
 
     end
   end
-end
+end

data/lib/emites/resources/nfse.rb

@@ -24,13 +24,28 @@ module Emites
       #
       #   Documentation: http://myfreecomm.github.io/emites/v1/modules/nfse.html#listagem
       #
-      # @return [Array] an array of Webhook
+      # @return Emites::Entities::Collection a collection of Emites::Entities::Nfse
       def list
         http.get("/nfse") do |response|
           respond_with_collection(response)
         end
       end
 
+      # Lists all NFSes matching search parameters
+      #
+      # [API]
+      #   Method: <tt>GET /api/v1/nfse?status=:status&page=:page</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/emites/v1/modules/nfse.html#filtros
+      #
+      # @param params [Hash] an optional hash with filter parameters
+      # @return Emites::Entities::Collection a collection of Emites::Entities::Nfse
+      def search(params = {})
+        http.get("/nfse", params: filter(params)) do |response|
+          respond_with_collection(response)
+        end
+      end
+
       # Retrieves a Nfse by it's id
       #
       # [API]
@@ -69,7 +84,7 @@ module Emites
       #   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
+      # @return Emites::Entities::Collection a collection of Emites::Entities::NfseStatusTransition
       def history(id)
         http.get("/nfse/#{id}/history") do |response|
           respond_with_collection(response, Entities::NfseStatusTransition)
@@ -168,6 +183,30 @@ module Emites
       end
 
       notify :create, :update, :cancel, :destroy
+
+      private
+
+      PERMITTED_PARAMS = %W(
+        status
+        emitter_id
+        nfse_key
+        emission_date_lte
+        emission_date_gte
+        number
+        nfse_number
+        amount_lte
+        amount_gte
+        taker_social_reason
+        taker_cpf
+        taker_cnpj
+        is_complete
+        serie,
+        page
+      )
+
+      def filter(params)
+        Emites::Params.new(params).permit(PERMITTED_PARAMS)
+      end
     end
   end
-end
+end

data/lib/emites/response.rb

@@ -7,17 +7,22 @@ module Emites
   class Response < SimpleDelegator
 
     def resolve!(&block)
-      if success? || redirected?
+      timeout! if timed_out?
+      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
+      (300..308).include?(self.code)
+    end
+
+    def parsed_body
+      MultiJson.load(body)
+    rescue MultiJson::ParseError
+      {}
     end
 
     private
@@ -30,9 +35,9 @@ module Emites
       raise RequestError.new(
         code:    code,
         message: status_message,
-        body:    (MultiJson.load(body) rescue {})
+        body:    parsed_body
       )
     end
 
   end
-end
+end

data/lib/emites/version.rb

@@ -1,3 +1,3 @@
 module Emites
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/emites/entities/base_spec.rb

@@ -25,4 +25,4 @@ describe Emites::Entities::Base do
       })
     end
   end
-end
+end

data/spec/emites/entities/collection_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Emites::Entities::Collection do
+  let(:json) { File.read('spec/fixtures/nfse_list.json') }
+  let(:response) { double(parsed_body: MultiJson.load(json)) }
+
+  subject { described_class.new(response, Emites::Entities::Nfse) }
+
+  describe '#build' do
+    it 'returns self' do
+      expect(subject.build).to eq(subject)
+    end
+
+    it 'builds a nfse collection' do
+      expect(subject.build.count).to eq(3)
+      expect(subject.build.first.class).to eq(Emites::Entities::Nfse)
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns next page (3)' do
+      expect(subject.next_page).to eq(3)
+    end
+
+    context 'when there is no next page' do
+      let(:response) { double(parsed_body: {}) }
+
+      it 'returns nil' do
+        expect(subject.next_page).to be_nil
+      end
+    end
+  end
+
+  describe '#previous_page' do
+    it 'returns previous page (1)' do
+      expect(subject.previous_page).to eq(1)
+    end
+
+    context 'when there is no previous page' do
+      let(:response)  { double(parsed_body: {}) }
+
+      it 'returns nil' do
+        expect(subject.previous_page).to be_nil
+      end
+    end
+  end
+
+  describe '#total' do
+    it 'returns one thousand' do
+      expect(subject.total).to eq(1000)
+    end
+  end
+
+  describe "#to_a" do
+    it 'returns the collection as an array' do
+      expect(subject.to_a).to be_a(Array)
+      expect { subject.to_a.clear }.not_to change { subject.count }
+    end
+  end
+end
+

data/spec/emites/entities/nfse_spec.rb

@@ -128,7 +128,7 @@ describe Emites::Entities::Nfse do
 
   it_behaves_like "entity_attributes", [
     :id, :emitter_id, :taker, :rps_situation, :serie,
-    :number, :rps_type, :emission_date,
+    :number, :nfse_number, :rps_type, :emission_date,
     :emission_date_nfse, :operation_nature, :other_informations,
     :competence, :special_regime, :status,
     :description, :send_nfse_taker, :service_values,
@@ -145,4 +145,4 @@ describe Emites::Entities::Nfse do
     end
   end
 
-end
+end

data/spec/emites/params_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Emites::Params do
+  let(:permitted_params) { [:a, :b, :c] }
+  subject { Emites::Params.new(permitted_params) }
+
+  describe '#permit' do
+
+    it 'filters a hash with string keys' do
+      expect(Emites::Params.new({'a' => 1, 'b' => 2, 'd' => 3 }).permit(permitted_params)).to eq({ a: 1, b: 2 })
+    end
+
+    it 'filters a hash with symbol keys' do
+      expect(Emites::Params.new(a: 1, b: 2, d: 3).permit(permitted_params)).to eq({ a: 1, b: 2 })
+    end
+  end
+end

data/spec/emites/resources/base_spec.rb

@@ -39,20 +39,6 @@ describe Emites::Resources::Base do
     allow(Emites.configuration).to receive(:url).and_return("http://requestb.in")
   end
 
-  describe "#parsed_body" do
-    before do
-      allow(http).to receive(:send_request).and_return(request)
-    end
-
-    it "does not raise an error" do
-      expect{ subject.parseable }.not_to raise_error
-    end
-
-    it "response returns an empty hash" do
-      expect(subject.parseable).to eq({})
-    end
-  end
-
   describe ".notify" do
     before do
       allow(http).to receive(:send_request).and_return(request)
@@ -93,4 +79,4 @@ describe Emites::Resources::Base do
       expect { subject.timeout }.to raise_error(Emites::RequestTimeout)
     end
   end
-end
+end