shipppit-canada-post 0.5.0

data/lib/canada_post/credentials.rb

@@ -0,0 +1,17 @@
+module CanadaPost
+  class Credentials
+    include Helpers
+
+    attr_reader :username, :password, :customer_number, :mode
+
+    def initialize(options={})
+      requires!(options, :username, :password, :customer_number, :mode)
+      @username         = options[:username]
+      @password         = options[:password]
+      @customer_number  = options[:customer_number]
+      @mode             = options[:mode]
+    end
+
+  end
+
+end

data/lib/canada_post/helpers.rb

@@ -0,0 +1,15 @@
+module CanadaPost
+  module Helpers
+
+    private
+    # Helper method to validate required fields
+    def requires!(hash, *params)
+       params.each { |param| raise RateError, "Missing Required Parameter #{param}" if hash[param].nil? }
+    end
+
+    def underscorize(key) #:nodoc:
+      key.to_s.sub(/^(v[0-9]+|ns):/, "").gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+    
+  end
+end

data/lib/canada_post/rate.rb

@@ -0,0 +1,27 @@
+module CanadaPost
+  class Rate
+
+    attr_accessor :service_type, :service_code, :service_link, :total_net_charge, :rate_type,
+                  :total_base_charge, :guaranteed_delivery, :expected_transit_time,
+                  :expected_delivery_date, :am_delivery
+
+    def initialize(options={})
+      @service_type = options[:service_name]
+      @service_code = options[:service_code]
+      @service_link = options[:service_link]
+      @total_net_charge = options[:price_details][:due]
+      @total_base_charge = options[:price_details][:base]
+      @gst_taxes = options[:price_details][:taxes][:gst]
+      @pst_taxes = options[:price_details][:taxes][:pst]
+      @hst_taxes = options[:price_details][:taxes][:hst]
+      @expected_transit_time = options[:service_standard][:expected_transit_time]
+      @expected_delivery_date = options[:service_standard][:expected_delivery_date]
+      @guaranteed_delivery = options[:service_standard][:guaranteed_delivery]
+      @am_delivery = options[:service_standard][:am_delivery]
+    end
+
+    def total_taxes
+      (@gst_taxes.to_f + @pst_taxes.to_f + @hst_taxes.to_f).to_s
+    end
+  end
+end

data/lib/canada_post/request/base.rb

@@ -0,0 +1,155 @@
+require 'httparty'
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+require 'canada_post/helpers'
+require 'canada_post/rate'
+require 'canada_post/shipment'
+
+module CanadaPost
+  module Request
+    class Base
+      include Helpers
+      include HTTParty
+
+      # CanadaPost API Test URL
+      TEST_URL = "https://ct.soa-gw.canadapost.ca"
+
+      # CanadaPost API Production URL
+      PRODUCTION_URL = "https://soa-gw.canadapost.ca"
+
+      # CanadaPost API TEST CONTRACT ID
+      TEST_CONTRACT_ID = "0042708517"
+
+      # List of available Option Codes
+      # SO - Signature
+      # COV - Coverage  (requires qualifier)
+      # COD - COD (requires qualifier)
+      # PA18 - Proof of Age Required - 18
+      # PA19 - Proof of Age Required - 19
+      # HFP - Card for pickup
+      # DNS - Do not safe drop
+      # LAD - Leave at door - do not card
+      OPTION_CODES = ["SO", "COV", "COD", "PA18", "PA19", "HFP", "DNS", "LAD"]
+
+      # List of available Service Codes
+      # DOM.RP - Regular Parcel
+      # DOM.EP - Expedited Parcel
+      # DOM.XP - Xpresspost
+      # DOM.XP.CERT - Xpresspost Certified
+      # DOM.PC - Priority
+      # DOM.DT - Delivered Tonight
+      # DOM.LIB - Library Books
+      # USA.EP - Expedited Parcel USA
+      # USA.PW.ENV - Priority Worldwide Envelope USA
+      # USA.PW.PAK - Priority Worldwide pak USA
+      # USA.PW.Parcel - Priority Worldwide Parcel USA
+      # USA.SP.AIR - Small Packet USA Air
+      # USA.TP - Tracked Package - USA
+      # USA.TP.LVM - Tracked Package - USA (LVM) (large volume mailers)
+      # USA.XP - Xpresspost USA
+      # INT.XP - Xpresspost international
+      # INT.IP.AIR - International Parcel Air
+      # INT.IP.SURF - International Parcel Surface
+      # INT.PW.ENV - Priority Worldwide Envelope Int'l
+      # INT.PW.PAK - Priority Worldwide pak Int'l
+      # INT.PW.PARCEL - Priority Worldwide Parcel Int'l
+      # INT.SP.AIR - Small Packet International Air
+      # INT.SP.SURF - Small Packet International Surface
+      # INT.TP - Tracked Package - International
+      SERVICE_CODES = {
+        "DOM.RP" => 'Regular Parcel',
+        "DOM.EP" => 'Expedited Parcel',
+        "DOM.XP" => 'Xpresspost',
+        "DOM.XP.CERT" => 'Xpresspost Certified',
+        "DOM.PC" => 'Priority',
+        "DOM.DT" => 'Delivered Tonight',
+        "DOM.LIB" => 'Library Books',
+        "USA.EP" => 'Expedited Parcel USA',
+        "USA.PW.ENV" => 'Priority Worldwide Envelope USA',
+        "USA.PW.PAK" => 'Priority Worldwide pak USA',
+        "USA.PW.PARCEL" => 'Priority Worldwide Parcel USA',
+        "USA.SP.AIR" => 'Small Packet USA Air',
+        "USA.TP" => 'Tracked Package - USA',
+        "USA.TP.LVM" => 'Tracked Package - USA (LVM) (large volume mailers)',
+        "USA.XP" => 'Xpresspost USA',
+        "INT.XP" => 'Xpresspost international',
+        "INT.IP.AIR" => 'International Parcel Air',
+        "INT.IP.SURF" => 'International Parcel Surface',
+        "INT.PW.ENV" => "Priority Worldwide Envelope Int'l",
+        "INT.PW.PAK" => "Priority Worldwide pak Int'l",
+        "INT.PW.PARCEL" => "Priority Worldwide Parcel Int'l",
+        "INT.SP.AIR" => 'Small Packet International Air',
+        "INT.SP.SURF" => 'Small Packet International Surface',
+        "INT.TP" => 'Tracked Package - International'
+      }
+
+      def initialize(credentials, options = {})
+        @credentials = credentials
+        @authorization = {username: @credentials.username, password: @credentials.password}
+        @customer_number = @credentials.customer_number
+      end
+
+      # def initialize(credentials, options={})
+      #   requires!(options, :shipper, :recipient, :package)
+      #   @credentials = credentials
+      #   @shipper, @recipient, @package, @service_type = options[:shipper], options[:recipient], options[:package], options[:service_type]
+      #   @authorization = { username: @credentials.username, password: @credentials.password }
+      #   @customer_number = @credentials.customer_number
+      # end
+
+      def process_request
+        raise NotImplementedError, "Override #process_request in subclass"
+      end
+
+      # Sends POST request to CanadaPost API and parse the response,
+      # a class object (Shipment, Rate...) is created if the response is successful
+      def client(url, body, headers)
+        self.class.post(
+          url,
+          body: body,
+          headers: headers,
+          basic_auth: @authorization
+        )
+      end
+
+      def api_url
+        @credentials.mode == "production" ? PRODUCTION_URL : TEST_URL
+      end
+
+      def build_xml
+        raise NotImplementedError, "Override #build_xml in subclass"
+      end
+
+      # Parse response, convert keys to underscore symbols
+      def parse_response(response)
+        response = Hash.from_xml(response.parsed_response.gsub("\n", "")) if response.parsed_response.is_a? String
+        response = sanitize_response_keys(response)
+      end
+
+      def process_response(api_response)
+        shipping_response = {errors: ''}
+        response = parse_response(api_response)
+        if response[:messages].present?
+          response[:messages].each do |key, message|
+            shipping_response[:errors] << message[:description].split('}').last
+          end
+          return shipping_response
+        end
+
+        return response
+      end
+
+      # Recursively sanitizes the response object by cleaning up any hash keys.
+      def sanitize_response_keys(response)
+        if response.is_a?(Hash)
+          response.inject({}) { |result, (key, value)| result[underscorize(key).to_sym] = sanitize_response_keys(value); result }
+        elsif response.is_a?(Array)
+          response.collect { |result| sanitize_response_keys(result) }
+        else
+          response
+        end
+      end
+
+    end
+  end
+end

data/lib/canada_post/request/manifest.rb

@@ -0,0 +1,103 @@
+module CanadaPost
+  module Request
+    class Manifest < Base
+
+      attr_accessor :phone, :destination, :group_id
+
+      def initialize(credentials, options={})
+        @credentials = credentials
+        if options.present?
+          @phone = options[:phone]
+          @destination = options[:destination]
+          @group_id = options[:group_id]
+        end
+        super(credentials)
+      end
+
+      def process_request
+        api_response = self.class.post(
+          api_url,
+          body: build_xml,
+          headers: manifest_header,
+          basic_auth: @authorization
+        )
+        process_response(api_response)
+      end
+
+      def get_manifest(url)
+        api_response = self.class.get(
+          url,
+          headers: manifest_header,
+          basic_auth: @authorization
+        )
+        process_response(api_response)
+      end
+
+      def get_artifact(url)
+        self.class.get(
+          url,
+          headers: artifact_header,
+          basic_auth: @authorization
+        )
+      end
+
+      private
+
+      def api_url
+        api_url = @credentials.mode == "production" ? PRODUCTION_URL : TEST_URL
+        api_url += "/rs/#{@credentials.customer_number}/#{@credentials.customer_number}/manifest"
+      end
+
+      def manifest_header
+        {
+          'Content-type' => 'application/vnd.cpc.manifest-v7+xml',
+          'Accept' => 'application/vnd.cpc.manifest-v7+xml'
+        }
+      end
+
+      def artifact_header
+        {
+          'Content-type' => 'application/pdf',
+          'Accept' => 'application/pdf'
+        }
+      end
+
+      def build_xml
+        ns = "http://www.canadapost.ca/ws/manifest-v7"
+        xsi = 'http://www.w3.org/2001/XMLSchema-instance'
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.send(:"transmit-set", :'xmlns:xsi' => xsi, xmlns: ns) {
+            xml.send(:'group-ids') {
+              xml.send(:'group-id', @group_id)
+            }
+            xml.send(:'detailed-manifests', true)
+            xml.send(:'method-of-payment', 'Account')
+            xml.send(:'manifest-address') {
+              add_manifest_details(xml)
+            }
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def add_manifest_details(xml)
+        xml.send(:'manifest-company', @destination[:company])
+        xml.send(:'manifest-name', @destination[:name])
+        xml.send(:'phone-number', @phone)
+        xml.send(:'address-details') {
+          manifest_address(xml, @destination[:address_details])
+        }
+      end
+
+      def manifest_address(xml, params)
+        xml.send(:'address-line-1', params[:address])
+        xml.send(:'city', params[:city])
+        xml.send(:'prov-state', params[:state])
+        if params[:postal_code].present?
+          xml.send(:'postal-zip-code', params[:postal_code].gsub(' ', ''))
+        end
+      end
+
+    end
+  end
+end

data/lib/canada_post/request/rate.rb

@@ -0,0 +1,122 @@
+module CanadaPost
+  module Request
+    class Rate < Base
+
+      attr_accessor :shipper, :recipient, :package
+
+      def initialize(credentials, options={})
+        requires!(options, :shipper, :recipient, :package)
+        @credentials = credentials
+        @shipper, @recipient, @package, @service_type = options[:shipper], options[:recipient], options[:package], options[:service_type]
+        super(credentials)
+      end
+
+      def process_request
+        api_response = client(rate_url, build_xml, rate_headers)
+        response = parse_response(api_response)
+
+        if success?(response)
+          rate_reply_details = response[:price_quotes][:price_quote] || []
+          rate_reply_details = [rate_reply_details] if rate_reply_details.is_a? Hash
+          rate_reply_details.map do |rate_reply|
+            CanadaPost::Rate.new(rate_reply)
+          end
+        else
+          error_message =
+            if response[:messages]
+              response[:messages][:message][:description]
+            else
+              'api_response.response'
+            end
+          raise RateError, error_message
+        end
+      end
+
+      private
+
+      def rate_url
+        api_url + "/rs/ship/price"
+      end
+
+      def rate_headers
+        {
+          'Content-type' => 'application/vnd.cpc.ship.rate-v3+xml',
+          'Accept' => 'application/vnd.cpc.ship.rate-v3+xml'
+        }
+      end
+
+      def build_xml
+        ns = "http://www.canadapost.ca/ws/ship/rate-v3"
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.send(:"mailing-scenario", xmlns: ns) {
+            add_requested_shipment(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def add_requested_shipment(xml)
+        xml.send(:"customer-number", @customer_number)
+        add_package(xml)
+        add_services(xml)
+        add_shipper(xml)
+        add_recipient(xml)
+      end
+
+      def add_shipper(xml)
+        xml.send(:"origin-postal-code", @shipper[:postal_code])
+      end
+
+      def add_recipient(xml)
+        xml.destination {
+          add_destination(xml)
+        }
+      end
+
+      def add_package(xml)
+        xml.send(:"parcel-characteristics") {
+          xml.weight @package[:weight][:value]
+          if @package[:dimensions]
+            xml.dimensions {
+              xml.height @package[:dimensions][:height].round(1)
+              xml.width @package[:dimensions][:width].round(1)
+              xml.length @package[:dimensions][:length].round(1)
+            }
+          end
+          if @package[:cylinder]
+            xml.send(:"mailing-tube", @package[:cylinder])
+          end
+        }
+      end
+
+      def add_destination(xml)
+        if @recipient[:country_code] == "CA"
+          xml.domestic {
+            xml.send(:"postal-code", @recipient[:postal_code])
+          }
+        elsif @recipient[:country_code] == "US"
+          xml.send(:"united-states") {
+            xml.send(:"zip-code", @recipient[:postal_code])
+          }
+        else
+          xml.international {
+            xml.send(:"country-code", @recipient[:country_code])
+          }
+        end
+      end
+
+      def add_services(xml)
+        if @service_type
+          xml.services {
+            xml.send(:"service-code", @service_type)
+          }
+        end
+      end
+
+      def success?(response)
+        response[:price_quotes]
+      end
+
+    end
+  end
+end

data/lib/canada_post/request/registration.rb

@@ -0,0 +1,49 @@
+module CanadaPost
+  module Request
+    class Registration < Base
+
+      def initialize(credentials)
+        @credentials = credentials
+        super(credentials)
+      end
+
+      def get_token
+        api_response = self.class.post(
+          api_url,
+          headers: api_header,
+          basic_auth: @authorization
+        )
+        shipping_response = process_response(api_response)
+        if shipping_response[:token].present?
+          shipping_response[:token]
+        else
+          shipping_response
+        end
+      end
+
+      def merchant_info(token)
+        merchant_url = api_url + "/#{token}"
+        api_response = self.class.get(
+          merchant_url,
+          headers: api_header,
+          basic_auth: @authorization
+        )
+        process_response(api_response)
+      end
+
+      private
+
+        def api_header
+          {
+            'Accept-Language' => 'en-CA',
+            'Accept' => 'application/vnd.cpc.registration+xml'
+          }
+        end
+
+        def api_url
+          api_url = @credentials.mode == "production" ? PRODUCTION_URL : TEST_URL
+          api_url += "/ot/token"
+        end
+    end
+  end
+end