aus_post_api 1.0.0

data/spec/aus_post_api/dce/endpoint_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe AusPostAPI::DCE::Endpoint do
+  describe "Implementation" do
+    context "no `api_uri` method is defined" do
+      it "should raise an error" do
+        dce_endpoint = Class.new(AusPostAPI::DCE::Endpoint).new({}, dce_config)
+
+        expect { dce_endpoint.uri }.to(
+          raise_error(AusPostAPI::DCE::Endpoint::ImplementationError)
+        )
+      end
+    end
+
+    context "an `api_uri` method is defined" do
+      it "should not raise an error" do
+        dce_endpoint = Class.new(AusPostAPI::DCE::Endpoint) do
+          def api_uri
+            'api_uri'
+          end
+        end.new({}, dce_config)
+
+        expect { dce_endpoint.uri }.to_not raise_error
+      end
+    end
+  end
+
+  describe "Configuration" do
+    before do
+      stub_const('DCEEndpoint', Class.new(AusPostAPI::DCE::Endpoint) {
+        def api_uri; 'api_uri'; end
+      })
+    end
+
+    describe "Format" do
+      context "no format is provided" do
+        it "should raise an error" do
+          no_format_config = dce_config
+          no_format_config.delete(:FORMAT)
+
+          dce_endpoint = DCEEndpoint.new({}, no_format_config)
+
+          expect { dce_endpoint.uri }.to(
+            raise_error(AusPostAPI::DCE::Endpoint::NoFormatProvidedError)
+          )
+        end
+      end
+
+      context "an invalid format is provided" do
+        it "should raise an error" do
+          dce_endpoint = DCEEndpoint.new({}, dce_config.merge(FORMAT: :invalid))
+
+          expect { dce_endpoint.uri }.to(
+            raise_error(AusPostAPI::DCE::Endpoint::InvalidFormatError)
+          )
+        end
+      end
+    end
+
+    context "no USERNAME is provided" do
+      it "should raise an error" do
+        no_username_config = dce_config
+        no_username_config.delete(:USERNAME)
+
+        dce_endpoint = DCEEndpoint.new({}, no_username_config)
+
+        expect { dce_endpoint.headers }.to(
+          raise_error(AusPostAPI::DCE::Endpoint::NoHeaderProvidedError)
+        )
+      end
+    end
+
+    context "no PASSWORD is provided" do
+      it "should raise an error" do
+        no_password_config = dce_config
+        no_password_config.delete(:PASSWORD)
+
+        dce_endpoint = DCEEndpoint.new({}, no_password_config)
+
+        expect { dce_endpoint.headers }.to(
+          raise_error(AusPostAPI::DCE::Endpoint::NoHeaderProvidedError)
+        )
+      end
+    end
+  end
+end

data/spec/aus_post_api/dce/validate_australian_address_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe AusPostAPI::DCE::ValidateAustralianAddress do
+  skip "There are no test credentials for this endpoint" do
+    let(:required_attributes) {
+      {
+        addressline1: '111',
+        suburb:       "Melbourne",
+        postcode:     "3000",
+        state:        "VIC",
+        country:      "AU"
+      }
+    }
+    let(:optional_attributes) { { addressline2: 'Bourke St' } }
+
+    it_behaves_like 'an endpoint'
+  end
+end

data/spec/aus_post_api/dce_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.shared_examples_for "a DCE endpoint wrapper" do |wrapped_api_class|
+  let(:api_instance) { instance_double(wrapped_api_class) }
+  let(:api_method)   { convert_class_to_method(wrapped_api_class) }
+  let(:params)       { { test: :param } }
+  let(:config)       { { test: :config } }
+
+  it "should call execute on the appropriate api class" do
+    expect(wrapped_api_class).to receive(:new).with(params, config) { api_instance }
+    expect(api_instance).to      receive(:execute)
+
+    AusPostAPI::DCE.new(config).send(api_method, params)
+  end
+end
+
+def convert_class_to_method(klass)
+  klass = klass.to_s.gsub(/AusPostAPI::DCE/, '')
+
+  # underscores -> camel case
+  klass
+    .to_s
+    .gsub(/.*::/, '')
+    .split(/(?=[A-Z])/)
+    .map(&:downcase)
+    .join('_')
+end
+
+describe AusPostAPI::DCE do
+  describe "#validate_australian_address" do
+    it_behaves_like 'a DCE endpoint wrapper', AusPostAPI::DCE::ValidateAustralianAddress
+  end
+end

data/spec/aus_post_api/endpoint/attributes_spec.rb

@@ -0,0 +1,35 @@
+require_relative "../../../lib/aus_post_api/endpoint/attributes"
+
+describe "Including the attributes module on a class" do
+  it "should allow attributes to be specified using the required_attributes method" do
+    test = Class.new do
+      include AusPostAPI::Endpoint::Attributes
+
+      required_attributes :one, :two
+    end.new
+
+    expect(test.required_attributes).to eql([:one, :two])
+
+    test.one = 1
+    test.two = 2
+
+    expect(test.one).to eql(1)
+    expect(test.two).to eql(2)
+  end
+
+  it "should allow attributes to be specified using the optional_attributes method" do
+    test = Class.new do
+      include AusPostAPI::Endpoint::Attributes
+
+      optional_attributes :one, :two
+    end.new
+
+    expect(test.optional_attributes).to eql([:one, :two])
+
+    test.one = 1
+    test.two = 2
+
+    expect(test.one).to eql(1)
+    expect(test.two).to eql(2)
+  end
+end

data/spec/aus_post_api/endpoint_spec.rb

@@ -0,0 +1,43 @@
+require_relative '../../lib/aus_post_api/endpoint'
+
+describe AusPostAPI::Endpoint do
+  before do
+    stub_const "NullUriHandler", Class.new { def self.call(uri, headers); nil; end }
+    stub_const "AusPost::API::Attributes", Module.new
+  end
+
+  describe "#execute" do
+    context "no `uri` or `headers` methods defined" do
+      it "should raise an error" do
+        test = AusPostAPI::Endpoint.new({}, {}, NullUriHandler)
+
+        expect { test.execute }.to raise_error(
+          AusPostAPI::Endpoint::ImplementationError
+        )
+      end
+    end
+
+    context "only the `uri` method defined" do
+      it "should raise an error" do
+        test = AusPostAPI::Endpoint.new({}, {}, NullUriHandler)
+
+        def test.uri; "uri"; end
+
+        expect { test.execute }.to raise_error(
+          AusPostAPI::Endpoint::ImplementationError
+        )
+      end
+    end
+
+    context "both the `uri` and the `headers` method defined" do
+      it "should not raise an error" do
+        test = AusPostAPI::Endpoint.new({}, {}, NullUriHandler)
+
+        def test.uri; "uri"; end
+        def test.headers; "headers"; end
+
+        expect { test.execute }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/aus_post_api/pac/country_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::Country do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_letter_size_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticLetterSize do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_letter_thickness_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticLetterThickness do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_letter_weight_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticLetterWeight do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_parcel_size_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticParcelSize do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_parcel_type_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticParcelType do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/domestic_parcel_weight_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticLetterSize do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/endpoint_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::Endpoint do
+  describe "Implementation" do
+    context "no `api_uri` method is defined" do
+      it "should raise an error" do
+        pac_endpoint = Class.new(AusPostAPI::PAC::Endpoint).new({}, json_config)
+
+        expect { pac_endpoint.uri }.to(
+          raise_error(AusPostAPI::PAC::Endpoint::ImplementationError)
+        )
+      end
+    end
+
+    context "an `api_uri` method is defined" do
+      it "should not raise an error" do
+        pac_endpoint = Class.new(AusPostAPI::PAC::Endpoint) do
+          def api_uri
+            'api_uri'
+          end
+        end.new({}, json_config)
+
+        expect { pac_endpoint.uri }.to_not raise_error
+      end
+    end
+  end
+
+  describe "Configuration" do
+    before do
+      stub_const('PACEndpoint', Class.new(AusPostAPI::PAC::Endpoint) {
+        def api_uri; 'api_uri'; end
+      })
+    end
+
+    context "no format is provided" do
+      it "should raise an error" do
+        no_format_config = json_config
+        no_format_config.delete(:FORMAT)
+
+        pac_endpoint = PACEndpoint.new({}, no_format_config)
+
+        expect { pac_endpoint.uri }.to(
+          raise_error(AusPostAPI::PAC::Endpoint::NoFormatProvidedError)
+        )
+      end
+    end
+
+    context "an invalid format is provided" do
+      it "should raise an error" do
+        pac_endpoint = PACEndpoint.new({}, json_config.merge(FORMAT: :invalid))
+
+        expect { pac_endpoint.uri }.to(
+          raise_error(AusPostAPI::PAC::Endpoint::InvalidFormatError)
+        )
+      end
+    end
+
+    context "no PAC_AUTH_KEY is provided" do
+      context "the TEST config is false" do
+        it "should raise an error" do
+          no_auth_key_config = json_config.merge(TEST: false)
+          no_auth_key_config.delete(:PAC_AUTH_KEY)
+
+          pac_endpoint = PACEndpoint.new({}, no_auth_key_config)
+
+          expect { pac_endpoint.headers }.to(
+            raise_error(AusPostAPI::PAC::Endpoint::NoAuthKeyProvidedError)
+          )
+        end
+      end
+
+      context "the TEST config is true" do
+        it "should not raise an error" do
+          no_auth_key_config = json_config.merge(TEST: true)
+          no_auth_key_config.delete(:PAC_AUTH_KEY)
+
+          pac_endpoint = PACEndpoint.new({}, no_auth_key_config)
+
+          expect { pac_endpoint.headers }.to_not raise_error
+        end
+      end
+    end
+
+    context "a PAC_AUTH_KEY is provided" do
+      context "the TEST config is false" do
+        it "should not raise an error" do
+          no_auth_key_config =
+
+          pac_endpoint = PACEndpoint.new({}, json_config.merge(
+            TEST: false, PAC_AUTH_KEY: :abc
+          ))
+
+          expect { pac_endpoint.headers }.to_not raise_error
+        end
+      end
+
+      context "the TEST config is true" do
+        it "should not raise an error" do
+
+          pac_endpoint = PACEndpoint.new({}, json_config.merge(
+            TEST: true, PAC_AUTH_KEY: :abc
+          ))
+
+          expect { pac_endpoint.headers }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/aus_post_api/pac/international_letter_weight_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::InternationalLetterWeight do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/international_parcel_weight_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::InternationalParcelWeight do
+  let(:required_attributes) { {} }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_letter_domestic_calculate_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageLetterDomesticCalculate do
+  let(:required_attributes) {
+    {
+      service_code: 'AUS_LETTER_REGULAR_LARGE',
+      weight:       100
+    }
+  }
+  let(:optional_attributes) {
+    {
+      option_code:    'AUS_SERVICE_OPTION_REGISTERED_POST',
+      suboption_code: 'AUS_SERVICE_OPTION_DELIVERY_CONFIRMATION',
+      extra_cover:     1000,
+    }
+  }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_letter_domestic_service_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageLetterDomesticService do
+  let(:required_attributes) {
+    {
+      length:    100,
+      width:     100,
+      thickness: 20,
+      weight:    100
+    }
+  }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end