Module: Zippopotamus

Extended by:
Zippopotamus
Included in:
Zippopotamus
Defined in:
lib/zippopotamus.rb,
lib/zippopotamus/client.rb,
lib/zippopotamus/version.rb,
lib/zippopotamus/configuration.rb

Overview

Configure

Zippopotamus.configure do |c|
  # enable `use_persistent_connection` to keep the connection alive between subsequent calls
  c.use_persistent_connection = fase # default: true
end

Use

# Lookup US zip codes by default
Zippopotamus.lookup_postcode('90210')

# Specify country by 2 letter code
Zippopotamus.lookup_postcode('01000', 'fr')

Defined Under Namespace

Classes: Client, Configuration, Place

Constant Summary collapse

VERSION = 
"0.2.0"

Instance Method Summary collapse

Instance Method Details

#configure(&block) ⇒ Object 



27
28
29
 
# File 'lib/zippopotamus.rb', line 27

def configure(&block)
  block.call(get_configuration)
end

#lookup_postcode(postcode, country = 'us') ⇒ Zippopotamus::Place Also known as: lookup_zipcode, lookup_postal_code

lookup a postcode for a country and return the place(s) for it

Parameters:

  • postcode (String)
  • country (String) (defaults to: 'us') —

    2 letter country code (default: ‘us’)

Returns:

Raises:

  • if invalid parameters



38
39
40
41
 
# File 'lib/zippopotamus.rb', line 38

def lookup_postcode(postcode, country = 'us')
  @client ||= Zippopotamus::Client.new(get_configuration.use_persistent_connection)
  return @client.lookup_postcode(postcode, country)
end