viacep 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b64d6ee01644f4f8b6febc8ed674889738deb2b740fa3415fd34decc47af2797
-  data.tar.gz: f91cd76cc0aeadd76ced64672971b09b96cbecdfddaf51854f77d91fe3103002
+  metadata.gz: 6a0da61db07bc87dc9593747ae9d63580cc685e1d299da83dd0a03ab0ff13419
+  data.tar.gz: cf244b4466c7a73e25ffbf84024faf8fd2f50c7b797e6c9a892f9c381a4aa1b6
 SHA512:
-  metadata.gz: 89cd06d5b60aa3bc72c40475f34ea27cef9e03e7f855ea9620418fc4ee6b9c54c6685035d747fd58b1934ff296049ca1f2c712468de35c9cf758a9c6e3462a6a
-  data.tar.gz: 8e460e65e109f215c6074d4344bb6252eeff3f821de721a7cf90ef6ddb8bf9e25aed3d92e38c84207d58b0f52913c12f2f2beeccbf8b7508eb5603617be344ef
+  metadata.gz: 99d3fb4ba76ab983c3eadb79194e84fe2c73614724adedc8d9498ac5cce9e41e430e9b5587518a6fe731a3312a18b6bc11c509bab363a4eecaa291b3c3668a7c
+  data.tar.gz: 1ba60a80b2fefb9a5f80d941d84a4c58ad6bc5b83cd2d5ae95c8b5ab0e259f88c52f3f98f33e077a7b4bdd484c953848c0dc6828daf8d97a898772d953d370cf

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,55 @@
+*.gem
+*.rbc
+/.config
+capybara-*.html
+.rspec
+/log
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/version_tmp/
+**/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+
+## Specific to RubyMotion:
+config/initializers/secret_token.rb
+config/secrets.yml
+
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version*
+.ruby-gemset*
+.rvmrc*
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/BRA_orthographic.svg/270px-BRA_orthographic.svg.png" align="right" />
+
+# viacep [![GitHub license](https://img.shields.io/github/license/vnbrs/burocracia.cr.svg)](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE) 
+> Gem responsável por buscar endereços a partir do CEP utilizando a API do ViaCEP com features úteis como timeout.
+
+## Instalação
+
+Instale o viacep pelo [RubyGems](https://rubygems.org/gems/viacep/) facilmente via terminal:
+
+```shell
+gem install viacep
+=> Vai que é tua! 🚀
+```
+
+## Como usar?
+
+```ruby
+require 'viacep'
+
+# com CEPs sem formatação...
+ViaCep::Address.new('80210130')
+=> #<ViaCep::Address:0x00007fe52a8a0568 @cep="80210-130", @address="Rua José Ananias Mauad", @neighborhood="Jardim Botânico", @city="Curitiba", @state="PR", @ibge="4106902", @gia="">
+
+# com CEPs formatados...
+ViaCep::Address.new('13035-680')
+=> #<ViaCep::Address:0x00007fe52a99e730 @cep="13035-680", @address="Avenida João Jorge", @neighborhood="Vila Industrial", @city="Campinas", @state="SP", @ibge="3509502", @gia="2446">
+
+# um CEP não existente...
+ViaCep::Address.new('123')
+=> exception thrown: ViaCep::ApiRequestError
+
+# especificando um timeout em segundos...
+ViaCep::Address.new('80210130', timeout: 0.2)
+=> exception thrown: Timeout::Error (execution expired)
+```
+
+## Contribuindo
+
+1. Faça um fork (https://github.com/vnbrs/viacep/fork)
+2. Crie uma branch (git checkout -b my-new-feature)
+3. Faça um commit  (git commit -am 'Add some feature')
+4. Faça o push (git push origin my-new-feature)
+5. Crie um Pull Request
+6. Valeu! 🤙🏼
+
+## Contribuidores
+
+- [vnbrs](https://github.com/vnbrs) Vinicius Brasil - creator, maintainer

data/lib/viacep.rb

@@ -1,26 +1,6 @@
-require 'service'
-
 module ViaCep
-  class Address
-    attr_reader :cep, :address, :neighborhood, :city, :state, :ibge, :gia
-
-    def initialize(cep, options = {})
-      cep = cep.to_s.delete('^0-9')
-
-      response = Service.fetch cep, options[:timeout]
-      fill_from response
-    end
-
-    private
+  VERSION = "2.0.1".freeze
 
-    def fill_from(response)
-      @cep          = response['cep']
-      @address      = response['logradouro']
-      @neighborhood = response['bairro']
-      @city         = response['localidade']
-      @state        = response['uf']
-      @ibge         = response['ibge']
-      @gia          = response['gia']
-    end
-  end
+  require_relative "viacep/address"
+  require_relative "viacep/exceptions"
 end

data/lib/viacep/address.rb

@@ -0,0 +1,27 @@
+require_relative 'service'
+
+module ViaCep
+  class Address
+    attr_reader :cep, :address, :neighborhood, :city, :state, :ibge, :gia
+
+    # Initializes an instance of Address and fetches the CEP using the external API
+    def initialize(cep, options = {})
+      cep = cep.to_s.delete('^0-9')
+
+      response = Service.fetch cep, options[:timeout]
+      fill_from response
+    end
+
+    private
+
+    def fill_from(response)
+      @cep          = response['cep']
+      @address      = response['logradouro']
+      @neighborhood = response['bairro']
+      @city         = response['localidade']
+      @state        = response['uf']
+      @ibge         = response['ibge']
+      @gia          = response['gia']
+    end
+  end
+end

data/lib/{service.rb → viacep/service.rb}

@@ -2,12 +2,13 @@ require 'net/http'
 require 'uri'
 require 'json'
 require 'timeout'
-require 'exceptions'
+require_relative 'exceptions'
 
 module ViaCep
   class Service
     BASE_URL = 'https://viacep.com.br/ws'.freeze
 
+    # Fetches the ViaCEP API to request a CEP
     def self.fetch(cep, timeout)
       Timeout.timeout(timeout) do
         uri = URI("#{BASE_URL}/#{cep}/json")

data/spec/address_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe ViaCep::Address do
+  describe '#initialize' do
+    context 'when a valid CEP is passed' do
+      subject(:address) { ViaCep::Address.new('80210130') }
+
+      it 'returns the Address' do
+        expect(address.address).not_to be_empty
+      end
+    end
+
+    context 'when a invalid CEP is passed' do
+      it 'raises ViaCep::ApiRequestError' do
+        expect { ViaCep::Address.new('000000') }.
+          to raise_error(ViaCep::ApiRequestError)
+      end
+    end
+
+    context 'when a low timeout is specified' do
+      it 'raises a Timeout::Error' do
+        expect { ViaCep::Address.new('80210130', timeout: 0.001) }.
+          to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when a regular timeout is specified' do
+      subject(:address) { ViaCep::Address.new('80210130', timeout: 25) }
+
+      it 'returns the Address' do
+        expect(address.address).not_to be_empty
+      end
+    end
+  end
+end

data/spec/service_spec.rb

@@ -0,0 +1,29 @@
+RSpec.describe ViaCep::Service do
+  it 'should have a base URL' do
+    expect(ViaCep::Service::BASE_URL).not_to be_empty
+  end
+
+  describe '.fetch' do
+    context 'when a small timeout is specified' do
+      it 'raises Timeout::Error' do
+        expect { ViaCep::Service.fetch('80210130', 0.001) }.
+          to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'when a suficient timeout is specified' do
+      subject(:response) { ViaCep::Service.fetch('80210130', 25) }
+
+      it 'returns the response' do
+        expect(response).not_to be_empty
+      end
+    end
+
+    context 'when a invalid CEP is passed' do
+      it 'raises ViaCep::ApiRequestError' do
+        expect { ViaCep::Service.fetch('000000', nil) }.
+          to raise_error(ViaCep::ApiRequestError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/viacep'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.order = :random
+end

data/viacep.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/viacep', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'viacep'
+  s.version       = ViaCep::VERSION
+  s.date          = '2018-05-02'
+  s.summary       = 'Gem sem dependências e fácil de usar para busca de endereços a partir do CEP utilizando o ViaCEP'
+  s.description   = 'Gem sem dependências e fácil de usar para busca de endereços a partir do CEP utilizando o ViaCEP'
+  s.authors       = ['Vinicius Brasil (@vnbrs)']
+  s.email         = 'marcosbrasilaraujo@gmail.com'
+  s.license       = 'MIT'
+  s.homepage      = 'https://github.com/vnbrs/viacep'
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files | grep -Ev '^(test|doc|examples|.yardoc|.github)'`.split("\n")
+
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'yard', '~> 0.9.11'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: viacep
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Vinicius Brasil (@vnbrs)
@@ -24,16 +24,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
-email: vnbrs@icloud.com
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Gem sem dependências e fácil de usar para busca de endereços a partir
+  do CEP utilizando o ViaCEP
+email: marcosbrasilaraujo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/exceptions.rb
-- lib/service.rb
+- ".editorconfig"
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- README.md
 - lib/viacep.rb
-homepage: 
+- lib/viacep/address.rb
+- lib/viacep/exceptions.rb
+- lib/viacep/service.rb
+- spec/address_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+- viacep.gemspec
+homepage: https://github.com/vnbrs/viacep
 licenses:
 - MIT
 metadata: {}
@@ -56,6 +81,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Gem responsável por buscar endereços a partir do CEP utilizando a API do
-  ViaCEP com features úteis como timeout.
+summary: Gem sem dependências e fácil de usar para busca de endereços a partir do
+  CEP utilizando o ViaCEP
 test_files: []