shipppit-canada-post 0.5.0

data/spec/rate_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'canada_post'
+require 'canada_post/client'
+
+describe CanadaPost::Client do
+
+  context 'missing required parameters' do
+    it 'does raise Rate exception' do
+      expect{ CanadaPost::Client.new }.to raise_error(CanadaPost::RateError)
+    end
+  end
+
+  context 'required parameters present' do
+    it 'does create a valid instance' do
+      expect( CanadaPost::Client.new(canada_post_credentials) ).to be_an_instance_of(CanadaPost::Client)
+    end
+  end
+
+  describe 'rate service' do
+    let(:canada_post) { CanadaPost::Client.new(canada_post_credentials) }
+    let(:simple_package)  { { weight: {value: 2, units: "KG"} } }
+    let(:complex_package) { { weight: {value: 2, units: "KG"}, dimension: {length: 25, width: 15, height: 10, units: "CM"} } }
+    let(:mailing_tube) { { cylinder: true, weight: {value: 2, units: "KG"}, dimension: {length: 25, width: 15, height: 10, units: "CM"} } }
+    let(:shipper) { { postal_code: "M5X1B8", country_code: "CA" } }
+    let(:domestic_recipient) { { postal_code: "M5R1C6", country_code: "CA" } }
+    let(:us_recipient) { { postal_code: "10012", country_code: "US", residential: true } }
+    let(:intl_recipient) { { country_code: "GB" } }
+
+    context 'domestic shipment', :vcr do
+      let(:rates) {
+        canada_post.rate(shipper: shipper, recipient: domestic_recipient, package: simple_package) }
+      it 'does return a rate' do
+        expect(rates.first).to be_an_instance_of(CanadaPost::Rate)
+      end
+      it 'does return a cost' do
+        expect(rates.first.total_net_charge).not_to be_nil
+      end
+      it 'does return a service_code' do
+        expect(rates.first.service_code).not_to be_nil
+      end
+      it 'does return expected_transit_time' do
+        expect(rates.first.expected_transit_time).not_to be_nil
+      end
+      it 'does return guaranteed_delivery' do
+        expect(rates.first.guaranteed_delivery).not_to be_nil
+      end
+      it 'does return expected_delivery_date' do
+        expect(rates.first.expected_delivery_date).not_to be_nil
+      end
+    end
+
+    context 'with package options specified', :vcr do
+      let(:rates) {
+        canada_post.rate(shipper: shipper, recipient: domestic_recipient, package: mailing_tube) }
+      it 'does return a rate' do
+        expect(rates.first).to be_an_instance_of(CanadaPost::Rate)
+      end
+    end
+
+    context 'with service type specified', :vcr do
+      let(:rates) { canada_post.rate(shipper: shipper, recipient: domestic_recipient, package: simple_package, service_type: "DOM.RP") }
+
+      it 'returns a single rate' do
+        expect(rates.count).to eq 1
+      end
+
+      it 'has a service_type attribute' do
+        expect(rates.first.service_type).to eq("Regular Parcel")
+      end
+    end
+
+    context 'with no service type specified', :vcr do
+      let(:rates) { canada_post.rate(shipper: shipper, recipient: domestic_recipient, package: simple_package) }
+      it 'returns multiple rates' do
+        expect(rates.count).to be >= 1
+      end
+
+      context 'each rate' do
+        it 'has service type attribute' do
+          expect(rates.first).to respond_to(:service_type)
+        end
+      end
+    end
+
+    context 'when there are no valid services available', :vcr do
+      let(:bad_shipper) { shipper.merge(postal_code: '0') }
+      let(:rates) { canada_post.rate(shipper: bad_shipper, recipient: domestic_recipient, package: simple_package) }
+
+      it 'does raise Rate exception' do
+        expect{ rates }.to raise_error(CanadaPost::RateError)
+      end
+    end
+
+  end
+
+end

data/spec/registration_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'canada_post'
+require 'canada_post/shipment'
+require 'canada_post/client'
+
+describe CanadaPost::Request::Registration do
+  let(:canada_post_service) { CanadaPost::Client.new(canada_post_credentials) }
+  context 'missing required parameters' do
+    it 'does raise Rate exception' do
+      expect { CanadaPost::Client.new }.to raise_error(CanadaPost::RateError)
+    end
+  end
+
+  context 'required parameters present', :vcr do
+    it 'does create a valid instance' do
+      expect(CanadaPost::Client.new(canada_post_credentials)).to be_an_instance_of(CanadaPost::Client)
+    end
+
+    let(:registration) {
+      canada_post_service.registration_token
+    }
+
+    it 'should generate new token' do
+      expect(registration[:token_id]).not_to be_nil
+    end
+  end
+end

data/spec/shipping_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'canada_post'
+require 'canada_post/shipment'
+require 'canada_post/client'
+
+describe CanadaPost::Shipment do
+  context 'missing required parameters' do
+    it 'does raise Rate exception' do
+      expect { CanadaPost::Client.new }.to raise_error(CanadaPost::RateError)
+    end
+  end
+
+  context 'required parameters present' do
+    it 'does create a valid instance' do
+      expect(CanadaPost::Client.new(canada_post_credentials)).to be_an_instance_of(CanadaPost::Client)
+    end
+  end
+
+  describe 'Shipment shipping service' do
+    let(:canada_post_service) { CanadaPost::Client.new(canada_post_credentials) }
+    let(:package) { {weight: 2, unpackaged: false, mailing_tube: false, dimensions: {length: 2, width: 2, height: 2}} }
+    let(:sender) { {name: 'nazrul', company: 'my company', phone: '34343434', shipping_point: 'H2B1A0', address_details: {address: 'test address road', city: 'MONTREAL', state: 'QC', country: 'CA', postal_code: 'H2B1A0'}} }
+    let(:destination) { {name: 'nazrul recp', company: 'your company', address_details: {address: 'test dest address', city: 'Ottawa', state: 'ON', country: 'CA', postal_code: 'K1P5Z9'}} }
+    let(:notification) { {email: 'user@gmail.com', on_shipment: 'true', on_exception: 'true', on_delivery: 'true'} }
+    let(:preferences) { {show_packing_instructions: 'true', show_postage_rate: 'false', show_insured_value: 'true'} }
+    let(:group_id) { {value: '5241557'} }
+    let(:mailing_date) { {value: "#{Date.today + 5}"} }
+    let(:service_code) { {value: 'DOM.EP'} }
+    let(:contract_number) { {value: '42708517'} }
+    let(:mobo) {
+      {
+        username: 'xxx',
+        password: 'password',
+        customer_number: '123456789',
+        contract_number: '987654321'
+      }
+    }
+
+    context 'create shipment', :vcr do
+      let(:shipping) {
+        canada_post_service.create(
+          sender: sender,
+          destination: destination,
+          package: package,
+          notification: notification,
+          preferences: preferences,
+          group_id: group_id[:value],
+          mailing_date: mailing_date[:value],
+          service_code: service_code[:value],
+          contract_number: contract_number[:value]
+        )
+      }
+
+      it 'Should create a shipping' do
+        expect(shipping[:create_shipping][:errors]).to be_nil
+      end
+
+      it 'Should get a shipping id' do
+        expect(shipping[:create_shipping][:shipment_info][:shipment_id]).not_to be_nil
+      end
+
+      it 'Should transmit shipping' do
+        expect(shipping[:transmit_shipping][:errors]).to be_nil
+      end
+
+      it 'Should create manifest link for shipping' do
+        expect(shipping[:transmit_shipping][:manifests]).not_to be_nil
+      end
+
+      let(:get_shipment) {
+        canada_post_service.details(shipping[:create_shipping][:shipment_info][:shipment_id])
+      }
+
+      it 'Should get shipping details' do
+        expect(get_shipment[:shipment_details]).not_to be_nil
+      end
+
+      it 'Should shipping status be transmitted' do
+        expect(get_shipment[:shipment_details][:shipment_status]).to eq 'transmitted'
+      end
+
+      let(:get_price) {
+        canada_post_service.get_price(shipping[:create_shipping][:shipment_info][:shipment_id])
+      }
+
+      it 'Should get shipping price' do
+        expect(get_price[:shipment_price]).not_to be_nil
+      end
+
+      let(:void_shipping) {
+        canada_post_service.void_shipment(shipping[:create_shipping][:shipment_info][:shipment_id])
+      }
+
+      it 'Should void' do
+        expect(void_shipping[:errors]).to be_nil
+      end
+
+    end
+
+    context "Create MOBO shipping (on behalf of)", :vcr do
+      let(:shipping) {
+        canada_post_service.create(
+          sender: sender,
+          destination: destination,
+          package: package,
+          mobo: mobo,
+          notification: notification,
+          preferences: preferences,
+          group_id: group_id[:value],
+          mailing_date: mailing_date[:value],
+          service_code: service_code[:value],
+          contract_number: contract_number[:value]
+        )
+      }
+
+      let(:get_shipment) {
+        canada_post_service.details(shipping[:create_shipping][:shipment_info][:shipment_id], mobo[:customer_number])
+      }
+
+      it 'Should create a shipping' do
+        expect(shipping[:create_shipping][:errors]).to be_nil
+      end
+
+      it 'Should get a MOBO shipping id' do
+        expect(shipping[:create_shipping][:shipment_info][:shipment_id]).not_to be_nil
+      end
+
+      it 'Should transmit MOBO shipping' do
+        expect(shipping[:transmit_shipping][:errors]).to be_nil
+      end
+
+      it 'Should get MOBO shipping details' do
+        expect(get_shipment[:shipment_details]).not_to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'canada_post'
+require 'support/vcr'
+require 'support/credentials'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :production unless canada_post_production_credentials
+  c.expect_with :rspec do |expect_config|
+    expect_config.syntax = :expect
+  end
+end

data/spec/support/credentials.rb

@@ -0,0 +1,16 @@
+def canada_post_credentials
+  @canada_post_credentials ||= credentials["development"]
+end
+
+def canada_post_production_credentials
+  @canada_post_production_credentials ||= credentials["production"]
+end
+
+private
+
+def credentials
+  @credentials ||= begin
+    YAML.load_file("#{File.dirname(__FILE__)}/../config/canada_post_credentials.yml")
+  end
+end
+

data/spec/support/vcr.rb

@@ -0,0 +1,14 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = File.expand_path('../../vcr', __FILE__)
+  c.hook_into :webmock
+end
+
+RSpec.configure do |c|
+  c.include CanadaPost::Helpers
+  c.around(:each, :vcr) do |example|
+    name = underscorize(example.metadata[:full_description].split(/\s+/, 2).join("/")).gsub(/[^\w\/]+/, "_")
+    VCR.use_cassette(name) { example.call }
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: shipppit-canada-post
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Olivier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for the Canada Post API V3
+email:
+- olivier@yafoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- canada-post-api.gemspec
+- lib/canada_post.rb
+- lib/canada_post/client.rb
+- lib/canada_post/credentials.rb
+- lib/canada_post/helpers.rb
+- lib/canada_post/rate.rb
+- lib/canada_post/request/base.rb
+- lib/canada_post/request/manifest.rb
+- lib/canada_post/request/rate.rb
+- lib/canada_post/request/registration.rb
+- lib/canada_post/request/shipment.rb
+- lib/canada_post/request/shipping.rb
+- lib/canada_post/shipment.rb
+- lib/canada_post/version.rb
+- spec/config/canada_post_credentials.example.yml
+- spec/manifest_spec.rb
+- spec/rate_spec.rb
+- spec/registration_spec.rb
+- spec/shipping_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb
+homepage: https://github.com/shipppit/shipppit-canada-post
+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.3
+signing_key: 
+specification_version: 4
+summary: Canada Post API
+test_files:
+- spec/config/canada_post_credentials.example.yml
+- spec/manifest_spec.rb
+- spec/rate_spec.rb
+- spec/registration_spec.rb
+- spec/shipping_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb