Module: IdealPostcodes

Defined in:
lib/idealpostcodes.rb,
lib/idealpostcodes/util.rb,
lib/idealpostcodes/errors.rb,
lib/idealpostcodes/version.rb,
lib/idealpostcodes/postcode.rb

Defined Under Namespace

Classes: AuthenticationError, IdealPostcodesError, LimitReachedError, Postcode, ResourceNotFoundError, TokenExhaustedError, Util

Constant Summary collapse

VERSION = 
'0.1.0'

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/idealpostcodes.rb', line 15

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



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

def base_url
  @base_url
end

.version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.request(method, path, params = {}) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/idealpostcodes.rb', line 18

def self.request(method, path, params = {})
	unless @api_key
		raise IdealPostcodes::AuthenticationError.new('No API Key provided. ' +
			'Set your key with IdealPostcodes.api_key = #your_key')
	end

	url = URI.parse(resource_url(path))
	params.merge! api_key: @api_key
	url.query = Util.merge_params(params)
	request_options = {
		method: method.downcase.to_sym,
		url: url.to_s
	}

	begin
		response = generate_request(request_options)
	rescue RestClient::ExceptionWithResponse => error
		if rcode = error.http_code && rbody = error.http_body
			handle_error(rcode, rbody)
		else
			handle_client_error(error)
		end
	rescue RestClient::Exception, Errno::ECONNREFUSED => error
		handle_client_error(e)
	end
	parse response.body
end