via_cep 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6acf1f1df8168ec0213dba8cb0f8bc4a1604db9268b29fa30593a9d7323c1eb1
-  data.tar.gz: 9c16eaef9491ad33989a63c49d9c4faaac68b07e572b72a215c676474c96d633
+  metadata.gz: a5b87542eabffdf88cf0c29abc14f443096126c90ebbe62cca399977cd32ddf6
+  data.tar.gz: 5aab5e128777294d118d7b79547f2b220b11551f74bf39eddb8e6367758ccf91
 SHA512:
-  metadata.gz: ef87668c195c9c3f288909972af1964c037b77985d76d55d8d3b1f50191bf6cddd762401a66e73778f64d6bc9a1c68e699b330e56da0608b578aa13a5eaed524
-  data.tar.gz: 35ac112a7acc2337c70e5184b15f18961d9e03169aca0e54a4332a243e6f47a853277a16d48357b43f017d9aea8a2d07eab6dbf569329a2a33b3c17a2d9a2f28
+  metadata.gz: 165e86cfe16bbdcbeeac1f279969fe347aaa5b5988cf28f1b049a7bdc50102e1998822ccf7f14dd01446a9fb9c70385e75527bb26b601e21af2a658f2be39f42
+  data.tar.gz: cb3130b542ef1b02b5f1345f1205c4c30c587d14d674b1e8043b015e49c314d5a77580293c5052381e43a6daf49239bc0d978f4bd1d75d3aa700b1d09a31e587

data/.codeclimate.yml

@@ -1,7 +1,10 @@
-engines:
+version: "2"
+plugins:
   rubocop:
     enabled: true
-ratings:
-  paths:
-  - Gemfile.lock
-  - "**.rb"
+    channel: rubocop-0-60
+    config:
+      file: ".rubocop.yml"
+exclude_patterns:
+  - "spec/"
+  - "!spec/support/helpers"

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "09:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rspec
+    versions:
+    - 3.10.0
+  - dependency-name: rubocop
+    versions:
+    - 1.10.0
+    - 1.11.0
+    - 1.8.1
+    - 1.9.1

data/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+# Overview
+
+## Implementation Details
+
+## Required Documentation Updates
+
+None.
+
+## Testing Notes
+
+None.
+
+## API Changes
+
+None.
+
+## External Dependency Changes
+
+None.

data/.rubocop.yml

@@ -8,5 +8,5 @@ Style/HashEachMethods:
   Enabled: false
 Lint/MissingSuper:
   Enabled: false
-Lint/UriEscapeUnescap:
+Lint/UriEscapeUnescape:
   Enabled: false

data/.travis.yml

@@ -1,7 +1,15 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CODE_CLIMATE_TOKEN
 language: ruby
 rvm:
   - 2.6.3
-before_install: gem install bundler:2.1.4
-addons:
-    code_climate:
-        repo_token: c70e0538e62cddacecb3cb86033e4595d0e3a36653ab9dfeb51328f7be55a0f3
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - gem install bundler:2.1.4
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+patreon: marcelobarreto

data/Gemfile.lock

@@ -1,23 +1,22 @@
 PATH
   remote: .
   specs:
-    via_cep (3.1.3)
+    via_cep (3.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.4.4)
-    docile (1.3.2)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    docile (1.4.1)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -31,32 +30,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (1.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.19.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.3)
-    unicode-display_width (2.0.0)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.0)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter (~> 0.6)
   rake (~> 13.0.3)
   rspec (~> 3.5)
-  rubocop (~> 1.12.0)
+  rubocop (~> 1.43.0)
+  simplecov (~> 0.22.0)
   via_cep!
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,12 @@
 # ViaCep
 
 ## Status
-[![Build Status](https://api.travis-ci.org/marcelobarreto/via_cep.svg?branch=master)](https://travis-ci.org/marcelobarreto/via_cep) [![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep.svg)](https://codeclimate.com/github/marcelobareto/via_cep) [![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep/coverage.svg)](https://codeclimate.com/github/marcelobarreto/via_cep)[![RubyGems](http://img.shields.io/gem/dt/via_cep.svg?style=flat)](http://rubygems.org/gems/via_cep)
+
+[![Build Status](https://api.travis-ci.org/marcelobarreto/via_cep.svg?branch=master)](https://travis-ci.org/marcelobarreto/via_cep)
+[![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep.svg)](https://codeclimate.com/github/marcelobareto/via_cep)
+[![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep/coverage.svg)](https://codeclimate.com/github/marcelobarreto/via_cep)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![RubyGems](http://img.shields.io/gem/dt/via_cep.svg?style=flat)](http://rubygems.org/gems/via_cep)
 
 
 ## Installation
@@ -14,28 +19,29 @@ gem 'via_cep'
 
 And then execute:
 
-    $ bundle
+```$ bundle```
 
 Or install it yourself as:
 
-    $ gem install via_cep
+```$ gem install via_cep```
 
 ## Usage
 
 On terminal you can use via_cep like this:
+
 ```ruby
-  require 'via_cep'
+require 'via_cep'
 
-  address = ViaCep::Address.new('01001-000')
-  address = ViaCep::Address.new(01001000)
+address = ViaCep::Address.new('01001-000')
+address = ViaCep::Address.new(01001000)
 
-  address.street # Returns "Praça da Sé"
+address.street # Returns "Praça da Sé"
 ```
 
 You can use from terminal either
 
 ```bash
-  $ zipcode 01001-000 01406000
+$ zipcode 01001-000 01406000
 ```
 It will return 2 address with its information
 
@@ -64,7 +70,7 @@ search.zipcode # => "01001-000"
 
 ### Available methods
 
-  zipcode, street, complement, neighborhood, city, state, ibge, gia.
+zipcode, street, complement, neighborhood, city, state, ibge, gia.
 
 ## Development
 

data/lib/via_cep/address.rb

@@ -1,10 +1,30 @@
 # frozen_string_literal: true
 
 module ViaCep
-  # Address class
   class Address < Instance
     attr_reader :zipcode
 
+    #
+    # Initialize an instance of ViaCep::Address and retrieve the CEP using the ViaCep WS API.
+    #
+    # Retrieve a zipcode
+    #   ViaCep::Address.new('01001000')
+    #   #=> #<ViaCep::Address:0x0000558da60b3770 @zipcode="01001-000",
+    #   @street="Praca da Se", @complement="lado impar", @neighborhood="Se", @city="Sao Paulo", @state="SP",
+    #   @ibge="3550308", @gia="1004", @error=nil>
+    #
+    # Retrieve a zipcode with a formatted string
+    #   ViaCep::Address.new('01001-000')
+    #   #=> #<ViaCep::Address:0x000055e5429aef98 @zipcode="01001-000", @street="Praca da Se", @complement="lado impar",
+    #   @neighborhood="Se", @city="Sao Paulo", @state="SP", @ibge="3550308", @gia="1004", @error=nil>
+    #
+    # raise [ArgumentError] Error raised when zipcode is nil.
+    # raise [ViaCep::Errors::InvalidZipcodeFormat] Errorraised when zipcode format is invalid.
+    # raise [ViaCep::Errors::ZipcodeNotFound] Error raised when the external API is down or the CEP does not exist.
+    #
+    # return [ViaCep::Address]
+    #
+
     def initialize(zipcode)
       @zipcode = zipcode
       valid?

data/lib/via_cep/http.rb

@@ -2,16 +2,24 @@
 
 module ViaCep
   module HTTP
+    #
+    # Main HTTP module using Net::HTTP
+    #
+    # return [Net::HTTPOK] | [Net::HTTPBadRequest]
+    #
     def self.get(path:, query: {})
-      uri = URI(BASE_URL)
-      uri.path = "/ws/#{URI.encode(path)}/json"
-      uri.query = URI.encode_www_form(query)
-
-      Net::HTTP.get_response(uri)
+      Net::HTTP.get_response(ViaCep::HTTP.uri(path: path, query: query))
     end
 
     def self.was_successful?(request)
       request.code.eql?('200')
     end
+
+    def self.uri(path:, query: {})
+      base_uri = URI(BASE_URL)
+      base_uri.path = "/ws/#{URI::Parser.new.escape(path)}/json"
+      base_uri.query = URI.encode_www_form(query)
+      base_uri
+    end
   end
 end

data/lib/via_cep/instance.rb

@@ -2,6 +2,11 @@
 
 module ViaCep
   class Instance
+    #
+    # Default class to define methods based on the response
+    #
+    # return [ViaCep::Instance]
+    #
     def define_attributes(response)
       ViaCep::METHODS.each do |method_name, response_key|
         value = response[response_key.to_s]

data/lib/via_cep/methods.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 module ViaCep
-  # Translate methods allows us to use metaprogramming.
+  #
+  # Constant with the params mapped
+  #
+  # return Hash
+  #
   METHODS = {
     zipcode: :cep,
     street: :logradouro,
@@ -11,6 +15,8 @@ module ViaCep
     state: :uf,
     ibge: :ibge,
     gia: :gia,
-    error: :erro
+    error: :erro,
+    ddd: :ddd,
+    siafi: :siafi
   }.freeze
 end

data/lib/via_cep/search_by_address.rb

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
 
 module ViaCep
-  # Search an address
   class SearchByAddress < Instance
     attr_reader :state, :city, :street
 
+    #
+    # Initialize an instance of ViaCep::SearchByAddress and retrieve the CEP using the ViaCep WS API.
+    #
+    # Search for a zipcode through the address
+    #   ViaCep::SearchByAddress.new(state: 'SP', city: 'Sao Paulo', street: 'Praca da Se')
+    #   #=> #<ViaCep::SearchByAddress:0x000055e542d90210 @state="SP", @city="Sao Paulo", @street="Praca da Se",
+    #   @zipcode="01001-000", @complement="lado impar", @neighborhood="Se", @ibge="3550308", @gia="1004", @error=nil>
+    #
+    # raise [ViaCep::Errors::InvalidAddressFormat] Error raised when there is any address field empty.
+    # raise [ViaCep::Errors::InvalidStateFormat] Error raised when the state is not a valid one
+    #
+    # return [ViaCep::SearchByAddress]
+    #
+
     def initialize(state:, city:, street:)
       @state = state
       @city = city
@@ -19,8 +32,8 @@ module ViaCep
     private
 
     def valid?
+      raise ViaCep::Errors::InvalidAddressFormat unless state && city && street
       raise ViaCep::Errors::InvalidStateFormat unless ViaCep::Validators::State.valid?(state)
-      raise ViaCep::Errors::InvalidAddressFormat unless city || state
     end
 
     def call_service

data/lib/via_cep/validators.rb

@@ -2,9 +2,19 @@
 
 module ViaCep
   module Validators
-    # State validator
     module State
       class << self
+        #
+        # Validates if the state passed is a valid one.
+        #
+        # Return if is valid or not
+        #   ViaCep::Validators::State.valid?('foo')
+        #   #=> false
+        #   ViaCep::Validators::State.valid?('RJ')
+        #   #=> true
+        #
+        # return Boolean
+        #
         def valid?(state)
           %w[
             AC AL AP AM BA CE DF ES GO
@@ -18,6 +28,17 @@ module ViaCep
     # Zipcode validator
     module Zipcode
       class << self
+        #
+        # Validates if the zipcode passed is a valid one.
+        #
+        # Return if is valid or not
+        #   ViaCep::Validators::Zipcode.valid?('0')
+        #   #=> false
+        #   ViaCep::Validators::Zipcode.valid?('01001000')
+        #   #=> true
+        #
+        # return Boolean
+        #
         def valid?(zipcode)
           zipcode = zipcode.to_s
           !!zipcode.match(/^[0-9]{5}(-)[0-9]{3}$/) || !!zipcode.match(/^[0-9]{8}$/)

data/lib/via_cep/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViaCep
-  VERSION = '3.1.3'
+  VERSION = '3.1.4'
 end

data/via_cep.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = ['zipcode']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
   spec.add_development_dependency 'rake', '~> 13.0.3'
   spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'rubocop', '~> 1.12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.43.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
 end

metadata

@@ -1,72 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: via_cep
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - Marcelo Barreto (@marcelobarreto)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-03 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 1.43.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 1.43.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
-description: 
+        version: 0.22.0
+description:
 email:
 - marcelobarretojunior@gmail.com
 executables:
@@ -75,6 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -82,6 +84,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- FUNDING.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -104,7 +107,7 @@ homepage: http://www.github.com/marcelobarreto/via_cep
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Brazillian zip-code information
 test_files: []