via_cep 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19a89de51b4fad2837169e4dd2078b8b3b4551de
-  data.tar.gz: e177fe46477c0ac7493e0b78dbc96e3828e12a65
+  metadata.gz: 28ae07ae24ba0766a1ebb411a759ba179d4efbfa
+  data.tar.gz: 42dda2251888df5160c8ac65bc31dced889d8da5
 SHA512:
-  metadata.gz: b7886e783cc04870f72a3bc9e559bd54dc4ba1ddaf7db769712d13abbed9a1d6571934de4cab2965b54a3444f9740f7c90eb2bdd5f1e9ac7237ace2eb2e4d7dd
-  data.tar.gz: d035e7ec0feb57b755ee6fcc93d3d8f86a6b77ffb061ad00d0021edec296bb0fc891979f8fc5b7f79b29f5d8298f9bbf01b70ed8ecff8644671bfdb25caa9543
+  metadata.gz: 29567bac66005ab75b5ad35be22282b4f6e7259e7ec78f45bb60db846dd09669bd74bffb95248b6d2aafac86a1d682d2e5ef4e46c40e3c08985b3577c8c05080
+  data.tar.gz: 11a604452e5e61db02dbfcda264504c93762a246e1d480938b0b637e880dbb440e9febc6d5c4c0636c7dc0db5c8f9f2262604ca662a212be9845f9e53d2657b8

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.10.6
+addons:
+    code_climate:
+        repo_token: c70e0538e62cddacecb3cb86033e4595d0e3a36653ab9dfeb51328f7be55a0f3

data/Gemfile

@@ -2,4 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in via_cep.gemspec
 gemspec
-gem 'httparty'

data/README.md

@@ -2,7 +2,8 @@
 
 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.
 
-TODO: Delete this and the text above, and describe your gem
+## 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)
 
 ## Installation
 
@@ -22,7 +23,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+On terminal you can use via_cep like this:
+```ruby
+  require 'via_cep'
+
+  address = ViaCep::Address.new('01001-000')
+  address = ViaCep::Address.new(01001000)
+
+  address.street # Returns "Praça da Sé"
+```
+
+### Available methods
+
+  zipcode, street, complement, neighborhood, city, state, ibge, gia.
 
 ## Development
 
@@ -32,10 +45,9 @@ 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/[USERNAME]/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](contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/via_cep/address.rb

@@ -0,0 +1,22 @@
+module ViaCep
+  class Address
+    attr_reader :response
+
+    def initialize(zipcode)
+      begin
+        @response = HTTParty.get("https://viacep.com.br/ws/#{zipcode}/json/")
+      raise ArgumentError, 'Invalid zipcode format' unless has_valid_format?(zipcode)
+      end
+    end
+
+    def has_valid_format?(zipcode)
+      zipcode.to_s.match(/\d{5}(-)\d{3}\z/) || zipcode.to_s.match(/\d{8}/)
+    end
+
+    ViaCep::METHODS.each do |method_name, response_method_name|
+      define_method(method_name) do
+        response[response_method_name]
+      end
+    end
+  end
+end

data/lib/via_cep/methods.rb

@@ -0,0 +1,12 @@
+module ViaCep
+  METHODS = {
+    zipcode: 'cep',
+    street: 'logradouro',
+    complement: 'complemento',
+    neighborhood: 'bairro',
+    city: 'localidade',
+    state: 'uf',
+    ibge: 'ibge',
+    gia: 'gia'
+  }
+end

data/lib/via_cep/version.rb

@@ -1,3 +1,3 @@
 module ViaCep
-  VERSION = "0.1.0"
+  VERSION = '0.2.1'
 end

data/lib/via_cep.rb

@@ -1,46 +1,5 @@
 require 'via_cep/version'
+require 'via_cep/methods'
+require 'via_cep/format'
+require 'via_cep/address'
 require 'httparty'
-
-module ViaCep
-  class CEP
-    def initialize(cep)
-      begin
-        @cep = cep.to_s
-        @response = HTTParty.get("https://viacep.com.br/ws/#{@cep}/json/")
-      raise RuntimeError unless correct_format(cep.to_s)
-      end
-    end
-
-    def street
-      @response["logradouro"]
-    end
-
-    def complement
-      @response["complemento"]
-    end
-
-    def neighborhood
-      @response["bairro"]
-    end
-
-    def city
-      @response["localidade"]
-    end
-
-    def state
-      @response["uf"]
-    end
-
-    def ibge
-      @response["ibge"]
-    end
-
-    def gia
-      @response["gia"]
-    end
-
-    def correct_format(cep)
-      return true if cep.match(/\d{5}(-)\d{3}\z/) or cep.match(/\d{8}/)
-    end
-  end
-end

data/via_cep.gemspec

@@ -3,22 +3,24 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'via_cep/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "via_cep"
-  spec.version       = ViaCep::VERSION
-  spec.authors       = ["Marcelo Barreto"]
-  spec.email         = ["marcelobarretojunior@gmail.com"]
-  spec.summary       = %q{Get Brazil zip-code}
-  spec.homepage      = "http://www.github.com/marcelobarreto/via_cep"
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name          = "via_cep"
+  s.version       = ViaCep::VERSION
+  s.authors       = ["Marcelo Barreto"]
+  s.email         = ["marcelobarretojunior@gmail.com"]
+  s.summary       = %q{Get brazillian zip-code information}
+  s.homepage      = "http://www.github.com/marcelobarreto/via_cep"
+  s.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_dependency 'httparty'
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'pry'
+  s.add_dependency 'httparty'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: via_cep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marcelo Barreto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -84,6 +113,8 @@ files:
 - bin/console
 - bin/setup
 - lib/via_cep.rb
+- lib/via_cep/address.rb
+- lib/via_cep/methods.rb
 - lib/via_cep/version.rb
 - via_cep.gemspec
 homepage: http://www.github.com/marcelobarreto/via_cep
@@ -109,5 +140,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Get Brazil zip-code
+summary: Get brazillian zip-code information
 test_files: []