ShippingInfo 2.0

data/lib/fedex/request/label.rb

@@ -0,0 +1,29 @@
+require 'fedex/request/base'
+require 'fedex/label'
+require 'fedex/request/shipment'
+require 'fileutils'
+
+module Fedex
+  module Request
+    class Label < Shipment
+      def initialize(credentials, options={})
+        super(credentials, options)
+        @filename = options[:filename]
+      end
+
+      private
+
+      def success_response(api_response, response)
+        super
+
+        label_details = response.merge!({
+          :format => @label_specification[:image_type],
+          :file_name => @filename
+        })
+
+        Fedex::Label.new label_details
+      end
+
+    end
+  end
+end

data/lib/fedex/request/rate.rb

@@ -0,0 +1,66 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class Rate < Base
+      # Sends post request to Fedex web service and parse the response, a Rate 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)
+          rate_details = [response[:rate_reply][:rate_reply_details][:rated_shipment_details]].flatten.first[:shipment_rate_detail]
+          Fedex::Rate.new(rate_details)
+        else
+          error_message = if response[:rate_reply]
+            [response[:rate_reply][:notifications]].flatten.first[:message]
+          else
+            api_response["Fault"]["detail"]["fault"]["reason"]
+          end rescue $1
+          raise RateError, error_message
+        end
+      end
+
+      private
+
+      # Add information for shipments
+      def add_requested_shipment(xml)
+        xml.RequestedShipment{
+          xml.DropoffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP"
+          xml.ServiceType service_type
+          xml.PackagingType @shipping_options[:packaging_type] ||= "YOUR_PACKAGING"
+          add_shipper(xml)
+          add_recipient(xml)
+          add_shipping_charges_payment(xml)
+          add_customs_clearance(xml) if @customs_clearance
+          xml.RateRequestTypes "ACCOUNT"
+          add_packages(xml)
+        }
+      end
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.RateRequest(:xmlns => "http://fedex.com/ws/rate/v10"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_requested_shipment(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'crs', :version => 10 }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:rate_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:rate_reply][:highest_severity])
+      end
+
+    end
+  end
+end

data/lib/fedex/request/shipment.rb

@@ -0,0 +1,108 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class Shipment < Base
+      attr_reader :response_details
+
+      def initialize(credentials, options={})
+        super
+        requires! options
+        # 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]
+      end
+
+      # 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_shipment_detail][:completed_package_details][:tracking_ids][:tracking_number]
+      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
+
+      # Add information for shipments
+      def add_requested_shipment(xml)
+        xml.RequestedShipment{
+          xml.ShipTimestamp 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_shipper(xml)
+          add_recipient(xml)
+          add_shipping_charges_payment(xml)
+          add_customs_clearance(xml) if @customs_clearance
+          add_custom_components(xml)
+          xml.RateRequestTypes "ACCOUNT"
+          add_packages(xml)
+        }
+      end
+
+      # Hook that can be used to add custom parts.
+      def add_custom_components(xml)
+        add_label_specification xml
+      end
+
+      # Add the label specification
+      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]
+        }
+      end
+
+      # Callback used after a failed shipment response.
+      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"]
+        end rescue $1
+        raise RateError, error_message
+      end
+
+      # Callback used after a successful shipment response.
+      def success_response(api_response, response)
+        @response_details = response[:process_shipment_reply]
+      end
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v10"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_requested_shipment(xml)
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'ship', :version => 10 }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:process_shipment_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:process_shipment_reply][:highest_severity])
+      end
+
+    end
+  end
+end

data/lib/fedex/request/tracking_information.rb

@@ -0,0 +1,89 @@
+require 'fedex/request/base'
+require 'fedex/tracking_information'
+
+module Fedex
+  module Request
+    class TrackingInformation < Base
+
+      attr_reader :package_type, :package_id
+
+      def initialize(credentials, options={})
+        requires!(options, :package_type, :package_id) unless options.has_key?(:tracking_number)
+
+        @package_id   = options[:package_id]   || options.delete(:tracking_number)
+        @package_type = options[:package_type] || "TRACKING_NUMBER_OR_DOORTAG"
+        @credentials  = credentials
+
+        # Optional
+        @include_detailed_scans = options[:include_detailed_scans]
+        @uuid                   = options[:uuid]
+        @paging_token           = options[:paging_token]
+
+        unless package_type_valid?
+          raise "Unknown package type '#{package_type}'"
+        end
+      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)
+          options = response[:track_reply][:track_details]
+
+          Fedex::TrackingInformation.new(options)
+        else
+          error_message = if response[:track_reply]
+            response[:track_reply][:notifications][:message]
+          else
+            api_response["Fault"]["detail"]["fault"]["reason"]
+          end rescue $1
+          raise RateError, error_message
+        end
+      end
+
+      private
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.TrackRequest(:xmlns => "http://fedex.com/ws/track/v#{service[:version]}"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            add_package_identifier(xml)
+            xml.IncludeDetailedScans @include_detailed_scans
+
+            # Optional
+            xml.TrackingNumberUniqueIdentifier @uuid if @uuid
+            xml.PagingToken @paging_token            if @paging_token
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'trck', :version => 5 }
+      end
+
+      def add_package_identifier(xml)
+        xml.PackageIdentifier{
+          xml.Value package_id
+          xml.Type  package_type
+        }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:track_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:track_reply][:highest_severity])
+      end
+
+      def package_type_valid?
+        Fedex::TrackingInformation::PACKAGE_IDENTIFIER_TYPES.include? package_type
+      end
+
+    end
+  end
+end

data/lib/fedex/shipment.rb

@@ -0,0 +1,61 @@
+require 'fedex/credentials'
+require 'fedex/request/label'
+require 'fedex/request/rate'
+require 'fedex/request/tracking_information'
+require 'fedex/request/address'
+
+module Fedex
+  class Shipment
+
+    # In order to use Fedex rates API you must first apply for a developer(and later production keys),
+    # Visit {http://www.fedex.com/us/developer/ Fedex Developer Center} for more information about how to obtain your keys.
+    # @param [String] key - Fedex web service key
+    # @param [String] password - Fedex password
+    # @param [String] account_number - Fedex account_number
+    # @param [String] meter - Fedex meter number
+    # @param [String] mode - [development/production]
+    #
+    # return a Fedex::Shipment object
+    def initialize(options={})
+      @credentials = Credentials.new(options)
+    end
+
+    # @param [Hash] shipper, A hash containing the shipper information
+    # @param [Hash] recipient, A hash containing the recipient information
+    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
+    # @param [String] filename, A location where the label will be saved
+    # @param [Hash] label_specification, A hash containing the label printer settings
+    def label(options = {})
+      Request::Label.new(@credentials, options).process_request
+    end
+
+    # @param [Hash] shipper, A hash containing the shipper information
+    # @param [Hash] recipient, A hash containing the recipient information
+    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
+    def rate(options = {})
+      Request::Rate.new(@credentials, options).process_request
+    end
+
+    # @param [Hash] address, A hash containing the address information
+    def validate_address(options = {})
+      Request::Address.new(@credentials, options).process_request
+    end
+
+    # @param [Hash] shipper, A hash containing the shipper information
+    # @param [Hash] recipient, A hash containing the recipient information
+    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
+    def ship(options = {})
+      Request::Shipment.new(@credentials, options).process_request
+    end
+
+    # @param [Hash] package_id, A string with the requested tracking number
+    # @param [Hash] package_type, A string identifitying the type of tracking number used. Full list Fedex::Track::PACKAGE_IDENTIFIER_TYPES
+    def track(options = {})
+      Request::TrackingInformation.new(@credentials, options).process_request
+    end
+
+  end
+end

data/lib/fedex/tracking_information.rb

@@ -0,0 +1,49 @@
+require 'fedex/tracking_information/event'
+
+module Fedex
+  class TrackingInformation
+    PACKAGE_IDENTIFIER_TYPES = %w{
+      BILL_OF_LADING
+      COD_RETURN_TRACKING_NUMBER
+      CUSTOMER_AUTHORIZATION_NUMBER
+      CUSTOMER_REFERENCE
+      DEPARTMENT
+      FREE_FORM_REFERENCE
+      GROUND_INTERNATIONAL
+      GROUND_SHIPMENT_ID
+      GROUP_MPS
+      INVOICE
+      JOB_GLOBAL_TRACKING_NUMBER
+      ORDER_GLOBAL_TRACKING_NUMBER
+      ORDER_TO_PAY_NUMBER
+      PARTNER_CARRIER_NUMBER
+      PART_NUMBER
+      PURCHASE_ORDER
+      RETURN_MATERIALS_AUTHORIZATION
+      RETURNED_TO_SHIPPER_TRACKING_NUMBER
+      TRACKING_CONTROL_NUMBER
+      TRACKING_NUMBER_OR_DOORTAG
+      TRANSPORTATION_CONTROL_NUMBER
+      SHIPPER_REFERENCE
+      STANDARD_MPS
+    }
+
+    attr_reader :tracking_number, :signature_name, :service_type, :status,
+                :delivery_at, :events
+
+    def initialize(details = {})
+      @details = details
+
+      @tracking_number = details[:tracking_number]
+      @signature_name  = details[:delivery_signature_name]
+      @service_type    = details[:service_type]
+      @status          = details[:status_description]
+      @delivery_at     = Time.parse(details[:actual_delivery_timestamp])
+
+      @events = details[:events].map do |event_details|
+        Event.new(event_details)
+      end
+    end
+
+  end
+end

data/lib/fedex/tracking_information/event.rb

@@ -0,0 +1,19 @@
+module Fedex
+  class TrackingInformation
+    class Event
+      attr_reader :description, :type, :occured_at, :city, :state, :postal_code,
+                  :country, :residential
+
+      def initialize(details = {})
+        @description  = details[:event_description]
+        @type         = details[:event_type]
+        @occured_at   = Time.parse(details[:timestamp])
+        @city         = details[:address][:city]
+        @state        = details[:address][:state_or_province_code]
+        @postal_code  = details[:address][:postal_code]
+        @country      = details[:address][:country_code]
+        @residential  = details[:address][:residential] == "true"
+      end
+    end
+  end
+end

data/lib/fedex/version.rb

@@ -0,0 +1,3 @@
+module Fedex
+  VERSION = "2.2.1"
+end

data/lib/shipping.rb

@@ -0,0 +1,46 @@
+#--
+# Copyright (c) 2005 Lucas Carlson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+# Author::    Lucas Carlson  (mailto:lucas@rufy.com)
+# Copyright:: Copyright (c) 2005 Lucas Carlson
+# License::   LGPL
+
+$:.unshift(File.dirname(__FILE__))
+
+begin
+   require 'rubygems'
+rescue LoadError
+   nil
+end
+
+require 'builder'
+require 'yaml'
+require 'rexml/document'
+require 'net/http'
+require 'net/https'
+require 'base64'
+require 'fileutils'
+require 'tempfile'
+
+require 'extensions'
+require 'Shipping/base'
+require 'Shipping/ups'