sigep_web 0.2.6.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25d48f5fd67b85fa89615845b3434bef38198ab6
-  data.tar.gz: 4b650fc1efeb5439255462b52e9b7321d4ec5ae2
+SHA256:
+  metadata.gz: b15f2b5e8823b2fa0e3ddcd82f81f69bc851aedf5e185fbfd1acc23d8889ed20
+  data.tar.gz: d5a55f1d63603da8d81f454f1b6bd740aff804e0206687b58b14fab68c19907a
 SHA512:
-  metadata.gz: beaf3aae47e9cfdfface93d3ad65b0d4d33cb542e1c9c01eea6ae4655398afbb33c1d69480e5bf4702303bf76dd636decae1687bec7f42760c2e7469a8cd5060
-  data.tar.gz: 030a058c6908ded008aac3272e126c8a6f34826c6426de10f1ce9ec9f5cecb5273fa46cfb7409da47d0ecbac431b2f4a66a04301d739067f7cb73e25ae95cf2d
+  metadata.gz: ccd0a77f6254a8d9adc8987f88fe2c65fe4c35d77fa5ac882d409f2aadb7a9a29d47a73594497cb26d75a0b0ede4150c1442f492d35ee2c4e4fd6f8108872649
+  data.tar.gz: 1ba66ee5c968725d9e90e320de07f98db2e34fb9d6a8dfb4e3ab0d38508d1fdbde9b23767ffc9853f268d48272df57cb93b0fc24e58e50471cf92c43e50a9a1d

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: gha-workflow-test
+on: [push, pull_request]
+
+jobs:
+  gha-job-lint:
+    name: Lint
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Bundle
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Lint
+        run: bundle exec standardrb
+
+  # The test job is a matrix of ruby/rails versions.
+  gha-job-test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        run: bundle exec rspec
+
+      - name: Coverage
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -27,9 +27,11 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.tool-versions
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.coverwalls.yml

data/Gemfile

@@ -1,4 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in sigep_web.gemspec
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Marcelo Perini Veloso
+Copyright (c) 2018 Marcelo Perini Veloso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/LICENSE.txt

@@ -1,8 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Marcelo Perini Veloso
-
-
+Copyright (c) 2018 Marcelo Perini Veloso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -11,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,12 +1,13 @@
 # Sigep Web
 
-[![Build Status](https://travis-ci.org/Sidoniuns/sigep_web.svg?branch=master)](https://travis-ci.org/Sidoniuns/sigep_web)
+![Build Status](https://github.com/marceloperini/sigep_web/workflows/Ruby/badge.svg)
 [![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)
+[![Coverage Status](https://coveralls.io/repos/github/marceloperini/sigep_web/badge.svg?branch=master)](https://coveralls.io/github/marceloperini/sigep_web?branch=master)
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DWFWT6N2YCZTG)
 
 ## About
 
-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)
+This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this [API documentation](https://www2.correios.com.br/sistemas/encomendas/sigepweb/doc/Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf)
 
 ## Getting started
 
@@ -37,43 +38,47 @@ end
 ```
 ### How It Works
 
-####  Consulting service availability
+#### 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')
+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 }
+{ 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")
+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 => [
+  success: true,
+  response: {
+    cnpj: '0000000000',
+    contratos: {
+      cartoes_postage: {
+        codigo_administrativo: '000000000',
+        numero: '000000000',
+        servicos: [
           {
-            :codigo => '40096',
-            :descricao => 'SEDEX - CONTRATO',
-            :id => '104625'
+            codigo: '40096',
+            descricao: 'SEDEX - CONTRATO',
+            id: '104625'
           },
           ...
         ]
@@ -84,6 +89,7 @@ The method will return something like this
 ```
 
 #### Zip Query
+
 This method return the address based on zip code
 
 ``` ruby
@@ -94,22 +100,107 @@ 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'
+  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)
+SigepWeb.request_labels(receiver_type: 'C', identifier: '00000000000000',
+                        id_service: '104625', qt_labels: 1)
+```
+
+return:
+
+```ruby
+{ success: true, response: ['DL61145929 BR'] }
+```
+
+#### Request verifying digit
+
+to generate the verifying digit for a specific label use:
+
+```ruby
+SigepWeb.generate_labels_digit_verifier(labels: 'DL61145929 BR')
+```
+
+return:
+
+```ruby
+{ success: true, response: 6 }
+```
+
+#### Create receiver structure
+
+use the _SigepWeb::Models::Receiver_ to create receiver structure:
+
+```ruby
+SigepWeb::Models::Receiver.new(name: 'Josefina', email: 'josefina@foo.com',
+                               number: '10', address: 'Rua X',
+                               complement: 'Perto da rua X+1',
+                               neighborhood: 'Bairro X-1',
+                               city: 'Cidade Y', uf: 'SP', amount: '0,0',
+                               cep: '04105-070')
+```
+#### Create post object dimensions
+
+use the _SigepWeb::Models::DimensionObject_ to create object dimensions:
+
+```ruby
+SigepWeb::Models::DimensionObject.new(object_type: '002', height: '20',
+                                      width: '30', length: '38',
+                                      diameter: '0')
+```
+
+*   object_type: use 001 to letter envelope, 002 to package/ box and 003 to roll/ cylinder
+
+#### Create post object
+
+use the _SigepWeb::Models::PostalObject_ to create post object:
+
+```ruby
+SigepWeb::Models::PostalObject.new(label_number: 'DL611459296BR',
+                                   postage_code_service: '40096',
+                                   cubage: 0.0, weight: '400',
+                                   receiver: receiver,
+                                   dimension_object: dimension_object,
+                                   processing_status: '0')
+```
+
+*   label_number: tracking code with verifying digit
+*   postage_code: service code to use (SEDEX, PAC, etc.), for this example was used SEDEX, to get all available codes use _SigepWeb.search_client_
+*   receiver: object instance of _SigepWeb::Models::Receiver_ class
+*   dimension_object: object instance of _SigepWeb::Models::DimensionObject_ class
+*   processing_status: default value is '0'
+
+#### Create sender
+
+```ruby
+SigepWeb::Models::Sender.new(directorship_number: '16', name: 'Loja X',
+                             address: 'Rua X', number: '10',
+                             complement: 'perto da rua X+1',
+                             neighborhood: 'Bairro Y',
+                             zip_code: '7400000', city: 'Goiânia',
+                             uf: 'GO', email: 'contato@loja_x.com.br',
+                             postal_objects: postal_objects)
+```
+
+#### Submit the plp
+
+```ruby
+SigepWeb.request_plp_services(plp: sender, id_plp_client: 00_000_000,
+                              labels: labels)
 ```

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-#RSpec::Core::RakeTask.new(:spec)
+# RSpec::Core::RakeTask.new(:spec)
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/lib/sigep_web/calculate_digit_checker.rb

@@ -1,31 +1,35 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class CalculateDigitChecker < WebServiceReverseLogisticApi
-    def initialize(options = {})
-      @number = options[:number]
+    def initialize(number:)
+      @number = 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]
+      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
-        }
+      if response[:cod_erro] == "0"
+        {success: true, response: response}
+      else
+        {success: false, error: response}
       end
+    rescue Savon::SOAPFault => exception
+      {success: false, error: exception.message}
     end
+
+    private
+
+    attr_reader :number
   end
 end

data/lib/sigep_web/configuration.rb

@@ -5,9 +5,11 @@ module SigepWeb
 
     def authenticate
       @authenticate ||=
-        Authenticate.new(user: user, password: password,
-                         administrative_code: administrative_code,
-                         contract: contract, card: card)
+        Authenticate.new(
+          user: user, password: password,
+          administrative_code: administrative_code,
+          contract: contract, card: card
+        )
     end
   end
 end

data/lib/sigep_web/generate_labels_digit_verifier.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class GenerateLabelsDigitVerifier < WebServiceInterfaceApi
-    def initialize(options = {})
-      @labels = options[:labels]
+    def initialize(labels:)
+      @labels = labels
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
-      begin
-        response = process(:gera_digito_verificador_etiquetas, {
-          etiquetas: @labels,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:gera_digito_verificador_etiquetas_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      response = process(
+        :gera_digito_verificador_etiquetas,
+        etiquetas: labels,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:gera_digito_verificador_etiquetas_response][:return]
+
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :labels
   end
 end

data/lib/sigep_web/models/additional_service.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module Models
+    class AdditionalService
+      attr_accessor :codes, :declareted_value
+
+      def initialize(codes:, declareted_value:)
+        @codes = codes
+        @declareted_value = declareted_value
+      end
+    end
+  end
+end

data/lib/sigep_web/models/dimension_object.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module Models
+    class DimensionObject
+      attr_accessor :object_type, :height, :width, :length, :diameter
+
+      def initialize(object_type:, height:, width:, length:, diameter:)
+        @object_type = object_type
+        @height = height
+        @width = width
+        @length = length
+        @diameter = diameter
+      end
+    end
+  end
+end

data/lib/sigep_web/models/postal_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module Models
+    class PostalObject
+      attr_accessor :label_number, :postage_code_service, :cubage,
+        :weight, :receiver, :dimension_object, :processing_status,
+        :additional_service_codes, :additional_services_declared_value
+
+      def initialize(label_number:, postage_code_service:, cubage:, weight:,
+        receiver:, dimension_object:, processing_status:,
+        additional_service_codes: nil, additional_services_declared_value: nil)
+
+        @label_number = label_number
+        @postage_code_service = postage_code_service
+        @cubage = cubage
+        @weight = weight
+        @receiver = receiver
+        @dimension_object = dimension_object
+        @processing_status = processing_status
+        @additional_service_codes = additional_service_codes
+        @additional_services_declared_value = additional_services_declared_value
+      end
+    end
+  end
+end

data/lib/sigep_web/models/receiver.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module Models
+    class Receiver
+      attr_accessor :name, :phone, :cellphone, :email, :address,
+        :complement, :neighborhood, :city, :uf, :cep, :number,
+        :user_postal_code, :cost_center_client, :invoice_number,
+        :invoice_serie, :invoice_value, :invoice_nature,
+        :description_object, :amount
+
+      def initialize(options = {})
+        @name = options[:name]
+        @phone = options[:phone]
+        @cellphone = options[:cellphone]
+        @email = options[:email]
+        @address = options[:address]
+        @complement = options[:complement]
+        @number = options[:number]
+        @neighborhood = options[:neighborhood]
+        @city = options[:city]
+        @uf = options[:uf]
+        @cep = options[:cep]
+        @user_postal_code = options[:user_postal_code]
+        @cost_center_client = options[:cost_center_client]
+        @invoice_number = options[:invoice_number]
+        @invoice_serie = options[:invoice_serie]
+        @invoice_value = options[:invoice_value]
+        @invoice_nature = options[:invoice_nature]
+        @description_object = options[:description_object]
+        @amount = options[:amount]
+      end
+    end
+  end
+end

data/lib/sigep_web/{Models → models}/sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SigepWeb
   module Models
     class Sender
@@ -24,10 +26,10 @@ module SigepWeb
       end
 
       def to_xml
-        builder = Nokogiri::XML::Builder.new(encoding: 'ISO-8859-1') do |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.tipo_arquivo "Postagem"
+            xml.versao_arquivo "2.3"
             plp_xml(xml)
             receiver_xml(xml)
             xml.forma_pagamento @payment_form

data/lib/sigep_web/postage_card_status.rb

@@ -1,29 +1,26 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class PostageCardStatus < WebServiceInterfaceApi
-    def initialize(options = {})
-      @postage_number_card = options[:postage_number_card]
+    def initialize(postage_number_card:)
+      @postage_number_card = postage_number_card
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
-      begin
-        response = process(:get_status_cartao_postagem, {
-          numeroCartaoPostagem: @postage_number_card,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:get_status_cartao_postagem_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      response = process(
+        :get_status_cartao_postagem,
+        numeroCartaoPostagem: @postage_number_card,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:get_status_cartao_postagem_response][:return]
+
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
   end
 end