fedex 1.0.0 → 2.0.1

data/lib/fedex/request/label.rb

@@ -0,0 +1,94 @@
+require 'fedex/request/base'
+require 'fedex/label'
+require 'fileutils'
+
+module Fedex
+  module Request
+    class Label < Base
+      def initialize(credentials, options={})
+        super(credentials, options)
+        requires!(options, :filename)
+        @filename = options[:filename]
+      end
+
+      # Sends post request to Fedex web service and parse the response.
+      # A Fedex::Label object is created if the response is successful and
+      # a PDF file is created with the label at the specified location.
+      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)
+          label_details = response[:process_shipment_reply][:completed_shipment_detail][:completed_package_details][:label]
+
+          create_pdf(label_details)
+          Fedex::Label.new(label_details)
+        else
+          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
+      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
+          xml.LabelSpecification {
+            xml.LabelFormatType "COMMON2D"
+            xml.ImageType "PDF"
+          }
+          xml.RateRequestTypes "ACCOUNT"
+          add_packages(xml)
+        }
+      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 create_pdf(label_details)
+        [label_details[:parts]].flatten.each do |part|
+          if image = (Base64.decode64(part[:image]) if part[:image])
+            FileUtils.mkdir_p File.dirname(@filename)
+            File.open(@filename, 'w') do |file|
+              file.write image
+            end
+          end
+        end
+      end
+
+      def service_id
+        'ship'
+      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/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 == true
+        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'
+      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/shipment.rb

@@ -1,285 +1,39 @@
-require 'httparty'
-require 'nokogiri'
+require 'fedex/credentials'
+require 'fedex/request/label'
+require 'fedex/request/rate'
+
 module Fedex
-  #Fedex::Shipment
   class Shipment
-    include HTTParty
-    format :xml
-    # If true the rate method will return the complete response from the Fedex Web Service
-    attr_accessor :debug
-    # Fedex Text URL
-    TEST_URL = "https://gatewaybeta.fedex.com:443/xml/"
-    
-    # Fedex Production URL
-    PRODUCTION_URL = "https://gateway.fedex.com:443/xml/"
-    
-    # Fedex Version number for the Fedex service used
-    VERSION = 10
-    
-    # List of available Service Types
-    SERVICE_TYPES = %w(EUROPE_FIRST_INTERNATIONAL_PRIORITY FEDEX_1_DAY_FREIGHT FEDEX_2_DAY FEDEX_2_DAY_AM FEDEX_2_DAY_FREIGHT FEDEX_3_DAY_FREIGHT     FEDEX_EXPRESS_SAVER FEDEX_FIRST_FREIGHT FEDEX_FREIGHT_ECONOMY  FEDEX_FREIGHT_PRIORITY  FEDEX_GROUND FIRST_OVERNIGHT GROUND_HOME_DELIVERY  INTERNATIONAL_ECONOMY  INTERNATIONAL_ECONOMY_FREIGHT  INTERNATIONAL_FIRST INTERNATIONAL_PRIORITY  INTERNATIONAL_PRIORITY_FREIGHT  PRIORITY_OVERNIGHT SMART_POST STANDARD_OVERNIGHT)
-    
-    # List of available Packaging Type
-    PACKAGING_TYPES = %w(FEDEX_10KG_BOX FEDEX_25KG_BOX FEDEX_BOX FEDEX_ENVELOPE FEDEX_PAK FEDEX_TUBE YOUR_PACKAGING)
-    
-    # List of available DropOffTypes
-    DROP_OFF_TYPES = %w(BUSINESS_SERVICE_CENTER DROP_BOX REGULAR_PICKUP REQUEST_COURIER STATION)
-    
-    # Clearance Brokerage Type
-    CLEARANCE_BROKERAGE_TYPE = %w(BROKER_INCLUSIVE BROKER_INCLUSIVE_NON_RESIDENT_IMPORTER BROKER_SELECT BROKER_SELECT_NON_RESIDENT_IMPORTER BROKER_UNASSIGNED)
-    
-    # Recipient Custom ID Type
-    RECIPIENT_CUSTOM_ID_TYPE = %w(COMPANY INDIVIDUAL PASSPORT)
-   
-    # In order to use Fedex rates API you must first apply for a developer(and later production keys), 
+
+    # 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] meter - Fedex meter number
     # @param [String] mode - [development/production]
-    # 
+    #
     # return a Fedex::Shipment object
     def initialize(options={})
-      requires!(options, :key, :password, :account_number, :meter, :mode)
-      @key = options[:key]
-      @password = options[:password] 
-      @account_number = options[:account_number] 
-      @meter = options[:meter]
-      @mode = options[:mode]
+      @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
-    def rate(options = {})
-      requires!(options, :shipper, :recipient, :packages, :service_type)
-      @shipper, @recipient, @packages, @service_type, @customs_clearance, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:customs_clearance], options[:debug]
-      @shipping_options =  options[:shipping_options] ||={}
-      process_request
-    end
-    
-    # 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 = Shipment.post(api_url, :body => build_xml)
-      puts api_response if @debug == true
-      response = parse_response(api_response)
-      if success?(response) 
-        rate_details = [response[:rate_reply][:rate_reply_details][:rated_shipment_details]].flatten.first[:shipment_rate_detail]
-        rate = Fedex::Rate.new(rate_details)
-      else
-        error_message = (response[:rate_reply].nil? ? api_response["Fault"]["detail"]["fault"]["reason"] : [response[:rate_reply][:notifications]].flatten.first[:message]) rescue $1
-        raise RateError, error_message 
-      end
-    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
-    
-    # Fedex Web Service Api
-    def api_url
-      @mode == "production" ? PRODUCTION_URL : TEST_URL
-    end
-    
-    private
-    # Helper method to validate required fields
-    def requires!(hash, *params)
-       params.each { |param| raise RateError, "Missing Required Parameter #{param}" if hash[param].nil? }
-    end
-    
-    def camelize(str) #:nodoc:
-      str.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-    end
-    
-    # Add web authentication detail information(key and password) to xml request
-    def add_web_authentication_detail(xml)
-      xml.WebAuthenticationDetail{
-        xml.UserCredential{
-          xml.Key @key
-          xml.Password @password
-        }
-      }
-    end
-    
-    # Add Client Detail information(account_number and meter_number) to xml request
-    def add_client_detail(xml)
-      xml.ClientDetail{
-        xml.AccountNumber @account_number
-        xml.MeterNumber @meter
-      }
-    end
-    
-    # Add Version to xml request, using the latest version V10 Sept/2011
-    def add_version(xml)
-      xml.Version{
-        xml.ServiceId 'crs'
-        xml.Major VERSION
-        xml.Intermediate 0
-        xml.Minor 0
-      }
-    end
-    
-    # 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
-    
-    # Add shipper to xml request
-    def add_shipper(xml)
-      xml.Shipper{
-        xml.Contact{
-          xml.PersonName @shipper[:name]
-          xml.CompanyName @shipper[:company]
-          xml.PhoneNumber @shipper[:phone_number]
-        }
-        xml.Address {
-          xml.StreetLines @shipper[:address]
-          xml.City @shipper[:city]
-          xml.StateOrProvinceCode @shipper[:state]
-          xml.PostalCode @shipper[:postal_code]
-          xml.CountryCode @shipper[:country_code]
-        }  
-      }
-    end
-    
-    # Add recipient to xml request
-    def add_recipient(xml)
-      xml.Recipient{
-        xml.Contact{
-          xml.PersonName @recipient[:name]
-          xml.CompanyName @recipient[:company]
-          xml.PhoneNumber @recipient[:phone_number]
-        }
-        xml.Address {
-          xml.StreetLines @recipient[:address]
-          xml.City @recipient[:city]
-          xml.StateOrProvinceCode @recipient[:state]
-          xml.PostalCode @recipient[:postal_code]
-          xml.CountryCode @recipient[:country_code]
-          xml.Residential @recipient[:residential]
-        }
-      }
-    end
-    
-    # Add shipping charges to xml request
-    def add_shipping_charges_payment(xml)
-      xml.ShippingChargesPayment{
-        xml.PaymentType "SENDER"
-        xml.Payor{
-          xml.AccountNumber @account_number
-          xml.CountryCode @shipper[:country_code]
-        }
-      }  
-    end
-    
-    # Add packages to xml request
-    def add_packages(xml)
-      package_count = @packages.size
-      xml.PackageCount package_count
-      @packages.each do |package|
-        xml.RequestedPackageLineItems{
-          xml.GroupPackageCount 1
-          xml.Weight{
-            xml.Units package[:weight][:units]
-            xml.Value package[:weight][:value]
-          }
-          xml.Dimensions{
-            xml.Length package[:dimensions][:length]
-            xml.Width package[:dimensions][:width]
-            xml.Height package[:dimensions][:height]
-            xml.Units package[:dimensions][:units]
-          }
-        }  
-      end  
-    end
-    
-    # Add customs clearance(for international shipments)
-    def add_customs_clearance(xml)
-      xml.CustomsClearanceDetail{
-        customs_to_xml(xml, @customs_clearance)
-      }
-    end
-    
-    # Build nodes dinamically from the provided customs clearance hash
-    def customs_to_xml(xml, hash)
-      hash.each do |key, value|
-        if value.is_a?(Hash)
-          xml.send "#{camelize(key.to_s)}" do |x|
-            customs_to_xml(x, value)
-          end 
-        elsif value.is_a?(Array)
-          node = key
-          value.each do |v|
-            xml.send "#{camelize(node.to_s)}" do |x|
-              customs_to_xml(x, v)
-            end  
-          end  
-        else  
-          xml.send "#{camelize(key.to_s)}", value unless key.is_a?(Hash)
-        end  
-      end
-    end  
-    
-    # Parse response, convert keys to underscore symbols
-    def parse_response(response)
-      response = sanitize_response_keys(response)
+    # @param [String] filename, A location where the label will be saved
+    def label(options = {})
+      Request::Label.new(@credentials, options).process_request
     end
 
-    # Recursively sanitizes the response object by clenaing up any hash keys.
-    def sanitize_response_keys(response)
-      if response.is_a?(Hash)
-        response.inject({}) { |result, (key, value)| result[underscorize(key).to_sym] = sanitize_response_keys(value); result } 
-      elsif response.is_a?(Array)
-        response.collect { |result| sanitize_response_keys(result) }
-      else
-        response
-      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
 
-    def underscorize(key) #:nodoc:
-      key.to_s.sub(/^(v[0-9]+|ns):/, "").gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
-    end
-    
-    # Successful request
-    def success?(response)
-      (!response[:rate_reply].nil? and %w{SUCCESS WARNING NOTE}.include? response[:rate_reply][:highest_severity])
-    end
-    
-    # Use GROUND_HOME_DELIVERY for shipments going to a residential address within the US.
-    def service_type
-      if @recipient[:residential].to_s =~ /true/i and @service_type =~ /GROUND/i and @recipient[:country_code] =~ /US/i
-        "GROUND_HOME_DELIVERY"
-      else
-        @service_type
-      end  
-    end
-    
-    # String to CamelCase
-    def camelize(str)
-      str.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-    end
-    
   end
 end