class Fedex::Request::Shipment
Attributes
response_details[R]
Public Class Methods
new(credentials, options={})
click to toggle source
Calls superclass method
Fedex::Request::Base::new
# File lib/fedex/request/shipment.rb, line 8 def initialize(credentials, options={}) super requires!(options, :service_type) # Label specification is required even if we're not using it. @label_specification = { :label_format_type => 'COMMON2D', :image_type => 'PDF', :label_stock_type => 'PAPER_LETTER' } @label_specification.merge! options[:label_specification] if options[:label_specification] @customer_specified_detail = options[:customer_specified_detail] if options[:customer_specified_detail] end
Public Instance Methods
process_request()
click to toggle source
Sends post request to Fedex
web service and parse the response. A label file is created with the label at the specified location. The parsed Fedex
response is available in response_details
e.g. response_details[:completed_package_details][:tracking_number]
# File lib/fedex/request/shipment.rb, line 25 def process_request api_response = self.class.post api_url, :body => build_xml puts api_response if @debug response = parse_response(api_response) if success?(response) success_response(api_response, response) else failure_response(api_response, response) end end
Private Instance Methods
add_custom_components(xml)
click to toggle source
Hook that can be used to add custom parts.
# File lib/fedex/request/shipment.rb, line 68 def add_custom_components(xml) add_label_specification xml end
add_label_specification(xml)
click to toggle source
Add the label specification
# File lib/fedex/request/shipment.rb, line 73 def add_label_specification(xml) xml.LabelSpecification { xml.LabelFormatType @label_specification[:label_format_type] xml.ImageType @label_specification[:image_type] xml.LabelStockType @label_specification[:label_stock_type] xml.CustomerSpecifiedDetail{ hash_to_xml(xml, @customer_specified_detail) } if @customer_specified_detail if @label_specification[:printed_label_origin] && @label_specification[:printed_label_origin][:address] xml.PrintedLabelOrigin { xml.Contact { xml.PersonName @label_specification[:printed_label_origin][:address][:name] xml.CompanyName @label_specification[:printed_label_origin][:address][:company] xml.PhoneNumber @label_specification[:printed_label_origin][:address][:phone_number] } xml.Address { Array(@label_specification[:printed_label_origin][:address][:address]).each do |address_line| xml.StreetLines address_line end xml.City @label_specification[:printed_label_origin][:address][:city] xml.StateOrProvinceCode @label_specification[:printed_label_origin][:address][:state] xml.PostalCode @label_specification[:printed_label_origin][:address][:postal_code] xml.CountryCode @label_specification[:printed_label_origin][:address][:country_code] } } end } end
add_requested_shipment(xml)
click to toggle source
Add information for shipments
# File lib/fedex/request/shipment.rb, line 39 def add_requested_shipment(xml) xml.RequestedShipment{ xml.ShipTimestamp @shipping_options[:ship_timestamp] ||= Time.now.utc.iso8601(2) xml.DropoffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP" xml.ServiceType service_type xml.PackagingType @shipping_options[:packaging_type] ||= "YOUR_PACKAGING" add_total_weight(xml) if @mps.has_key? :total_weight add_shipper(xml) add_origin(xml) if @origin add_recipient(xml) add_shipping_charges_payment(xml) add_special_services(xml) if @shipping_options[:return_reason] || @shipping_options[:cod] || @shipping_options[:saturday_delivery] add_customs_clearance(xml) if @customs_clearance_detail add_custom_components(xml) xml.RateRequestTypes "ACCOUNT" add_packages(xml) } end
add_special_services(xml)
click to toggle source
# File lib/fedex/request/shipment.rb, line 101 def add_special_services(xml) xml.SpecialServicesRequested { if @shipping_options[:return_reason] xml.SpecialServiceTypes "RETURN_SHIPMENT" xml.ReturnShipmentDetail { xml.ReturnType "PRINT_RETURN_LABEL" xml.Rma { xml.Reason "#{@shipping_options[:return_reason]}" } } end if @shipping_options[:cod] xml.SpecialServiceTypes "COD" xml.CodDetail { xml.CodCollectionAmount { xml.Currency @shipping_options[:cod][:currency].upcase if @shipping_options[:cod][:currency] xml.Amount @shipping_options[:cod][:amount] if @shipping_options[:cod][:amount] } xml.CollectionType @shipping_options[:cod][:collection_type] if @shipping_options[:cod][:collection_type] } end if @shipping_options[:saturday_delivery] xml.SpecialServiceTypes "SATURDAY_DELIVERY" end } end
add_total_weight(xml)
click to toggle source
# File lib/fedex/request/shipment.rb, line 58 def add_total_weight(xml) if @mps.has_key? :total_weight xml.TotalWeight{ xml.Units @mps[:total_weight][:units] xml.Value @mps[:total_weight][:value] } end end
build_xml()
click to toggle source
Build xml Fedex
Web Service request
# File lib/fedex/request/shipment.rb, line 144 def build_xml builder = Nokogiri::XML::Builder.new do |xml| xml.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v#{service[:version]}"){ add_web_authentication_detail(xml) add_client_detail(xml) add_version(xml) add_requested_shipment(xml) } end builder.doc.root.to_xml end
failure_response(api_response, response)
click to toggle source
Callback used after a failed shipment response.
# File lib/fedex/request/shipment.rb, line 129 def failure_response(api_response, response) error_message = if response[:process_shipment_reply] [response[:process_shipment_reply][:notifications]].flatten.first[:message] else "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n--#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"].join("\n--")}" end rescue $1 raise RateError, error_message end
service()
click to toggle source
# File lib/fedex/request/shipment.rb, line 156 def service { :id => 'ship', :version => Fedex::API_VERSION } end
success?(response)
click to toggle source
Successful request
# File lib/fedex/request/shipment.rb, line 161 def success?(response) response[:process_shipment_reply] && %w{SUCCESS WARNING NOTE}.include?(response[:process_shipment_reply][:highest_severity]) end
success_response(api_response, response)
click to toggle source
Callback used after a successful shipment response.
# File lib/fedex/request/shipment.rb, line 139 def success_response(api_response, response) @response_details = response[:process_shipment_reply] end