aus_post_api 1.0.0

data/spec/aus_post_api/pac/postage_letter_international_calculate_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageLetterInternationalCalculate do
+  let(:required_attributes) {
+    {
+      country_code: 'NZ',
+      service_code: 'INTL_SERVICE_AIR_MAIL'
+    }
+  }
+  let(:optional_attributes) {
+    {
+      weight:         100,
+      option_code:    'INTL_SERVICE_OPTION_EXTRA_COVER',
+      suboption_code: 'INTL_SERVICE_OPTION_CONFIRM_DELIVERY',
+      extra_cover:    1000,
+    }
+  }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_letter_international_service_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageLetterInternationalService do
+  let(:required_attributes) {
+    {
+      country_code: 'NZ',
+      weight:       100
+    }
+  }
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_parcel_domestic_calculate_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageParcelDomesticCalculate do
+  let(:required_attributes) do
+    {
+      from_postcode: '2000',
+      to_postcode:   '3000',
+      length:        '10',
+      width:         '10',
+      height:        '10',
+      weight:        '10',
+      service_code:  'AUS_PARCEL_REGULAR'
+    }
+  end
+  let(:optional_attributes) do
+    {
+      option_code:    'AUS_SERVICE_OPTION_SIGNATURE_ON_DELIVERY',
+      suboption_code: 'AUS_SERVICE_OPTION_EXTRA_COVER',
+      extra_cover:    100
+    }
+  end
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_parcel_domestic_service_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageParcelDomesticService do
+  let(:required_attributes) do
+    {
+      from_postcode: '2000',
+      to_postcode:   '3000',
+      length:        '10',
+      width:         '10',
+      height:        '10',
+      weight:        '10'
+    }
+  end
+  let(:optional_attributes) { {} }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_parcel_international_calculate_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::PostageParcelInternationalCalculate do
+  let(:required_attributes) do
+    {
+      country_code:  'NZ',
+      weight:        '10',
+      service_code:  'INTL_SERVICE_EPI'
+    }
+  end
+
+  let(:optional_attributes) { { } }
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac/postage_parcel_international_service_spec.rb

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

data/spec/aus_post_api/pac/postcode_search_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AusPostAPI::PAC::DomesticPostcodeSearch do
+  let(:required_attributes) do
+    {
+      q: 'Melbourne'
+    }
+  end
+  let(:optional_attributes) do
+    {
+      state: 'VIC',
+      excludepostboxflag: 'true'
+    }
+  end
+
+  it_behaves_like 'an endpoint'
+end

data/spec/aus_post_api/pac_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+RSpec.shared_examples_for "a PAC 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::PAC.new(config).send(api_method, params)
+  end
+end
+
+def convert_class_to_method(klass)
+  klass = klass.to_s.gsub(/AusPostAPI::PAC/, '')
+
+  # underscores -> camel case
+  klass
+    .to_s
+    .gsub(/.*::/, '')
+    .split(/(?=[A-Z])/)
+    .map(&:downcase)
+    .join('_')
+end
+
+describe AusPostAPI::PAC do
+  describe "#pac_domestic_postcode_search" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticPostcodeSearch
+  end
+
+  describe "#pac_country" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::Country
+  end
+
+  describe "#pac_domestic_letter_thickness" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticLetterThickness
+  end
+
+  describe "#pac_domestic_letter_weight" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticLetterWeight
+  end
+
+  describe "#pac_domestic_letter_size" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticLetterSize
+  end
+
+  describe "#pac_international_letter_weight" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::InternationalLetterWeight
+  end
+
+  describe "#pac_international_parcel_weight" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::InternationalParcelWeight
+  end
+
+  describe "#pac_domestic_parcel_weight" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticParcelWeight
+  end
+
+  describe "#pac_domestic_parcel_type" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticParcelType
+  end
+
+  describe "#pac_domestic_parcel_size" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::DomesticParcelSize
+  end
+
+  describe "#pac_postage_letter_domestic_service" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageLetterDomesticService
+  end
+
+  describe "#pac_postage_parcel_domestic_service" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageParcelDomesticService
+  end
+
+  describe "#pac_postage_letter_international_service" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageLetterInternationalService
+  end
+
+  describe "#pac_postage_parcel_international_service" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageParcelInternationalService
+  end
+
+  describe "#pac_postage_parcel_domestic_calculate" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageParcelDomesticCalculate
+  end
+
+  describe "#pac_postage_parcel_international_calculate" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageParcelInternationalCalculate
+  end
+
+  describe "#pac_postage_letter_domestic_calculate" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageLetterDomesticCalculate
+  end
+
+  describe "#pac_postage_letter_international_calculate" do
+    it_behaves_like 'a PAC endpoint wrapper', AusPostAPI::PAC::PostageLetterInternationalCalculate
+  end
+end

data/spec/aus_post_api/uri_handler_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../../lib/aus_post_api/uri_handler'
+require 'webmock/rspec'
+
+describe AusPostAPI::UriHandler do
+  it 'should make the call to the uri with the given headers' do
+    stub_request(:get, "https://www.test.com:80/")
+      .with(headers: { test: 'test' })
+      .to_return(status: 200, body: "response", headers: {})
+
+    expect(
+      AusPostAPI::UriHandler.call('http://www.test.com', test: 'test').body
+    ).to eql('response')
+  end
+end

data/spec/shared_examples/shared_examples_for_endpoint_classes.rb

@@ -0,0 +1,37 @@
+RSpec.shared_examples 'an endpoint' do
+  subject { described_class }
+
+  let(:attributes) { required_attributes.merge(optional_attributes) }
+
+  describe "#execute", :vcr do
+    it "should call the api endpoint" do
+      response = JSON.parse(subject.new(attributes, json_config).execute.body)
+      expect(response).to_not      eql(nil)
+      expect(response["error"]).to eql(nil)
+    end
+  end
+
+  describe "Attributes" do
+    context "required" do
+      described_class.required_attributes.each do |attr|
+        it "should raise a required argument error if #{attr} is not given" do
+          attributes.delete(attr)
+          expect { subject.new(attributes, json_config) }.to raise_error(
+            AusPostAPI::Endpoint::RequiredArgumentError
+          )
+        end
+      end
+    end
+
+    context "optional" do
+      described_class.optional_attributes.each do |attr|
+        it "should not raise a required argument error if #{attr} is not given" do
+          optional_attributes.delete(attr)
+          expect {
+            subject.new(attributes.merge(optional_attributes), json_config)
+          }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'vcr'
+require 'json'
+require 'require_all'
+
+require_all 'lib'
+
+Dir[(File.dirname(__dir__)) + "/spec/shared_examples/**/*.rb"].each { |f| require f}
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+end
+
+def config
+  # This uses a live endpoint. The key used is not used in any production
+  # environments. The test endpoint is broken...
+  {
+    TEST: false,
+    USERNAME: "fake",
+    PASSWORD: "fake",
+    PAC_AUTH_KEY: 'f9c917c2-33bf-468b-824a-6739702505f9'
+  }
+end
+
+def dce_config
+  {
+    USERNAME: "fake",
+    PASSWORD: "fake",
+    FORMAT:   'json'
+  }
+end
+
+def json_config
+  config.merge(FORMAT: 'json')
+end
+
+def xml_config
+  config.merge(FORMAT: 'xml')
+end
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: aus_post_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- JaredShay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-16 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper for Australia Post's developer API
+email:
+- jared.shay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aus_post_api.gemspec
+- lib/aus_post_api.rb
+- lib/aus_post_api/dce.rb
+- lib/aus_post_api/dce/endpoint.rb
+- lib/aus_post_api/dce/validate_australian_address.rb
+- lib/aus_post_api/endpoint.rb
+- lib/aus_post_api/endpoint/attributes.rb
+- lib/aus_post_api/pac.rb
+- lib/aus_post_api/pac/country.rb
+- lib/aus_post_api/pac/domestic_letter_size.rb
+- lib/aus_post_api/pac/domestic_letter_thickness.rb
+- lib/aus_post_api/pac/domestic_letter_weight.rb
+- lib/aus_post_api/pac/domestic_parcel_size.rb
+- lib/aus_post_api/pac/domestic_parcel_type.rb
+- lib/aus_post_api/pac/domestic_parcel_weight.rb
+- lib/aus_post_api/pac/domestic_postcode_search.rb
+- lib/aus_post_api/pac/endpoint.rb
+- lib/aus_post_api/pac/international_letter_weight.rb
+- lib/aus_post_api/pac/international_parcel_weight.rb
+- lib/aus_post_api/pac/postage_letter_domestic_calculate.rb
+- lib/aus_post_api/pac/postage_letter_domestic_service.rb
+- lib/aus_post_api/pac/postage_letter_international_calculate.rb
+- lib/aus_post_api/pac/postage_letter_international_service.rb
+- lib/aus_post_api/pac/postage_parcel_domestic_calculate.rb
+- lib/aus_post_api/pac/postage_parcel_domestic_service.rb
+- lib/aus_post_api/pac/postage_parcel_international_calculate.rb
+- lib/aus_post_api/pac/postage_parcel_international_service.rb
+- lib/aus_post_api/uri_handler.rb
+- spec/aus_post_api/dce/endpoint_spec.rb
+- spec/aus_post_api/dce/validate_australian_address_spec.rb
+- spec/aus_post_api/dce_spec.rb
+- spec/aus_post_api/endpoint/attributes_spec.rb
+- spec/aus_post_api/endpoint_spec.rb
+- spec/aus_post_api/pac/country_spec.rb
+- spec/aus_post_api/pac/domestic_letter_size_spec.rb
+- spec/aus_post_api/pac/domestic_letter_thickness_spec.rb
+- spec/aus_post_api/pac/domestic_letter_weight_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_size_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_type_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_weight_spec.rb
+- spec/aus_post_api/pac/endpoint_spec.rb
+- spec/aus_post_api/pac/international_letter_weight_spec.rb
+- spec/aus_post_api/pac/international_parcel_weight_spec.rb
+- spec/aus_post_api/pac/postage_letter_domestic_calculate_spec.rb
+- spec/aus_post_api/pac/postage_letter_domestic_service_spec.rb
+- spec/aus_post_api/pac/postage_letter_international_calculate_spec.rb
+- spec/aus_post_api/pac/postage_letter_international_service_spec.rb
+- spec/aus_post_api/pac/postage_parcel_domestic_calculate_spec.rb
+- spec/aus_post_api/pac/postage_parcel_domestic_service_spec.rb
+- spec/aus_post_api/pac/postage_parcel_international_calculate_spec.rb
+- spec/aus_post_api/pac/postage_parcel_international_service_spec.rb
+- spec/aus_post_api/pac/postcode_search_spec.rb
+- spec/aus_post_api/pac_spec.rb
+- spec/aus_post_api/uri_handler_spec.rb
+- spec/shared_examples/shared_examples_for_endpoint_classes.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jaredshay/aus_post_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: Wrapper for Australia Post's developer API
+test_files:
+- spec/aus_post_api/dce/endpoint_spec.rb
+- spec/aus_post_api/dce/validate_australian_address_spec.rb
+- spec/aus_post_api/dce_spec.rb
+- spec/aus_post_api/endpoint/attributes_spec.rb
+- spec/aus_post_api/endpoint_spec.rb
+- spec/aus_post_api/pac/country_spec.rb
+- spec/aus_post_api/pac/domestic_letter_size_spec.rb
+- spec/aus_post_api/pac/domestic_letter_thickness_spec.rb
+- spec/aus_post_api/pac/domestic_letter_weight_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_size_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_type_spec.rb
+- spec/aus_post_api/pac/domestic_parcel_weight_spec.rb
+- spec/aus_post_api/pac/endpoint_spec.rb
+- spec/aus_post_api/pac/international_letter_weight_spec.rb
+- spec/aus_post_api/pac/international_parcel_weight_spec.rb
+- spec/aus_post_api/pac/postage_letter_domestic_calculate_spec.rb
+- spec/aus_post_api/pac/postage_letter_domestic_service_spec.rb
+- spec/aus_post_api/pac/postage_letter_international_calculate_spec.rb
+- spec/aus_post_api/pac/postage_letter_international_service_spec.rb
+- spec/aus_post_api/pac/postage_parcel_domestic_calculate_spec.rb
+- spec/aus_post_api/pac/postage_parcel_domestic_service_spec.rb
+- spec/aus_post_api/pac/postage_parcel_international_calculate_spec.rb
+- spec/aus_post_api/pac/postage_parcel_international_service_spec.rb
+- spec/aus_post_api/pac/postcode_search_spec.rb
+- spec/aus_post_api/pac_spec.rb
+- spec/aus_post_api/uri_handler_spec.rb
+- spec/shared_examples/shared_examples_for_endpoint_classes.rb
+- spec/spec_helper.rb
+has_rdoc: