brazil-cep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebcf36ea20edd02418b626e0741972620cea2b3a4af54dbaffb0413c4af1bb1e
+  data.tar.gz: 4fa2527e8007a0f0d7dc5a13a72f54a54508be5aab0887dfb21582b7c395ccdf
+SHA512:
+  metadata.gz: 3aa434fd7b4ab0149bf7a70167c2302b3eb78782d5df6077e18763b3f24e5eb5d70e151384cced2b46d1676d54f90a4a14b2ba710ef4f537842675df8ad9ea52
+  data.tar.gz: 2048b051f9853cc1fce960257e49c13d30f11a20d10414c914ce0f4d068fe96e9ea240e72c3eec76597097d2873e5c0a8f84b84301c5e90199a9d106b83f445b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at daniel.vinciguerra@bivee.com.br. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Daniel Vinciguerra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Brazil::Cep
+
+This gem provides a simple way to validate and format Brazilian postal codes (CEP).
+
+## Installation
+
+`$ gem install brazil-cep`
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'brazil-cep'
+```
+
+## Usage
+
+### Fetching address by CEP using default provider
+
+```ruby
+address = Brazil::Cep.fetch('01311-200')
+address.street # => "Avenida Paulista"
+address.neighborhood # => "Bela Vista"
+```
+
+### Fetching address by CEP using custom provider
+
+```ruby
+address = Brazil::Cep.fetch('01311-200', provider: :postmon)
+address.street # => "Avenida Paulista"
+address.neighborhood # => "Bela Vista"
+```
+
+### Creating a custom provider adapter
+
+```ruby
+module Brazil
+  module Cep
+    module Adapters
+      class MyProvider < Base
+        provider base_url: 'https://api.myprovider.com/address/{{cep}}'
+
+        private
+
+        def transformation!
+          address_params = {
+            street: response[:street],
+            neighborhood: response[:neighborhood],
+            ...
+          }
+          
+          Brazil::Cep::Address.new(**address_params)
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvinciguerra/brazil-cep. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dvinciguerra/brazil-cep/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Brazil::Cep project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dvinciguerra/brazil-cep/blob/master/CODE_OF_CONDUCT.md).
+```
+
+## License
+
+Created by Daniel Vinciguerra and available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/brazil-cep.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "brazil_cep"

data/lib/brazil_cep/adapters/base.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+
+module Brazil
+  module Cep
+    module Adapters
+      # Base adapter class
+      # @abstract
+      class Base
+        def self.provider(**params)
+          @__provider = params
+        end
+
+        # class constructor method
+        # @param [String] cep the CEP to fetch (optional)
+        def initialize(cep = nil)
+          @cep = cep
+          @__provider = self.class.instance_variable_get(:@__provider) || {}
+
+          @open_timeout = ENV.fetch("BRAZIL_CEP_OPEN_TIMEOUT", 3).to_i
+          @read_timeout = ENV.fetch("BRAZIL_CEP_READ_TIMEOUT", 3).to_i
+          @write_timeout = ENV.fetch("BRAZIL_CEP_WRITE_TIMEOUT", 3).to_i
+        end
+
+        # fetch address information from a Brazilian CEP
+        # @param [String] value the CEP to fetch
+        # @return [Hash] the address information
+        def fetch(value = nil)
+          @cep = value unless value.nil?
+
+          http_request(provider_url) do |http_response|
+            raise Brazil::Cep::RequestError, http_response unless http_response.is_a?(Net::HTTPSuccess)
+          end
+
+          deserialization!
+          transformation!
+        end
+
+        alias get fetch
+
+        private
+
+        attr_reader :cep, :response, :payload, :open_timeout, :read_timeout, :write_timeout
+
+        def http_request(uri, **options, &block)
+          http_options =
+            { open_timeout: open_timeout, read_timeout: read_timeout, write_timeout: write_timeout }
+            .update(**options)
+
+          http_options[:use_ssl] = uri.scheme == "https"
+
+          Net::HTTP.start(uri.host, uri.port, **http_options) do |http|
+            request = Net::HTTP::Get.new(uri)
+            @response = http.request(request)
+
+            block.call(@response)
+          end
+        end
+
+        # returns the provider URL from provider base_url attribute
+        # @return [URI] the provider URL
+        def provider_url
+          raise ArgumentError unless @__provider.key?(:base_url)
+
+          URI.parse(@__provider[:base_url].gsub("{{cep}}", cep))
+        end
+
+        # deserialization method
+        # @return [Hash] the deserialized payload
+        def deserialization!
+          @payload = JSON.parse(response.body, symbolize_names: true)
+        end
+
+        # transformation method
+        # @return [Hash] the transformed payload
+        def transformation!
+          @payload
+        end
+      end
+    end
+  end
+end

data/lib/brazil_cep/adapters/postmon.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    module Adapters
+      # Postmon provider adapter class
+      # This class is responsible for fetching the address information from the Postmon provider
+      class Postmon < Base
+        provider base_url: "https://api.postmon.com.br/v1/cep/{{cep}}"
+
+        private
+
+        def transformation!
+          address_params = {
+            cep: @payload[:cep],
+            state: @payload[:estado],
+            city: @payload[:cidade],
+            neighborhood: @payload[:bairro],
+            street: @payload[:logradouro],
+            complement: @payload[:complemento],
+            meta: @payload.update(provider: :postmon)
+          }
+
+          Brazil::Cep::Address.new(**address_params)
+        end
+      end
+    end
+  end
+end

data/lib/brazil_cep/adapters/republica_virtual.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    module Adapters
+      # Republica Virtual provider adapter class
+      # This class is responsible for fetching the address information from the Republica Virtual provider
+      class RepublicaVirtual < Base
+        provider base_url: "http://cep.republicavirtual.com.br/web_cep.php?cep={{cep}}&formato=json"
+
+        private
+
+        def transformation!
+          address_params = {
+            cep: @cep,
+            state: @payload[:uf],
+            city: @payload[:cidade],
+            neighborhood: @payload[:bairro],
+            street: "#{@payload[:tipo_logradouro]} #{@payload[:logradouro]}",
+            complement: @payload[:complemento],
+            meta: @payload.update(provider: :republica_virtual)
+          }
+
+          Brazil::Cep::Address.new(**address_params)
+        end
+      end
+    end
+  end
+end

data/lib/brazil_cep/adapters/viacep.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    module Adapters
+      # Viacep provider adapter class
+      # This class is responsible for fetching the address information from the Viacep provider
+      class Viacep < Base
+        provider base_url: "https://viacep.com.br/ws/{{cep}}/json/"
+
+        private
+
+        def transformation!
+          address_params = {
+            cep: @payload[:cep],
+            state: @payload[:uf],
+            city: @payload[:localidade],
+            neighborhood: @payload[:bairro],
+            street: @payload[:logradouro],
+            complement: @payload[:complemento],
+            meta: @payload.update(provider: :postmon)
+          }
+
+          Brazil::Cep::Address.new(**address_params)
+        end
+      end
+    end
+  end
+end

data/lib/brazil_cep/adapters.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    # Adapters class namespace
+    module Adapters
+      autoload :Base, "brazil_cep/adapters/base"
+      autoload :Viacep, "brazil_cep/adapters/viacep"
+      autoload :Postmon, "brazil_cep/adapters/postmon"
+      autoload :RepublicaVirtual, "brazil_cep/adapters/republica_virtual"
+
+      # list of provider keys and classes
+      PROVIDERS = {
+        viacep: Viacep,
+        postmon: Postmon,
+        republica_virtual: RepublicaVirtual
+      }.freeze
+
+      def self.get(provider = :viacep)
+        PROVIDERS[provider].new
+      end
+    end
+  end
+end

data/lib/brazil_cep/address.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    # Address class
+    class Address
+      attr_reader :cep, :state, :city, :neighborhood, :street, :complement, :meta
+
+      def initialize(**arguments)
+        @cep = arguments[:cep]
+        @state = arguments[:state]
+        @city = arguments[:city]
+        @neighborhood = arguments[:neighborhood]
+        @street = arguments[:street]
+        @complement = arguments[:complement]
+        @meta = arguments[:meta]
+      end
+
+      def provider
+        meta[:provider]
+      end
+    end
+  end
+end

data/lib/brazil_cep/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Brazil
+  module Cep
+    VERSION = "0.1.0"
+  end
+end

data/lib/brazil_cep.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "brazil_cep/version"
+require_relative "brazil_cep/address"
+require_relative "brazil_cep/adapters"
+
+module Brazil
+  # Brazil::Cep providers a simple way to fetch address information from a Brazilian CEP
+  # @public
+  module Cep
+    class Error < StandardError; end
+    class RequestError < Error; end
+
+    # fetch address information from a Brazilian CEP
+    # @param [String] cep the CEP to fetch
+    # @return [Hash] the address information
+    def self.fetch(cep, provider: :viacep)
+      provider = Adapters.get(provider)
+      provider.get(cep)
+    end
+  end
+end

data/sig/brazil/cep.rbs

@@ -0,0 +1,6 @@
+module Brazil
+  module Cep
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: brazil-cep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Vinciguerra
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies: []
+description: Brazil::CEP is a gem to provide interface to use common CEP services
+email:
+- daniel.vinciguerra@bivee.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/brazil-cep.rb
+- lib/brazil_cep.rb
+- lib/brazil_cep/adapters.rb
+- lib/brazil_cep/adapters/base.rb
+- lib/brazil_cep/adapters/postmon.rb
+- lib/brazil_cep/adapters/republica_virtual.rb
+- lib/brazil_cep/adapters/viacep.rb
+- lib/brazil_cep/address.rb
+- lib/brazil_cep/version.rb
+- sig/brazil/cep.rbs
+homepage: https://github.com/dvinciguerra/brazil-cep
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvinciguerra/brazil-cep
+  source_code_uri: https://github.com/dvinciguerra/brazil-cep
+  changelog_uri: https://github.com/dvinciguerra/brazil-cep
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Brazil::CEP is a gem to provide interface to use common CEP services
+test_files: []