parcel_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 796b5726fcf645a3a08bc3f3604571543204838a
+  data.tar.gz: 0aa5d2dec24519e44ac578819d6604a3d86b31df
+SHA512:
+  metadata.gz: a1719f6f35ac57609e2f3e142e82a0ff3e42f43bc29e9fcb40e935e00052e752995afbc19019426c52d3f77bd4b6de3522cad0159068c428e3314ea37cd56682
+  data.tar.gz: 214072e0c14a216fae2947d0faaecf01c1ab4b4c272f1c96c5f8565a13c5cbb6f0f3ad4d02bd8804241e7a97a374ad0edb23f1fc80ec3b97ff438aa9e765f900

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+addons:
+  code_climate:
+    repo_token: 71a1f8fa6b8f4bd0e13542f237fd8f060d4dab088c71e5f980ed6247197d1820

data/.yardopts

@@ -0,0 +1,7 @@
+--readme          README.md
+--markup          markdown
+--default-return  ""
+--hide-void-return
+--protected
+--no-private
+--no-highlight

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parcel_api.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    parcel_api (0.2.0)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      oauth2 (~> 1.0)
+      recursive-open-struct (~> 0.6)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    jwt (1.5.0)
+    method_source (0.8.2)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rake (10.4.2)
+    recursive-open-struct (0.6.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.8)
+  codeclimate-test-reporter
+  parcel_api!
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  vcr (~> 2.9)
+  webmock (~> 1.21)
+  yard (~> 0.8)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robert Coleman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# ParcelApi
+
+[![RubyGem](https://badge.fury.io/rb/parcel_api.svg)](https://rubygems.org/gems/parcel_api)[![Build Status](https://magnum.travis-ci.com/etailer/parcel_api.svg?token=hCq9S5vXdep6iBazZLuu)](https://magnum.travis-ci.com/etailer/parcel_api) [![Code Climate](https://codeclimate.com/repos/552dc72e69568025e8001d73/badges/d0ccddbcdb28ce0d2834/gpa.svg)](https://codeclimate.com/repos/552dc72e69568025e8001d73/feed) [![Test Coverage](https://codeclimate.com/repos/552dc72e69568025e8001d73/badges/d0ccddbcdb28ce0d2834/coverage.svg)](https://codeclimate.com/repos/552dc72e69568025e8001d73/feed)
+
+Ruby wrapper for [NZ Post's Shipping APIs](https://www.nzpost.co.nz/developer-centre#parcel).
+
+You must be a registered user of these APIs to use this gem.
+
+__Features__
+
+* ParcelAddress
+* ShippingOptions
+* ParcelPickUp
+* ParcelLabel
+* ParcelTrack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parcel_api'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install parcel_api`
+
+## Usage
+
+### Configuration Options
+
+By default credentials are taken from the local environment, for this to work the following ENV variables must be set:
+
+* `ENV['CLIENT_ID']`
+* `ENV['CLIENT_SECRET']`
+* `ENV['USERNAME']`
+* `ENV['PASSWORD']`
+
+You can also configure credentials via `ParcelApi::Client.new`:
+
+```ruby
+client = ParcelApi::Client.new.tap do |config|
+  config.client_id     = ENV['CLIENT_ID']
+  config.client_secret = ENV['CLIENT_SECRET']
+  config.username      = ENV['USERNAME']
+  config.password      = ENV['PASSWORD']
+  config.address       = 'https://api.uat.nzpost.co.nz/' # defaults to api.nzpost.co.nz
+end
+```
+
+Client connections can be passed to each method:
+
+`ParcelApi::Address(client.connection)`
+
+## Documentation
+
+Documentation is available [here](http://www.rubydoc.info/github/etailer/parcel_api)
+
+Some usage examples are also available [here](example/mock.rb)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/etailer/parcel_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'parcel_api'
+
+require 'pry'
+Pry.start

data/bin/parcel

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'parcel_api/cli'
+
+ParcelApi::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/mock.rb

@@ -0,0 +1,267 @@
+require 'parcel_api'
+
+# configure the client
+client = ParcelApi::Client.new.tap do |config|
+  config.client_id     = ENV['CLIENT_ID']
+  config.client_secret = ENV['CLIENT_SECRET']
+  config.username      = ENV['USERNAME']
+  config.password      = ENV['PASSWORD']
+  config.address       = 'https://api.uat.nzpost.co.nz/'
+end
+
+
+# Address examples
+
+query = '151 vic'
+address = ParcelApi::Address.new
+# search for the query, 3 results
+results = address.search(query, 3)
+puts "Address Search: #{query}"
+puts "Results:"
+# dump the results out
+puts results.map {|r| r.full_address}
+
+# get details for the first result
+puts 'First Address Details:'
+details = address.details(results.first.address_id)
+
+# dump the detail parts out
+details.to_h.each {|k, v| puts "#{k}: #{v}"}
+
+intl_query = '38 Lap'
+# search for the query, defult number of results
+intl_results = address.international_search(intl_query)
+puts "International Address Search: #{query}"
+puts "Results:"
+puts intl_results.map {|r| r.full_address}
+
+# get details for the first result
+puts 'First International Address Details:'
+intl_details = address.international_details(intl_results.first.address_id)
+
+# dump the detail parts out
+intl_details.to_h.each {|k, v| puts "#{k}: #{v}"}
+
+
+# Tracking Example
+
+tracking = ParcelApi::Track.new
+results = tracking.details('1818120002213401AKL003HN')
+
+# example tracking output
+last_event = results.tracking_events.last
+puts results.carrier
+puts results.service
+puts last_event.event_datetime.to_s + ' ' + last_event.event_description
+
+
+# Labelling example
+
+labeller = ParcelApi::Label.new
+
+# Label options
+cp_label_options = {
+  orientation: 'landscape',
+  requests: [
+    {
+      carrier: 'COURIERPOST',
+      sender_details: {
+        name: 'Glenn Dodd',
+        phone: '0274123456',
+        email: 'glenn@example.co.nz',
+        reference: '654334',
+      },
+      pickup_address: {
+        company: 'Glenns Acme Company',
+        city: 'Auckland',
+        floor: 'Floor 2',
+        postcode: '2102',
+        street: '25 Buller Crescent',
+        suburb: 'Manurewa',
+        unit_type: 'Flat',
+        unit_value: '2',
+      },
+      receiver_details: {
+        name: 'Glenn Dodd',
+        phone: '0274123456',
+      },
+      delivery_address: {
+        company: 'Acme Company',
+        city: 'Auckland',
+        floor: 'Floor 2',
+        postcode: '2102',
+        street: '151 Victoria Street',
+        suburb: 'Manurewa',
+        unit_type: 'Flat',
+        unit_value: '2',
+      },
+      return_indicator: 'NORMAL',
+      delivery_instructions: 'Dont feed my dog tonight',
+      service_code: 'CPOLE',
+      add_ons: [],
+      dimensions: {
+        weight: '10',
+        height: '35',
+        width: '45',
+        length: '15',
+      }
+    }
+  ]
+}
+
+# create the label
+cp = labeller.create(cp_label_options)
+
+# get the label details
+details = labeller.details(cp.label_id)
+
+# Print the tracking references
+details.tracking_reference.map {|tr| puts tr}
+# download the ticket
+cp_ticket = labeller.download(cp.label_id)
+
+# Write the ticket out
+File.open("#{cp.label_id}.pdf", 'w') do |f|
+  f.puts(cp_ticket.read)
+end
+
+# International Labelling Example
+
+intl_labeller = ParcelApi::Label.new
+
+# Label options
+intl_label_options = {
+  requests: [
+    {
+      sender_details: {
+        name: 'The sender',
+        phone: '091428774',
+        email: 'the_sender@mail.com',
+        reference: 'Glqddd 008',
+        signatory: 'Mary Jones',
+        customs_code: 'HGD34373',
+      },
+      pickup_address: {
+        building: '',
+        company: 'Express Courier Limited',
+        street: '151 Victoria Street West',
+        suburb: 'Auckland Central',
+        city: 'Auckland',
+        country_code: 'NZ',
+        postcode: '1070',
+      },
+      receiver_details: {
+        name: 'Tom Smith',
+        phone: '051236547',
+        vat_number: 'GB123123123123',
+      },
+      delivery_address: {
+        building: '',
+        company: 'American Express',
+        street: '23 Broadway Street',
+        suburb: 'Queens',
+        city: 'New York',
+        postcode: '4414',
+        country_code: 'US',
+        state: 'New York',
+      },
+      delivery_instructions: 'Leave at door',
+      dimensions: {
+        length: 600,
+        width: 100,
+        height: 200
+      },
+      undeliverable_instructions: 'RETURN',
+      contents: [
+        {
+          unit_description: 'Light bulbs',
+          unit_count: 2,
+          unit_value: 5.1,
+          unit_weight: 0.5,
+        },
+        {
+          unit_description: 'Lego',
+          unit_count: 10,
+          unit_value: 6.1,
+          unit_weight: 0.6,
+        },
+        {
+          unit_description: 'Hot wheels',
+          unit_count: 13,
+          unit_value: 5.4,
+          unit_weight: 0.8,
+        }
+      ],
+      service_code: 'TIEX',
+      indicia_number: '123456',
+      insurance_required: true,
+      contains_only_documents: true,
+      export_type: 'Gift',
+      harmonised_system_tariff: '12121212'
+    }
+  ]
+}
+
+# create the label
+intl = intl_labeller.international_create(intl_label_options)
+
+# get the label details
+intl_details = intl_labeller.details(intl.label_id)
+
+# Print the tracking references
+intl_details.tracking_reference.map {|tr| puts tr}
+# download the ticket
+intl_ticket = intl_labeller.download(intl.label_id)
+
+# Write the ticket out
+File.open("#{intl.label_id}.pdf", 'w') do |f|
+  f.puts(intl_ticket.read)
+end
+
+
+ShippingOptions Example
+
+shipping_options = ParcelApi::ShippingOptions.new
+
+params = {
+  weight: 10,
+  length: 10,
+  width: 10,
+  height: 10,
+  pickup_address_id: 990003,
+  delivery_dpid: 2727895,
+}
+
+domestic_options = shipping_options.get_domestic(params)
+domestic_options.to_h.each {|k, v| puts "#{k}: #{v}"}
+
+intl_params = {
+  value: 100,
+  length: 10,
+  height: 10,
+  width: 10,
+  weight: 13,
+  country_code: 'AU',
+}
+
+intl_options = shipping_options.get_international(intl_params)
+intl_options.to_h.each {|k, v| puts "#{k}: #{v}"}
+
+# Pickup Example
+
+pickup_params = {
+  carrier: 'CourierPost',
+  message_id: 'Test Message ID',
+  message_date_time: '2015-05-27T14:19:50',
+  account_number: '91327067',
+  pickup_address: {
+    site_code: '28979',
+    instructions: 'TEST'
+  },
+  pickup_date_time: '2015-05-28T17:00:00',
+  quantity: 1
+}
+
+pickup = ParcelApi::Pickup.new(client.connection) # use a custom connection
+pickup_results = pickup.create(pickup_params)
+pickup_results.to_h.each {|k, v| puts "#{k}: #{v}"}

data/lib/parcel_api/address.rb

@@ -0,0 +1,66 @@
+module ParcelApi
+
+  # This module provides API requests to Search Domestic(NZ) Addresses, Get Specific Domestic Address Detail,
+  # Search International Addresses and Get Specifc International Address Detail.
+
+  class Address
+    DOMESTIC_URL = '/ParcelAddress/2.0/domestic/addresses'
+    INTERNATIONAL_URL = '/ParcelAddress/2.0/international/addresses'
+
+    # Creates a new ParcelApi::Address instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Search for a Domestic (NZ) Address
+    # @param [String] characters to search for
+    # @param [Integer] number of search results to return (max 10)
+    # @return [Array] array of addresses
+
+    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
+
+    # Return domestic address details for a domestic address id
+    # @param address_id [String]
+    # @return address detail object
+
+    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
+
+    # Search for an International Address
+    # @param [String] characters to search for
+    # @param [Integer] number of search results to return (max 10)
+    # @param [String] country code for results - listed here: https://developers.google.com/public-data/docs/canonical/countries_csv/
+    # @return [Array] array of international addresses
+
+    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
+
+    # Return international address details for a specific international address id
+    # @param address_id [String]
+    # @return international address detail
+
+    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
+
+  end
+end

data/lib/parcel_api/cli.rb

@@ -0,0 +1,10 @@
+require 'thor'
+
+module ParcelApi
+  class CLI < Thor
+    desc 'version', 'print version'
+    def version
+      puts "Version: #{ParcelApi::VERSION}"
+    end
+  end
+end

data/lib/parcel_api/client.rb

@@ -0,0 +1,59 @@
+module ParcelApi
+  class Client
+
+    attr_accessor :client_id,
+      :client_secret,
+      :username,
+      :password,
+      :address,
+      :auth_address
+
+    def self.connection
+      @connection ||= new.connection
+    end
+
+    def initialize
+      @client_id     = client_id     || ENV['CLIENT_ID']
+      @client_secret = client_secret || ENV['CLIENT_SECRET']
+      @username      = username      || ENV['USERNAME']
+      @password      = password      || ENV['PASSWORD']
+      @address       = address       || 'https://api.nzpost.co.nz'
+      @auth_address  = auth_address  || 'https://oauth.nzpost.co.nz/as/token.oauth2'
+    end
+
+    def connection
+      Faraday.new(url: @address) do |conn|
+        conn.authorization 'Bearer', token
+        conn.headers['client_id'] = @client_id
+        conn.request  :json
+        conn.response :json,  :content_type => /\bjson$/
+        conn.use      FaradayMiddleware::RaiseHttpException
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def token
+      @token ||= begin
+        params = {
+          client_id:     @client_id,
+          client_secret: @client_secret,
+          username:      @username,
+          password:      @password,
+          grant_type:    'password',
+        }
+
+        auth_api = Faraday.new do |conn|
+          conn.request  :url_encoded
+          conn.response :json
+          conn.use      FaradayMiddleware::RaiseHttpException
+          conn.adapter  Faraday.default_adapter
+        end
+        response = auth_api.post @auth_address, params
+        response.body['access_token']
+      end
+    end
+
+  end
+end

data/lib/parcel_api/error.rb

@@ -0,0 +1,80 @@
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise ParcelApi::BadRequest, error_message_400(response)
+        when 404
+          raise ParcelApi::NotFound, error_message_400(response)
+        when 500
+          raise ParcelApi::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 502
+          raise ParcelApi::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+        when 503
+          raise ParcelApi::ServiceUnavailable, error_message_500(response, "NZ Post is rate limiting your requests.")
+        when 504
+          raise ParcelApi::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s} status: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        body = ::JSON.parse(body)
+      end
+
+      if body.nil? || body['errors'].nil?
+        nil
+      else
+        body_errors = body['errors'].flat_map {|error| error.map {|k,v| "#{k}: #{v}" }}.compact.join(', ')
+        " - #{body_errors}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s} status: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end
+
+module ParcelApi
+  # Custom error class for rescuing from all NZ Post errors
+  class Error < StandardError; end
+
+  # Raised when NZ Post returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when NZ Post returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+end

data/lib/parcel_api/label.rb

@@ -0,0 +1,60 @@
+module ParcelApi
+
+  # This module provides API requests to label parcels, get existing label details
+  # and download labels.
+
+  class Label
+    LABEL_URL = '/ParcelLabel/2.0/labels'
+
+    # Creates a new ParcelApi::Label instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Create a label with the specified options
+    # @param label_options [Hash]
+    # @return Single or array of label objects
+
+    def create(label_options)
+      domestic_url = File.join(LABEL_URL, 'domestic')
+      response = @connection.post domestic_url, label_options
+      labels = response.body['labels'].map {|label| OpenStruct.new(label)}
+      labels.first if labels.count == 1
+    end
+
+    # Create an international label with the specified options
+    # @param label_options [Hash]
+    # @return Single or array of label objects
+
+    def international_create(label_options)
+      international_url = File.join(LABEL_URL, 'international')
+      response = @connection.post international_url, label_options
+      labels = response.body['labels'].map {|label| OpenStruct.new(label)}
+      labels.first if labels.count == 1
+    end
+
+    # Get label details
+    # @param label_id [String]
+    # @return Object of label details
+
+    def details(label_id)
+      details_url = File.join(LABEL_URL, "#{label_id}.json")
+      response = @connection.get details_url
+      details = response.body.tap {|d| d.delete('success')}
+      OpenStruct.new(details)
+    end
+
+    # Download label
+    # @param label_id [String]
+    # @return Object of label
+
+    def download(label_id)
+      download_url = File.join(LABEL_URL, "#{label_id}.pdf")
+      response = @connection.get download_url
+      StringIO.new(response.body)
+    end
+
+  end
+
+end

data/lib/parcel_api/pickup.rb

@@ -0,0 +1,26 @@
+module ParcelApi
+
+  # The ParcelPickUp API that notifies PACE or CourierPost to come and pick up your parcel.
+  # The integrator provides the pick up location in the form of a site id or an address to create the pick up record.
+
+  class Pickup
+    PARCELPICKUP_URL = '/ParcelPickUp/2.0/bookings'
+
+    # Creates a new ParcelApi::Pickup instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Create a new parcel booking
+    # @param pickup_options [Hash]
+    # @return Object of pickup details
+
+    def create(pickup_options)
+      response = @connection.post PARCELPICKUP_URL, pickup_options
+      RecursiveOpenStruct.new(response.body, recurse_over_arrays: true)
+    end
+
+  end
+
+end

data/lib/parcel_api/shipping_options.rb

@@ -0,0 +1,44 @@
+module ParcelApi
+
+  # Returns the shipping options and rates available depending on customer,
+  # pick up and destination addresses and parcel dimensions and weight.
+  # Both domestic and international.
+
+  class ShippingOptions
+    DOMESTIC_URL = '/ShippingOptions/2.0/domestic'
+    INTERNATIONAL_URL = '/ShippingOptions/2.0/international'
+
+    # Creates a new ParcelApi::ShippingOptions instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Search for Domestic (NZ) Shipping Options
+    # @param parcel_params [Hash] parcel parameters
+    # @return [Array] return array of shipping options
+
+    def get_domestic(parcel_params)
+      response = @connection.get DOMESTIC_URL, parcel_params
+      options = response.body.tap do |so|
+        so.delete('success')
+        so.delete('message_id')
+      end
+      RecursiveOpenStruct.new(options, recurse_over_arrays: true)
+    end
+
+    # Search for International Shipping Options
+    # @param parcel_params [Hash] parcel parameters
+    # @return [Array] return array of shipping options
+
+    def get_international(parcel_params)
+      response = @connection.get INTERNATIONAL_URL, parcel_params
+      options = response.body.tap do |so|
+        so.delete('success')
+        so.delete('message_id')
+      end
+      RecursiveOpenStruct.new(options, recurse_over_arrays: true)
+    end
+
+  end
+end

data/lib/parcel_api/track.rb

@@ -0,0 +1,32 @@
+module ParcelApi
+
+  # This module provides API requests to track the parcels and
+  # return tracking information for a specific tracking reference.
+
+  class Track
+    PARCELTRACK_URL = '/ParcelTrack/2.0/parcels'
+
+    # Creates a new ParcelApi::Track instance.
+
+    def initialize(connection=nil)
+      @connection ||= connection || ParcelApi::Client.connection
+    end
+
+    # Return details for a specific tracking reference.
+    # @param tracking_reference [String]
+    # @return Object of tracking details
+
+    def details(tracking_reference)
+      details_url = File.join(PARCELTRACK_URL, tracking_reference.to_s)
+      response = @connection.get details_url
+      events = response.body.tap do |d|
+        d.delete('success')
+        d['tracking_events'].map {|e| e['event_datetime'] = Time.parse(e['event_datetime'])}
+        d['tracking_events'].sort_by! {|k| k['event_datetime'].to_i}
+      end
+      RecursiveOpenStruct.new(events, recurse_over_arrays: true)
+    end
+
+  end
+
+end

data/lib/parcel_api/version.rb

@@ -0,0 +1,3 @@
+module ParcelApi
+  VERSION = '0.2.0'
+end

data/lib/parcel_api.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'recursive-open-struct'
+
+require 'parcel_api/version'
+require 'parcel_api/error'
+require 'parcel_api/address'
+require 'parcel_api/track'
+require 'parcel_api/label'
+require 'parcel_api/shipping_options'
+require 'parcel_api/pickup'
+require 'parcel_api/client'
+
+module ParcelApi; end

data/parcel_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parcel_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'parcel_api'
+  spec.version       = ParcelApi::VERSION
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+
+  spec.summary       = %q{Ruby client for NZ Post's Parcel APIs}
+  spec.homepage      = 'https://github.com/etailer/parcel_api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'oauth2', '~> 1.0'
+  spec.add_dependency 'recursive-open-struct', '~> 0.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: parcel_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/parcel
+- bin/setup
+- example/mock.rb
+- lib/parcel_api.rb
+- lib/parcel_api/address.rb
+- lib/parcel_api/cli.rb
+- lib/parcel_api/client.rb
+- lib/parcel_api/error.rb
+- lib/parcel_api/label.rb
+- lib/parcel_api/pickup.rb
+- lib/parcel_api/shipping_options.rb
+- lib/parcel_api/track.rb
+- lib/parcel_api/version.rb
+- parcel_api.gemspec
+homepage: https://github.com/etailer/parcel_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for NZ Post's Parcel APIs
+test_files: []
+has_rdoc: