Module: GetAddress

Defined in:
lib/get_address.rb,
lib/get_address/utils.rb,
lib/get_address/errors.rb,
lib/get_address/address.rb,
lib/get_address/version.rb

Defined Under Namespace

Classes: Address, AuthenticationError, GetAddressError, ResourceNotFoundError, Utils

Constant Summary collapse

VERSION = 
'0.1.1'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



15
16
17
 
# File 'lib/get_address.rb', line 15

def api_key
  @api_key
end

.endpoint ⇒ Object

Returns the value of attribute endpoint.



15
16
17
 
# File 'lib/get_address.rb', line 15

def endpoint
  @endpoint
end

Class Method Details

.get_address(postcode, house = '', options = {}) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/get_address.rb', line 19

def self.get_address(postcode, house = '', options = {})
  path = Utils.present?(house) ? "find/#{postcode}/#{house}" : "find/#{postcode}"
  query = options[:sort].nil? ? {} : { sort: options[:sort] }
  GetAddress.request :get, path, query
rescue ResourceNotFoundError => error
  []
end