CoreZipCode 1.0.5

Overview

This package is supposed to be used for easily implements address services to yours Microsoft .Net Core based software.

Also the CoreZipCode are designed to be easily extensible, and if you want, implement your own address services.

Get Started

Well, you can download the code and build it by yourself or you can install by Nuget package in: CoreZipCode Package.

Just in case if you doesn't want leave GitHub:

$ dotnet add package CoreZipCode

After you decide how you'll get the CoreZipCode, just inject and use it.

using CoreZipCode.Interfaces;
using CoreZipCode.Services;

namespace YouProject
{
    public YourClass
    {   
        private readonly ZipCodeBaseService _coreZipCode;

        public YourClass(ZipCodeBaseService coreZipCode)
        {
            _coreZipCode = coreZipCode;
        }

        public void YourMethod() 
        {
            var addressByZipCode = _coreZipCode.Execute("14810100");
            var zipCodeByAddress = _coreZipCode.Execute("sp", "araraquara", "barão do rio");
        }
    }
}

NOTE: We have only brazilian address service working out-of-the-box in this moment. We intent add the USA service ad others coming soon.

Extending CoreZipCode

Also you can extends ZipCodeBaseService abstract class and create your own implementation of your preferred address service. Like below:

using CoreZipCode.Interfaces;

namespace CoreZipCode.Services
{
    public class ViaCep : ZipCodeBaseService
    {
        public override string SetZipCodeUrl(string zipcode)
        {
            zipcode = zipcode.Replace("-", "");
            return $"https://viacep.com.br/ws/{zipcode}/json/";    
        }

        public override string SetZipCodeUrlBy(string state, string city, string street) => $"https://viacep.com.br/ws/{state}/{city}/{street}/json/";
    }
}

Contributing

Thank you for considering contributing to the CodeZipCore! Just see our Contributing Guide.

Code of Conduct

In order to ensure that the CodeZipCore community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover any security vulnerability within CoreZipCode, please create a vulnerability issue. All security vulnerabilities will be promptly addressed.

License

The CoreZipCode is open-sourced software licensed under the MIT license.