via_cep 0.2.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90b732c4ac01dc31ba7527b70c3b9fae38fa52b2
-  data.tar.gz: 96a08bd42aa9172fea057472c08b5d207ffdabd7
+  metadata.gz: 0bfebba5a73a67cffa9d1784375e8cdeb9e68e22
+  data.tar.gz: 3b037be00bf894557952433a442e16328fbcf953
 SHA512:
-  metadata.gz: 75192cd19005764d836e21109c9532ffd665d9b820a9a33fb56beac876472703787d3907363b11ed676bd8321432cf7ae5f9f543384f7255d9bed1ba4424e84c
-  data.tar.gz: b9bb07c8bdb56ecbc493cecfaaa87e4c446a67888761c0bca84fb02a052c9ffef476e492eed519ff58403583ee2653224fecced106eede9fc7a3b583e766ddf0
+  metadata.gz: a55d2404351cc6870708a9aee357cd4547a10fe34956a5a16a6a54717fbdc054476566578393d0ff60f83adb1b86a775741bd3d2b2c7fdb3e33309c1fa7b3ffe
+  data.tar.gz: 216fb6603769db7e3a701b19a6a65bb704dd578100663d01276384416a8dd7f2f1ec5f3cc567fdb67fdc51b0d073f0db29b613d80dac8f88e6f6aac58a793c18

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Style/Encoding:
+  EnforcedStyle: always
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always

data/Gemfile

@@ -1,3 +1,5 @@
+# encoding: utf-8
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in via_cep.gemspec

data/README.md

@@ -1,9 +1,9 @@
 # ViaCep
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/via_cep`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## 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)
+[![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) [![Ebert](https://ebertapp.io/badges/N68FgrgxUFWYFU43eLvEK4qb.svg)](https://ebertapp.io/repos/85)
+[![RubyGems](http://img.shields.io/gem/dt/via_cep.svg?style=flat)](http://rubygems.org/gems/via_cep)
+
 
 ## Installation
 
@@ -55,6 +55,13 @@ It will return 2 address with its information
   SP
 ```
 
+And also search for a zipcode by an address
+
+```ruby
+search = ViaCep::SearchByAddress.new(state: 'SP', city: 'São Paulo', street: 'Praça da Sé')
+
+search.zipcode # => "01001-000"
+```
 
 ### Available methods
 
@@ -68,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcelobarreto/via_cep. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcelobarreto/via_cep. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
 
 
 ## License

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# encoding: utf-8
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+# encoding: utf-8
 
-require "bundler/setup"
-require "via_cep"
+require 'bundler/setup'
+require 'via_cep'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +13,5 @@ require "via_cep"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/zipcode

@@ -1,6 +1,9 @@
 #!/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

data/lib/via_cep.rb

@@ -1,18 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
 require 'httparty'
 require 'via_cep/version'
 
 # Core
 require 'via_cep/address'
 require 'via_cep/methods'
-require 'via_cep/search_by_zipcode'
+require 'via_cep/search_by_address'
 
 # Validators
 require 'via_cep/validators/zipcode'
+require 'via_cep/validators/state'
 
 # 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'
 
 # Utils
 require 'via_cep/utils/utils'

data/lib/via_cep/address.rb

@@ -1,15 +1,16 @@
+# encoding: utf-8
+# frozen_string_literal: true
 require_relative 'methods'
 
 module ViaCep
+  # Address class
   class Address
     def initialize(zipcode)
       @response = HTTParty.get("https://viacep.com.br/ws/#{zipcode}/json/")
 
-      if !ViaCep::Validators::Zipcode.valid?(zipcode)
-        raise ViaCep::Errors::InvalidZipcodeFormat
-      elsif @response['erro']
-        raise ViaCep::Errors::ZipcodeNotFound
-      end
+      raise ViaCep::Errors::ZipcodeNotFound if @response['erro']
+      raise ViaCep::Errors::InvalidZipcodeFormat unless ViaCep::Validators::
+                                                        Zipcode.valid?(zipcode)
     end
 
     ViaCep::METHODS.each do |method_name, response_method_name|

data/lib/via_cep/errors/address_not_found.rb

@@ -0,0 +1,14 @@
+# 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,5 +1,8 @@
+# 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
 

data/lib/via_cep/errors/invalid_zipcode_format.rb

@@ -1,5 +1,8 @@
+# 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
 

data/lib/via_cep/errors/zipcode_not_found.rb

@@ -1,10 +1,13 @@
+# 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"
+        @message = 'Not found anything for that zipcode'
       end
     end
   end

data/lib/via_cep/methods.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+# frozen_string_literal: true
 module ViaCep
+  # Translate methods allows us to use metaprogramming.
   METHODS = {
     zipcode: 'cep',
     street: 'logradouro',
@@ -8,5 +11,5 @@ module ViaCep
     state: 'uf',
     ibge: 'ibge',
     gia: 'gia'
-  }
+  }.freeze
 end

data/lib/via_cep/{search_by_zipcode.rb → search_by_address.rb}

@@ -1,20 +1,20 @@
+# encoding: utf-8
+# frozen_string_literal: true
 require_relative 'methods'
 
 module ViaCep
+  # Search an address
   class SearchByAddress
     def initialize(state:, city:, street:)
       city   = ViaCep::Utils.parameterize(city)
       street = ViaCep::Utils.parameterize(street)
 
-      if state.size != 2
-        raise ViaCep::Errors::InvalidStateFormat
-      end
+      raise ViaCep::Errors::InvalidStateFormat unless ViaCep::Validators::State
+                                                      .valid?(state)
 
       @response = HTTParty.get("#{base_url}/#{state}/#{city}/#{street}/json")
 
-      if @response.include?('Bad Request')
-        raise ViaCep::Errors::ZipcodeNotFound
-      end
+      raise ViaCep::Errors::AddressNotFound if @response.include?('Bad Request')
     end
 
     ViaCep::METHODS.each do |method_name, response_method_name|
@@ -26,7 +26,7 @@ module ViaCep
     private
 
     def base_url
-      "https://viacep.com.br/ws"
+      'https://viacep.com.br/ws'
     end
   end
 end

data/lib/via_cep/utils/utils.rb

@@ -1,6 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: true
 require 'active_support/all'
 
 module ViaCep
+  # Utils module
   class Utils
     class << self
       def handle_whitespaces(string)

data/lib/via_cep/validators/state.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module ViaCep
+  module Validators
+    # State validator
+    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
+          )
+        end
+      end
+    end
+  end
+end

data/lib/via_cep/validators/zipcode.rb

@@ -1,11 +1,14 @@
+# 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 self.match_regex?(zipcode)
+          return true if match_regex?(zipcode)
         end
 
         def match_regex?(zipcode)

data/lib/via_cep/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+# frozen_string_literal: true
 module ViaCep
-  VERSION = '0.2.4.1'
+  VERSION = '1.0.0'.freeze
 end

data/via_cep.gemspec

@@ -1,27 +1,32 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'via_cep/version'
 
 Gem::Specification.new do |s|
-  s.name          = "via_cep"
+  s.name          = 'via_cep'
   s.version       = ViaCep::VERSION
-  s.authors       = ["Marcelo Barreto"]
-  s.email         = ["marcelobarretojunior@gmail.com"]
-  s.summary       = %q{Brazillian zip-code information}
-  s.homepage      = "http://www.github.com/marcelobarreto/via_cep"
-  s.license       = "MIT"
+  s.authors       = ['Marcelo Barreto']
+  s.email         = ['marcelobarretojunior@gmail.com']
+  s.summary       = 'Brazillian zip-code information'
+  s.homepage      = 'http://www.github.com/marcelobarreto/via_cep'
+  s.license       = 'MIT'
 
-  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.bindir        = "bin"
-  s.executables   = ["zipcode"]
-  s.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
-  s.add_development_dependency 'bundler', '~> 1.10'
-  s.add_development_dependency 'rake', '~> 10.0'
-  s.add_development_dependency 'rspec', '~> 3.4'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.5'
-  s.add_dependency 'httparty', '~> 0.13'
-  s.add_dependency 'activesupport', '~> 4.0'
+  s.bindir        = 'bin'
+  s.executables   = ['zipcode']
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'rake', '~> 11.2'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
+  s.add_dependency 'httparty', '~> 0.14'
+  s.add_dependency 'activesupport', '~> 5.0'
   s.add_dependency 'i18n', '~> 0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: via_cep
 version: !ruby/object:Gem::Version
-  version: 0.2.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Marcelo Barreto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-22 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,84 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -130,12 +145,14 @@ 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/methods.rb
-- lib/via_cep/search_by_zipcode.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/version.rb
 - via_cep.gemspec
@@ -159,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Brazillian zip-code information