Class: ActiveShipping::UPS
- Defined in:
- lib/active_shipping/carriers/ups.rb
Constant Summary collapse
- TEST_URL =
'https://wwwcie.ups.com'
- LIVE_URL =
'https://onlinetools.ups.com'
- RESOURCES =
{ :rates => 'ups.app/xml/Rate', :track => 'ups.app/xml/Track', :ship_confirm => 'ups.app/xml/ShipConfirm', :ship_accept => 'ups.app/xml/ShipAccept', :delivery_dates => 'ups.app/xml/TimeInTransit', :void => 'ups.app/xml/Void', :validate_address => 'ups.app/xml/XAV' }
- PICKUP_CODES =
HashWithIndifferentAccess.new( :daily_pickup => "01", :customer_counter => "03", :one_time_pickup => "06", :on_call_air => "07", :suggested_retail_rates => "11", :letter_center => "19", :air_service_center => "20" )
- CUSTOMER_CLASSIFICATIONS =
HashWithIndifferentAccess.new( :wholesale => "01", :occasional => "03", :retail => "04" )
- DEFAULT_CUSTOMER_CLASSIFICATIONS =
these are the defaults described in the UPS API docs, but they don't seem to apply them under all circumstances, so we need to take matters into our own hands
Hash.new do |hash, key| hash[key] = case key.to_sym when :daily_pickup then :wholesale when :customer_counter then :retail else :occasional end end
- DEFAULT_SERVICES =
{ "01" => "UPS Next Day Air", "02" => "UPS Second Day Air", "03" => "UPS Ground", "07" => "UPS Worldwide Express", "08" => "UPS Worldwide Expedited", "11" => "UPS Standard", "12" => "UPS Three-Day Select", "13" => "UPS Next Day Air Saver", "14" => "UPS Next Day Air Early A.M.", "54" => "UPS Worldwide Express Plus", "59" => "UPS Second Day Air A.M.", "65" => "UPS Saver", "82" => "UPS Today Standard", "83" => "UPS Today Dedicated Courier", "84" => "UPS Today Intercity", "85" => "UPS Today Express", "86" => "UPS Today Express Saver", "92" => "UPS SurePost (USPS) < 1lb", "93" => "UPS SurePost (USPS) > 1lb", "94" => "UPS SurePost (USPS) BPM", "95" => "UPS SurePost (USPS) Media", }
- CANADA_ORIGIN_SERVICES =
{ "01" => "UPS Express", "02" => "UPS Expedited", "14" => "UPS Express Early A.M." }
- MEXICO_ORIGIN_SERVICES =
{ "07" => "UPS Express", "08" => "UPS Expedited", "54" => "UPS Express Plus" }
- EU_ORIGIN_SERVICES =
{ "07" => "UPS Express", "08" => "UPS Expedited" }
- OTHER_NON_US_ORIGIN_SERVICES =
{ "07" => "UPS Express" }
- RETURN_SERVICE_CODES =
{ "2" => "UPS Print and Mail (PNM)", "3" => "UPS Return Service 1-Attempt (RS1)", "5" => "UPS Return Service 3-Attempt (RS3)", "8" => "UPS Electronic Return Label (ERL)", "9" => "UPS Print Return Label (PRL)", "10" => "UPS Exchange Print Return Label", "11" => "UPS Pack & Collect Service 1-Attempt Box 1", "12" => "UPS Pack & Collect Service 1-Attempt Box 2", "13" => "UPS Pack & Collect Service 1-Attempt Box 3", "14" => "UPS Pack & Collect Service 1-Attempt Box 4", "15" => "UPS Pack & Collect Service 1-Attempt Box 5", "16" => "UPS Pack & Collect Service 3-Attempt Box 1", "17" => "UPS Pack & Collect Service 3-Attempt Box 2", "18" => "UPS Pack & Collect Service 3-Attempt Box 3", "19" => "UPS Pack & Collect Service 3-Attempt Box 4", "20" => "UPS Pack & Collect Service 3-Attempt Box 5", }
- TRACKING_STATUS_CODES =
HashWithIndifferentAccess.new( 'I' => :in_transit, 'D' => :delivered, 'X' => :exception, 'P' => :pickup, 'M' => :manifest_pickup )
- EU_COUNTRY_CODES =
From http://en.wikipedia.org/w/index.php?title=European_Union&oldid=174718707 (Current as of November 30, 2007)
%w(GB AT BE BG CY CZ DK EE FI FR DE GR HU IE IT LV LT LU MT NL PL PT RO SK SI ES SE)
- US_TERRITORIES_TREATED_AS_COUNTRIES =
%w(AS FM GU MH MP PW PR VI)
- IMPERIAL_COUNTRIES =
%w(US LR MM)
- COUNTRY_MAPPING =
{ 'XK' => 'KV' }.freeze
- DEFAULT_SERVICE_NAME_TO_CODE =
- SHIPMENT_DELIVERY_CONFIRMATION_CODES =
{ delivery_confirmation_signature_required: 1, delivery_confirmation_adult_signature_required: 2 }
- PACKAGE_DELIVERY_CONFIRMATION_CODES =
{ delivery_confirmation: 1, delivery_confirmation_signature_required: 2, delivery_confirmation_adult_signature_required: 3, usps_delivery_confirmation: 4 }
- @@name =
"UPS"
Instance Attribute Summary
Attributes inherited from Carrier
Instance Method Summary collapse
- #allow_package_level_reference_numbers(origin, destination) ⇒ Object protected
- #build_accept_request(digest, options = {}) ⇒ Object protected
- #build_access_request ⇒ Object protected
- #build_address_artifact_format_location(xml, name, location) ⇒ Object protected
- #build_address_validation_request(location, options = {}) ⇒ Object protected
- #build_billing_info_node(xml, options = {}) ⇒ Object protected
- #build_delivery_dates_request(origin, destination, packages, pickup_date, options = {}) ⇒ Object protected
- #build_document(xml, expected_root_tag) ⇒ Object protected
- #build_international_forms(xml, origin, destination, packages, options) ⇒ Object protected
- #build_location_node(xml, name, location, options = {}) ⇒ Object protected
- #build_package_node(xml, package, options = {}) ⇒ Object protected
-
#build_rate_request(origin, destination, packages, options = {}) ⇒ ActiveShipping::RateResponse
protected
Builds an XML node to request UPS shipping rates for the given packages.
-
#build_shipment_request(origin, destination, packages, options = {}) ⇒ Object
protected
Build XML node to request a shipping label for the given packages.
- #build_tracking_request(tracking_number, options = {}) ⇒ Object protected
- #build_void_request(tracking) ⇒ Object protected
- #commit(action, request, test = false) ⇒ Object protected
- #create_shipment(origin, destination, packages, options = {}) ⇒ Object
- #find_rates(origin, destination, packages, options = {}) ⇒ Object
-
#find_tracking_info(tracking_number, options = {}) ⇒ ActiveShipping::TrackingResponse
Retrieves tracking information for a previous shipment.
- #get_delivery_date_estimates(origin, destination, packages, pickup_date = Date.current, options = {}) ⇒ Object
- #handle_delivery_confirmation_options(origin, destination, packages, options) ⇒ Object protected
- #handle_package_level_delivery_confirmation(origin, destination, packages, options) ⇒ Object protected
- #handle_shipment_level_delivery_confirmation(origin, destination, packages, options) ⇒ Object protected
-
#location_from_address_key_format_node(address) ⇒ Object
protected
Converts from a AddressKeyFormat XML node to a Location.
- #location_from_address_node(address) ⇒ Object protected
- #mapped_country_code(country_code) ⇒ Object protected
- #maximum_address_field_length ⇒ Object
-
#package_level_delivery_confirmation?(origin, destination) ⇒ Boolean
protected
For certain origin/destination pairs, UPS allows each package in a shipment to have a specified delivery_confirmation option otherwise the delivery_confirmation option must be specified on the entire shipment.
- #parse_address_validation_response(address, response, options = {}) ⇒ Object protected
- #parse_delivery_dates_response(origin, destination, packages, response, options = {}) ⇒ Object protected
- #parse_rate_response(origin, destination, packages, response, options = {}) ⇒ Object protected
- #parse_ship_accept(response) ⇒ Object protected
- #parse_ship_confirm(response) ⇒ Object protected
- #parse_tracking_response(response, options = {}) ⇒ Object protected
- #parse_ups_datetime(options = {}) ⇒ Object protected
- #parse_void_response(response, options = {}) ⇒ Object protected
- #rate_warning_messages(rate_xml) ⇒ Object protected
- #requirements ⇒ Object
- #response_digest(xml) ⇒ Object protected
- #response_message(document) ⇒ Object protected
- #response_success?(document) ⇒ Boolean protected
- #service_name_for(origin, code) ⇒ Object protected
- #upsified_location(location) ⇒ Object protected
-
#validate_address(location, options = {}) ⇒ ActiveShipping::AddressValidationResponse
Validates a location with the Street Level Validation service.
- #void_shipment(tracking, options = {}) ⇒ Object
- #within_same_area?(origin, location) ⇒ Boolean protected
Methods inherited from Carrier
#available_services, #cancel_shipment, default_location, #initialize, #maximum_weight, #save_request, #timestamp_from_business_day, #valid_credentials?
Constructor Details
This class inherits a constructor from ActiveShipping::Carrier
Instance Method Details
#allow_package_level_reference_numbers(origin, destination) ⇒ Object (protected)
1167 1168 1169 1170 1171 |
# File 'lib/active_shipping/carriers/ups.rb', line 1167 def allow_package_level_reference_numbers(origin, destination) # if the package is US -> US or PR -> PR the only type of reference numbers that are allowed are package-level # Otherwise the only type of reference numbers that are allowed are shipment-level [['US','US'],['PR', 'PR']].include?([origin,destination].map(&:country_code)) end |
#build_accept_request(digest, options = {}) ⇒ Object (protected)
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/active_shipping/carriers/ups.rb', line 614 def build_accept_request(digest, = {}) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.ShipmentAcceptRequest do xml.Request do xml.RequestAction('ShipAccept') end xml.ShipmentDigest(digest) end end xml_builder.to_xml end |
#build_access_request ⇒ Object (protected)
269 270 271 272 273 274 275 276 277 278 |
# File 'lib/active_shipping/carriers/ups.rb', line 269 def build_access_request xml_builder = Nokogiri::XML::Builder.new do |xml| xml.AccessRequest do xml.AccessLicenseNumber(@options[:key]) xml.UserId(@options[:login]) xml.Password(@options[:password]) end end xml_builder.to_xml end |
#build_address_artifact_format_location(xml, name, location) ⇒ Object (protected)
686 687 688 689 690 691 692 693 694 695 696 |
# File 'lib/active_shipping/carriers/ups.rb', line 686 def build_address_artifact_format_location(xml, name, location) xml.public_send(name) do xml.AddressArtifactFormat do xml.PoliticalDivision2(location.city) xml.PoliticalDivision1(location.province) xml.CountryCode(mapped_country_code(location.country_code(:alpha2))) xml.PostcodePrimaryLow(location.postal_code) xml.ResidentialAddressIndicator(true) unless location.commercial? end end end |
#build_address_validation_request(location, options = {}) ⇒ Object (protected)
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 |
# File 'lib/active_shipping/carriers/ups.rb', line 986 def build_address_validation_request(location, = {}) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.AddressValidationRequest do xml.Request do xml.RequestAction('XAV') xml.RequestOption('3') if [:customer_context] xml.TransactionReference do xml.CustomerContext([:customer_context]) xml.XpciVersion("1.0") end end end xml.AddressKeyFormat do xml.AddressLine(location.address1) if location.address2.present? xml.AddressLine(location.address2) end xml.PoliticalDivision2(location.city) xml.PoliticalDivision1(location.state) xml.PostcodePrimaryLow(location.postal_code) xml.CountryCode(mapped_country_code(location.country_code)) end end end xml_builder.to_xml end |
#build_billing_info_node(xml, options = {}) ⇒ Object (protected)
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 |
# File 'lib/active_shipping/carriers/ups.rb', line 785 def build_billing_info_node(xml, ={}) if [:bill_third_party] xml.BillThirdParty do node_type = [:bill_to_consignee] ? :BillThirdPartyConsignee : :BillThirdPartyShipper xml.public_send(node_type) do xml.AccountNumber([:billing_account]) xml.ThirdParty do xml.Address do xml.PostalCode([:billing_zip]) xml.CountryCode(mapped_country_code([:billing_country])) end end end end else xml.BillShipper do xml.AccountNumber([:origin_account]) end end end |
#build_delivery_dates_request(origin, destination, packages, pickup_date, options = {}) ⇒ Object (protected)
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/active_shipping/carriers/ups.rb', line 533 def build_delivery_dates_request(origin, destination, packages, pickup_date, ={}) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.TimeInTransitRequest do xml.Request do xml.RequestAction('TimeInTransit') end build_address_artifact_format_location(xml, 'TransitFrom', origin) build_address_artifact_format_location(xml, 'TransitTo', destination) xml.ShipmentWeight do xml.UnitOfMeasurement do xml.Code([:imperial] ? 'LBS' : 'KGS') end value = packages.inject(0) do |sum, package| sum + ([:imperial] ? package.lbs.to_f : package.kgs.to_f ) end xml.Weight([value.round(3), 0.1].max) end if packages.any? {|package| package.value.present?} xml.InvoiceLineTotal do xml.CurrencyCode('USD') total_value = packages.inject(0) {|sum, package| sum + package.value.to_i} xml.MonetaryValue(total_value) end end xml.PickupDate(pickup_date.strftime('%Y%m%d')) end end xml_builder.to_xml end |
#build_document(xml, expected_root_tag) ⇒ Object (protected)
806 807 808 809 810 811 812 813 814 |
# File 'lib/active_shipping/carriers/ups.rb', line 806 def build_document(xml, expected_root_tag) document = Nokogiri.XML(xml) if document.root.nil? || document.root.name != expected_root_tag raise ActiveShipping::ResponseContentError.new(StandardError.new('Invalid document'), xml) end document rescue Nokogiri::XML::SyntaxError => e raise ActiveShipping::ResponseContentError.new(e, xml) end |
#build_international_forms(xml, origin, destination, packages, options) ⇒ Object (protected)
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'lib/active_shipping/carriers/ups.rb', line 583 def build_international_forms(xml, origin, destination, packages, ) if [:paperless_invoice] xml.InternationalForms do xml.FormType('01') # 01 is "Invoice" xml.InvoiceDate([:invoice_date] || Date.today.strftime('%Y%m%d')) xml.ReasonForExport([:reason_for_export] || 'SALE') xml.CurrencyCode([:currency_code] || 'USD') if [:terms_of_shipment] xml.TermsOfShipment([:terms_of_shipment]) end packages.each do |package| xml.Product do |xml| xml.Description(package.[:description]) xml.CommodityCode(package.[:commodity_code]) xml.OriginCountryCode(origin.country_code(:alpha2)) xml.Unit do |xml| xml.Value(package.value / (package.[:item_count] || 1)) xml.Number((package.[:item_count] || 1)) xml.UnitOfMeasurement do |xml| # NMB = number. You can specify units in barrels, boxes, etc. Codes are in the api docs. xml.Code(package.[:unit_of_item_count] || 'NMB') end end end end end end end |
#build_location_node(xml, name, location, options = {}) ⇒ Object (protected)
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 |
# File 'lib/active_shipping/carriers/ups.rb', line 641 def build_location_node(xml, name, location, = {}) # not implemented: * Shipment/Shipper/Name element # * Shipment/(ShipTo|ShipFrom)/CompanyName element # * Shipment/(Shipper|ShipTo|ShipFrom)/AttentionName element # * Shipment/(Shipper|ShipTo|ShipFrom)/TaxIdentificationNumber element xml.public_send(name) do if shipper_name = (location.name || location.company_name || [:origin_name]) xml.Name(shipper_name) end xml.PhoneNumber(location.phone.gsub(/[^\d]/, '')) unless location.phone.blank? xml.FaxNumber(location.fax.gsub(/[^\d]/, '')) unless location.fax.blank? if name == 'Shipper' and (origin_account = [:origin_account] || @options[:origin_account]) xml.ShipperNumber(origin_account) elsif name == 'ShipTo' and (destination_account = [:destination_account] || @options[:destination_account]) xml.ShipperAssignedIdentificationNumber(destination_account) end if name = (location.company_name || location.name || [:origin_name]) xml.CompanyName(name) end if phone = location.phone xml.PhoneNumber(phone) end if attn = location.name xml.AttentionName(attn) end xml.Address do xml.AddressLine1(location.address1) unless location.address1.blank? xml.AddressLine2(location.address2) unless location.address2.blank? xml.AddressLine3(location.address3) unless location.address3.blank? xml.City(location.city) unless location.city.blank? xml.StateProvinceCode(location.province) unless location.province.blank? # StateProvinceCode required for negotiated rates but not otherwise, for some reason xml.PostalCode(location.postal_code) unless location.postal_code.blank? xml.CountryCode(mapped_country_code(location.country_code(:alpha2))) unless location.country_code(:alpha2).blank? xml.ResidentialAddressIndicator(true) unless location.commercial? # the default should be that UPS returns residential rates for destinations that it doesn't know about # not implemented: Shipment/(Shipper|ShipTo|ShipFrom)/Address/ResidentialAddressIndicator element end end end |
#build_package_node(xml, package, options = {}) ⇒ Object (protected)
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 |
# File 'lib/active_shipping/carriers/ups.rb', line 698 def build_package_node(xml, package, = {}) xml.Package do # not implemented: * Shipment/Package/PackagingType element #return requires description if [:return] contents_description = package.[:description] xml.Description(contents_description) if contents_description end xml.PackagingType do xml.Code('02') end xml.Dimensions do xml.UnitOfMeasurement do xml.Code([:imperial] ? 'IN' : 'CM') end [:length, :width, :height].each do |axis| value = (([:imperial] ? package.inches(axis) : package.cm(axis)).to_f * 1000).round / 1000.0 # 3 decimals xml.public_send(axis.to_s.capitalize, [value, 0.1].max) end end xml.PackageWeight do if ([:service] || [:service_code]) == DEFAULT_SERVICE_NAME_TO_CODE["UPS SurePost (USPS) < 1lb"] # SurePost < 1lb uses OZS, not LBS code = [:imperial] ? 'OZS' : 'KGS' weight = [:imperial] ? package.oz : package.kgs else code = [:imperial] ? 'LBS' : 'KGS' weight = [:imperial] ? package.lbs : package.kgs end xml.UnitOfMeasurement do xml.Code(code) end value = ((weight).to_f * 1000).round / 1000.0 # 3 decimals xml.Weight([value, 0.1].max) end Array(package.[:reference_numbers]).each do |reference_number_info| xml.ReferenceNumber do xml.Code(reference_number_info[:code] || "") xml.Value(reference_number_info[:value]) end end xml.PackageServiceOptions do if delivery_confirmation = package.[:delivery_confirmation] xml.DeliveryConfirmation do xml.DCISType(PACKAGE_DELIVERY_CONFIRMATION_CODES[delivery_confirmation]) end end if dry_ice = package.[:dry_ice] xml.DryIce do xml.RegulationSet(dry_ice[:regulation_set] || 'CFR') xml.DryIceWeight do xml.UnitOfMeasurement do xml.Code([:imperial] ? 'LBS' : 'KGS') end # Cannot be more than package weight. # Should be more than 0.0. # Valid characters are 0-9 and .(Decimal point). # Limit to 1 digit after the decimal. The maximum length # of the field is 5 including . and can hold up # to 1 decimal place. xml.Weight(dry_ice[:weight]) end end end if package_value = package.[:insured_value] xml.InsuredValue do xml.CurrencyCode(package.[:currency] || 'USD') xml.MonetaryValue(package_value.to_f) end end end # not implemented: * Shipment/Package/LargePackageIndicator element # * Shipment/Package/AdditionalHandling element end end |
#build_rate_request(origin, destination, packages, options = {}) ⇒ ActiveShipping::RateResponse (protected)
Builds an XML node to request UPS shipping rates for the given packages
options:
- service: name of the service
- pickup_type: symbol for PICKUP_CODES
- customer_classification: symbol for CUSTOMER_CLASSIFICATIONS
- shipper: who is sending the package and where it should be returned if it is undeliverable.
- imperial: if truthy, measurements will use the metric system
- negotiated_rates: if truthy, negotiated rates will be requested from UPS. Only valid if shipper account has negotiated rates.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/active_shipping/carriers/ups.rb', line 299 def build_rate_request(origin, destination, packages, = {}) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.RatingServiceSelectionRequest do xml.Request do xml.RequestAction('Rate') xml.RequestOption(([:service].nil?) ? 'Shop' : 'Rate') end pickup_type = [:pickup_type] || :daily_pickup xml.PickupType do xml.Code(PICKUP_CODES[pickup_type]) # not implemented: PickupType/PickupDetails element end cc = [:customer_classification] || DEFAULT_CUSTOMER_CLASSIFICATIONS[pickup_type] xml.CustomerClassification do xml.Code(CUSTOMER_CLASSIFICATIONS[cc]) end xml.Shipment do # not implemented: Shipment/Description element build_location_node(xml, 'Shipper', ([:shipper] || origin), ) build_location_node(xml, 'ShipTo', destination, ) build_location_node(xml, 'ShipFrom', origin, ) if [:shipper] && [:shipper] != origin # not implemented: * Shipment/ShipmentWeight element # * Shipment/ReferenceNumber element # * Shipment/Service element # * Shipment/PickupDate element # * Shipment/ScheduledDeliveryDate element # * Shipment/ScheduledDeliveryTime element # * Shipment/AlternateDeliveryTime element # * Shipment/DocumentsOnly element unless [:service].nil? xml.Service do xml.Code([:service]) end end Array(packages).each do |package| [:imperial] ||= IMPERIAL_COUNTRIES.include?(origin.country_code(:alpha2)) build_package_node(xml, package, ) end # not implemented: * Shipment/ShipmentServiceOptions element if [:negotiated_rates] xml.RateInformation do xml.NegotiatedRatesIndicator end end end end end xml_builder.to_xml end |
#build_shipment_request(origin, destination, packages, options = {}) ⇒ Object (protected)
Build XML node to request a shipping label for the given packages.
options:
- origin_account: account number for the shipper
- customer_context: a "guid like substance" -- according to UPS
- shipper: who is sending the package and where it should be returned if it is undeliverable.
- ship_from: where the package is picked up.
- service_code: default to '03'
- saturday_delivery: any truthy value causes this element to exist
- optional_processing: 'validate' (blank) or 'nonvalidate' or blank
- paperless_invoice: set to truthy if using paperless invoice to ship internationally
- terms_of_shipment: used with paperless invoice to specify who pays duties and taxes
- reference_numbers: Array of hashes with :value => a reference number value and optionally :code => reference number type
- prepay: if truthy the shipper will be bill immediatly. Otherwise the shipper is billed when the label is used.
- negotiated_rates: if truthy negotiated rates will be requested from ups. Only valid if shipper account has negotiated rates.
- delivery_confirmation: Can be set to any key from SHIPMENT_DELIVERY_CONFIRMATION_CODES. Can also be set on package level via package.options
- bill_third_party: When truthy, bill an account other than the shipper's. Specified by billing_(account, zip and country)
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 |
# File 'lib/active_shipping/carriers/ups.rb', line 375 def build_shipment_request(origin, destination, packages, ={}) packages = Array(packages) shipper = [:shipper] || origin [:international] = origin.country.name != destination.country.name [:imperial] ||= IMPERIAL_COUNTRIES.include?(shipper.country_code(:alpha2)) [:return] = [:return_service_code].present? [:reason_for_export] ||= ("RETURN" if [:return]) if allow_package_level_reference_numbers(origin, destination) if [:reference_numbers] packages.each do |package| package.[:reference_numbers] = [:reference_numbers] end end [:reference_numbers] = [] end (origin, destination, packages, ) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.ShipmentConfirmRequest do xml.Request do xml.RequestAction('ShipConfirm') # Required element cotnrols level of address validation. xml.RequestOption([:optional_processing] || 'validate') # Optional element to identify transactions between client and server. if [:customer_context] xml.TransactionReference do xml.CustomerContext([:customer_context]) end end end xml.Shipment do xml.Service do xml.Code([:service_code] || '03') end build_location_node(xml, 'ShipTo', destination, ) build_location_node(xml, 'ShipFrom', origin, ) # Required element. The company whose account is responsible for the label(s). build_location_node(xml, 'Shipper', shipper, ) if [:saturday_delivery] xml.ShipmentServiceOptions do xml.SaturdayDelivery end end if [:negotiated_rates] xml.RateInformation do xml.NegotiatedRatesIndicator end end Array([:reference_numbers]).each do |reference_num_info| xml.ReferenceNumber do xml.Code(reference_num_info[:code] || "") xml.Value(reference_num_info[:value]) end end if [:prepay] xml.PaymentInformation do xml.Prepaid do build_billing_info_node(xml, ) end end else xml.ItemizedPaymentInformation do xml.ShipmentCharge do # Type '01' means 'Transportation' # This node specifies who will be billed for transportation. xml.Type('01') build_billing_info_node(xml, ) end if [:terms_of_shipment] == 'DDP' && [:international] # DDP stands for delivery duty paid and means the shipper will cover duties and taxes # Otherwise UPS will charge the receiver xml.ShipmentCharge do xml.Type('02') # Type '02' means 'Duties and Taxes' build_billing_info_node(xml, .merge(bill_to_consignee: true)) end end end end if [:international] unless [:return] build_location_node(xml, 'SoldTo', [:sold_to] || destination, ) end if origin.country_code(:alpha2) == 'US' && ['CA', 'PR'].include?(destination.country_code(:alpha2)) # Required for shipments from the US to Puerto Rico or Canada xml.InvoiceLineTotal do total_value = packages.inject(0) {|sum, package| sum + (package.value || 0)} xml.MonetaryValue(total_value) end end contents_description = packages.map {|p| p.[:description]}.compact.join(',') unless contents_description.empty? xml.Description(contents_description) end end if [:return] xml.ReturnService do xml.Code([:return_service_code]) end end xml.ShipmentServiceOptions do if delivery_confirmation = [:delivery_confirmation] xml.DeliveryConfirmation do xml.DCISType(SHIPMENT_DELIVERY_CONFIRMATION_CODES[delivery_confirmation]) end end if [:international] build_international_forms(xml, origin, destination, packages, ) end end # A request may specify multiple packages. packages.each do |package| build_package_node(xml, package, ) end end # Supported label formats: # GIF, EPL, ZPL, STARPL and SPL label_format = [:label_format] ? [:label_format].upcase : 'GIF' label_size = [:label_size] ? [:label_size] : [4, 6] xml.LabelSpecification do xml.LabelStockSize do xml.Height(label_size[0]) xml.Width(label_size[1]) end xml.LabelPrintMethod do xml.Code(label_format) end # API requires these only if returning a GIF formated label if label_format == 'GIF' xml.HTTPUserAgent('Mozilla/4.5') xml.LabelImageFormat(label_format) do xml.Code(label_format) end end end end end xml_builder.to_xml end |
#build_tracking_request(tracking_number, options = {}) ⇒ Object (protected)
626 627 628 629 630 631 632 633 634 635 636 637 638 639 |
# File 'lib/active_shipping/carriers/ups.rb', line 626 def build_tracking_request(tracking_number, = {}) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.TrackRequest do xml.TrackingOption([:tracking_option]) if [:tracking_option] xml.Request do xml.RequestAction('Track') xml.RequestOption('1') end xml.TrackingNumber(tracking_number.to_s) xml.TrackingOption('03') if [:mail_innovations] end end xml_builder.to_xml end |
#build_void_request(tracking) ⇒ Object (protected)
571 572 573 574 575 576 577 578 579 580 581 |
# File 'lib/active_shipping/carriers/ups.rb', line 571 def build_void_request(tracking) xml_builder = Nokogiri::XML::Builder.new do |xml| xml.VoidShipmentRequest do xml.Request do xml.RequestAction('Void') end xml.ShipmentIdentificationNumber(tracking) end end xml_builder.to_xml end |
#commit(action, request, test = false) ⇒ Object (protected)
1142 1143 1144 1145 |
# File 'lib/active_shipping/carriers/ups.rb', line 1142 def commit(action, request, test = false) response = ssl_post("#{test ? TEST_URL : LIVE_URL}/#{RESOURCES[action]}", request) response.encode('utf-8', 'iso-8859-1') end |
#create_shipment(origin, destination, packages, options = {}) ⇒ Object
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/active_shipping/carriers/ups.rb', line 184 def create_shipment(origin, destination, packages, = {}) = @options.merge() packages = Array(packages) access_request = build_access_request # STEP 1: Confirm. Validation step, important for verifying price. confirm_request = build_shipment_request(origin, destination, packages, ) logger.debug(confirm_request) if logger confirm_response = commit(:ship_confirm, save_request(access_request + confirm_request), ([:test] || false)) logger.debug(confirm_response) if logger # ... now, get the digest, it's needed to get the label. In theory, # one could make decisions based on the price or some such to avoid # surprises. This also has *no* error handling yet. xml = parse_ship_confirm(confirm_response) success = response_success?(xml) = (xml) raise ActiveShipping::ResponseContentError, StandardError.new() unless success digest = response_digest(xml) # STEP 2: Accept. Use shipment digest in first response to get the actual label. accept_request = build_accept_request(digest, ) logger.debug(accept_request) if logger accept_response = commit(:ship_accept, save_request(access_request + accept_request), ([:test] || false)) logger.debug(accept_response) if logger # ...finally, build a map from the response that contains # the label data and tracking information. parse_ship_accept(accept_response) end |
#find_rates(origin, destination, packages, options = {}) ⇒ Object
157 158 159 160 161 162 163 164 165 |
# File 'lib/active_shipping/carriers/ups.rb', line 157 def find_rates(origin, destination, packages, = {}) origin, destination = upsified_location(origin), upsified_location(destination) = @options.merge() packages = Array(packages) access_request = build_access_request rate_request = build_rate_request(origin, destination, packages, ) response = commit(:rates, save_request(access_request + rate_request), [:test]) parse_rate_response(origin, destination, packages, response, ) end |
#find_tracking_info(tracking_number, options = {}) ⇒ ActiveShipping::TrackingResponse
Override with whatever you need to get a shipping label
Retrieves tracking information for a previous shipment
176 177 178 179 180 181 182 |
# File 'lib/active_shipping/carriers/ups.rb', line 176 def find_tracking_info(tracking_number, = {}) = @options.merge() access_request = build_access_request tracking_request = build_tracking_request(tracking_number, ) response = commit(:track, save_request(access_request + tracking_request), [:test]) parse_tracking_response(response, ) end |
#get_delivery_date_estimates(origin, destination, packages, pickup_date = Date.current, options = {}) ⇒ Object
217 218 219 220 221 222 223 224 225 |
# File 'lib/active_shipping/carriers/ups.rb', line 217 def get_delivery_date_estimates(origin, destination, packages, pickup_date=Date.current, = {}) origin, destination = upsified_location(origin), upsified_location(destination) = @options.merge() packages = Array(packages) access_request = build_access_request dates_request = build_delivery_dates_request(origin, destination, packages, pickup_date, ) response = commit(:delivery_dates, save_request(access_request + dates_request), ([:test] || false)) parse_delivery_dates_response(origin, destination, packages, response, ) end |
#handle_delivery_confirmation_options(origin, destination, packages, options) ⇒ Object (protected)
1173 1174 1175 1176 1177 1178 1179 |
# File 'lib/active_shipping/carriers/ups.rb', line 1173 def (origin, destination, packages, ) if package_level_delivery_confirmation?(origin, destination) handle_package_level_delivery_confirmation(origin, destination, packages, ) else handle_shipment_level_delivery_confirmation(origin, destination, packages, ) end end |
#handle_package_level_delivery_confirmation(origin, destination, packages, options) ⇒ Object (protected)
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 |
# File 'lib/active_shipping/carriers/ups.rb', line 1181 def handle_package_level_delivery_confirmation(origin, destination, packages, ) packages.each do |package| # Transfer shipment-level option to package with no specified delivery_confirmation package.[:delivery_confirmation] = [:delivery_confirmation] unless package.[:delivery_confirmation] # Assert that option is valid if package.[:delivery_confirmation] && !PACKAGE_DELIVERY_CONFIRMATION_CODES[package.[:delivery_confirmation]] raise "Invalid delivery_confirmation option on package: '#{package.[:delivery_confirmation]}'. Use a key from PACKAGE_DELIVERY_CONFIRMATION_CODES" end end .delete(:delivery_confirmation) end |
#handle_shipment_level_delivery_confirmation(origin, destination, packages, options) ⇒ Object (protected)
1194 1195 1196 1197 1198 1199 1200 1201 1202 |
# File 'lib/active_shipping/carriers/ups.rb', line 1194 def handle_shipment_level_delivery_confirmation(origin, destination, packages, ) if packages.any? { |p| p.[:delivery_confirmation] } raise "origin/destination pair does not support package level delivery_confirmation options" end if [:delivery_confirmation] && !SHIPMENT_DELIVERY_CONFIRMATION_CODES[[:delivery_confirmation]] raise "Invalid delivery_confirmation option: '#{[:delivery_confirmation]}'. Use a key from SHIPMENT_DELIVERY_CONFIRMATION_CODES" end end |
#location_from_address_key_format_node(address) ⇒ Object (protected)
Converts from a AddressKeyFormat XML node to a Location
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 |
# File 'lib/active_shipping/carriers/ups.rb', line 1059 def location_from_address_key_format_node(address) return nil unless address country = address.at('CountryCode').try(:text) country = 'US' if country == 'ZZ' # Sometimes returned by SUREPOST in the US address_lines = address.css('AddressLine') Location.new( :country => country, :postal_code => address.at('PostcodePrimaryLow').try(:text), :province => address.at('PoliticalDivision1').try(:text), :city => address.at('PoliticalDivision2').try(:text), :address1 => address_lines[0].try(:text), :address2 => address_lines[1].try(:text), :address3 => address_lines[2].try(:text), ) end |
#location_from_address_node(address) ⇒ Object (protected)
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 |
# File 'lib/active_shipping/carriers/ups.rb', line 1077 def location_from_address_node(address) return nil unless address country = address.at('CountryCode').try(:text) country = 'US' if country == 'ZZ' # Sometimes returned by SUREPOST in the US country = 'XK' if country == 'KV' # ActiveUtils now refers to Kosovo by XK Location.new( :country => country, :postal_code => address.at('PostalCode').try(:text), :province => address.at('StateProvinceCode').try(:text), :city => address.at('City').try(:text), :address1 => address.at('AddressLine1').try(:text), :address2 => address.at('AddressLine2').try(:text), :address3 => address.at('AddressLine3').try(:text) ) end |
#mapped_country_code(country_code) ⇒ Object (protected)
1212 1213 1214 |
# File 'lib/active_shipping/carriers/ups.rb', line 1212 def mapped_country_code(country_code) COUNTRY_MAPPING[country_code].presence || country_code end |
#maximum_address_field_length ⇒ Object
235 236 237 238 |
# File 'lib/active_shipping/carriers/ups.rb', line 235 def maximum_address_field_length # http://www.ups.com/worldshiphelp/WS12/ENU/AppHelp/CONNECT/Shipment_Data_Field_Descriptions.htm 35 end |
#package_level_delivery_confirmation?(origin, destination) ⇒ Boolean (protected)
For certain origin/destination pairs, UPS allows each package in a shipment to have a specified delivery_confirmation option otherwise the delivery_confirmation option must be specified on the entire shipment. See Appendix P of UPS Shipping Package XML Developers Guide for the rules on which the logic below is based.
1207 1208 1209 1210 |
# File 'lib/active_shipping/carriers/ups.rb', line 1207 def package_level_delivery_confirmation?(origin, destination) origin.country_code == destination.country_code || [['US','PR'], ['PR','US']].include?([origin,destination].map(&:country_code)) end |
#parse_address_validation_response(address, response, options = {}) ⇒ Object (protected)
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'lib/active_shipping/carriers/ups.rb', line 1017 def parse_address_validation_response(address, response, ={}) xml = build_document(response, 'AddressValidationResponse') success = response_success?(xml) = (xml) validity = nil classification_code = nil classification_description = nil addresses = [] if success if xml.at('AddressClassification/Code').present? classification_code = xml.at('AddressClassification/Code').text end classification = case classification_code when "1" :commercial when "2" :residential else :unknown end validity = if xml.at("ValidAddressIndicator").present? :valid elsif xml.at("AmbiguousAddressIndicator").present? :ambiguous elsif xml.at("NoCandidatesIndicator").present? :invalid else :unknown end addresses = xml.css('AddressKeyFormat').collect { |node| location_from_address_key_format_node(node) } end params = Hash.from_xml(response).values.first response = AddressValidationResponse.new(success, , params, :validity => validity, :classification => classification, :candidate_addresses => addresses, :xml => response, :request => last_request) end |
#parse_delivery_dates_response(origin, destination, packages, response, options = {}) ⇒ Object (protected)
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 |
# File 'lib/active_shipping/carriers/ups.rb', line 951 def parse_delivery_dates_response(origin, destination, packages, response, ={}) xml = build_document(response, 'TimeInTransitResponse') success = response_success?(xml) = (xml) delivery_estimates = [] if success xml.css('ServiceSummary').each do |service_summary| # Translate the Time in Transit Codes to the service codes used elsewhere service_name = service_summary.at('Service/Description').text service_code = UPS::DEFAULT_SERVICE_NAME_TO_CODE[service_name] date = Date.strptime(service_summary.at('EstimatedArrival/Date').text, '%Y-%m-%d') business_transit_days = service_summary.at('EstimatedArrival/BusinessTransitDays').text.to_i delivery_estimates << DeliveryDateEstimate.new(origin, destination, self.class.class_variable_get(:@@name), service_name, :service_code => service_code, :guaranteed => service_summary.at('Guaranteed/Code').text == 'Y', :date => date, :business_transit_days => business_transit_days) end end response = DeliveryDateEstimatesResponse.new(success, , Hash.from_xml(response).values.first, :delivery_estimates => delivery_estimates, :xml => response, :request => last_request) end |
#parse_rate_response(origin, destination, packages, response, options = {}) ⇒ Object (protected)
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'lib/active_shipping/carriers/ups.rb', line 816 def parse_rate_response(origin, destination, packages, response, = {}) xml = build_document(response, 'RatingServiceSelectionResponse') success = response_success?(xml) = (xml) if success rate_estimates = xml.root.css('> RatedShipment').map do |rated_shipment| service_code = rated_shipment.at('Service/Code').text days_to_delivery = rated_shipment.at('GuaranteedDaysToDelivery').text.to_i days_to_delivery = nil if days_to_delivery == 0 = (rated_shipment) RateEstimate.new(origin, destination, @@name, service_name_for(origin, service_code), :total_price => rated_shipment.at('TotalCharges/MonetaryValue').text.to_f, :insurance_price => rated_shipment.at('ServiceOptionsCharges/MonetaryValue').text.to_f, :currency => rated_shipment.at('TotalCharges/CurrencyCode').text, :service_code => service_code, :packages => packages, :delivery_range => [(days_to_delivery)], :negotiated_rate => rated_shipment.at('NegotiatedRates/NetSummaryCharges/GrandTotal/MonetaryValue').try(:text).to_f, :messages => ) end end RateResponse.new(success, , Hash.from_xml(response).values.first, :rates => rate_estimates, :xml => response, :request => last_request) end |
#parse_ship_accept(response) ⇒ Object (protected)
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 |
# File 'lib/active_shipping/carriers/ups.rb', line 1127 def parse_ship_accept(response) xml = build_document(response, 'ShipmentAcceptResponse') success = response_success?(xml) = (xml) response_info = Hash.from_xml(response).values.first packages = response_info["ShipmentResults"]["PackageResults"] packages = [packages] if Hash === packages labels = packages.map do |package| Label.new(package["TrackingNumber"], Base64.decode64(package["LabelImage"]["GraphicImage"])) end LabelResponse.new(success, , response_info, {labels: labels}) end |
#parse_ship_confirm(response) ⇒ Object (protected)
1123 1124 1125 |
# File 'lib/active_shipping/carriers/ups.rb', line 1123 def parse_ship_confirm(response) build_document(response, 'ShipmentConfirmResponse') end |
#parse_tracking_response(response, options = {}) ⇒ Object (protected)
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 |
# File 'lib/active_shipping/carriers/ups.rb', line 842 def parse_tracking_response(response, = {}) xml = build_document(response, 'TrackResponse') success = response_success?(xml) = (xml) if success delivery_signature = nil exception_event, scheduled_delivery_date, actual_delivery_date = nil delivered, exception = false shipment_events = [] first_shipment = xml.root.at('Shipment') first_package = first_shipment.at('Package') tracking_number = first_shipment.at_xpath('ShipmentIdentificationNumber | Package/TrackingNumber').text # Build status hash status_nodes = first_package.css('Activity > Status > StatusType') if status_nodes.present? # Prefer a delivery node status_node = status_nodes.detect { |x| x.at('Code').text == 'D' } status_node ||= status_nodes.first status_code = status_node.at('Code').try(:text) status_description = status_node.at('Description').try(:text) status = TRACKING_STATUS_CODES[status_code] if status_description =~ /out.*delivery/i status = :out_for_delivery end end origin, destination = %w(Shipper ShipTo).map do |location| location_from_address_node(first_shipment.at("#{location}/Address")) end # Get scheduled delivery date unless status == :delivered scheduled_delivery_date_node = first_shipment.at('ScheduledDeliveryDate') scheduled_delivery_date_node ||= first_shipment.at('RescheduledDeliveryDate') if scheduled_delivery_date_node scheduled_delivery_date = parse_ups_datetime( :date => scheduled_delivery_date_node, :time => nil ) end end activities = first_package.css('> Activity') unless activities.empty? shipment_events = activities.map do |activity| description = activity.at('Status/StatusType/Description').try(:text) type_code = activity.at('Status/StatusType/Code').try(:text) zoneless_time = parse_ups_datetime(:time => activity.at('Time'), :date => activity.at('Date')) location = location_from_address_node(activity.at('ActivityLocation/Address')) ShipmentEvent.new(description, zoneless_time, location, description, type_code) end shipment_events = shipment_events.sort_by(&:time) # UPS will sometimes archive a shipment, stripping all shipment activity except for the delivery # event (see test/fixtures/xml/delivered_shipment_without_events_tracking_response.xml for an example). # This adds an origin event to the shipment activity in such cases. if origin && !(shipment_events.count == 1 && status == :delivered) first_event = shipment_events[0] origin_event = ShipmentEvent.new(first_event.name, first_event.time, origin, first_event., first_event.type_code) if within_same_area?(origin, first_event.location) shipment_events[0] = origin_event else shipment_events.unshift(origin_event) end end # Has the shipment been delivered? if status == :delivered delivered_activity = activities.first delivery_signature = delivered_activity.at('ActivityLocation/SignedForByName').try(:text) if delivered_activity.at('Status/StatusType/Code').text == 'D' actual_delivery_date = parse_ups_datetime(:date => delivered_activity.at('Date'), :time => delivered_activity.at('Time')) end unless destination destination = shipment_events[-1].location end shipment_events[-1] = ShipmentEvent.new(shipment_events.last.name, shipment_events.last.time, destination, shipment_events.last., shipment_events.last.type_code) end end end TrackingResponse.new(success, , Hash.from_xml(response).values.first, :carrier => @@name, :xml => response, :request => last_request, :status => status, :status_code => status_code, :status_description => status_description, :delivery_signature => delivery_signature, :scheduled_delivery_date => scheduled_delivery_date, :actual_delivery_date => actual_delivery_date, :shipment_events => shipment_events, :delivered => delivered, :exception => exception, :exception_event => exception_event, :origin => origin, :destination => destination, :tracking_number => tracking_number) end |
#parse_ups_datetime(options = {}) ⇒ Object (protected)
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'lib/active_shipping/carriers/ups.rb', line 1093 def parse_ups_datetime( = {}) time, date = [:time].try(:text), [:date].text if time.nil? hour, minute, second = 0 else hour, minute, second = time.scan(/\d{2}/) end year, month, day = date[0..3], date[4..5], date[6..7] Time.utc(year, month, day, hour, minute, second) end |
#parse_void_response(response, options = {}) ⇒ Object (protected)
975 976 977 978 979 980 981 982 983 984 |
# File 'lib/active_shipping/carriers/ups.rb', line 975 def parse_void_response(response, ={}) xml = build_document(response, 'VoidShipmentResponse') success = response_success?(xml) = (xml) if success true else raise ResponseError.new("Void shipment failed with message: #{}") end end |
#rate_warning_messages(rate_xml) ⇒ Object (protected)
1115 1116 1117 |
# File 'lib/active_shipping/carriers/ups.rb', line 1115 def (rate_xml) rate_xml.xpath("RatedShipmentWarning").map { |warning| warning.text } end |
#requirements ⇒ Object
153 154 155 |
# File 'lib/active_shipping/carriers/ups.rb', line 153 def requirements [:key, :login, :password] end |
#response_digest(xml) ⇒ Object (protected)
1119 1120 1121 |
# File 'lib/active_shipping/carriers/ups.rb', line 1119 def response_digest(xml) xml.root.at('ShipmentDigest').text end |
#response_message(document) ⇒ Object (protected)
1109 1110 1111 1112 1113 |
# File 'lib/active_shipping/carriers/ups.rb', line 1109 def (document) status = document.root.at_xpath('Response/ResponseStatusDescription').try(:text) desc = document.root.at_xpath('Response/Error/ErrorDescription').try(:text) [status, desc].select(&:present?).join(": ").presence || "UPS could not process the request." end |
#response_success?(document) ⇒ Boolean (protected)
1105 1106 1107 |
# File 'lib/active_shipping/carriers/ups.rb', line 1105 def response_success?(document) document.root.at('Response/ResponseStatusCode').text == '1' end |
#service_name_for(origin, code) ⇒ Object (protected)
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 |
# File 'lib/active_shipping/carriers/ups.rb', line 1154 def service_name_for(origin, code) origin = origin.country_code(:alpha2) name = case origin when "CA" then CANADA_ORIGIN_SERVICES[code] when "MX" then MEXICO_ORIGIN_SERVICES[code] when *EU_COUNTRY_CODES then EU_ORIGIN_SERVICES[code] end name ||= OTHER_NON_US_ORIGIN_SERVICES[code] unless name == 'US' name || DEFAULT_SERVICES[code] end |
#upsified_location(location) ⇒ Object (protected)
257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/active_shipping/carriers/ups.rb', line 257 def upsified_location(location) if location.country_code == 'US' && US_TERRITORIES_TREATED_AS_COUNTRIES.include?(location.state) atts = {:country => location.state} [:zip, :city, :address1, :address2, :address3, :phone, :fax, :address_type].each do |att| atts[att] = location.send(att) end Location.new(atts) else location end end |
#validate_address(location, options = {}) ⇒ ActiveShipping::AddressValidationResponse
Validates a location with the Street Level Validation service
246 247 248 249 250 251 252 253 |
# File 'lib/active_shipping/carriers/ups.rb', line 246 def validate_address(location, = {}) location = upsified_location(location) = @options.merge() access_request = build_access_request address_validation_request = build_address_validation_request(location, ) response = commit(:validate_address, save_request(access_request + address_validation_request), [:test]) parse_address_validation_response(location, response, ) end |
#void_shipment(tracking, options = {}) ⇒ Object
227 228 229 230 231 232 233 |
# File 'lib/active_shipping/carriers/ups.rb', line 227 def void_shipment(tracking, ={}) = @options.merge() access_request = build_access_request void_request = build_void_request(tracking) response = commit(:void, save_request(access_request + void_request), ([:test] || false)) parse_void_response(response, ) end |
#within_same_area?(origin, location) ⇒ Boolean (protected)
1147 1148 1149 1150 1151 1152 |
# File 'lib/active_shipping/carriers/ups.rb', line 1147 def within_same_area?(origin, location) return false unless location matching_country_codes = origin.country_code(:alpha2) == location.country_code(:alpha2) matching_or_blank_city = location.city.blank? || location.city == origin.city matching_country_codes && matching_or_blank_city end |