dhl-get_quote 0.5.0 → 0.5.1

data/README.md

@@ -6,6 +6,8 @@ Get shipping quotes from DHL's XML-PI Service.
 
 Use of the XML-PI Service requires you to have Site ID and Password from DHL. You can sign up here: https://myaccount.dhl.com/MyAccount/jsp/TermsAndConditionsIndex.htm
 
+Many thanks to John Riff of DHL for his help during the development of this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,8 +33,7 @@ Or install it yourself as:
     :test_mode => true # changes the url being hit
   )
 
-  r.kilograms!
-  r.centimeters!
+  r.metric_measurements!
 
   r.add_special_service("DD")
 
@@ -72,19 +73,40 @@ request = Dhl::GetQuote::Request.new(
 
 *NOTE*: You can also set default beforehand in, for example, an initializer. For more information on this, please see the section "Initializers with Dhl::GetQuote"
 
+#### Setting Payment Account Number
+
+If you are using a special account for shipping payments, you can specify it as
+
+```ruby
+  request.payment_account_number('12345678')
+```
+
+To read the current payment account number (if set), use:
+
+```ruby
+  request.payment_accout_number
+```
+
+It will return the current number or nil if none has been set.
+
 #### Package Source and Destination
 
 To set the source and destination, use the #to() and #from() methods:
 
-  #to(_country_code_, _postal_code_), #from(_country_code_, _postal_code_)
+  #to(_country_code_, _postal_code_, city_name), #from(_country_code_, _postal_code_, city_name)
 
-The country code must be the two-letter capitalized ISO country code. The postal code will be cast in to a string.
+The country code must be the two-letter capitalized ISO country code. The postal code will be cast in to a string. City name is optional.
 
 Example:
 
 ```ruby
+  # without city
   request.from('US', 84111)
   request.to('CA', 'T1H 0A1')
+
+  # with city
+  request.from('US', 84111, "Bountiful")
+  request.to('MX', "53950", 'Naucalpan de Juárez')
 ```
 
 #### Measurement Units
@@ -94,28 +116,21 @@ DHL can accept weights and measures in both Metric and US Customary units.  Weig
 To set to US Customary, use:
 
 ```ruby
-  request.inches! # set dimensions to inches
-  request.pounds! # set weight to pounds
+  request.us_measurements! # set dimensions to inches and weight to pounds
 ```
 
 To set back to Metric, use
 
 ```ruby
-  request.centimeters! # set dimensions to centimeters
-  request.centimetres! # alternate spelling
-
-  request.kilograms!   # set weight to kilograms
-  request.kilogrammes! # alternate spelling
+  request.metric_measurements! # set dimensions to centimeters and weight to kilograms
 ```
 
 To query what measurement system the object is currently using, use the following boolean calls:
 
 ```ruby
-  request.inches?
-  request.centimeters? # or request.centimetres?
+  request.us_measurements?
 
-  request.pounds?
-  request.kilograms? # or request.kilogrammes?
+  request.metric_measurements?
 ```
 
 You can also get the value directly:
@@ -129,11 +144,11 @@ You can also get the value directly:
 
 ! Note, this a breaking change from 0.4.x
 
-To set the duty on a shipment, use the dutiable!() method. It accepts the numeric value and an optional currency code. If not specified, the currency code default to US Dollars (USD).
+To set the duty on a shipment, use the dutiable() method. It accepts the numeric value and an optional currency code. If not specified, the currency code default to US Dollars (USD).
 
 ```ruby
   # set the dutiable value at $100 in US Dollars
-  request.dutiable!(100.00, 'USD')
+  request.dutiable(100.00, 'USD')
 ```
 
 To remove a previously set duty, use the not_dutiable!() method.
@@ -326,12 +341,10 @@ To do this, call Dhl::GetQuote::configure and pass a block:
 
     c.production_mode! # or test_mode!
 
-    c.kilograms!   # or kilogrammes!
-    c.centimeters! # or centimetres!
-    c.inches!
-    c.pounds!
+    c.metric_measurements!
+    c.us_measurements!
 
-    c.dutiable! # or not_dutiable!
+    c.dutiable(1.00, 'USD')
 
   end
 ```

data/lib/dhl/get_quote/request.rb

@@ -43,16 +43,18 @@ class Dhl::GetQuote::Request
     @test_mode = false
   end
 
-  def from(country_code, postal_code)
+  def from(country_code, postal_code, city=nil)
     @from_postal_code = postal_code.to_s
     validate_country_code!(country_code)
     @from_country_code = country_code
+    @from_city_name = city
   end
 
-  def to(country_code, postal_code)
+  def to(country_code, postal_code, city=nil)
     @to_postal_code = postal_code.to_s
     validate_country_code!(country_code)
     @to_country_code = country_code
+    @to_city_name = city
   end
 
   def dutiable?

data/lib/dhl/get_quote/version.rb

@@ -1,6 +1,6 @@
 class Dhl
   class GetQuote
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
 
     PostInstallMessage = <<EOS
 

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

@@ -63,6 +63,11 @@ describe Dhl::GetQuote::Request do
         subject.from('us', '84111')
       end.must raise_exception(Dhl::GetQuote::CountryCodeError)
     end
+
+    it 'must accept an optional city name' do
+      subject.from('US', '84111', "Bountiful")
+      subject.instance_variable_get(:@from_city_name).must == 'Bountiful'
+    end
   end
 
   describe '#to' do
@@ -94,6 +99,11 @@ describe Dhl::GetQuote::Request do
         subject.from('ca', 'T1H 0A1')
       end.must raise_exception(Dhl::GetQuote::CountryCodeError)
     end
+
+    it 'must accept an optional city name' do
+      subject.to('US', '84111', "Bountiful")
+      subject.instance_variable_get(:@to_city_name).must == 'Bountiful'
+    end
   end
 
   describe "#dutiable?" do

data/tpl/request.xml.erb

@@ -10,6 +10,7 @@
         <From>
             <CountryCode><%= @from_country_code %></CountryCode>
             <Postalcode><%= @from_postal_code %></Postalcode>
+            <% if @from_city_name -%><City><%= @from_city_name %></City><% end -%>
         </From>
         <BkgDetails>
             <PaymentCountryCode><%= @from_country_code %></PaymentCountryCode>
@@ -38,6 +39,7 @@
         <To>
             <CountryCode><%= @to_country_code %></CountryCode>
             <Postalcode><%= @to_postal_code %></Postalcode>
+            <% if @to_city_name -%><City><%= @to_city_name %></City><% end -%>
         </To>
         <%- if dutiable? %>
             <Dutiable>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhl-get_quote
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors: