aus_post_api 1.0.0

data/lib/aus_post_api/endpoint/attributes.rb

@@ -0,0 +1,54 @@
+module AusPostAPI
+  class Endpoint
+    # The attributes module adds a class level DSL that allows required and
+    # optional attributes to be set using the same interface as `attr_accessor`
+    #
+    # eg.
+    #     class Example
+    #       include Attributes
+    #
+    #       required_attributes :one, :two
+    #       optional_attributes :three
+    #     end
+    #
+    # Additionally it adds two instance methods: `required_attributes` &
+    # `optional_attributes` that return an array of attributes specified by the
+    # two methods.
+    module Attributes
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+    end
+
+    module ClassMethods
+      def required_attributes(*args)
+        if args.empty?
+          @required_attributes || []
+        else
+          @required_attributes = args
+          self.send(:attr_accessor, *args)
+        end
+      end
+
+      def optional_attributes(*args)
+        if args.empty?
+          @optional_attributes || []
+        else
+          @optional_attributes = args
+          self.send(:attr_accessor, *args)
+        end
+      end
+    end
+
+    module InstanceMethods
+      def required_attributes
+        self.class.required_attributes
+      end
+
+      def optional_attributes
+        self.class.optional_attributes
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac.rb

@@ -0,0 +1,83 @@
+module AusPostAPI
+  # The PAC class implements methods specified by the Australia Post Postage
+  # Assessment Calculator. A config hash must be supplied that specifies a valid
+  # PAC_AUTH_KEY, and request format. Setting the key TEST to true in the config
+  # hash will ignore any supplied auth_key and use the test endpoint.
+  class PAC
+    def initialize(config)
+      @config = config
+    end
+
+    def domestic_postcode_search(params = {})
+      AusPostAPI::PAC::DomesticPostcodeSearch.new(params, @config).execute
+    end
+
+    def country(params = {})
+      AusPostAPI::PAC::Country.new(params, @config).execute
+    end
+
+    def domestic_letter_thickness(params = {})
+      AusPostAPI::PAC::DomesticLetterThickness.new(params, @config).execute
+    end
+
+    def domestic_letter_weight(params = {})
+      AusPostAPI::PAC::DomesticLetterWeight.new(params, @config).execute
+    end
+
+    def domestic_letter_size(params = {})
+      AusPostAPI::PAC::DomesticLetterSize.new(params, @config).execute
+    end
+
+    def international_letter_weight(params = {})
+      AusPostAPI::PAC::InternationalLetterWeight.new(params, @config).execute
+    end
+
+    def international_parcel_weight(params = {})
+      AusPostAPI::PAC::InternationalParcelWeight.new(params, @config).execute
+    end
+
+    def domestic_parcel_weight(params = {})
+      AusPostAPI::PAC::DomesticParcelWeight.new(params, @config).execute
+    end
+
+    def domestic_parcel_type(params = {})
+      AusPostAPI::PAC::DomesticParcelType.new(params, @config).execute
+    end
+
+    def domestic_parcel_size(params = {})
+      AusPostAPI::PAC::DomesticParcelSize.new(params, @config).execute
+    end
+
+    def postage_letter_domestic_service(params = {})
+      AusPostAPI::PAC::PostageLetterDomesticService.new(params, @config).execute
+    end
+
+    def postage_parcel_domestic_service(params = {})
+      AusPostAPI::PAC::PostageParcelDomesticService.new(params, @config).execute
+    end
+
+    def postage_letter_international_service(params = {})
+      AusPostAPI::PAC::PostageLetterInternationalService.new(params, @config).execute
+    end
+
+    def postage_parcel_international_service(params = {})
+      AusPostAPI::PAC::PostageParcelInternationalService.new(params, @config).execute
+    end
+
+    def postage_parcel_domestic_calculate(params = {})
+      AusPostAPI::PAC::PostageParcelDomesticCalculate.new(params, @config).execute
+    end
+
+    def postage_parcel_international_calculate(params = {})
+      AusPostAPI::PAC::PostageParcelInternationalCalculate.new(params, @config).execute
+    end
+
+    def postage_letter_domestic_calculate(params = {})
+      AusPostAPI::PAC::PostageLetterDomesticCalculate.new(params, @config).execute
+    end
+
+    def postage_letter_international_calculate(params = {})
+      AusPostAPI::PAC::PostageLetterInternationalCalculate.new(params, @config).execute
+    end
+  end
+end

data/lib/aus_post_api/pac/country.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class Country < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/country"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_letter_size.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticLetterSize < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/letter/domestic/size"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_letter_thickness.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticLetterThickness < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/letter/domestic/thickness"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_letter_weight.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticLetterWeight < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/letter/domestic/weight"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_parcel_size.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticParcelSize < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/parcel/domestic/size"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_parcel_type.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticParcelType < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/parcel/domestic/type"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_parcel_weight.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class DomesticParcelWeight < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/parcel/domestic/weight"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/domestic_postcode_search.rb

@@ -0,0 +1,12 @@
+module AusPostAPI
+  class PAC
+    class DomesticPostcodeSearch < AusPostAPI::PAC::Endpoint
+      required_attributes :q
+      optional_attributes :state, :excludepostboxflag
+
+      def api_uri
+        "postcode/search"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/endpoint.rb

@@ -0,0 +1,76 @@
+module AusPostAPI
+  class PAC
+    # Abstract class that defines a PAC::Endpoint. It implements the `uri` &
+    # `headers` methods and expects the `api_uri` method to be implemented.
+    class Endpoint < AusPostAPI::Endpoint
+      LIVE_URI = 'https://auspost.com.au/api'
+      TEST_URI = 'https://test.npe.auspost.com.au'
+      TEST_KEY = '28744ed5982391881611cca6cf5c240'
+      FORMATS  = ['json', 'xml']
+
+      def uri
+        "#{base_uri}/#{api_uri}.#{format}?#{params}"
+      end
+
+      def headers
+        { "AUTH-KEY" => @config[:TEST] ? TEST_KEY : auth_key }
+      end
+
+      private
+
+      def api_uri
+        raise ImplementationError.new('api_uri')
+      end
+
+      def base_uri
+        @config[:TEST] ? TEST_URI : LIVE_URI
+      end
+
+      def format
+        if @config[:FORMAT].nil?
+          raise NoFormatProvidedError
+        else
+          if !FORMATS.include?(@config[:FORMAT])
+            raise InvalidFormatError
+          else
+            @config[:FORMAT]
+          end
+        end
+      end
+
+      def params
+        [].tap { |result|
+          @attributes.keys.each { |a| result << "#{a}=#{self.send(a)}" }
+        }.join('&')
+      end
+
+      def auth_key
+        if @config[:PAC_AUTH_KEY].nil? && !@config[:TEST]
+          raise NoAuthKeyProvidedError
+        end
+
+        @config[:PAC_AUTH_KEY]
+      end
+
+      class NoAuthKeyProvidedError < StandardError
+        def initialize
+          super("The called endpoint requires the PAC_AUTH_KEY to be set")
+        end
+      end
+
+      class InvalidFormatError < StandardError
+        def initialize
+          super("Accepted formats are: #{AusPostAPI::PAC::Endpoint::FORMATS.join(', ')}")
+        end
+      end
+
+      class NoFormatProvidedError < InvalidFormatError; end
+
+      class ImplementationError < StandardError
+        def initialize(method)
+          super("No #{method} implemented")
+        end
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/international_letter_weight.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class InternationalLetterWeight < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/letter/international/weight"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/international_parcel_weight.rb

@@ -0,0 +1,9 @@
+module AusPostAPI
+  class PAC
+    class InternationalParcelWeight < AusPostAPI::PAC::Endpoint
+      def api_uri
+        "postage/parcel/international/weight"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_letter_domestic_calculate.rb

@@ -0,0 +1,12 @@
+module AusPostAPI
+  class PAC
+    class PostageLetterDomesticCalculate < AusPostAPI::PAC::Endpoint
+      required_attributes :service_code, :weight
+      optional_attributes :option_code, :suboption_code, :extra_cover
+
+      def api_uri
+        "postage/letter/domestic/calculate"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_letter_domestic_service.rb

@@ -0,0 +1,11 @@
+module AusPostAPI
+  class PAC
+    class PostageLetterDomesticService < AusPostAPI::PAC::Endpoint
+      required_attributes :length, :width, :thickness, :weight
+
+      def api_uri
+        "postage/letter/domestic/service"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_letter_international_calculate.rb

@@ -0,0 +1,12 @@
+module AusPostAPI
+  class PAC
+    class PostageLetterInternationalCalculate < AusPostAPI::PAC::Endpoint
+      required_attributes :country_code, :service_code
+      optional_attributes :weight, :option_code, :suboption_code, :extra_cover
+
+      def api_uri
+        "postage/letter/international/calculate"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_letter_international_service.rb

@@ -0,0 +1,11 @@
+module AusPostAPI
+  class PAC
+    class PostageLetterInternationalService < AusPostAPI::PAC::Endpoint
+      required_attributes :country_code, :weight
+
+      def api_uri
+        "postage/letter/international/service"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_parcel_domestic_calculate.rb

@@ -0,0 +1,13 @@
+module AusPostAPI
+  class PAC
+    class PostageParcelDomesticCalculate < AusPostAPI::PAC::Endpoint
+      required_attributes :from_postcode, :to_postcode, :length, :width,
+        :height, :weight, :service_code
+      optional_attributes :option_code, :suboption_code, :extra_cover
+
+      def api_uri
+        "postage/parcel/domestic/calculate"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_parcel_domestic_service.rb

@@ -0,0 +1,12 @@
+module AusPostAPI
+  class PAC
+    class PostageParcelDomesticService < AusPostAPI::PAC::Endpoint
+      required_attributes :from_postcode, :to_postcode, :length, :width, :height,
+        :weight
+
+      def api_uri
+        "postage/parcel/domestic/service"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_parcel_international_calculate.rb

@@ -0,0 +1,12 @@
+module AusPostAPI
+  class PAC
+    class PostageParcelInternationalCalculate < AusPostAPI::PAC::Endpoint
+      required_attributes :country_code, :weight, :service_code
+      optional_attributes :option_code, :suboption_code, :extra_cover
+
+      def api_uri
+        "postage/parcel/international/calculate"
+      end
+    end
+  end
+end

data/lib/aus_post_api/pac/postage_parcel_international_service.rb

@@ -0,0 +1,11 @@
+module AusPostAPI
+  class PAC
+    class PostageParcelInternationalService < AusPostAPI::PAC::Endpoint
+      required_attributes :country_code, :weight
+
+      def api_uri
+        "postage/parcel/international/service"
+      end
+    end
+  end
+end

data/lib/aus_post_api/uri_handler.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+
+# The UriHandler class is wrapper around a http technology. It takes a uri and
+# a hash of header key values pairs and makes a http request.
+module AusPostAPI
+  class UriHandler
+    def self.call(uri, headers={})
+      self.new(uri, headers).call
+    end
+
+    def initialize(uri, headers)
+      @headers = headers
+      @uri     = URI.parse(uri)
+    end
+
+    def call
+      http.request(request)
+    end
+
+    private
+
+    def http
+      @http ||= Net::HTTP.new(@uri.host, @uri.port).tap do |h|
+        h.use_ssl     = true
+        h.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def request
+      @request ||= Net::HTTP::Get.new(@uri).tap do |r|
+        @headers.each { |key, val| r.add_field(key, val) }
+      end
+    end
+  end
+end