No release in over 3 years
Low commit activity in last 3 years
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 12.3.3
~> 3.9

Runtime

 Project Readme

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

GitHub license GitHub version GitHub top language GitHub code size in bytes

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.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:

Installation

Add this line to your application's Gemfile:

gem 'correios_toolkit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install correios_toolkit

Usage

Basic usage:

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

License

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

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.