cep_facil 0.0.3 → 0.1.0

data/README.md

@@ -19,27 +19,56 @@ Or via RubyGems, directly:
 
 Usage
 -----
+  
+### Fetching an address by zip code
 
 ```ruby
 require "cep_facil"
-cep = "5417-540"
+cep = "53417-540"
 token = "1234567890" # get yours at cepfacil.com.br
-result = CepFacil.get_address(cep, token)
+address = CepFacil.get_address(cep, token)
 # Returns the address referent to that zip code.
-result[:city]
+address[:city]
 # Returns the city referent to that zip code.
 ```
 
+Alternatively, you can do:
+
+```ruby
+require "cep_facil"
+include CepFacil
+address = get_address cep, token
+```
+
 The response is a Hash object that contains 6 keys: cep, type, state, city, neighborhood, description.
 
-There are three formats for one to store Brazilian zip codes (CEPS):
+There are three formats for one to store Brazilian zip codes (CEPs):
 
-* "12345-678"
-* "12345678"
-* 12345678 # I wouldn't use this one, really.
+```ruby
+"12345-678"
+"12345678"
+12345678   # I wouldn't use this one, really.
+```
 
 CepFácil works with the three of them.
 
+### Displaying an address in full mode
+
+```ruby
+address = CepFacil.get_address(cep, token)
+CepFacil.full address
+```
+
+Or:
+
+````ruby
+require "cep_facil"
+include CepFacil
+
+address = get_address("50050-000", token)
+full(address) # => Rua da Aurora, Boa Vista, Recife-PE, Brasil.
+```
+
 Author
 ------
 

data/lib/cep_facil/version.rb

@@ -1,3 +1,3 @@
 module CepFacil
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/cep_facil.rb

@@ -3,23 +3,33 @@ require "cep_facil/version"
 require "net/http"
 
 module CepFacil
+  
+  module_function
 
   # Receives the zip code (CEP) and the Token (get yours at http://cepfacil.com.br) and
   # returns the address referent to that zip code as a hash object.
   #
-  # == Exemplo 
-  # require "cep_facil"
-  # cep = "5417-540"
-  # token = "1234567890"
-  # address = CepFacil.get_address(cep, token)
-  # address is a hash with 6 keys: cep, type, state, city, neighborhood, description
+  # == Example 
+  #   require "cep_facil"
+  #   cep = "5417-540"
+  #   token = "1234567890"
+  #   address = CepFacil.get_address(cep, token)
+  #
+  # == You can also do:
+  #   require "cep_facil"
+  #   include CepFacil
+  #   get_address cep, token
+  #
+  #   # address is a hash with 6 keys: cep, type, state, city, neighborhood, description
+  #
   # Reading them: 
-  # address[:city]
-  # address[:state]
+  #   address[:city]
+  #   address[:state]
+  #
   # Some applications store Brazilian zip codes (CEPs) in formats like "22222222", or "22222-222"
   # or even as an integer. This method accept these three possible formats so you don´t need to format it yourself.
   
-  def self.get_address(zip_code, token)
+  def get_address(zip_code, token)
     zip_code = zip_code.to_s
     
     if zip_code.match(/^[0-9]{5}[-]?[0-9]{3}/)
@@ -56,12 +66,19 @@ module CepFacil
   end
   
   # Receives and address hash and returns its extense version
-  # = Example
-  # address = CepFacil.get_address "53417-540", "1234456677886545"
-  # CepFacil.full address
-  # => Rua Panelas, Artur Lundgren II, Paulista-PE, Brasil.
-  
-  def self.full(address)
+  # == Example
+  #   address = CepFacil.get_address "53417-540", "1234456677886545"
+  #   CepFacil.full address
+  #   # => Rua Panelas, Artur Lundgren II, Paulista-PE, Brasil.
+  #
+  # == You can also do:
+  #   require "cep_facil"
+  #   include CepFacil
+  #   address = CepFacil.get_address "53417-540", "1234456677886545"
+  #   full address
+   
+  def full(address)
     "#{address[:type]} #{address[:description]}, #{address[:neighborhood]}, #{address[:city]}-#{address[:state]}, Brasil."
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cep_facil
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000 Z
+date: 2012-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70346151186340 !ruby/object:Gem::Requirement
+  requirement: &70307525443140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70346151186340
+  version_requirements: *70307525443140
 description: Wrapper Ruby para o serviço cepfacil.com.br
 email:
 - rodrigo@atela.com.br