fedex 3.6.1 → 3.8.0

data/lib/fedex/request/ground_close.rb

@@ -0,0 +1,73 @@
+require 'fedex/request/base'
+require 'fedex/ground_manifest'
+
+module Fedex
+  module Request
+    class GroundClose < Base
+
+      attr_reader :up_to_time, :filename
+
+      def initialize(credentials, options={})
+        requires!(options, :up_to_time)
+
+        @credentials = credentials
+        @up_to_time = options[:up_to_time]
+        @filename = options[:filename]
+        @debug = ENV['DEBUG'] == 'true'
+      end
+
+      def process_request
+        api_response = self.class.post(api_url, :body => build_xml)
+        puts api_response if @debug == true
+        response = parse_response(api_response)
+        if success?(response)
+          success_response(response)
+        else
+          error_message = if response[:ground_close_reply]
+            [response[:ground_close_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
+      end
+
+      private
+
+      def success_response(response)
+        manifest_details = {
+          :filename => filename,
+          :manifest => response[:ground_close_reply][:manifest]
+        }
+        manifest = Fedex::GroundManifest.new(manifest_details)
+        puts "manifest written to #{filename}" if @debug == true
+        manifest
+      end
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.GroundCloseRequest(:xmlns => "http://fedex.com/ws/close/v2"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+
+            xml.TimeUpToWhichShipmentsAreToBeClosed up_to_time.utc.iso8601(2)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'clos', :version => '2' }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:ground_close_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:ground_close_reply][:highest_severity])
+      end
+    end
+  end
+end

data/lib/fedex/request/pickup.rb

@@ -0,0 +1,121 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class Pickup < Base
+      def initialize(credentials, options={})
+        requires!(options, :packages, :ready_timestamp, :close_time, :carrier_code, :country_relationship)
+        @debug = ENV['DEBUG'] == 'true'
+
+        @credentials = credentials
+        @packages = options[:packages]
+        @ready_timestamp = options[:ready_timestamp]
+        @close_time = options[:close_time]
+        @carrier_code = options[:carrier_code]
+        @remarks = options[:remarks] if options[:remarks]
+        @pickup_location = options[:pickup_location]
+        @commodity_description = options[:commodity_description] if options[:commodity_description]
+        @country_relationship = options[:country_relationship]
+      end
+
+      # Sends post request to Fedex web service and parse the response, a Pickup object is created if the response is successful
+      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
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        ns = "http://fedex.com/ws/pickup/v#{service[:version]}"
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.CreatePickupRequest(:xmlns => ns) {
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_origin_detail(xml)
+            add_package_details(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'pickup', :version => Fedex::PICKUP_API_VERSION }
+      end
+
+      # Add shipper to xml request
+      def add_origin_detail(xml)
+        xml.OriginDetail {
+          if @pickup_location
+            xml.UseAccountAddress false
+            add_pickup_location(xml)
+          else
+            xml.UseAccountAddress true
+          end
+          xml.ReadyTimestamp @ready_timestamp
+          xml.CompanyCloseTime @close_time.strftime("%H:%M:%S")
+        }
+      end
+
+      def add_package_details(xml)
+        xml.PackageCount @packages[:count]
+        xml.TotalWeight {
+          xml.Units @packages[:weight][:units]
+          xml.Value @packages[:weight][:value]
+        }
+        xml.CarrierCode @carrier_code
+        xml.Remarks @remarks if @remarks
+        xml.CommodityDescription @commodity_description if @commodity_description
+        xml.CountryRelationship @country_relationship
+      end
+
+      def add_pickup_location(xml)
+        xml.PickupLocation {
+          xml.Contact {
+            xml.PersonName @pickup_location[:name]
+            xml.CompanyName @pickup_location[:company]
+            xml.PhoneNumber @pickup_location[:phone_number]
+          }
+          xml.Address {
+            Array(@pickup_location[:address]).take(2).each do |address_line|
+              xml.StreetLines address_line
+            end
+            xml.City @pickup_location[:city]
+            xml.StateOrProvinceCode @pickup_location[:state]
+            xml.PostalCode @pickup_location[:postal_code]
+            xml.CountryCode @pickup_location[:country_code]
+          }
+        }
+      end
+
+      # Callback used after a failed pickup response.
+      def failure_response(api_response, response)
+        error_message = if response[:create_pickup_reply]
+          [response[:create_pickup_reply][:notifications]].flatten.first[:message]
+        else
+          "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n--#{Array(api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"]).join("\n--")}"
+        end rescue $1
+        raise RateError, error_message
+      end
+
+      # Callback used after a successful pickup response.
+      def success_response(api_response, response)
+        @response_details = response[:create_pickup_reply]
+      end
+
+      # Successful request
+      def success?(response)
+        response[:create_pickup_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:create_pickup_reply][:highest_severity])
+      end
+    end
+  end
+end

data/lib/fedex/request/pickup_availability.rb

@@ -0,0 +1,89 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class PickupAvailability < Base
+
+      def initialize(credentials, options={})
+        requires!(options, :country_code, :request_type, :carrier_code)
+        @debug = ENV['DEBUG'] == 'true'
+
+        @credentials = credentials
+        
+        @country_code  = options[:country_code]
+        @postal_code   = options[:postal_code] if options[:postal_code]
+        @state_code    = options[:state_code] if options[:state_code]
+        @request_type  = options[:request_type]
+        @carrier_code  = options[:carrier_code]
+        @dispatch_date = options[:dispatch_date] if options[:dispatch_date]
+      end
+
+      def process_request
+        api_response = self.class.post(api_url, :body => build_xml)
+        puts api_response if @debug == true
+        response = parse_response(api_response)
+        if success?(response)
+          success_response(api_response, response)
+        else
+          failure_response(api_response, response)
+        end
+      end
+
+      private
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        ns = "http://fedex.com/ws/pickup/v#{service[:version]}"
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.PickupAvailabilityRequest(:xmlns => ns) {
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_pickup_address(xml)
+            add_other_pickup_details(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'pickup', :version => Fedex::PICKUP_API_VERSION }
+      end
+
+      def add_pickup_address(xml)
+        xml.PickupAddress{
+          xml.PostalCode @postal_code if @postal_code
+          xml.CountryCode @country_code
+          xml.StateOrProvinceCode @state_code if @state_code
+        }
+      end
+
+      def add_other_pickup_details(xml)
+        xml.PickupRequestType @request_type
+        xml.DispatchDate @dispatch_date if @dispatch_date
+        xml.Carriers @carrier_code
+      end
+
+      # Callback used after a failed pickup response.
+      def failure_response(api_response, response)
+        error_message = if response[:pickup_availability_reply]
+          [response[:pickup_availability_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
+
+      # Callback used after a successful pickup response.
+      def success_response(api_response, response)
+        @response_details = response[:pickup_availability_reply]
+      end
+
+      # Successful request
+      def success?(response)
+        response[:pickup_availability_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:pickup_availability_reply][:highest_severity])
+      end
+    end
+  end
+end

data/lib/fedex/request/rate.rb

@@ -15,6 +15,7 @@ module Fedex
           rate_reply_details.map do |rate_reply|
             rate_details = [rate_reply[:rated_shipment_details]].flatten.first[:shipment_rate_detail]
             rate_details.merge!(service_type: rate_reply[:service_type])
+            rate_details.merge!(transit_time: rate_reply[:transit_time])
             Fedex::Rate.new(rate_details)
           end
         else
@@ -44,6 +45,11 @@ module Fedex
         }
       end
 
+      # Add transite time options
+      def add_transit_time(xml)
+        xml.ReturnTransitAndCommit true
+      end
+
       # Build xml Fedex Web Service request
       def build_xml
         ns = "http://fedex.com/ws/rate/v#{service[:version]}"
@@ -52,6 +58,7 @@ module Fedex
             add_web_authentication_detail(xml)
             add_client_detail(xml)
             add_version(xml)
+            add_transit_time(xml)
             add_requested_shipment(xml)
           }
         end

data/lib/fedex/request/service_availability.rb

@@ -0,0 +1,86 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class ServiceAvailability < Base
+      def initialize(credentials, options={})
+        requires!(options, :origin, :destination, :ship_date, :carrier_code)
+
+        @credentials  = credentials
+        @origin       = options[:origin]
+        @destination  = options[:destination]
+        @ship_date    = options[:ship_date]
+        @carrier_code = options[:carrier_code]
+      end
+
+      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      
+
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.ServiceAvailabilityRequest(:xmlns => "http://fedex.com/ws/packagemovementinformationservice/v#{service[:version]}"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_origin(xml)
+            add_destination(xml)
+            add_other_details(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def add_origin(xml)
+        xml.Origin{
+          xml.PostalCode  @origin[:postal_code]
+          xml.CountryCode @origin[:country_code]
+        }
+      end
+
+      def add_destination(xml)
+        xml.Destination{
+          xml.PostalCode  @destination[:postal_code]
+          xml.CountryCode @destination[:country_code]
+        }
+      end
+
+      def add_other_details(xml)
+        xml.ShipDate @ship_date
+        xml.CarrierCode @carrier_code
+      end
+
+      # Callback used after a failed shipment response.
+      def failure_response(api_response, response)
+        error_message = if response[:service_availability_reply]
+          [response[:service_availability_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
+
+      # Callback used after a successful shipment response.
+      def success_response(api_response, response)
+        @response_details = response[:service_availability_reply]
+      end      
+
+      def service
+        { :id => 'pmis', :version => Fedex::SERVICE_AVAILABILITY_API_VERSION }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:service_availability_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:service_availability_reply][:highest_severity])
+      end
+    end
+  end
+end

data/lib/fedex/request/shipment.rb

@@ -15,6 +15,7 @@ module Fedex
           :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
 
       # Sends post request to Fedex web service and parse the response.
@@ -41,10 +42,11 @@ module Fedex
           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_recipient(xml)
           add_shipping_charges_payment(xml)
-          add_special_services(xml) if @shipping_options[:return_reason]
+          add_special_services(xml) if @shipping_options[:return_reason] || @shipping_options[:cod]
           add_customs_clearance(xml) if @customs_clearance_detail
           add_custom_components(xml)
           xml.RateRequestTypes "ACCOUNT"
@@ -52,6 +54,15 @@ module Fedex
         }
       end
 
+      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
+
       # Hook that can be used to add custom parts.
       def add_custom_components(xml)
         add_label_specification xml
@@ -63,18 +74,31 @@ module Fedex
           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
         }
       end
 
       def add_special_services(xml)
         xml.SpecialServicesRequested {
-          xml.SpecialServiceTypes "RETURN_SHIPMENT"
-          xml.ReturnShipmentDetail {
-            xml.ReturnType "PRINT_RETURN_LABEL"
-            xml.Rma {
-              xml.Reason "#{@shipping_options[:return_reason]}"
+          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
         }
       end