Class: ParcelApi::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/parcel_api/address.rb

Overview

This module provides API requests to Search Domestic(NZ) Addresses, Get Specific Domestic Address Detail, Search International Addresses and Get Specifc International Address Detail.

Constant Summary collapse

DOMESTIC_URL = 
'/ParcelAddress/2.0/domestic/addresses'
INTERNATIONAL_URL = 
'/ParcelAddress/2.0/international/addresses'

Instance Method Summary collapse

Constructor Details

#initialize(connection = nil) ⇒ Address

Creates a new ParcelApi::Address instance.



12
13
14
 
# File 'lib/parcel_api/address.rb', line 12

def initialize(connection=nil)
  @connection ||= connection || ParcelApi::Client.connection
end

Instance Method Details

#details(address_id)

Return domestic address details for a domestic address id

Parameters:

  • address_id (String)

Returns:

  • address detail object



36
37
38
39
40
 
# File 'lib/parcel_api/address.rb', line 36

def details(address_id)
  details_url = File.join(DOMESTIC_URL, address_id.to_s)
  response = @connection.get details_url
  OpenStruct.new(response.body['address'])
end

#international_details(address_id)

Return international address details for a specific international address id

Parameters:

  • address_id (String)

Returns:

  • international address detail



59
60
61
62
63
 
# File 'lib/parcel_api/address.rb', line 59

def international_details(address_id)
  details_url = File.join(INTERNATIONAL_URL, address_id.to_s)
  response = @connection.get details_url
  RecursiveOpenStruct.new(response.body['result'], recurse_over_arrays: true)
end

#international_search(query, count = 5, country_code = nil) ⇒ Array

Search for an International Address

Parameters:

Returns:

  • (Array) —

    array of international addresses



48
49
50
51
52
53
 
# File 'lib/parcel_api/address.rb', line 48

def international_search(query, count=5, country_code=nil)
  return [] if query.length < 4

  response = @connection.get INTERNATIONAL_URL, { q: query, count: count, country_code: country_code }
  response.body['addresses'].map {|address| OpenStruct.new(address)}
end

#search(query, count = 10) ⇒ Array

Search for a Domestic (NZ) Address

Parameters:

  • characters (String) —

    to search for

  • number (Integer) —

    of search results to return (max 10)

Returns:

  • (Array) —

    array of addresses



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/parcel_api/address.rb', line 21

def search(query, count=10)
  return [] if query.length < 4

  response = @connection.get DOMESTIC_URL, { q: query, count: count }
  addresses = response.body['addresses'].each do |a|
    a['address_id'] = Integer(a['address_id'])
    a['dpid'] = Integer(a['dpid'])
  end
  addresses.map {|address| OpenStruct.new(address)}
end