correios_sigep 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2Q3ZjVmN2EwZGRiYmMwMjUzNGFmNWFiNDdmN2I5ZGExMGM0MmE5OQ==
+    YjA5NmI1OTJjZWQ3NTFjYTdmNDQ5ZDA1ZDMyYTdkNDM0MjdlNGJjZg==
   data.tar.gz: !binary |-
-    NzRiOTA1NWZhNzE4ZDgyMTY2YmQ4ZTdkMjBlZWZkZDIxMjUxMmEyYg==
+    NDgwOGYxMmY0NDA0Yzg5YWM4ZWRhYzBkOWJhYWRmYTg3N2VkNjcxZQ==
 SHA512:
   metadata.gz: !binary |-
-    NmZmMDFiNDllZmFlZDJhY2RjODk0Njc0MmFkOTU4Y2UzOTlkMzZmY2EwZjcz
-    OGMyNGI4ZWM2NTY1YjE2OTFiNDUzNGE2Mzc4OGU0YjI2NGRiOWFjZDZkOTZh
-    MTZiMWYwOWQxMjRlNDRhOWU0NmRjM2Q0NWVhN2Q4OTA3ZjI1ZTc=
+    MWYwMDI0NGI2MmIyMmJkNTdlZmNmZjY4NDIxMmQxNTZlYTI3MzBjOTNkNzBj
+    MDBiNDU2Y2MwYTdkZjUzMmEyYTQ5MzM2MzcxNWY5YzNiZDkzNWE3OTZkNDZm
+    NzQ0ZjYwYjY2MzQ1MzQxMjU5MjMzM2YxOWM3Y2RkMjg3MzZiODc=
   data.tar.gz: !binary |-
-    Njc3M2QwYmJiZTQ5ZGMzZjhmOTM5MDFkN2UwZWQyNjgzODE0YjA3M2I5YmY5
-    ZmQzYWQwMWYwM2M5Y2UwNmQ0NjBiMTUwYmMwZTZkMTQ2NTBkYzBkYTcxOWZk
-    NDJkZjgzNTdkNjdiOWI2NzJiYmE4OTgxMzMyZWViODI5Njk5OTg=
+    YWZjOWZmMTg3OTkwNGJiZWMzYzA4MGRhNTU0NzI5ZmQyYjkyYjM3Y2I1MjUy
+    ZmRhYTBmYjY1ZGRjNGI5ZTE1ZWFiZmYwOTAwZjkxZGJiOTNjNDRjYmFlZjMx
+    YWRkMzdjMDMxOWUwY2NiYzRmYWYwZDhjY2Y2NTkxMGQ3MThhNzU=

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 before_install:
 - gem install bundler -v '~> 1.5'
 rvm:
-- 1.9.3
 - 2.0.0
 - 2.1.1
+- 2.2.0
 - jruby-19mode
 bundler_args: --without debug
 deploy:

data/README.md

@@ -4,7 +4,7 @@ CorreiosSigep
 [![Build Status](https://travis-ci.org/duduribeiro/correios_sigep.svg?branch=master)](https://travis-ci.org/duduribeiro/correios_sigep)
 
 - Integrador responsável pela comunicação com o SigepWeb - http://goo.gl/z8VJjJ.
-- Documentação do SigepWeb: http://goo.gl/6TWp2f
+- Excelente documentação do SigepWeb providenciada pelos Correios: http://goo.gl/6TWp2f :trollface:
 - Atualmente a Gem faz somente uma solicitação de uma postagem de reversa (documentação, pág 36).
 
 ## Instalação

data/lib/correios_sigep.rb

@@ -7,6 +7,7 @@ require 'correios_sigep/builders/xml/collect_objects'
 require 'correios_sigep/builders/xml/collect'
 require 'correios_sigep/builders/xml/authentication'
 require 'correios_sigep/builders/xml/request_collect_number'
+require 'correios_sigep/builders/xml/request_sro'
 require 'correios_sigep/models/recipient'
 require 'correios_sigep/models/product'
 require 'correios_sigep/models/recipient'
@@ -15,6 +16,7 @@ require 'correios_sigep/models/object'
 require 'correios_sigep/models/sender'
 require 'correios_sigep/models/collect'
 require 'correios_sigep/models/logistic_reverse'
+require 'correios_sigep/models/sro'
 require 'correios_sigep/models/correios_response_codes'
 require 'correios_sigep/models/errors/ticket_already_used'
 require 'correios_sigep/models/errors/unavailable_service'
@@ -22,8 +24,10 @@ require 'correios_sigep/models/errors/inexistent_zipcode'
 require 'correios_sigep/models/errors/unavailable_house_collect'
 require 'correios_sigep/models/errors/collect_not_answered_for_the_zipcode'
 require 'correios_sigep/models/errors/unknown_error'
+require 'correios_sigep/models/errors/sro_not_ready'
 require 'correios_sigep/logistic_reverse/base_client'
 require 'correios_sigep/logistic_reverse/request_collect_number'
+require 'correios_sigep/logistic_reverse/request_sro'
 require 'nokogiri'
 require 'savon'
 

data/lib/correios_sigep/builders/xml/authentication.rb

@@ -7,7 +7,7 @@ module CorreiosSigep
           @config = CorreiosSigep.configuration
         end
 
-        def build_xml
+        def build_xml!
           add_node "usuario", @config.user
           add_node "senha", @config.password
           add_node "codAdministrativo", @config.administrative_code

data/lib/correios_sigep/builders/xml/request_collect_number.rb

@@ -4,9 +4,11 @@ module CorreiosSigep
       class RequestCollectNumber
 
         def self.build_xml(logistic_reverse)
-          document                  = Nokogiri::XML(logistic_reverse.to_xml)
-          XML::Authentication.new(document).build_xml
-          document.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+          document = Nokogiri::XML(logistic_reverse.to_xml)
+          XML::Authentication.new(document).build_xml!
+
+          document
+            .to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
             .gsub(/<(\/)?root>/, '')
         end
 

data/lib/correios_sigep/builders/xml/request_sro.rb

@@ -0,0 +1,19 @@
+module CorreiosSigep
+  module Builders
+    module XML
+      class RequestSRO
+
+        def self.build_xml(sro)
+          document = Nokogiri::XML(sro.to_xml)
+          XML::Authentication.new(document).build_xml!
+
+          document
+            .to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+            .gsub(/<(\/)?root>/, '')
+        end
+
+      end
+    end
+  end
+end
+

data/lib/correios_sigep/logistic_reverse/base_client.rb

@@ -14,8 +14,11 @@ module CorreiosSigep
       end
 
       def invoke(method, message)
-        @client.instance_variable_set(:@wsdl,
-          Wasabi::Document.new(CorreiosSigep.configuration.wsdl_base_url)) if wsdl_base_url_changed?
+        @client.instance_variable_set(
+          :@wsdl,
+          Wasabi::Document.new(CorreiosSigep.configuration.wsdl_base_url)
+        ) if wsdl_base_url_changed?
+
         @client.call(method, message: message)
       end
 

data/lib/correios_sigep/logistic_reverse/request_collect_number.rb

@@ -14,7 +14,7 @@ module CorreiosSigep
 
       private
 
-      def process_response(response)
+      def process_response response
         response_xml = response.to_xml.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
         response_doc = Nokogiri::XML.parse(response_xml)
         code = response_doc.search('//cod-erro | //cod_erro').text.to_i rescue nil
@@ -26,26 +26,29 @@ module CorreiosSigep
         result_node = response_doc.search(result_string)
 
         case code
-
         when Models::CorreiosResponseCodes::SUCCESS
           result = result_node.search('//numero-coleta | //numero_coleta')
-          if node = result.first
-            collect_number = node.text
-          end
+          result.first.text rescue nil
+
         when Models::CorreiosResponseCodes::TICKET_ALREADY_USED
-          raise Models::Errors::TicketAlreadyUsed.new result_node
-            .search('//msg_erro | //msg_erro').text
+          error_message = result_node.search('//msg_erro | //msg_erro').text
+          raise Models::Errors::TicketAlreadyUsed.new error_message
+
         when Models::CorreiosResponseCodes::UNAVAILABLE_SERVICE
           raise Models::Errors::UnavailableService
+
         when Models::CorreiosResponseCodes::INEXISTENT_ZIPCODE
           raise Models::Errors::InexistentZipcode
+
         when Models::CorreiosResponseCodes::UNAVAILABLE_HOUSE_COLLECT
           raise Models::Errors::UnavailableHouseCollect
+
         when Models::CorreiosResponseCodes::COLLECT_NOT_ANSWERED_FOR_THE_ZIPCODE
           raise Models::Errors::CollectNotAnsweredForTheZipcode
+
         else
-          raise Models::Errors::UnknownError.new result_node
-            .search('//msg_erro | //msg_erro').text
+          error_message = result_node.search('//msg_erro | //msg_erro').text
+          raise Models::Errors::UnknownError.new error_message
         end
       end
     end

data/lib/correios_sigep/logistic_reverse/request_sro.rb

@@ -0,0 +1,28 @@
+module CorreiosSigep
+  module LogisticReverse
+    class RequestSRO < BaseClient
+      def initialize(sro)
+        @sro = sro
+        super()
+      end
+
+      def process
+        xml = Builders::XML::RequestSRO.build_xml(@sro)
+        process_response invoke(:acompanhar_pedido, xml)
+      end
+
+      private
+      def process_response response
+        correios_hash = response.body[:acompanhar_pedido_response][:return]
+
+        case correios_hash[:cod_erro].to_i
+        when 0
+          correios_hash[:coleta][:objeto][:numero_etiqueta]
+        else
+          # TODO look for a descritpion of this weird error
+          raise Models::Errors::SRONotReady
+        end
+      end
+    end
+  end
+end

data/lib/correios_sigep/models/errors/sro_not_ready.rb

@@ -0,0 +1,8 @@
+module CorreiosSigep
+  module Models
+    module Errors
+      class SRONotReady < StandardError
+      end
+    end
+  end
+end

data/lib/correios_sigep/models/sro.rb

@@ -0,0 +1,23 @@
+module CorreiosSigep
+  module Models
+    class SRO
+      attr_accessor :collect_number, :type
+
+      def initialize(options={})
+        @collect_number = options[:collect_number]
+        @type           = options[:type]
+      end
+
+      def to_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.root {
+            xml.tipoBusca('H')
+            xml.tipoSolicitacao(@type)
+            xml.numeroPedido(@collect_number)
+          }
+        end
+        builder.to_xml
+      end
+    end
+  end
+end

data/lib/correios_sigep/version.rb

@@ -1,3 +1,3 @@
 module CorreiosSigep
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/correios_sigep/builders/xml/request_sro_spec.rb

@@ -0,0 +1,19 @@
+module CorreiosSigep
+  module Builders
+    module XML
+      describe RequestSRO do
+        let(:sro_params) { { collect_number: '1234', type: 'A' } }
+        let(:sro) { CorreiosSigep::Models::SRO.new(sro_params) }
+        let(:xml) do
+          "<cartao>0057018901</cartao><codigo_servico>41076</codigo_servico><contrato>9912208555</contrato><codAdministrativo>08082650</codAdministrativo><senha>8o8otn</senha><usuario>60618043</usuario>\n  <tipoBusca>H</tipoBusca>\n  <tipoSolicitacao>A</tipoSolicitacao>\n  <numeroPedido>1234</numeroPedido>\n\n"
+        end
+
+        subject { described_class.build_xml(sro) }
+
+        it 'builds a xml without root but with authentication' do
+          expect(subject).to eq xml
+        end
+      end
+    end
+  end
+end

data/spec/correios_sigep/logistic_reverse/request_sro_spec.rb

@@ -0,0 +1,64 @@
+module CorreiosSigep
+  module LogisticReverse
+    describe RequestSRO do
+      let(:sro_params) { { collect_number: '1234', type: 'A' } }
+      let(:sro) { CorreiosSigep::Models::SRO.new(sro_params) }
+
+      describe '.initialize' do
+        subject { described_class.new(sro) }
+
+        it 'instantiates necessary classes' do
+          expect(subject.class).to eq CorreiosSigep::LogisticReverse::RequestSRO
+        end
+      end
+
+      describe '.process' do
+        subject { described_class.new(sro).process }
+
+        before :each do
+          expect_any_instance_of(RequestSRO).to receive(:invoke).with(any_args) { response }
+        end
+
+        let(:response) { double('response', body: response_hash) }
+        let(:sro_ticket) { 'ABC123123123BR' }
+
+        context 'when successfully brings a SRO' do
+          let(:response_hash) do
+            {
+              acompanhar_pedido_response: {
+                return: {
+                  cod_erro: 0,
+                  coleta: {
+                    objeto: {
+                      numero_etiqueta: sro_ticket
+                    }
+                  }
+                }
+              }
+            }
+          end
+
+          it 'returns sro ticket' do
+            expect(subject).to eq sro_ticket
+          end
+        end
+
+        context 'when SRO is not ready yet' do
+          let(:response_hash) do
+            {
+              acompanhar_pedido_response: {
+                return: {
+                  cod_erro: 1
+                }
+              }
+            }
+          end
+
+          it 'raises an error' do
+            expect{subject}.to raise_error Models::Errors::SRONotReady
+          end
+        end
+      end
+    end
+  end
+end

data/spec/correios_sigep/models/sro_spec.rb

@@ -0,0 +1,40 @@
+module CorreiosSigep
+  module Models
+    describe SRO do
+      it { should respond_to :collect_number }
+      it { should respond_to :type }
+
+      describe '.initialize' do
+        subject { described_class.new params }
+
+        context 'with nil params' do
+          let(:params) { Hash.new }
+
+          it 'binds attrs to nil' do
+            expect(subject.collect_number).to be_nil
+            expect(subject.type).to be_nil
+          end
+        end
+
+        context 'with present params' do
+          let(:params) { { collect_number: '1234', type: 'A' } }
+          it 'binds params to params' do
+            expect(subject.collect_number).to eq params[:collect_number]
+            expect(subject.type).to eq params[:type]
+          end
+        end
+      end
+
+      describe '.to_xml' do
+        let(:sro) { described_class.new(collect_number: '12345', type: 'A') }
+        let(:xml) do
+          "<?xml version=\"1.0\"?>\n<root>\n  <tipoBusca>H</tipoBusca>\n  <tipoSolicitacao>A</tipoSolicitacao>\n  <numeroPedido>12345</numeroPedido>\n</root>\n"
+        end
+
+        it 'generates the correct xml with root' do
+          expect(sro.to_xml).to eq xml
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'simplecov'
 require 'support/logistic_reverse_helper'
 require 'support/fixture_helper'
 require 'webmock/rspec'
-require 'pry'
 
 File.expand_path(File.dirname(File.dirname(__FILE__)))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: correios_sigep
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Carlos Ribeiro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -138,14 +138,17 @@ files:
 - lib/correios_sigep/builders/xml/product.rb
 - lib/correios_sigep/builders/xml/recipient.rb
 - lib/correios_sigep/builders/xml/request_collect_number.rb
+- lib/correios_sigep/builders/xml/request_sro.rb
 - lib/correios_sigep/builders/xml/sender.rb
 - lib/correios_sigep/configuration.rb
 - lib/correios_sigep/logistic_reverse/base_client.rb
 - lib/correios_sigep/logistic_reverse/request_collect_number.rb
+- lib/correios_sigep/logistic_reverse/request_sro.rb
 - lib/correios_sigep/models/collect.rb
 - lib/correios_sigep/models/correios_response_codes.rb
 - lib/correios_sigep/models/errors/collect_not_answered_for_the_zipcode.rb
 - lib/correios_sigep/models/errors/inexistent_zipcode.rb
+- lib/correios_sigep/models/errors/sro_not_ready.rb
 - lib/correios_sigep/models/errors/ticket_already_used.rb
 - lib/correios_sigep/models/errors/unavailable_house_collect.rb
 - lib/correios_sigep/models/errors/unavailable_service.rb
@@ -155,17 +158,21 @@ files:
 - lib/correios_sigep/models/product.rb
 - lib/correios_sigep/models/recipient.rb
 - lib/correios_sigep/models/sender.rb
+- lib/correios_sigep/models/sro.rb
 - lib/correios_sigep/version.rb
 - spec/correios_sigep/builders/xml/request_collect_number_spec.rb
+- spec/correios_sigep/builders/xml/request_sro_spec.rb
 - spec/correios_sigep/configuration_spec.rb
 - spec/correios_sigep/logistic_reverse/base_client_spec.rb
 - spec/correios_sigep/logistic_reverse/request_collect_number_spec.rb
+- spec/correios_sigep/logistic_reverse/request_sro_spec.rb
 - spec/correios_sigep/models/collect_spec.rb
 - spec/correios_sigep/models/logistic_reverse_spec.rb
 - spec/correios_sigep/models/object_spec.rb
 - spec/correios_sigep/models/product_spec.rb
 - spec/correios_sigep/models/recipient_spec.rb
 - spec/correios_sigep/models/sender_spec.rb
+- spec/correios_sigep/models/sro_spec.rb
 - spec/correios_sigep_spec.rb
 - spec/fixtures/correios/response_already_in_use.xml
 - spec/fixtures/correios/response_inexistent_zipcode.xml
@@ -204,15 +211,18 @@ specification_version: 4
 summary: A gem that integrates with Correios SIGEP WEB.
 test_files:
 - spec/correios_sigep/builders/xml/request_collect_number_spec.rb
+- spec/correios_sigep/builders/xml/request_sro_spec.rb
 - spec/correios_sigep/configuration_spec.rb
 - spec/correios_sigep/logistic_reverse/base_client_spec.rb
 - spec/correios_sigep/logistic_reverse/request_collect_number_spec.rb
+- spec/correios_sigep/logistic_reverse/request_sro_spec.rb
 - spec/correios_sigep/models/collect_spec.rb
 - spec/correios_sigep/models/logistic_reverse_spec.rb
 - spec/correios_sigep/models/object_spec.rb
 - spec/correios_sigep/models/product_spec.rb
 - spec/correios_sigep/models/recipient_spec.rb
 - spec/correios_sigep/models/sender_spec.rb
+- spec/correios_sigep/models/sro_spec.rb
 - spec/correios_sigep_spec.rb
 - spec/fixtures/correios/response_already_in_use.xml
 - spec/fixtures/correios/response_inexistent_zipcode.xml