correios_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48cb312a91a8bba19fae4653d1bb6b6476ff3a7d5c4ab66664511e967ba377b9
+  data.tar.gz: 69f73b4dc4c685689ef26b49a3d968faaeac18381c0b64cae59cdf872b45cc0b
+SHA512:
+  metadata.gz: 6fa43e15edce41f9250a634f3434767da8c663d4e88df75f2f22a0bee11ef9abc4333d7bfb25f8748ae5e031105d22d84958a02ad2639bfafb630dd2788cd127
+  data.tar.gz: 35969cf786c7065cde5d99a2b86e3d8945bee14300670e50d619f5fb7ab1f5c5690f2ca0daead2397f7142c654b27bc8f3494cf2aaa3decfc4e62495268ad88a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at diligasi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,66 @@
+# Ruby library for an easy integration with the Correios (brazilian post office service) SOAP web service.
+
+![GitHub license](https://img.shields.io/github/license/diligasi/correios_toolkit)
+[![GitHub version](https://badge.fury.io/gh/diligasi%2Fcorreios_toolkit.svg)](https://badge.fury.io/gh/diligasi%2Fcorreios_toolkit)
+![GitHub top language](https://img.shields.io/github/languages/top/diligasi/correios_toolkit)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/diligasi/correios_toolkit)
+
+The _Correios do Brasil_ (brazilian post office service) makes available, free of charge, to customers
+with or without a contract, a set of services accessible via a SOAP Web service that enable the
+integration from customer's systems with the Correios' technological environment. Therefore, this gem
+aims to create an abstraction layer that facilitates the communication and consumption of the services
+provided from ruby applications.
+
+## Requirements
+Ruby 2.0 and newer are supported. Alternative interpreters compatible with 2.0+ should work as well.
+
+Earlier Ruby versions such as 1.8.7, 1.9.2, and 1.9.3 were not tested, don't have any official support,
+and will not receive features and/or security updates.
+
+The _correios_toolkit_ gem depends on these other gems for usage at runtime:
+
+* [activesupport](https://rubygems.org/gems/activesupport)
+* [rest-client](https://rubygems.org/gems/rest-client)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'correios_toolkit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install correios_toolkit
+
+## Usage
+Basic usage:
+
+```ruby
+require 'correios_toolkit'
+
+CorreiosToolkit.consulta_cep('01310000')
+```
+
+## Current available services
+On the following list are the services already available on this gem:
+
+* _ConsultaCEP_
+  * Get address' information by zip code
+* Others are coming soon...
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/diligasi/correios_toolkit. This
+project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+Everyone interacting in the CorreiosToolkit project's codebases, issue trackers, chat rooms and mailing
+lists is expected to follow the [code of conduct](https://github.com/diligasi/correios_toolkit/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "correios_toolkit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/correios_toolkit.rb

@@ -0,0 +1,43 @@
+require 'correios_toolkit/version'
+require 'correios_toolkit/base'
+require 'correios_toolkit/consulta_cep'
+
+##
+# This module's static methods are the entry point for using CorreiosToolkit.
+module CorreiosToolkit
+
+  # Get address' information by zip code
+  #
+  # Example:
+  #   # Valid zip code (without dots, hyphens and the like)
+  #   >> CorreiosToolkit.consulta_cep('01310000')
+  #   => { "bairro"=>"Bela Vista", "cep"=>"01310000", "cidade"=>"São Paulo", "complemento2"=>"- até 610 - lado par", "end"=>"Avenida Paulista", "uf"=>"SP" }
+  #
+  #   # Valid zip code (with dots, hyphens and the like)
+  #   >> CorreiosToolkit.consulta_cep('01310-000')
+  #   => { "bairro"=>"Bela Vista", "cep"=>"01310000", "cidade"=>"São Paulo", "complemento2"=>"- até 610 - lado par", "end"=>"Avenida Paulista", "uf"=>"SP" }
+  #
+  #   # Invalid zip code (less/more than 8 numbers)
+  #   >> CorreiosToolkit.consulta_cep('01310000000')
+  #   => CorreiosToolkit::Base::LengthError (Wrong CEP format, expected CEP to have 8 numbers but 11 was found.)
+  #
+  #   # Invalid zip code (nonexistent zip code - zip code not found)
+  #   >> CorreiosToolkit.consulta_cep('01310005')
+  #   => CorreiosToolkit::Base::GatewayError (CEP NAO ENCONTRADO)
+  #
+  # Param:
+  #  <tt>:cep</tt> [String] - The zip code to verify, it must have 8 number
+  #
+  # Return:
+  #   # Hash object with indifferent access attributes
+  #   # => Hash attributes:
+  #   # <tt>:bairro</tt>       - The neighborhood name
+  #   # <tt>:cep</tt>          - The requested zip code
+  #   # <tt>:cidade</tt>       - The city name
+  #   # <tt>:complemento2</tt> - The complement when available
+  #   # <tt>:end</tt>          - The street name
+  #   # <tt>:uf</tt>           - The state abbreviation
+  def self.consulta_cep(cep)
+    CorreiosToolkit::ConsultaCep.request_data_for(cep: cep)
+  end
+end

data/lib/correios_toolkit/base.rb

@@ -0,0 +1,49 @@
+require 'rest-client'
+require 'active_support/core_ext'
+
+##
+# This class concentrate the basic information to retrieve data from the web
+# service. This class is intended to be inherited by all other classes.
+module CorreiosToolkit
+  class Base
+    class GatewayError < StandardError; end
+    class LengthError < StandardError; end
+
+    SOAP_URL = 'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'.freeze
+    CORREIOS_DEFAULT_ENCODE = 'ISO-8859-1'.freeze
+
+    protected
+
+    def request(payload:, response_node:)
+      response = RestClient.post(SOAP_URL, payload, content_type: 'application/xml')
+
+      if response.code.between?(200, 299)
+        json_parse(response.body, response_node)
+      else
+        raise(RestClient::ExceptionWithResponse, response)
+      end
+    rescue RestClient::ExceptionWithResponse => e
+      raise(GatewayError, json_parse(e.response.body))
+    end
+
+    private
+
+    def json_parse(xml, node = nil)
+      xml.encode!('UTF-8', CORREIOS_DEFAULT_ENCODE)
+
+      if node.present?
+        success_parser(xml, node)
+      else
+        error_parser(xml)
+      end
+    end
+
+    def success_parser(xml, node)
+      Hash.from_xml(xml).dig('Envelope', 'Body', "#{node}Response", 'return').with_indifferent_access
+    end
+
+    def error_parser(xml)
+      Hash.from_xml(xml).dig('Envelope', 'Body', 'Fault', 'faultstring')
+    end
+  end
+end

data/lib/correios_toolkit/consulta_cep.rb

@@ -0,0 +1,41 @@
+# <b>This class is intended to get the full address information for a given zip
+# code.</b> In order to do that, this class receives the zip code value with its
+# 8 digits, normalizes it by removing dots, hyphens and the like, then, requests
+# the information about it from the brazilian post office (Correios) and returns
+# a hash with the corresponding information.
+module CorreiosToolkit
+  class ConsultaCep < CorreiosToolkit::Base
+
+    def self.request_data_for(cep:)
+      consulta_cep = new(cep: cep)
+      consulta_cep.data
+    end
+
+    def initialize(cep:)
+      cep = cep.scan(/[0-9]/).join
+
+      raise(LengthError, "Wrong CEP format, expected CEP to have 8 numbers but #{cep.size} was found.") if cep.size != 8
+
+      @cep = cep
+    end
+
+    def data
+      request(payload: payload, response_node: 'consultaCEP')
+    end
+
+    private
+
+    def payload
+      <<-EOXML
+        <x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
+          <x:Header/>
+          <x:Body>
+            <cli:consultaCEP>
+              <cep>#{@cep}</cep>
+            </cli:consultaCEP>
+          </x:Body>
+        </x:Envelope>
+      EOXML
+    end
+  end
+end

data/lib/correios_toolkit/version.rb

@@ -0,0 +1,3 @@
+module CorreiosToolkit
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: correios_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diogo de Lima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: |2
+      The Correios do Brasil (brazilian post office service) makes available, free of charge, to
+      customers with or without a contract, a set of services accessible via a SOAP Web service
+      that enable the integration from customer's systems with the Correios' technological
+      environment.
+      Therefore, this gem aims to create an abstraction layer that facilitates the communication
+      and consumption of the services provided from ruby applications.
+email:
+- diligasi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/console
+- bin/setup
+- lib/correios_toolkit.rb
+- lib/correios_toolkit/base.rb
+- lib/correios_toolkit/consulta_cep.rb
+- lib/correios_toolkit/version.rb
+homepage: https://rubygems.org/gems/correios_toolkit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/correios_toolkit
+  source_code_uri: https://github.com/diligasi/correios_toolkit
+  changelog_uri: https://github.com/diligasi/correios_toolkit/releases
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby library for an easy integration with the Correios (brazilian post office
+  service) SOAP web service.
+test_files: []