purolator_ruby 0.0.6 → 0.0.7

data/spec/purolator_ruby/integration/create_shipment_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "Integration create shipment" do
+
+  before { setup_env }
+
+  let(:client) { PurolatorRuby::Client.new }
+
+  context "valid payload" do
+
+    let(:payload) do
+      {
+        sender_address: sender_address,
+        receiver_address: receiver_address,
+        shipping_date: Date.today,
+        weight: '10',
+        pieces: 1,
+        reference: 'ref 45'
+      }
+    end
+
+    it "succesfully communicates with ShippingService and returns shipment pin" do
+      VCR.use_cassette('shipping_service_integration') do
+        response = client.call(:create_shipment, payload)
+        expect(response.shipment_pin).to eq('329018602238')
+        expect(response.status).to eq(:ok)
+      end
+    end
+
+  end
+
+  context "invalid payload" do
+    let(:payload) do
+      {
+        sender_address: sender_address,
+        receiver_address: receiver_address,
+        shipping_date: Date.new(2014, 01, 01),
+        weight: '10',
+        pieces: 1,
+        reference: '12'
+      }
+    end
+
+
+    it "has status error" do
+      VCR.use_cassette('shipping_service_integration_2') do
+        response = client.call(:create_shipment, payload)
+        expect(response.status).to eq(:error)
+      end
+    end
+  end
+
+end

data/spec/purolator_ruby/integration/get_documents_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Get Documents integration" do
+
+  before { setup_env }
+
+  let(:client) { PurolatorRuby::Client.new }
+
+  context "valid payload" do
+
+    let(:payload) do
+      {
+        pin: '42',
+        document_type: 'DomesticBillOfLading'
+      }
+    end
+
+    it "gets document url" do
+      VCR.use_cassette('get_documents') do
+        response = client.call(:get_documents, payload)
+
+        expect(response.status).to eq(:ok)
+        expect(response.url).to eq('https://eshiponline.purolator.com/ShipOnline/shipment/getLabel.ashx?TEMP_TYPE=STUB&REPORT_NAME=GenericDummyReport.pdf&REPORT_NAME=GenericDummyReport.pdf')
+      end
+    end
+
+  end
+
+end

data/spec/purolator_ruby/integration/validate_address_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "Integration Validate Address" do
+
+  before { setup_env }
+
+  let(:client) { PurolatorRuby::Client.new }
+
+  context "valid payload" do
+
+    let(:payload) do
+      {
+        city: 'Ottawa',
+        province: 'ON',
+        country: 'CA',
+        postal_code: 'K1Y 0M5',
+       }
+    end
+
+    it "validates address" do
+      VCR.use_cassette('validate_address') do
+        response = client.call(:validate_city_postal_code_zip, payload)
+
+        expect(response.status).to eq(:ok)
+        expect(response.valid?).to eq(true)
+      end
+    end
+
+  end
+
+  context "invalid payload" do
+    let(:payload) do
+      {
+        city: 'Berlin',
+        province: 'ON',
+        country: 'CA',
+        postal_code: '1'
+      }
+    end
+
+    it "validates address" do
+      VCR.use_cassette('validate_address_invalid') do
+        response = client.call(:validate_city_postal_code_zip, payload)
+
+        expect(response.valid?).to eq(false)
+      end
+    end
+
+  end
+
+end

data/spec/purolator_ruby/validate_city_postal_code_zip_payload_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PurolatorRuby::ValidateCityPostalCodeZipPayload do
+
+  let(:payload) do
+    {
+      city: 'Ottawa',
+      province: 'ON',
+      postal_code: 'K1Y 0M5',
+      country: 'CA'
+    }
+  end
+
+  subject { described_class.new(payload) }
+
+  it "has a to_h method" do
+    expect(subject.to_h).to eq(
+      {
+        'Addresses' => {
+          'ShortAddress' => {
+            'City' => 'Ottawa',
+            'Province' => 'ON',
+            'PostalCode' => 'K1Y 0M5',
+            'Country' => 'CA'
+          }
+        }
+      }
+    )
+  end
+
+end

data/spec/purolator_ruby/wsdl_location_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe PurolatorRuby::WsdlLocation do
+
+  let(:test_root) { File.expand_path(File.join(File.dirname(__FILE__), '..')) }
+  let(:credentials) { double(wsdl_location: test_root, soap_header_v15: 'v15', soap_header_v13: 'v13') }
+
+  subject { described_class.new(credentials: credentials) }
+
+  it "can tell location for wsdl based on method" do
+    expect(subject.location_for(:create_shipment))
+      .to eq(File.join(test_root, 'ShippingService.wsdl'))
+  end
+
+  it "can tell location for validation service" do
+    expect(subject.location_for(:validate_city_postal_code_zip))
+      .to eq(File.join(test_root, 'ServiceAvailabilityService.wsdl'))
+  end
+
+  it "can tell soap_header for create shipment" do
+    expect(subject.soap_header_for(:create_shipment)).to eq('v15')
+  end
+
+  it "can tell soap_header for validation service" do
+    expect(subject.soap_header_for(:validate_city_postal_code_zip)).to eq('v13')
+  end
+
+  it "can tell location for get_documents service" do
+    expect(subject.location_for(:get_documents))
+      .to eq(File.join(test_root, 'ShippingDocumentsService.wsdl'))
+  end
+
+  it "can tell soap_header for get_documents service" do
+    expect(subject.soap_header_for(:get_documents)).to eq('v13')
+  end
+
+end

data/spec/spec_helper.rb

@@ -28,3 +28,12 @@ def receiver_address
     {'Name' => 'Fake Name', 'StreetNumber' => '5', 'StreetName' => 'Douglas Road','City' => 'Burnaby', 'Province' => 'BC', 'Country' => 'CA', 'PostalCode' => 'V5C1A1',
      'PhoneNumber' => {'CountryCode' => '1', 'AreaCode' => '604', 'Phone' => '2982181'}}}
 end
+
+def setup_env
+  ENV['PLUROLATOR_RUBY_WSDL_LOCATION'] = File.expand_path 'spec/fixtures/'
+  ENV['PLUROLATOR_RUBY_DEVELOPER_KEY'] = "f1096de28f3d43d6a27872cc0c3c39a9"
+  ENV['PLUROLATOR_RUBY_DEVELOPER_PASSWORD'] = "10Wl)dh}"
+  ENV['PLUROLATOR_RUBY_CLIENT_ID'] = "9999999999"
+  ENV['PLUROLATOR_RUBY_ACCOUNT_NUMBER'] = "9999999999"
+  ENV['PLUROLATOR_RUBY_BILLING_NUMBER'] = "9999999999"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purolator_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Boris Filipov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -151,17 +151,37 @@ files:
 - lib/purolator_ruby.rb
 - lib/purolator_ruby/client.rb
 - lib/purolator_ruby/create_shipment_payload.rb
-- lib/purolator_ruby/create_shipment_request.rb
+- lib/purolator_ruby/create_shipment_response.rb
 - lib/purolator_ruby/environment_credentials.rb
+- lib/purolator_ruby/get_documents_payload.rb
+- lib/purolator_ruby/get_documents_response.rb
+- lib/purolator_ruby/purolator_response.rb
+- lib/purolator_ruby/request.rb
+- lib/purolator_ruby/validate_city_postal_code_zip_payload.rb
+- lib/purolator_ruby/validate_city_postal_code_zip_response.rb
 - lib/purolator_ruby/version.rb
+- lib/purolator_ruby/wsdl_location.rb
 - purolator_ruby.gemspec
 - spec/.DS_Store
+- spec/fixtures/ServiceAvailabilityService.wsdl
+- spec/fixtures/ShippingDocumentsService.wsdl
 - spec/fixtures/ShippingService.wsdl
+- spec/fixtures/vcr_cassettes/get_documents.yml
 - spec/fixtures/vcr_cassettes/shipping_service_integration.yml
+- spec/fixtures/vcr_cassettes/shipping_service_integration_2.yml
+- spec/fixtures/vcr_cassettes/validate_address.yml
+- spec/fixtures/vcr_cassettes/validate_address_invalid.yml
 - spec/purolator_ruby/client_spec.rb
 - spec/purolator_ruby/create_shipment_payload_spec.rb
-- spec/purolator_ruby/create_shipment_request_spec.rb
+- spec/purolator_ruby/create_shipment_response_spec.rb
 - spec/purolator_ruby/environment_credentials_spec.rb
+- spec/purolator_ruby/get_documents_payload_spec.rb
+- spec/purolator_ruby/get_documents_response_spec.rb
+- spec/purolator_ruby/integration/create_shipment_spec.rb
+- spec/purolator_ruby/integration/get_documents_spec.rb
+- spec/purolator_ruby/integration/validate_address_spec.rb
+- spec/purolator_ruby/validate_city_postal_code_zip_payload_spec.rb
+- spec/purolator_ruby/wsdl_location_spec.rb
 - spec/spec_helper.rb
 - spec/support/ShippingService.wsdl
 homepage: http://github.com/Redelas/purolator_ruby
@@ -190,11 +210,24 @@ specification_version: 4
 summary: Ruby wrapper around the Purolator E-Ship services.
 test_files:
 - spec/.DS_Store
+- spec/fixtures/ServiceAvailabilityService.wsdl
+- spec/fixtures/ShippingDocumentsService.wsdl
 - spec/fixtures/ShippingService.wsdl
+- spec/fixtures/vcr_cassettes/get_documents.yml
 - spec/fixtures/vcr_cassettes/shipping_service_integration.yml
+- spec/fixtures/vcr_cassettes/shipping_service_integration_2.yml
+- spec/fixtures/vcr_cassettes/validate_address.yml
+- spec/fixtures/vcr_cassettes/validate_address_invalid.yml
 - spec/purolator_ruby/client_spec.rb
 - spec/purolator_ruby/create_shipment_payload_spec.rb
-- spec/purolator_ruby/create_shipment_request_spec.rb
+- spec/purolator_ruby/create_shipment_response_spec.rb
 - spec/purolator_ruby/environment_credentials_spec.rb
+- spec/purolator_ruby/get_documents_payload_spec.rb
+- spec/purolator_ruby/get_documents_response_spec.rb
+- spec/purolator_ruby/integration/create_shipment_spec.rb
+- spec/purolator_ruby/integration/get_documents_spec.rb
+- spec/purolator_ruby/integration/validate_address_spec.rb
+- spec/purolator_ruby/validate_city_postal_code_zip_payload_spec.rb
+- spec/purolator_ruby/wsdl_location_spec.rb
 - spec/spec_helper.rb
 - spec/support/ShippingService.wsdl

data/lib/purolator_ruby/create_shipment_request.rb

@@ -1,55 +0,0 @@
-module PurolatorRuby
-
-  CreateShipmentResponse = Struct.new(:status, :shipment_pin, :payload, :errors)
-
-  class CreateShipmentRequest
-
-    attr_reader :client, :payload_opts
-
-    def initialize(options)
-      @client = options.fetch(:client)
-      _opts = options.dup
-      _opts.delete(:client)
-      @payload_opts = _opts.merge(account_number: client.account_number, billing_number: client.billing_number)
-    end
-
-    def send!
-      send.tap do |resp|
-        if resp.status == :error
-          puts resp
-          raise ArgumentError, resp.errors
-        end
-      end
-    end
-
-    def send
-      payload = shipment_payload
-
-      if payload.valid?
-        response = client.call(:create_shipment, message: payload.to_h)
-          .body
-          .fetch(:create_shipment_response)
-
-        if response[:shipment_pin]
-          CreateShipmentResponse.new(:ok, response[:shipment_pin][:value], payload, nil)
-        else
-          begin
-            errors = response[:response_information][:errors].map {|k, v| v[:description]}
-          rescue TypeError
-            errors = response[:response_information][:errors].map(&:to_s)
-          end
-          CreateShipmentResponse.new(:error, nil, payload, errors)
-        end
-      else
-        CreateShipmentResponse.new(:error, nil, payload, payload.errors)
-      end
-    end
-
-    private
-      def shipment_payload
-        CreateShipmentPayload.new(payload_opts)
-      end
-
-  end
-
-end

data/spec/purolator_ruby/create_shipment_request_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-
-describe PurolatorRuby::CreateShipmentRequest do
-
-  before do
-    ENV['PLUROLATOR_RUBY_WSDL_LOCATION'] = File.expand_path 'spec/fixtures/ShippingService.wsdl'
-    ENV['PLUROLATOR_RUBY_DEVELOPER_KEY'] = "f1096de28f3d43d6a27872cc0c3c39a9"
-    ENV['PLUROLATOR_RUBY_DEVELOPER_PASSWORD'] = "10Wl)dh}"
-    ENV['PLUROLATOR_RUBY_CLIENT_ID'] = "9999999999"
-    ENV['PLUROLATOR_RUBY_ACCOUNT_NUMBER'] = "9999999999"
-    ENV['PLUROLATOR_RUBY_BILLING_NUMBER'] = "9999999999"
-  end
-
-  let(:client) { PurolatorRuby::Client.new }
-
-  context "valid api input" do
-    subject do
-      described_class.new(
-        client: client,
-        sender_address: sender_address,
-        receiver_address: receiver_address,
-        shipping_date: Date.today,
-        weight: '10',
-        pieces: 1,
-        reference: 'ref 45')
-    end
-
-    it "succesfully communicates with ShippingService and returns shipment pin" do
-      VCR.use_cassette('shipping_service_integration') do
-        response = subject.send!
-        expect(response.shipment_pin).to eq('329018601172')
-        expect(response.status).to eq(:ok)
-       end
-    end
-  end
-
-  context "invalid input" do
-    subject do
-      described_class.new(client: client)
-    end
-
-    it "raises ArgumentError when called with a bang" do
-      expect { subject.send!.status }.to raise_error(ArgumentError)
-    end
-
-    it "displays missing attributes" do
-      response = subject.send
-      expect(response.errors.join(' ')).to include('sender_address')
-    end
-  end
-
-  context "invalid but from soap side" do
-    subject do
-      described_class.new(client: client, sender_address: sender_address, receiver_address: receiver_address, shipping_date: Date.new(2014,01,01), weight: '0', pieces: 0, reference: '1')
-    end
-
-    it "raises ArgumentError" do
-      VCR.use_cassette('shipping_service_integration_2') do
-        expect { subject.send!.status }.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-end