Merge pull request #40 from guibranco/feature/updates

Feature/updates
guibranco · Jan 14, 2023 · f90f878 · f90f878
2 parents 460b0fb + 76af46d
commit f90f878
Show file tree

Hide file tree

Showing 18 changed files with 561 additions and 317 deletions.
diff --git a/.github/workflows/autoMerge.yml b/.github/workflows/autoMerge.yml
diff --git a/README.md b/README.md
@@ -9,10 +9,9 @@ A .NET client wrapper for both .NET Core & .NET Framework projects of [Via CEP A
 
 ## CI/CD
 
-| Branch | Build status | Last commit | Tests |
-|--------|--------------|-------------|-------|
-| Master | [![Build status](https://ci.appveyor.com/api/projects/status/9jnsy1e08jhyxl7j/branch/master?svg=true)](https://ci.appveyor.com/project/guibranco/ViaCEP) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/ViaCEP/master)](https://github.com/guibranco/ViaCEP) | ![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/ViaCEP/master?compact_message) |
-| Develop | [![Build status](https://ci.appveyor.com/api/projects/status/9jnsy1e08jhyxl7j/branch/develop?svg=true)](https://ci.appveyor.com/project/guibranco/ViaCEP/branch/develop) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/ViaCEP/develop)](https://github.com/guibranco/ViaCEP) | ![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/ViaCEP/develop?compact_message) |
+| Build status | Last commit | Tests |
+|--------------|-------------|-------|
+| [![Build status](https://ci.appveyor.com/api/projects/status/9jnsy1e08jhyxl7j/branch/master?svg=true)](https://ci.appveyor.com/project/guibranco/ViaCEP) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/ViaCEP/master)](https://github.com/guibranco/ViaCEP) | ![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/ViaCEP/master?compact_message) |
 
 ## Code Quality
 

diff --git a/Src/ViaCEP/IViaCepClient.cs b/Src/ViaCEP/IViaCepClient.cs
@@ -1,9 +1,9 @@
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
-
-namespace ViaCep
+namespace ViaCep
 {
+    using System.Collections.Generic;
+    using System.Threading;
+    using System.Threading.Tasks;
+
     /// <summary>
     /// The ViaCEP client interface.
     /// </summary>
@@ -17,7 +17,7 @@ public interface IViaCepClient
         ViaCepResult Search(string zipCode);
 
         /// <summary>
-        /// Searches the specified state initials.
+        /// Searches the specified address by state initials (UF), city and address name.
         /// </summary>
         /// <param name="stateInitials">The state initials.</param>
         /// <param name="city">The city.</param>
@@ -26,15 +26,15 @@ public interface IViaCepClient
         IEnumerable<ViaCepResult> Search(string stateInitials, string city, string address);
 
         /// <summary>
-        /// Searches the asynchronous.
+        /// Searches the specified zip code asynchronous.
         /// </summary>
         /// <param name="zipCode">The zip code.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns></returns>
         Task<ViaCepResult> SearchAsync(string zipCode, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Searches the asynchronous.
+        /// Searches the specified address by state initials (UF), city and address name asynchronous.
         /// </summary>
         /// <param name="stateInitials">The state initials.</param>
         /// <param name="city">The city.</param>

diff --git a/Src/ViaCep/IViaCepClient.cs b/Src/ViaCep/IViaCepClient.cs
@@ -0,0 +1,46 @@
+namespace ViaCep
+{
+    using System.Collections.Generic;
+    using System.Threading;
+    using System.Threading.Tasks;
+
+    /// <summary>
+    /// The ViaCEP client interface.
+    /// </summary>
+    public interface IViaCepClient
+    {
+        /// <summary>
+        /// Searches the specified zip code.
+        /// </summary>
+        /// <param name="zipCode">The zip code.</param>
+        /// <returns></returns>
+        ViaCepResult Search(string zipCode);
+
+        /// <summary>
+        /// Searches the specified address by state initials (UF), city and address name.
+        /// </summary>
+        /// <param name="stateInitials">The state initials.</param>
+        /// <param name="city">The city.</param>
+        /// <param name="address">The address.</param>
+        /// <returns></returns>
+        IEnumerable<ViaCepResult> Search(string stateInitials, string city, string address);
+
+        /// <summary>
+        /// Searches the specified zip code asynchronous.
+        /// </summary>
+        /// <param name="zipCode">The zip code.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns></returns>
+        Task<ViaCepResult> SearchAsync(string zipCode, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Searches the specified address by state initials (UF), city and address name asynchronous.
+        /// </summary>
+        /// <param name="stateInitials">The state initials.</param>
+        /// <param name="city">The city.</param>
+        /// <param name="address">The address.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns></returns>
+        Task<IEnumerable<ViaCepResult>> SearchAsync(string stateInitials, string city, string address, CancellationToken cancellationToken);
+    }
+}
diff --git a/Src/ViaCep/VIaCEPResult.cs b/Src/ViaCep/VIaCEPResult.cs
diff --git a/Src/ViaCEP/VIaCEPResult.cs → Src/ViaCep/VIaCepResult.cs b/Src/ViaCEP/VIaCEPResult.cs → Src/ViaCep/VIaCepResult.cs
diff --git a/Src/ViaCEP/ViaCEP.csproj → Src/ViaCep/ViaCep.csproj b/Src/ViaCEP/ViaCEP.csproj → Src/ViaCep/ViaCep.csproj
@@ -1,30 +1,30 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>
-    <ProjectGuid>A251D320-410E-48F1-889D-9F59EB8CFEB9</ProjectGuid>
-    <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
-    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Authors>Guilherme Branco Stracini</Authors>
-    <Copyright>© 2020 Guilherme Branco Stracini. All rights reserved.</Copyright>
-    <Description>The ViaCEP WebService client for .NET projects (both .NET Core and .NET Framework)</Description>
-    <PackageProjectUrl>https://guibranco.github.io/ViaCEP/</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/guibranco/ViaCEP/</RepositoryUrl>
-    <RepositoryType>GIT</RepositoryType>
-    <PackageTags>cep zipcode postalcode postal zip address location api webservice brasil brazil correios ibge gia mf fazenda</PackageTags>
-    <PackageIconUrl>https://raw.githubusercontent.com/guibranco/ViaCEP/master/logo.png?v=1</PackageIconUrl>
-    <PackageIcon>logo.png</PackageIcon>
-    <Version>1.0.0</Version>
-    <AssemblyVersion>1.0.0.0</AssemblyVersion>
-    <PackageLicenseFile>LICENSE</PackageLicenseFile>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <PackageReference Include="Microsoft.AspNet.WebApi.Client" Version="5.2.9" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <None Include="../../LICENSE" Pack="true" PackagePath="\" />
-    <None Include="../../logo.png" Pack="true" PackagePath="\" />
-  </ItemGroup>
-</Project>
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <ProjectGuid>A251D320-410E-48F1-889D-9F59EB8CFEB9</ProjectGuid>
+    <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <Authors>Guilherme Branco Stracini</Authors>
+    <Copyright>© 2020 Guilherme Branco Stracini. All rights reserved.</Copyright>
+    <Description>The ViaCep API/WebService client for .NET projects (both .NET Core and .NET Framework)</Description>
+    <PackageProjectUrl>https://guibranco.github.io/ViaCEP/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/guibranco/ViaCEP/</RepositoryUrl>
+    <RepositoryType>GIT</RepositoryType>
+    <PackageTags>cep zipcode postalcode postal zip address location api webservice brasil brazil correios ibge gia mf fazenda</PackageTags>
+    <PackageIconUrl>https://raw.githubusercontent.com/guibranco/ViaCEP/master/logo.png?v=1</PackageIconUrl>
+    <PackageIcon>logo.png</PackageIcon>
+    <Version>1.0.0</Version>
+    <AssemblyVersion>1.0.0.0</AssemblyVersion>
+    <PackageLicenseFile>LICENSE</PackageLicenseFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNet.WebApi.Client" Version="5.2.9" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="../../LICENSE" Pack="true" PackagePath="\" />
+    <None Include="../../logo.png" Pack="true" PackagePath="\" />
+  </ItemGroup>
+</Project>