cep-aberto 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9d4140860329970af79ea89a40fe79302440aeb
+  data.tar.gz: 8e33fbe4e0815c4968027870f1ab3743e988ff38
+SHA512:
+  metadata.gz: 806f68fb463b30f3ff3dfae8a10cbc02e2a9b82ec0d5d48b7e6531994fbf782e63f91347b06f1c56071cbd4e24892c6b34b729d6c64870e343b0e2af1da6da49
+  data.tar.gz: 4b0243428f6aa846dedd999c328d18a9338b7fd09ee81c61fc1a60f526ccbce09369ce0eb6f826a733d37f23e99740149edcaa4540efa5c0af492b7b2617d194

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jefferson dos Santos Felix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# cep-aberto
+Ruby Connector for the CEP ABERTO API (www.cepaberto.com)
+
+## Installation
+Include cep-aberto in Gemfile:
+```ruby
+gem 'cep-aberto'
+```
+And bundle with:
+```bash
+bundle 
+```
+Or execute manually:
+```bash
+gem install cep-aberto
+```
+
+## Usage
+First, you need a Token Authorization to use this gem. Go to [CEP Aberto site](http://www.cepaberto.com/) and sign up for free.
+
+### Find address
+Run:
+```ruby
+require "cep-aberto"
+CepAberto::Cep::find("01001000", "1234567890abcdef01234567890abcde")
+```
+
+This method return a hash with the full address for the zipcode:
+```ruby
+=> {"altitude"=>760.0,
+ "bairro"=>"Sé",
+ "cep"=>"01001000",
+ "latitude"=>"-23.5479099981",
+ "longitude"=>"-46.636",
+ "logradouro"=>"Praça da Sé",
+ "cidade"=>"São Paulo",
+ "ddd"=>11,
+ "ibge"=>"3550308",
+ "estado"=>"SP"}
+```
+
+### List cities 
+To list cities from a given state, do this:
+```ruby
+require "cep-aberto"
+CepAberto::Cep::cities("SP", "1234567890abcdef01234567890abcde")
+```
+And the result is:
+```ruby
+=> ["Adamantina",
+ "Adolfo",
+ "Agisse (Rancharia)",
+ "Aguaí",
+ "Águas da Prata",
+ "Águas de Lindóia",
+ "Águas de Santa Bárbara",
+ "Águas de São Pedro",
+ "Água Vermelha (São Carlos)",
+ ...
+```
+
+## Thanks
+
+Thanks to [CEP Aberto](http://www.cepaberto.com)

data/cep-aberto.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'cep-aberto'
+  s.version     = '0.1.2'
+  s.date        = '2017-08-08'
+  s.summary     = "Ruby Connector for the CEP ABERTO API (www.cepaberto.com). A token is required to use this gem."
+  s.description = s.summary
+  s.authors     = ["Jefferson Felix"]
+  s.email       = 'jsfelix@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    =
+    'https://github.com/jsfelix/cep-aberto'
+  s.license       = 'MIT'
+end

data/lib/cep-aberto.rb

@@ -0,0 +1 @@
+require "cep_aberto/cep.rb"

data/lib/cep_aberto/cep.rb

@@ -0,0 +1,68 @@
+# Main module CepAberto.
+# Author:: Jefferson Felix
+module CepAberto
+  # This class holds the methods to find zipcodes and address using the CEP 
+  # Aberto API.
+  class Cep
+    
+    require "net/http"
+    require "uri"
+    require "json"
+    
+    # CEP Aberto API (v2)
+    @domain = "http://www.cepaberto.com/api/v2/"
+
+    # Find an address from a zipcode using the CEP Aberto API.
+    # Params:
+    # +zipcode+:: the zipcode to be searched by CEP Aberto API
+    # +token+:: the user authorization token
+    # Returns a hash with the full address
+    def Cep::find(cep, token)
+      validate_cep(cep)
+      uri = URI("#{@domain}ceps.json")
+      params = {'cep' => cep}
+      address = request_cep(uri, params, token)
+      if(address["logradouro"].is_a?String)
+        address["logradouro"] = address["logradouro"].split(",")[0]
+      end
+      return address
+    end
+
+    # Returns a list of cities from a given state.
+    # Params:
+    # +state+:: State acronym (e.g. SP)
+    # +token+:: the user authorization token
+    # Returns an array with all cities from the state
+    def Cep::cities(state, token)
+      uri = URI("#{@domain}cities.json")
+      params = {'estado' => state}
+      all_cities = request_cep(uri, params, token)
+      cities_arr = Array.new
+      all_cities.each do |c|
+        cities_arr.push(c["nome"])
+      end
+      return cities_arr
+    end
+    
+    private
+    
+    # Validate cep entry
+    # * Must be a string
+    # * Must be 8 characters
+    def Cep::validate_cep(str)
+      raise ArgumentError, 'Argument is not string with 8 characters' unless str.is_a? String and str.length == 8
+    end
+    
+    # Request API
+    def Cep::request_cep(uri, params, token)
+      headers = { "Authorization" => "Token token=#{token}" }
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.path)
+      request.set_form_data(params)
+      request = Net::HTTP::Get.new(uri.path + '?' + request.body, headers)
+      response = http.request(request).body
+      JSON.parse(response)
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: cep-aberto
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jefferson Felix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Connector for the CEP ABERTO API (www.cepaberto.com). A token is
+  required to use this gem.
+email: jsfelix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- cep-aberto.gemspec
+- lib/cep-aberto.rb
+- lib/cep_aberto/cep.rb
+homepage: https://github.com/jsfelix/cep-aberto
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby Connector for the CEP ABERTO API (www.cepaberto.com). A token is required
+  to use this gem.
+test_files: []