via_cep 2.0.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00df8646dc3a6b1717bad27a4d433d4390707f3c1fec92cfc9f6eb872e514d8e
-  data.tar.gz: 51ddd7c7c2ee022c4fc807a5e52175f6639d89488e3ad0bdc7a98fffecb5ba6e
+  metadata.gz: 6acf1f1df8168ec0213dba8cb0f8bc4a1604db9268b29fa30593a9d7323c1eb1
+  data.tar.gz: 9c16eaef9491ad33989a63c49d9c4faaac68b07e572b72a215c676474c96d633
 SHA512:
-  metadata.gz: ca4c5852b3f90bac32c6d4de7bc23c8ad368a920683b4dba0f80fdaee52724a352b4720247eb82bdd4b9656bccb95597d4cb6bf1aa2c0001300323065fe52650
-  data.tar.gz: e5f88bf4f73af01835d8b17ffe3365c7240cca292231c0aabada1c4065277da307b65930c4cbc73d106003e89b5f1ac3a066b1efa39602943c7dffb275f31b01
+  metadata.gz: ef87668c195c9c3f288909972af1964c037b77985d76d55d8d3b1f50191bf6cddd762401a66e73778f64d6bc9a1c68e699b330e56da0608b578aa13a5eaed524
+  data.tar.gz: 35ac112a7acc2337c70e5184b15f18961d9e03169aca0e54a4332a243e6f47a853277a16d48357b43f017d9aea8a2d07eab6dbf569329a2a33b3c17a2d9a2f28

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,9 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.2
-
-Style/Encoding:
-  EnforcedStyle: always
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
+  SuggestExtensions: false
+  Exclude:
+    - 'spec/**/*.rb'
+Style/Documentation:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Lint/UriEscapeUnescap:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+via_cep

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 2.6.3
+before_install: gem install bundler:2.1.4
 addons:
     code_climate:
         repo_token: c70e0538e62cddacecb3cb86033e4595d0e3a36653ab9dfeb51328f7be55a0f3

data/Gemfile

@@ -1,13 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in via_cep.gemspec
 gemspec
-
-group :test do
-  gem 'codeclimate-test-reporter', '~> 0.6'
-  gem 'rubocop', '~> 0.49.0'
-  gem 'rspec', '~> 3.5'
-end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    via_cep (3.1.3)
+
+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)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (1.12.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 0.6)
+  rake (~> 13.0.3)
+  rspec (~> 3.5)
+  rubocop (~> 1.12.0)
+  via_cep!
+
+BUNDLED WITH
+   2.1.4

data/Makefile

@@ -0,0 +1,2 @@
+default:
+	./bin/console

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'

data/bin/console

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'bundler/setup'
 require 'via_cep'

data/bin/zipcode

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
 # frozen_string_literal: true
-# encoding: utf-8
 
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+$LOAD_PATH.unshift(File.expand_path("#{File.dirname(__FILE__)}/../lib"))
 require 'via_cep'
 
-if ARGV.count > 0
+if ARGV.count.positive?
   ARGV.each do |zipcode|
     address = ViaCep::Address.new(zipcode)
     puts "#{zipcode}:"

data/lib/via_cep.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'via_cep/version'
@@ -6,22 +5,30 @@ require 'net/http'
 require 'uri'
 require 'json'
 
+# Validators
+require 'via_cep/validators'
+
+# HTTP
+require 'via_cep/http'
+
 # Core
-require 'via_cep/address'
 require 'via_cep/methods'
+require 'via_cep/instance'
+require 'via_cep/address'
 require 'via_cep/search_by_address'
 
-# Validators
-require 'via_cep/validators/zipcode'
-require 'via_cep/validators/state'
+module ViaCep
+  BASE_URL = 'https://viacep.com.br'
+
+  module Errors
+    class ZipcodeNotFound < StandardError; end
+
+    class InvalidZipcodeFormat < StandardError; end
 
-# Errors
-require 'via_cep/errors/invalid_zipcode_format'
-require 'via_cep/errors/invalid_state_format'
-require 'via_cep/errors/zipcode_not_found'
-require 'via_cep/errors/address_not_found'
+    class InvalidStateFormat < StandardError; end
 
-# Utils
-require 'via_cep/utils/utils'
+    class InvalidAddressFormat < StandardError; end
 
-BASE_URL = 'https://viacep.com.br/ws'.freeze
+    class AddressNotFound < StandardError; end
+  end
+end

data/lib/via_cep/address.rb

@@ -1,29 +1,29 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'methods'
-
 module ViaCep
   # Address class
-  class Address
+  class Address < Instance
+    attr_reader :zipcode
+
     def initialize(zipcode)
-      uri = URI("#{BASE_URL}/#{zipcode}/json/")
-      request = Net::HTTP.get_response(uri)
+      @zipcode = zipcode
+      valid?
+      call_service
+    rescue JSON::ParserError, Net::HTTPBadRequest
+      raise ViaCep::Errors::ZipcodeNotFound
+    end
 
-      raise ViaCep::Errors::InvalidZipcodeFormat unless ViaCep::Validators::
-                                                        Zipcode.valid?(zipcode)
+    private
 
-      if request.code === '200'
-        @response = JSON.parse(request.body)
+    def call_service
+      response = JSON.parse(ViaCep::HTTP.get(path: zipcode).body)
+      raise ViaCep::Errors::ZipcodeNotFound if response['erro']
 
-        raise ViaCep::Errors::ZipcodeNotFound if @response['erro']
-      end
+      define_attributes(response)
     end
 
-    ViaCep::METHODS.each do |method_name, response_method_name|
-      define_method(method_name) do
-        @response[response_method_name]
-      end
+    def valid?
+      raise ViaCep::Errors::InvalidZipcodeFormat unless ViaCep::Validators::Zipcode.valid?(zipcode)
     end
   end
 end

data/lib/via_cep/http.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ViaCep
+  module HTTP
+    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)
+    end
+
+    def self.was_successful?(request)
+      request.code.eql?('200')
+    end
+  end
+end

data/lib/via_cep/instance.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ViaCep
+  class Instance
+    def define_attributes(response)
+      ViaCep::METHODS.each do |method_name, response_key|
+        value = response[response_key.to_s]
+
+        instance_variable_set("@#{method_name}", value)
+        self.class.define_method(method_name) do
+          instance_variable_get("@#{method_name}")
+        end
+      end
+    end
+  end
+end

data/lib/via_cep/methods.rb

@@ -1,16 +1,16 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module ViaCep
   # Translate methods allows us to use metaprogramming.
   METHODS = {
-    zipcode: 'cep',
-    street: 'logradouro',
-    complement: 'complemento',
-    neighborhood: 'bairro',
-    city: 'localidade',
-    state: 'uf',
-    ibge: 'ibge',
-    gia: 'gia'
+    zipcode: :cep,
+    street: :logradouro,
+    complement: :complemento,
+    neighborhood: :bairro,
+    city: :localidade,
+    state: :uf,
+    ibge: :ibge,
+    gia: :gia,
+    error: :erro
   }.freeze
 end

data/lib/via_cep/search_by_address.rb

@@ -1,28 +1,36 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'methods'
-
 module ViaCep
   # Search an address
-  class SearchByAddress
+  class SearchByAddress < Instance
+    attr_reader :state, :city, :street
+
     def initialize(state:, city:, street:)
-      city   = ViaCep::Utils.parameterize(city)
-      street = ViaCep::Utils.parameterize(street)
+      @state = state
+      @city = city
+      @street = street
 
-      raise ViaCep::Errors::InvalidStateFormat unless ViaCep::Validators::State.valid?(state)
+      valid?
+      call_service
+    rescue JSON::ParserError, Net::HTTPBadRequest
+      raise ViaCep::Errors::AddressNotFound
+    end
 
-      uri = URI("#{BASE_URL}/#{state}/#{city}/#{street}/json")
-      request = Net::HTTP.get_response(uri)
+    private
 
-      @response = JSON.parse(request.body) if request.code === '200'
-      raise ViaCep::Errors::AddressNotFound if @response.include?('Bad Request')
+    def valid?
+      raise ViaCep::Errors::InvalidStateFormat unless ViaCep::Validators::State.valid?(state)
+      raise ViaCep::Errors::InvalidAddressFormat unless city || state
     end
 
-    ViaCep::METHODS.each do |method_name, response_method_name|
-      define_method(method_name) do
-        @response.first[response_method_name]
-      end
+    def call_service
+      request = HTTP.get(path: "#{state}/#{city}/#{street}")
+      raise ViaCep::Errors::AddressNotFound unless HTTP.was_successful?(request)
+
+      response = JSON.parse(request.body)
+      raise ViaCep::Errors::AddressNotFound if response.length.eql?(0)
+
+      define_attributes(response[0])
     end
   end
 end

data/lib/via_cep/{validators/state.rb → validators.rb}

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module ViaCep
@@ -7,15 +6,21 @@ module ViaCep
     module State
       class << self
         def valid?(state)
-          states.include?(state.to_s)
-        end
-
-        def states
           %w[
             AC AL AP AM BA CE DF ES GO
             MA MT MS MG PR PB PA PE PI
             RJ RN RS RO RR SC SE SP TO
-          ]
+          ].include?(state.to_s)
+        end
+      end
+    end
+
+    # Zipcode validator
+    module Zipcode
+      class << self
+        def valid?(zipcode)
+          zipcode = zipcode.to_s
+          !!zipcode.match(/^[0-9]{5}(-)[0-9]{3}$/) || !!zipcode.match(/^[0-9]{8}$/)
         end
       end
     end

data/lib/via_cep/version.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module ViaCep
-  VERSION = '2.0.1'.freeze
+  VERSION = '3.1.3'
 end

data/via_cep.gemspec

@@ -1,26 +1,29 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'via_cep/version'
 
-Gem::Specification.new do |s|
-  s.name          = 'via_cep'
-  s.version       = ViaCep::VERSION
-  s.authors       = ['Marcelo Barreto (@marcelobarreto)']
-  s.email         = ['marcelobarretojunior@gmail.com']
-  s.summary       = 'Brazillian zip-code information'
-  s.homepage      = 'http://www.github.com/marcelobarreto/via_cep'
-  s.license       = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name          = 'via_cep'
+  spec.version       = ViaCep::VERSION
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
+  spec.authors       = ['Marcelo Barreto (@marcelobarreto)']
+  spec.email         = ['marcelobarretojunior@gmail.com']
+  spec.summary       = 'Brazillian zip-code information'
+  spec.homepage      = 'http://www.github.com/marcelobarreto/via_cep'
+  spec.license       = 'MIT'
 
-  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  s.bindir        = 'bin'
-  s.executables   = ['zipcode']
-  s.require_paths = ['lib']
+  spec.bindir        = 'bin'
+  spec.executables   = ['zipcode']
+  spec.require_paths = ['lib']
 
-  s.add_dependency 'activesupport', '~> 5.0'
+  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'
 end

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: via_cep
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Marcelo Barreto (@marcelobarreto)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '0.6'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
 description: 
 email:
 - marcelobarretojunior@gmail.com
@@ -36,10 +78,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -47,15 +93,11 @@ files:
 - bin/zipcode
 - lib/via_cep.rb
 - lib/via_cep/address.rb
-- lib/via_cep/errors/address_not_found.rb
-- lib/via_cep/errors/invalid_state_format.rb
-- lib/via_cep/errors/invalid_zipcode_format.rb
-- lib/via_cep/errors/zipcode_not_found.rb
+- lib/via_cep/http.rb
+- lib/via_cep/instance.rb
 - lib/via_cep/methods.rb
 - lib/via_cep/search_by_address.rb
-- lib/via_cep/utils/utils.rb
-- lib/via_cep/validators/state.rb
-- lib/via_cep/validators/zipcode.rb
+- lib/via_cep/validators.rb
 - lib/via_cep/version.rb
 - via_cep.gemspec
 homepage: http://www.github.com/marcelobarreto/via_cep
@@ -70,15 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Brazillian zip-code information

data/lib/via_cep/errors/address_not_found.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module ViaCep
-  module Errors
-    # This class is responsible to show an error
-    class AddressNotFound < ArgumentError
-      attr_reader :message
-
-      def initialize
-        @message = 'Not found anything for that address'
-      end
-    end
-  end
-end

data/lib/via_cep/errors/invalid_state_format.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module ViaCep
-  module Errors
-    # This class is responsible to show an error
-    class InvalidStateFormat < ArgumentError
-      attr_reader :message
-
-      def initialize
-        @message = 'State has an invalid format'
-      end
-    end
-  end
-end

data/lib/via_cep/errors/invalid_zipcode_format.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module ViaCep
-  module Errors
-    # This class is responsible to show an error
-    class InvalidZipcodeFormat < ArgumentError
-      attr_reader :message
-
-      def initialize
-        @message = 'Zipcode has an invalid format'
-      end
-    end
-  end
-end

data/lib/via_cep/errors/zipcode_not_found.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module ViaCep
-  module Errors
-    # This class is responsible to show an error
-    class ZipcodeNotFound < StandardError
-      attr_reader :message
-
-      def initialize
-        @message = 'Not found anything for that zipcode'
-      end
-    end
-  end
-end

data/lib/via_cep/utils/utils.rb

@@ -1,24 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'active_support/all'
-
-module ViaCep
-  # Utils module
-  class Utils
-    class << self
-      def handle_whitespaces(string)
-        string.split(' ').join('%20')
-      end
-
-      def handle_accents(string)
-        ActiveSupport::Inflector.transliterate(string)
-      end
-
-      def parameterize(string)
-        string = handle_accents(string)
-        handle_whitespaces(string)
-      end
-    end
-  end
-end

data/lib/via_cep/validators/zipcode.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module ViaCep
-  module Validators
-    # Zipcode validator
-    module Zipcode
-      class << self
-        def valid?(zipcode)
-          zipcode = zipcode.to_s
-
-          return true if match_regex?(zipcode)
-        end
-
-        def match_regex?(zipcode)
-          zipcode = zipcode.to_s
-          zipcode.match(/^[0-9]{5}(-)[0-9]{3}$/) || zipcode.match(/^[0-9]{8}$/)
-        end
-      end
-    end
-  end
-end