dhl-get_quote 0.4.25

data/lib/dhl/get_quote/request.rb

@@ -0,0 +1,183 @@
+require 'rubygems'
+require 'httparty'
+require 'erb'
+require 'set'
+
+class Dhl::GetQuote::Request
+  attr_reader :site_id, :password, :from_country_code, :from_postal_code, :to_country_code, :to_postal_code
+  attr_accessor :pieces
+
+  URLS = {
+    :production => 'https://xmlpi-ea.dhl.com/XMLShippingServlet',
+    :test       => 'https://xmlpitest-ea.dhl.com/XMLShippingServlet'
+  }
+
+  def initialize(options = {})
+    @test_mode = !!options[:test_mode] || Dhl::GetQuote.test_mode?
+
+    @site_id = options[:site_id] || Dhl::GetQuote.site_id
+    @password = options[:password] || Dhl::GetQuote.password
+
+    [ :site_id, :password ].each do |req|
+      unless instance_variable_get("@#{req}").to_s.size > 0
+        raise Dhl::GetQuote::OptionsError, ":#{req} is a required option"
+      end
+    end
+
+    @special_services_list = Set.new
+
+    @is_dutiable = Dhl::GetQuote.dutiable?
+
+    @pieces = []
+  end
+
+  def test_mode?
+    !!@test_mode
+  end
+
+  def test_mode!
+    @test_mode = true
+  end
+
+  def production_mode!
+    @test_mode = false
+  end
+
+  def from(country_code, postal_code)
+    @from_postal_code = postal_code.to_s
+    validate_country_code!(country_code)
+    @from_country_code = country_code
+  end
+
+  def to(country_code, postal_code)
+    @to_postal_code = postal_code.to_s
+    validate_country_code!(country_code)
+    @to_country_code = country_code
+  end
+
+  def dutiable?
+    !!@is_dutiable
+  end
+
+  def dutiable(val)
+    @is_dutiable = !!val
+  end
+
+  def dutiable!
+    dutiable(true)
+  end
+
+  def not_dutiable!
+    dutiable(false)
+  end
+
+  def dimensions_unit
+    @dimensions_unit ||= Dhl::GetQuote.dimensions_unit
+  end
+
+  def weight_unit
+    @weight_unit ||= Dhl::GetQuote.weight_unit
+  end
+
+  def centimeters!
+    @dimensions_unit = Dhl::GetQuote::DIMENSIONS_UNIT_CODES[:centimeters]
+  end
+  alias :centimetres! :centimeters!
+
+  def inches!
+    @dimensions_unit = Dhl::GetQuote::DIMENSIONS_UNIT_CODES[:inches]
+  end
+
+  def centimeters?
+    dimensions_unit == Dhl::GetQuote::DIMENSIONS_UNIT_CODES[:centimeters]
+  end
+  alias :centimetres? :centimeters?
+
+  def inches?
+    dimensions_unit == Dhl::GetQuote::DIMENSIONS_UNIT_CODES[:inches]
+  end
+
+  def kilograms!
+    @weight_unit = Dhl::GetQuote::WEIGHT_UNIT_CODES[:kilograms]
+  end
+  alias :kilogrammes! :kilograms!
+
+  def pounds!
+    @weight_unit = Dhl::GetQuote::WEIGHT_UNIT_CODES[:pounds]
+  end
+
+  def pounds?
+    weight_unit == Dhl::GetQuote::WEIGHT_UNIT_CODES[:pounds]
+  end
+
+  def kilograms?
+    weight_unit == Dhl::GetQuote::WEIGHT_UNIT_CODES[:kilograms]
+  end
+  alias :kilogrammes? :kilograms?
+
+  def to_xml
+    validate!
+    ERB.new(File.new(xml_template_path).read, nil,'%<>-').result(binding)
+  end
+
+  def ready_time(time=Time.now)
+    time.strftime("PT%HH%MM")
+  end
+
+  def post
+    validate!
+    response = HTTParty.post(servlet_url,
+      :body => to_xml,
+      :headers => { 'Content-Type' => 'application/xml' }
+    ).response
+
+    Dhl::GetQuote::Response.new(response.body)
+  end
+
+  def special_services
+    @special_services_list.to_a.sort
+  end
+
+  def add_special_service(special_service_type)
+    return if special_service_type.to_s.size < 1
+    @special_services_list << special_service_type
+  end
+
+  def remove_special_service(special_service_type)
+    return if special_service_type.to_s.size < 1
+    @special_services_list.delete_if{|x| x == special_service_type}
+  end
+
+protected
+
+  def servlet_url
+    test_mode? ? URLS[:test] : URLS[:production]
+  end
+
+  def validate!
+    raise Dhl::GetQuote::FromNotSetError, "#from() is not set" unless (@from_country_code && @from_postal_code)
+    raise Dhl::GetQuote::ToNotSetError, "#to() is not set" unless (@to_country_code && @to_postal_code)
+    validate_pieces!
+  end
+
+  def validate_pieces!
+    pieces.each do |piece|
+      klass_name = "Dhl::GetQuote::Piece"
+      if piece.class.to_s != klass_name
+        raise Dhl::GetQuote::PieceError, "entry in #pieces is not a #{klass_name} object!"
+      end
+    end
+  end
+
+  def validate_country_code!(country_code)
+    unless country_code =~ /^[A-Z]{2}$/
+      raise Dhl::GetQuote::CountryCodeError, 'country code must be upper-case, two letters (A-Z)'
+    end
+  end
+
+  def xml_template_path
+    spec = Gem::Specification.find_by_name("dhl-get_quote")
+    gem_root = spec.gem_dir
+    gem_root + "/tpl/request.xml.erb"
+  end
+end

data/lib/dhl/get_quote/response.rb

@@ -0,0 +1,94 @@
+class Dhl::GetQuote::Response
+  include Dhl::GetQuote::Helper
+
+  attr_reader :raw_xml, :parsed_xml, :error
+  attr_reader :currency_code, :currency_role_type_code, :weight_charge, :total_amount, :total_tax_amount, :weight_charge_tax
+
+  CURRENCY_ROLE_TYPE_CODES = %w[ BILLC PULCL BASEC INVCU ]
+  DEFAULT_CURRENCY_ROLE_TYPE_CODE = 'BILLC'
+
+  def initialize(xml="")
+    @raw_xml = xml
+    begin
+      @parsed_xml = MultiXml.parse(xml)
+    rescue MultiXml::ParseError => e
+      @error = e
+      return self
+    end
+
+    if response_indicates_error?
+      @error = case response_error_condition_code.to_s
+      when "100"
+        Dhl::GetQuote::Upstream::ValidationFailureError.new(response_error_condition_data)
+      else
+        Dhl::GetQuote::Upstream::UnknownError.new(response_error_condition_data)
+      end
+    else
+      load_costs(DEFAULT_CURRENCY_ROLE_TYPE_CODE)
+    end
+  end
+
+  def error?
+    !!@error
+  end
+
+  def load_costs(currency_role_type_code=DEFAULT_CURRENCY_ROLE_TYPE_CODE)
+    validate_currency_role_type_code!(currency_role_type_code)
+
+    return if error?
+    qtd_s_in_ad_cur = @parsed_xml["DCTResponse"]["GetQuoteResponse"]["BkgDetails"]["QtdShp"]["QtdSInAdCur"]
+    pricing = if x = qtd_s_in_ad_cur.detect{|q|q["CurrencyRoleTypeCode"]==currency_role_type_code}
+      x
+    else
+      qtd_s_in_ad_cur.first
+    end
+
+    pricing.each do |k,v|
+      instance_variable_set("@#{underscore(k)}".to_sym, v)
+    end
+  end
+
+  def validate_currency_role_type_code!(currency_role_type_code)
+    unless CURRENCY_ROLE_TYPE_CODES.include?(currency_role_type_code)
+      raise Dhl::GetQuote::OptionsError,
+        "'#{currency_role_type_code}' is not one of #{CURRENCY_ROLE_TYPE_CODES.join(', ')}"
+    end
+  end
+
+  def offered_services
+    market_services.select do
+      |m| m['TransInd'].to_s == "Y" || m['MrkSrvInd'].to_s == "Y"
+    end.map do |m|
+      Dhl::GetQuote::MarketService.new(m)
+    end.sort{|a,b| a.code <=> b.code }
+  end
+
+  def all_services
+    market_services.map do |m|
+      Dhl::GetQuote::MarketService.new(m)
+    end.sort{|a,b| a.code <=> b.code }
+  end
+
+protected
+
+  def response_indicates_error?
+    @parsed_xml.keys.include?('ErrorResponse')
+  end
+
+  def response_error_status_condition
+    @response_error_status_condition ||= @parsed_xml['ErrorResponse']['Response']['Status']['Condition']
+  end
+
+  def response_error_condition_code
+    @response_error_condition_code ||= response_error_status_condition['ConditionCode']
+  end
+
+  def response_error_condition_data
+    @response_error_condition_data ||= response_error_status_condition['ConditionData']
+  end
+
+  def market_services
+    @market_services ||= @parsed_xml["DCTResponse"]["GetQuoteResponse"]["Srvs"]["Srv"]["MrkSrv"]
+  end
+
+end

data/lib/dhl/get_quote/version.rb

@@ -0,0 +1,5 @@
+class Dhl
+  class GetQuote
+    VERSION = "0.4.25"
+  end
+end

data/lib/dhl-get_quote.rb

@@ -0,0 +1,96 @@
+require "dhl/get_quote/version"
+require "dhl/get_quote/helper"
+require "dhl/get_quote/errors"
+require "dhl/get_quote/request"
+require "dhl/get_quote/response"
+require "dhl/get_quote/piece"
+require "dhl/get_quote/market_service"
+
+class Dhl
+  class GetQuote
+
+    DIMENSIONS_UNIT_CODES = { :centimeters => "CM", :inches => "IN" }
+    WEIGHT_UNIT_CODES = { :kilograms => "KG", :pounds => "LB" }
+
+    def self.configure(&block)
+      yield self if block_given?
+    end
+
+    def self.test_mode!
+      @@test_mode = true
+    end
+
+    def self.test_mode?
+      !!@@test_mode
+    end
+
+    def self.production_mode!
+      @@test_mode = false
+    end
+
+    def self.site_id(site_id=nil)
+      if (s = site_id.to_s).size > 0
+        @@site_id = s
+      else
+        @@site_id
+      end
+    end
+
+    def self.password(password=nil)
+      if (s = password.to_s).size > 0
+        @@password = s
+      else
+        @@password
+      end
+    end
+
+    def self.kilograms!
+      @@weight_unit = WEIGHT_UNIT_CODES[:kilograms]
+    end
+    def self.kilogrammes!; self.kilograms!; end
+
+    def self.pounds!
+      @@weight_unit = WEIGHT_UNIT_CODES[:pounds]
+    end
+
+    def self.weight_unit
+      @@weight_unit
+    end
+
+    def self.centimeters!
+      @@dimensions_unit = DIMENSIONS_UNIT_CODES[:centimeters]
+    end
+    def self.centimetres!; self.centimeters!; end
+
+    def self.inches!
+      @@dimensions_unit = DIMENSIONS_UNIT_CODES[:inches]
+    end
+
+    def self.dimensions_unit
+      @@dimensions_unit
+    end
+
+    def self.dutiable!
+      @@dutiable = true
+    end
+
+    def self.not_dutiable!
+      @@dutiable = false
+    end
+
+    def self.dutiable?
+      !!@@dutiable
+    end
+
+    def self.set_defaults
+      @@site_id = nil
+      @@password = nil
+      @@weight_unit = WEIGHT_UNIT_CODES[:kilograms]
+      @@dimensions_unit = DIMENSIONS_UNIT_CODES[:centimeters]
+      @@dutiable = false
+      @@test_mode = false
+    end
+  end
+end
+
+Dhl::GetQuote.set_defaults

data/spec/lib/dhl/dh-get_quote_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+require 'dhl-get_quote'
+
+describe Dhl::GetQuote do
+
+  # classvars may be remembered between tests, this sets things back to default
+  after(:each) do
+    Dhl::GetQuote.set_defaults
+  end
+
+  let(:klass) { Dhl::GetQuote }
+
+  let(:valid_request_options) do
+    {
+      :site_id  => 'SiteId',
+      :password => 'p4ssw0rd'
+    }
+  end
+
+  let (:valid_request) { request = Dhl::GetQuote::Request.new(valid_request_options) }
+
+  describe ".configure" do
+
+    it "must accept and execute a block" do
+      lambda do
+        klass.configure do
+          raise RuntimeError, "Testing"
+        end
+      end.must raise_exception RuntimeError
+    end
+
+    context "configure() block" do
+
+      describe ".test_mode!" do
+        before(:each) do
+          klass.configure { |c| c.test_mode! }
+        end
+
+        it "must set the class test_mode? to true" do
+          klass.test_mode?.must be_true
+        end
+
+        it "Dhl::GetQuote::Request must honor this test mode" do
+          request = Dhl::GetQuote::Request.new(valid_request_options)
+          request.test_mode?.must be_true
+        end
+      end
+
+      describe ".production_mode!" do
+        before(:each) do
+          klass.configure { |c| c.production_mode! }
+        end
+
+        it "must set the classvar test_mode to false" do
+          klass.test_mode?.must be_false
+        end
+
+        it "Dhl::GetQuote::Request must honor this test mode" do
+          request = Dhl::GetQuote::Request.new(valid_request_options)
+          request.test_mode?.must be_false
+        end
+      end
+
+      describe ".site_id" do
+        before(:each) { klass.configure { |c| c.site_id "SomethingHere" } }
+
+        it "must set class site_id to passed string" do
+          klass.site_id.must == "SomethingHere"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          request = Dhl::GetQuote::Request.new(
+            :password => 'xxx'
+          )
+
+          request.instance_variable_get(:@site_id).must == "SomethingHere"
+        end
+      end
+
+      describe ".password" do
+        before(:each) { klass.configure { |c| c.password "ppaasswwoorrdd" } }
+
+        it "must set class password to passed string" do
+          klass.password.must == "ppaasswwoorrdd"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          request = Dhl::GetQuote::Request.new(
+            :site_id => 'ASiteId'
+          )
+
+          request.instance_variable_get(:@password).must == "ppaasswwoorrdd"
+        end
+      end
+
+      describe "kilograms!" do
+        before(:each) { klass.configure { |c| c.kilograms! } }
+
+        it "must set class weight_unit to KG" do
+          klass.weight_unit.must == "KG"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          valid_request.weight_unit.must == "KG"
+        end
+      end
+
+      describe "pounds!" do
+        before(:each) { klass.configure { |c| c.pounds! } }
+
+        it "must set class weight_unit to LB" do
+          klass.weight_unit.must == "LB"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          valid_request.weight_unit.must == "LB"
+        end
+      end
+
+      describe "centimeters!" do
+        before(:each) { klass.configure { |c| c.centimeters! } }
+
+        it "must set class weight_unit to CM" do
+          klass.dimensions_unit.must == "CM"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          valid_request.dimensions_unit.must == "CM"
+        end
+      end
+
+      describe "inches!" do
+        before(:each) { klass.configure { |c| c.inches! } }
+
+        it "must set class weight_unit to IN" do
+          klass.dimensions_unit.must == "IN"
+        end
+
+        it "Dhl::GetQuote::Request must honor this" do
+          valid_request.dimensions_unit.must == "IN"
+        end
+      end
+
+      describe ".dutiable!" do
+        before(:each) do
+          klass.configure { |c| c.dutiable! }
+        end
+
+        it "must set the class dutiable to true" do
+          klass.dutiable?.must be_true
+        end
+
+        it "Dhl::GetQuote::Request must honor this test mode" do
+          request = Dhl::GetQuote::Request.new(valid_request_options)
+          request.dutiable?.must be_true
+        end
+      end
+
+      describe ".not_dutiable!" do
+        before(:each) do
+          klass.configure { |c| c.not_dutiable! }
+        end
+
+        it "must set the classvar test_mode to false" do
+          klass.dutiable?.must be_false
+        end
+
+        it "Dhl::GetQuote::Request must honor this test mode" do
+          request = Dhl::GetQuote::Request.new(valid_request_options)
+          request.dutiable?.must be_false
+        end
+      end
+
+    end
+  end
+
+end

data/spec/lib/dhl/get_quote/market_service_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'dhl-get_quote'
+
+describe Dhl::GetQuote::MarketService do
+
+  let(:valid_params) do
+    {
+      :local_service_type => "SA",
+      :global_service_name => "DELIVERY SIGNATURE",
+      :local_service_type_name => "DELIVERY SIGNATURE",
+      :s_offered_cust_agreement => "N",
+      :charge_code_type => "XCH",
+      :mrk_srv_ind => "Y"
+    }
+  end
+
+  let(:valid_xml) do
+    '<MrkSrv>
+  <LocalServiceType>SA</LocalServiceType>
+  <GlobalServiceName>DELIVERY SIGNATURE</GlobalServiceName>
+  <LocalServiceTypeName>DELIVERY SIGNATURE</LocalServiceTypeName>
+  <SOfferedCustAgreement>N</SOfferedCustAgreement>
+  <ChargeCodeType>XCH</ChargeCodeType>
+  <MrkSrvInd>Y</MrkSrvInd>
+</MrkSrv>'
+  end
+
+  let(:klass) { Dhl::GetQuote::MarketService }
+
+  subject do
+    klass.new(valid_params)
+  end
+
+  describe "#initialize" do
+
+    context "string of xml is passed" do
+
+      it 'must build object from xml data' do
+
+        m = klass.new(valid_xml)
+
+        m.local_service_type.must == "SA"
+        m.global_service_name.must == "DELIVERY SIGNATURE"
+        m.local_service_type_name.must == "DELIVERY SIGNATURE"
+        m.s_offered_cust_agreement.must == "N"
+        m.charge_code_type.must == "XCH"
+        m.mrk_srv_ind.must == "Y"
+
+      end
+    end
+
+    context "hash is passed" do
+
+      it "must build an object from the hash" do
+
+        m = klass.new(valid_params)
+
+        valid_params.each do |k,v|
+          m.send(k).must == v
+        end
+
+      end
+
+    end
+  end
+
+  describe "#code" do
+    it "must return the special service code for a mrksrv" do
+      subject.code.must == "SA"
+    end
+  end
+
+  describe "#name" do
+    it "must return the local name for a mrksrv" do
+      subject.name.must == "DELIVERY SIGNATURE"
+    end
+  end
+end