cep-aberto 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9d4140860329970af79ea89a40fe79302440aeb
-  data.tar.gz: 8e33fbe4e0815c4968027870f1ab3743e988ff38
+  metadata.gz: 881699ff45db088d1ca531edc631fa44c2b27cf1
+  data.tar.gz: 53aad4d89d5b119cec1c06fe9d61364e261f82cb
 SHA512:
-  metadata.gz: 806f68fb463b30f3ff3dfae8a10cbc02e2a9b82ec0d5d48b7e6531994fbf782e63f91347b06f1c56071cbd4e24892c6b34b729d6c64870e343b0e2af1da6da49
-  data.tar.gz: 4b0243428f6aa846dedd999c328d18a9338b7fd09ee81c61fc1a60f526ccbce09369ce0eb6f826a733d37f23e99740149edcaa4540efa5c0af492b7b2617d194
+  metadata.gz: bbd4aed738ffc448585f67739fae79f32ef8e14340f717dd6ab1eca2faf976d7b46fdf227364944e3b00e1ff0c0408f5b02e4a5b7c1096ba47d7451fa5b07d0d
+  data.tar.gz: 7d808af07845d13c62f1f2c6ad9f2759c72180b3ca6afe347114267bfd75636b12deec3afd1e4274a849934acaaad0f67332c336d968ee98c79d4b24e06827d4

data/README.md

@@ -8,7 +8,7 @@ gem 'cep-aberto'
 ```
 And bundle with:
 ```bash
-bundle 
+bundle
 ```
 Or execute manually:
 ```bash
@@ -16,7 +16,8 @@ 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.
+First, you need an authorization token to use this gem. Go to [CEP Aberto](http://www.cepaberto.com/)
+and sign up for free.
 
 ### Find address
 Run:
@@ -39,7 +40,7 @@ This method return a hash with the full address for the zipcode:
  "estado"=>"SP"}
 ```
 
-### List cities 
+### List cities
 To list cities from a given state, do this:
 ```ruby
 require "cep-aberto"
@@ -49,15 +50,32 @@ 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)",
  ...
 ```
+### List cities (including districts)
+To list cities and districts from a state, do this:
+```ruby
+require "cep-aberto"
+CepAberto::Cep::cities_with_districts("SP", "1234567890abcdef01234567890abcde")
+```
+And the result is:
+```ruby
+=> ["Adamantina",
+ "Adolfo",
+ "Agisse (Rancharia)",
+ "Aguaí",
+ "Águas da Prata",
+ "Águas de Lindóia",
+ "Águas de Santa Bárbara",
+ ...
+```
+
+
 
 ## Thanks
 

data/cep-aberto.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'cep-aberto'
-  s.version     = '0.1.2'
-  s.date        = '2017-08-08'
+  s.version     = '0.1.4'
+  s.date        = '2017-08-11'
   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"]
@@ -10,4 +10,4 @@ Gem::Specification.new do |s|
   s.homepage    =
     'https://github.com/jsfelix/cep-aberto'
   s.license       = 'MIT'
-end
+end

data/lib/cep_aberto/cep.rb

@@ -1,18 +1,18 @@
 # Main module CepAberto.
 # Author:: Jefferson Felix
 module CepAberto
-  # This class holds the methods to find zipcodes and address using the CEP 
+  # This class holds the methods to find zipcodes and addresses 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.
+    # Find an address from a zipcode using the CEP Aberto API. <br />
     # Params:
     # +zipcode+:: the zipcode to be searched by CEP Aberto API
     # +token+:: the user authorization token
@@ -28,12 +28,12 @@ module CepAberto
       return address
     end
 
-    # Returns a list of cities from a given state.
+    # Returns a list of cities from a given state, including their districts. <br />
     # 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)
+    def Cep::cities_with_districts(state, token)
       uri = URI("#{@domain}cities.json")
       params = {'estado' => state}
       all_cities = request_cep(uri, params, token)
@@ -43,16 +43,30 @@ module CepAberto
       end
       return cities_arr
     end
-    
+
+    # Returns a list of cities from a given state. This method excludes districts. <br />
+    # 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)
+      all_cities = cities_with_districts(state, token)
+      cities_arr = Array.new
+      all_cities.each do |c|
+        cities_arr.push(c) unless c.end_with?(')')
+      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}" }
@@ -63,6 +77,6 @@ module CepAberto
       response = http.request(request).body
       JSON.parse(response)
     end
-    
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cep-aberto
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Jefferson Felix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-11 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.