correios_gem 1.4.0

data/lib/sigep/requests/search_available_additional_services.rb

@@ -0,0 +1,62 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class SearchAvailableAdditionalServices < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:busca_servicos_adicionais_ativos,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].buscaServicosAdicionaisAtivos
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:busca_servicos_adicionais_ativos_response][:return]
+        response = [response] if response.is_a?(Hash)
+
+        { additional_services: format_additional_services(response) }
+      end
+
+      def format_additional_services(additional_services)
+        formatted_additional_services = []
+        additional_services.each do |additional_service|
+          formatted_additional_services << {
+            code: additional_service[:codigo],
+            description: additional_service[:descricao].encode(Encoding::UTF_8),
+            initials: additional_service[:sigla]
+          }
+        end
+        formatted_additional_services
+      end
+    end
+  end
+end

data/lib/sigep/requests/search_customer.rb

@@ -0,0 +1,129 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class SearchCustomer < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:busca_cliente,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].buscaCliente do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.idContrato @credentials.contract
+                xml.idCartaoPostagem @credentials.card
+                xml.usuario @credentials.sigep_user
+                xml.senha @credentials.sigep_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:busca_cliente_response][:return]
+
+        contracts = response[:contratos]
+        contracts = [contracts] if contracts.is_a?(Hash)
+
+        formatted_contracts = []
+        contracts.each do |contract|
+          formatted_contracts << format_contract(contract)
+        end
+
+        {
+          status_code: response[:status_codigo].strip,
+          status_description: response[:descricao_status_cliente].strip,
+          contracts: formatted_contracts
+        }
+      end
+
+      def format_contract(contract)
+        cards = contract[:cartoes_postagem]
+        cards = [cards] if cards.is_a?(Hash)
+
+        formatted_cards = []
+        cards.each do |card|
+          formatted_cards << format_card(card)
+        end
+
+        {
+          board_id: contract[:codigo_diretoria].strip,
+          board_description: contract[:descricao_diretoria_regional].strip,
+          validity_begin: contract[:data_vigencia_inicio],
+          validity_end: contract[:data_vigencia_fim],
+          cards: formatted_cards
+        }
+      end
+
+      def format_card(card)
+        services = card[:servicos]
+        services = [services] if services.is_a?(Hash)
+
+        formatted_services = []
+        services.each do |service|
+          formatted_services << format_service(service)
+        end
+
+        {
+          validity_begin: card[:data_vigencia_inicio],
+          validity_end: card[:data_vigencia_fim],
+          services: formatted_services
+        }
+      end
+
+      def format_service(service)
+        sigep_service = service[:servico_sigep]
+
+        {
+          category: sigep_service[:categoria_servico],
+          code: service[:codigo].strip,
+          description: service[:descricao].strip,
+          id: service[:id].strip,
+          seal: sigep_service[:chancela][:chancela],
+          conditions: {
+            dimensions_required: sigep_service[:exige_dimensoes],
+            addtional_price_required: sigep_service[:exige_valor_cobrar],
+            payment_on_delivery: HELPER.convert_string_to_bool(
+              sigep_service[:pagamento_entrega]
+            ),
+            grouped_shipment: HELPER.convert_string_to_bool(
+              sigep_service[:remessa_agrupada]
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/sigep/requests/search_zip_code.rb

@@ -0,0 +1,63 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class SearchZipCode < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        @zip_code = data[:zip_code]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:consulta_cep,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].consultaCEP do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.cep @zip_code
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:consulta_cep_response][:return]
+        {
+          neighborhood: response[:bairro],
+          zip_code: response[:cep],
+          city: response[:cidade],
+          additional: response[:complemento2],
+          street: response[:end],
+          state: response[:uf]
+        }
+      end
+    end
+  end
+end

data/lib/sigep/requests/track_shippings.rb

@@ -0,0 +1,145 @@
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class TrackShippings < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @label_numbers = data[:label_numbers]
+        @query_type = data[:query_type]
+        @result_type = data[:result_type]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:consulta_sro,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].consultaSRO do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                @label_numbers.each do |label_number|
+                  xml.listaObjetos label_number
+                end
+                xml.tipoConsulta query_type(@query_type)
+                xml.tipoResultado result_type(@result_type)
+                xml.usuarioSro @credentials.sro_user
+                xml.senhaSro @credentials.sro_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:consulta_sro_response][:return]
+        response = Hash.from_xml(response)
+
+        objects = response['rastro']['objeto']
+        objects = [objects] if objects.is_a?(Hash)
+
+        formatted_objects = []
+        objects.each do |object|
+          formatted_objects << format_object(object)
+        end
+
+        { tracking: formatted_objects }
+      end
+
+      def format_object(object)
+        events = object['evento']
+        events = [events] if events.is_a?(Hash)
+
+        formatted_events = []
+        events.each do |event|
+          formatted_events << format_event(event)
+        end
+
+        {
+          label: {
+            number: object['numero'],
+            initials: object['sigla'],
+            name: object['nome'],
+            category: object['categoria']
+          },
+          events: formatted_events
+        }
+      end
+
+      def format_event(event)
+        {
+          movement: HELPER.tracking_event_status(event),
+          type: event['tipo'],
+          status: event['status'],
+          time: HELPER.convert_string_to_date(event['data'], event['hora']),
+          description: event['descricao'],
+          detail: event['detalhe'],
+          city: event['cidade'],
+          state: event['uf'],
+          destination: format_destination(event['destino']),
+          site: {
+            description: event['local'],
+            code: event['codigo']
+          }
+        }
+      end
+
+      def format_destination(destination)
+        return nil if destination.nil?
+        {
+          city: destination['cidade'],
+          neighborhood: destination['bairro'],
+          state: destination['uf'],
+          site: {
+            description: destination['local'],
+            code: destination['codigo']
+          }
+        }
+      end
+
+      def query_type(type)
+        case type
+        when :list
+          'L'
+        when :range
+          'F'
+        end
+      end
+
+      def result_type(type)
+        case type
+        when :last_event
+          'U'
+        when :all_events
+          'T'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: correios_gem
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Arthur Soares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Integration with Sigep Web, SRO, Reverse Logistics and Pricefier
+email: arthurvsp97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/SRO/client.rb
+- lib/SRO/helper.rb
+- lib/SRO/requests/track_shippings.rb
+- lib/SRO/requests/track_shippings_list.rb
+- lib/correios_exception.rb
+- lib/correios_gem.rb
+- lib/credentials.rb
+- lib/pricefier/client.rb
+- lib/pricefier/helper.rb
+- lib/pricefier/requests/calculate_deadline.rb
+- lib/pricefier/requests/calculate_deadline_with_date.rb
+- lib/pricefier/requests/calculate_deadline_with_restrictions.rb
+- lib/pricefier/requests/calculate_price.rb
+- lib/pricefier/requests/calculate_price_deadline.rb
+- lib/pricefier/requests/calculate_price_deadline_with_date.rb
+- lib/pricefier/requests/calculate_price_deadline_with_restrictions.rb
+- lib/pricefier/requests/calculate_price_fac.rb
+- lib/pricefier/requests/calculate_price_with_date.rb
+- lib/pricefier/requests/list_services.rb
+- lib/pricefier/requests/list_services_star.rb
+- lib/reverse_logistics/client.rb
+- lib/reverse_logistics/helper.rb
+- lib/reverse_logistics/requests/calculate_ticket_number_check_digit.rb
+- lib/reverse_logistics/requests/cancel_shipping.rb
+- lib/reverse_logistics/requests/create_shippings.rb
+- lib/reverse_logistics/requests/create_shippings_with_collection.rb
+- lib/reverse_logistics/requests/request_ticket_numbers.rb
+- lib/reverse_logistics/requests/track_shipping.rb
+- lib/reverse_logistics/requests/track_shippings_by_date.rb
+- lib/sigep/client.rb
+- lib/sigep/helper.rb
+- lib/sigep/requests/calculate_label_number_check_digit.rb
+- lib/sigep/requests/cancel_shipping.rb
+- lib/sigep/requests/check_card_status.rb
+- lib/sigep/requests/check_service_availability.rb
+- lib/sigep/requests/create_shippings.rb
+- lib/sigep/requests/request_label_numbers.rb
+- lib/sigep/requests/request_shippings_xml.rb
+- lib/sigep/requests/search_available_additional_services.rb
+- lib/sigep/requests/search_customer.rb
+- lib/sigep/requests/search_zip_code.rb
+- lib/sigep/requests/track_shippings.rb
+homepage: https://github.com/arthursoas/correios_gem
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: correios-gem integrates your app with Brazil post office APIs
+test_files: []