Ruby library for an easy integration with the Correios (brazilian post office service) SOAP web service.

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.

Ruby 2.3 and newer are supported. Alternative interpreters compatible with 2.3+ should work as well.

Earlier Ruby versions such as 1.8.7, 1.9.2, 1.9.3 and 2.0 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
• rest-client

Add this line to your application's Gemfile:

gem 'correios_toolkit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install correios_toolkit

Basic usage:

require 'correios_toolkit'

CorreiosToolkit.consulta_cep('01310000')

On the following list are the services already available on this gem:

• ConsultaCEP
  • Get address' information by zip code
• Others are coming soon...

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 code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the CorreiosToolkit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.