sigep_web 0.2.5 → 0.2.6

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    sigep_web (0.2.4)
+    sigep_web (0.2.6)
       nokogiri (~> 1.6)
-      savon (~> 2.10.0)
+      savon (~> 2.10, >= 2.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,13 +15,14 @@ GEM
     diff-lcs (1.2.5)
     gyoku (1.3.1)
       builder (>= 2.1.2)
-    httpi (2.4.1)
+    httpi (2.4.2)
       rack
+      socksify
     macaddr (1.7.1)
       systemu (~> 2.6.2)
-    mini_portile2 (2.0.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
     nori (2.6.0)
     rack (1.6.4)
     rake (10.4.2)
@@ -47,6 +48,7 @@ GEM
       nori (~> 2.4)
       uuid (~> 2.3.7)
       wasabi (~> 3.4)
+    socksify (1.7.0)
     systemu (2.6.5)
     uuid (2.3.8)
       macaddr (~> 1.0)
@@ -64,4 +66,4 @@ DEPENDENCIES
   sigep_web!
 
 BUNDLED WITH
-   1.11.2
+   1.13.5

data/README.md

@@ -1,11 +1,115 @@
-# sigep_web
+# Sigep Web
 
 [![Build Status](https://travis-ci.org/Sidoniuns/sigep_web.svg?branch=master)](https://travis-ci.org/Sidoniuns/sigep_web)
 [![Gem Version](https://badge.fury.io/rb/sigep_web.svg)](https://badge.fury.io/rb/sigep_web)
 [![Code Climate](https://codeclimate.com/github/Sidoniuns/sigep_web/badges/gpa.svg)](https://codeclimate.com/github/Sidoniuns/sigep_web)
 
-## Installation
-  gem install sigep_web
+## About
 
-## Usage
-  require 'sigep_web'
+This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this API documentation [http://goo.gl/UglwTj](http://goo.gl/UglwTj)
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+``` ruby
+gem 'sigep_web'
+```
+
+or in your console:
+
+``` ruby
+gem install sigep_web
+```
+
+### Configuration
+
+If you are using Rails put this in your environments configuration files:
+
+``` ruby
+SigepWeb.configure do |config|
+  config.user = 'YOUR_USER'
+  config.password = 'YOUR_PASSWORD'
+  config.administrative_code = 'YOUR_ADM_CODE'
+  config.card = 'YOUR_CARD_NUMBER'
+  config.contract = 'YOUR_CONTRACT_NUMBER'
+end
+```
+### How It Works
+
+####  Consulting service availability
+
+This check whether a particular service is available from source zip code to target zip code.
+
+``` ruby
+SigepWeb.service_availability(service_number: '40215', source_zip: '70002900', target_zip: '74730490')
+```
+
+This method will return a hash like this if has a success response, the second attribute indicate if a particular service is available.
+
+``` ruby
+{ :success => true, :response => true }
+```
+
+#### Search Client
+This method return the available services of specific post card
+
+``` ruby
+SigepWeb.search_client(id_contract: "0000000000", id_post_card: "0000000000")
+```
+
+The method will return something like this
+
+``` ruby
+{
+  :success => true,
+  :response => {
+    :cnpj => '0000000000',
+    :contratos => {
+      :cartoes_postage => {
+        :codigo_administrativo => '000000000',
+        :numero => '000000000',
+        :servicos => [
+          {
+            :codigo => '40096',
+            :descricao => 'SEDEX - CONTRATO',
+            :id => '104625'
+          },
+          ...
+        ]
+      }
+    }
+  }
+}
+```
+
+#### Zip Query
+This method return the address based on zip code
+
+``` ruby
+SigepWeb.zip_query(zip: "70002900")
+```
+
+This method will return a hash like this
+
+``` ruby
+{
+  :success => true,
+  :response => {
+    :bairro => 'Asa Norte',
+    :cep => '70002900',
+    :cidade => 'Brasília',
+    :complemento => nil,
+    :complemento2 => nil,
+    :end => 'SBN Quadra 1 Bloco A',
+    :id => '0',
+    :uf => 'DF'
+  }
+}
+```
+
+#### Request Labels For Posts
+Return one label or a range of labels to use for posts
+``` ruby
+SigepWeb.request_labels(receiver_type: "C", identifier: "00000000000000", id_service: "104625", qt_labels: 1)
+```

data/lib/sigep_web/Models/sender.rb

@@ -28,77 +28,46 @@ module SigepWeb
           xml.correioslog do
             xml.tipo_arquivo 'Postagem'
             xml.versao_arquivo '2.3'
-            xml.plp do
-              xml.id_plp
-              xml.valor_global
-              xml.mcu_unidade_postagem
-              xml.nome_unidade_postagem
-              xml.cartao_postagem @card
-            end
-
-            xml.remetente do
-              xml.numero_contrato @contract_number
-              xml.numero_diretoria @directorship_number
-              xml.codigo_administrativo @administrative_code
-              xml.nome_remetente { xml.cdata @name }
-              xml.logradouro_remetente { xml.cdata @address }
-              xml.numero_remetente @number
-              xml.complemento_remetente { xml.cdata @complement }
-              xml.bairro_remetente { xml.cdata @neighborhood }
-              xml.cep_remetente { xml.cdata @zip_code }
-              xml.cidade_remetente { xml.cdata @city }
-              xml.uf_remetente @uf
-              xml.telefone_remetente { xml.cdata @phone }
-              xml.fax_remetente { xml.cdata @fax }
-              xml.email_remetente { xml.cdata @email }
-            end
-
+            plp_xml
+            receiver_xml
             xml.forma_pagamento @payment_form
 
             XML::PostalObject.new(xml, @postal_objects).build_xml
           end
         end
 
-        builder.to_xml.gsub(/\n/, '').encode(Encoding::UTF_8)
+        builder.to_xml.delete(/\n/).encode(Encoding::UTF_8)
       end
 
-      def example_xml
-        builder = Nokogiri::XML::Builder.new(encoding: 'ISO-8859-1') do |xml|
-          xml.correioslog do
-            xml.tipo_arquivo 'Postagem'
-            xml.versao_arquivo '2.3'
-            xml.plp do
-              xml.id_plp
-              xml.valor_global
-              xml.mcu_unidade_postagem
-              xml.nome_unidade_postagem
-              xml.cartao_postagem @card
-            end
-
-            xml.remetente do
-              xml.numero_contrato @contract_number
-              xml.numero_diretoria @directorship_number
-              xml.codigo_administrativo @administrative_code
-              xml.nome_remetente { xml.cdata @name }
-              xml.logradouro_remetente { xml.cdata @address }
-              xml.numero_remetente @number
-              xml.complemento_remetente { xml.cdata @complement }
-              xml.bairro_remetente { xml.cdata @neighborhood }
-              xml.cep_remetente { xml.cdata @zip_code }
-              xml.cidade_remetente { xml.cdata @city }
-              xml.uf_remetente @uf
-              xml.telefone_remetente { xml.cdata @phone }
-              xml.fax_remetente { xml.cdata @fax }
-              xml.email_remetente { xml.cdata @email }
-            end
+      private
 
-            xml.forma_pagamento @payment_form
-
-            XML::PostalObject.new(xml, @postal_objects).build_xml
-          end
+      def plp_xml (xml)
+        xml.plp do
+          xml.id_plp
+          xml.valor_global
+          xml.mcu_unidade_postagem
+          xml.nome_unidade_postagem
+          xml.cartao_postagem @card
         end
+      end
 
-        builder.to_xml.encode(Encoding::UTF_8)
+      def receiver_xml (xml)
+        xml.remetente do
+          xml.numero_contrato @contract_number
+          xml.numero_diretoria @directorship_number
+          xml.codigo_administrativo @administrative_code
+          xml.nome_remetente { xml.cdata @name }
+          xml.logradouro_remetente { xml.cdata @address }
+          xml.numero_remetente @number
+          xml.complemento_remetente { xml.cdata @complement }
+          xml.bairro_remetente { xml.cdata @neighborhood }
+          xml.cep_remetente { xml.cdata @zip_code }
+          xml.cidade_remetente { xml.cdata @city }
+          xml.uf_remetente @uf
+          xml.telefone_remetente { xml.cdata @phone }
+          xml.fax_remetente { xml.cdata @fax }
+          xml.email_remetente { xml.cdata @email }
+        end
       end
     end
   end

data/lib/sigep_web/calculate_digit_checker.rb

@@ -0,0 +1,31 @@
+module SigepWeb
+  class CalculateDigitChecker < WebServiceReverseLogisticApi
+    def initialize(options = {})
+      @number = options[:number]
+      super()
+    end
+
+    def request
+      authenticate = SigepWeb.configuration.authenticate
+
+      begin
+        response = process(:calcular_digito_verificador, {
+          usuario: authenticate.user,
+          senha: authenticate.password,
+          codAdministrativo: authenticate.administrative_code,
+          numero: @number
+        }).to_hash[:calcular_digito_verificador_response][:return]
+
+        {
+          success: true,
+          response: response
+        }
+      rescue Savon::SOAPFault => msg
+        {
+          success: false,
+          error: msg
+        }
+      end
+    end
+  end
+end

data/lib/sigep_web/request_range.rb

@@ -0,0 +1,36 @@
+module SigepWeb
+  class RequestRange < WebServiceReverseLogisticApi
+    def initialize(options = {})
+      @type = options[:type]
+      @service = options[:service]
+      @quantity = options[:quantity]
+      super()
+    end
+
+    def request
+      authenticate = SigepWeb.configuration.authenticate
+
+      begin
+        response = process(:solicitar_range, {
+          usuario: authenticate.user,
+          senha: authenticate.password,
+          codAdministrativo: authenticate.administrative_code,
+          contrato: authenticate.contract,
+          tipo: @type,
+          servico: @service,
+          quantidade: @quantity
+        }).to_hash[:solicitar_range_response][:return]
+
+        {
+          success: true,
+          response: response
+        }
+      rescue Savon::SOAPFault => msg
+        {
+          success: false,
+          error: msg
+        }
+      end
+    end
+  end
+end

data/lib/sigep_web/version.rb

@@ -1,3 +1,3 @@
 module SigepWeb
-  VERSION = "0.2.5"
+  VERSION = '0.2.6'
 end

data/lib/sigep_web/web_service_reverse_logistic_api.rb

@@ -1,15 +1,23 @@
 module SigepWeb
   class WebServiceReverseLogisticApi
     def initialize
-      @client = Savon.client({ wsdl: url })
+      @client = Savon.client({
+        wsdl: url,
+        ssl_verify_mode: :none
+      })
     end
 
-    def url
-      @url ||= if ENV['GEM_ENV'] == 'test'
-                 'http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl'
-               else
-                 'http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl'
-               end
+    def process(method, message)
+      @client.call(method, soap_action: "", message: message)
     end
+
+    private
+      def url
+        if ENV['GEM_ENV'] == 'test'
+          'http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl'
+        else
+          'http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl'
+        end
+      end
   end
 end

data/lib/sigep_web/zip_query.rb

@@ -13,7 +13,7 @@ module SigepWeb
 
         {
           success: true,
-          response: ApiResponse.new(response)
+          response: response
         }
       rescue Savon::SOAPFault => msg
         {
@@ -23,20 +23,4 @@ module SigepWeb
       end
     end
   end
-
-  class ApiResponse
-    attr_reader :neighborhood, :zip, :city, :complement, :other_complement,
-      :address, :id, :uf
-
-    def initialize(options = {})
-      @neighborhood     = options[:bairro]
-      @zip              = options[:cep]
-      @city             = options[:cidade]
-      @complement       = options[:complemento]
-      @other_complement = options[:complemento2]
-      @address          = options[:end]
-      @id               = options[:id]
-      @uf               = options[:uf]
-    end
-  end
 end

data/lib/sigep_web.rb

@@ -20,6 +20,8 @@ require 'sigep_web/generate_labels_digit_verifier'
 require 'sigep_web/request_plp_services'
 require 'sigep_web/postage_card_status'
 require 'sigep_web/request_xml_plp'
+require 'sigep_web/request_range'
+require 'sigep_web/calculate_digit_checker'
 require 'savon'
 require 'nokogiri'
 
@@ -63,4 +65,12 @@ module SigepWeb
   def self.request_xml_plp(options = {})
     RequestXmlPlp.new(options).request
   end
+
+  def self.request_range(options = {})
+    RequestRange.new(options).request
+  end
+
+  def self.calculate_digit_checker(options = {})
+    CalculateDigitChecker.new(options).request
+  end
 end

data/sigep_web.gemspec

@@ -4,15 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sigep_web/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sigep_web"
+  spec.name          = 'sigep_web'
   spec.version       = SigepWeb::VERSION
-  spec.authors       = ["Marcelo Perini Veloso\n\n"]
-  spec.email         = ["marcelo.perini.veloso@gmail.com"]
+  spec.authors       = ['Marcelo Perini Veloso\n\n']
+  spec.email         = ['marcelo.perini.veloso@gmail.com']
 
   spec.summary       = %q{A gem to integrate Sigep Web API}
   spec.description   = %q{This gem provide a easy way to integrate an application to Correios Sigep Web API}
-  spec.homepage      = "https://github.com/Sidoniuns/sigep_web"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/Sidoniuns/sigep_web'
+  spec.license       = 'MIT'
 
   spec.rubyforge_project = 'sigep_web'
 
@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
 #  end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "savon"               , "~> 2.10.0"
-  spec.add_dependency "nokogiri"            , "~> 1.6"
+  spec.add_dependency 'savon', '~> 2.10', '>= 2.10.0'
+  spec.add_dependency 'nokogiri', '~> 1.6'
 
-  spec.add_development_dependency "bundler" , "~> 1.11"
-  spec.add_development_dependency "rake"    , "~> 10.0"
-  spec.add_development_dependency "rspec"   , "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,22 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: sigep_web
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
-- |+
-  Marcelo Perini Veloso
-
+- Marcelo Perini Veloso\n\n
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.0
   type: :runtime
@@ -24,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.10.0
 - !ruby/object:Gem::Dependency
@@ -90,8 +94,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -113,11 +119,13 @@ files:
 - lib/sigep_web/XML/postal_object.rb
 - lib/sigep_web/XML/receiver.rb
 - lib/sigep_web/authenticate.rb
+- lib/sigep_web/calculate_digit_checker.rb
 - lib/sigep_web/configuration.rb
 - lib/sigep_web/generate_labels_digit_verifier.rb
 - lib/sigep_web/postage_card_status.rb
 - lib/sigep_web/request_labels.rb
 - lib/sigep_web/request_plp_services.rb
+- lib/sigep_web/request_range.rb
 - lib/sigep_web/request_xml_plp.rb
 - lib/sigep_web/search_client.rb
 - lib/sigep_web/service_availability.rb
@@ -146,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sigep_web
-rubygems_version: 2.1.9
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem to integrate Sigep Web API