fedex_ship 0.1.0

data/lib/fedex_ship/request/document.rb

@@ -0,0 +1,45 @@
+require 'fedex_ship/request/shipment'
+require 'fedex_ship/document'
+
+module FedexShip
+  module Request
+    class Document < Shipment
+
+      def initialize(credentials, options={})
+        super(credentials, options)
+
+        @shipping_document = options[:shipping_document]
+        @filenames = options.fetch(:filenames) { {} }
+      end
+
+      def add_custom_components(xml)
+        super
+
+        add_shipping_document(xml) if @shipping_document
+      end
+
+      private
+
+      # Add shipping document specification
+      def add_shipping_document(xml)
+        xml.ShippingDocumentSpecification{
+          Array(@shipping_document[:shipping_document_types]).each do |type|
+            xml.ShippingDocumentTypes type
+          end
+          hash_to_xml(xml, @shipping_document.reject{ |k| k == :shipping_document_types})
+        }
+      end
+
+      def success_response(api_response, response)
+        super
+
+        shipment_documents = response.merge!({
+          :filenames => @filenames
+        })
+
+        FedexShip::Document.new shipment_documents
+      end
+
+    end
+  end
+end

data/lib/fedex_ship/request/ground_close.rb

@@ -0,0 +1,73 @@
+require 'fedex_ship/request/base'
+require 'fedex_ship/ground_manifest'
+
+module FedexShip
+  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 = FedexShip::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_ship/request/label.rb

@@ -0,0 +1,29 @@
+require 'fedex_ship/request/base'
+require 'fedex_ship/label'
+require 'fedex_ship/request/shipment'
+require 'fileutils'
+
+module FedexShip
+  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
+        })
+
+        FedexShip::Label.new label_details
+      end
+
+    end
+  end
+end

data/lib/fedex_ship/request/logs_fedex.rb

@@ -0,0 +1,74 @@
+require 'fedex_ship/request/base'
+require 'logger'
+module FedexShip
+  module Request
+    class LogsFedex < Base
+
+      def ship_serv_log(info)
+        begin
+          date = Date.today.to_s
+          info = (Time.now).to_s + ' ' + info
+          log = File.open('log/shipment_' + date + '.log','a')
+          log.puts(info)
+          log.close
+        rescue Exception => ex.to_s
+          puts ex.to_s
+          log.close
+        end
+      end
+
+      def rate_serv_log(info)
+        begin
+          date = Date.today.to_s
+          info = (Time.now).to_s + ' ' + info
+          log = File.open('log/rate_' + date + '.log','a')
+          log.puts(info)
+          log.close
+        rescue Exception => ex.to_s
+          puts ex.to_s
+          log.close
+        end
+      end
+
+      def track_serv_log(info)
+        begin
+          date = Date.today.to_s
+          info = (Time.now).to_s + ' ' + info
+          log = File.open('log/track_' + date + '.log','a')
+          log.puts(info)
+          log.close
+        rescue Exception => ex.to_s
+          puts ex.to_s
+          log.close
+        end
+      end
+
+      def pickup_serv_log(info)
+        begin
+          date = Date.today.to_s
+          info = (Time.now).to_s + ' ' + info
+          log = File.open('log/pickup_' + date + '.log','a')
+          log.puts(info)
+          log.close
+        rescue Exception => ex.to_s
+          puts ex.to_s
+          log.close
+        end
+      end
+
+      def delete_ship_serv_log(info)
+        begin
+          date = Date.today.to_s
+          info = (Time.now).to_s + ' ' + info
+          log = File.open('log/delete_shipment_' + date + '.log','a')
+          log.puts(info)
+          log.close
+        rescue Exception => ex.to_s
+          puts ex.to_s
+          log.close
+        end
+      end
+
+    end
+  end
+end

data/lib/fedex_ship/request/pickup.rb

@@ -0,0 +1,135 @@
+require 'fedex_ship/request/base'
+require 'fedex_ship/request/logs_fedex'
+
+module FedexShip
+  module Request
+    class Pickup < LogsFedex
+      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
+        @build_xml = build_xml
+        pickup_serv_log('Final XML Request : ' + @build_xml.to_s)
+        api_url_srv = api_url + "/pickup"
+        pickup_serv_log('URL for API : ' + api_url_srv.to_s)
+        api_response = self.class.post(api_url_srv, :body => build_xml)
+        pickup_serv_log('API Response : ' + api_response.to_s)
+        puts api_response if @debug
+        response = parse_response(api_response)
+        if success?(response)
+          pickup_serv_log('Successfully Done : ' + response.to_s)
+          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/v17"
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.Envelope("xmlns" => "http://fedex.com/ws/pickup/v17") {
+            xml.parent.namespace = xml.parent.add_namespace_definition("soapenv", "http://schemas.xmlsoap.org/soap/envelope/")
+            xml['soapenv'].Header {}
+            xml['soapenv'].Body {
+              xml.CreatePickupRequest() {
+                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 => 'disp', :version => "17"}
+      end
+
+      # Add shipper to xml request
+      def add_origin_detail(xml)
+        xml.OriginDetail {
+          # if @pickup_location
+          if true
+            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[:envelope][:body][:create_pickup_reply]
+                          [response[:envelope][:body][: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[:envelope][:body][:create_pickup_reply]
+      end
+
+      # Successful request
+      def success?(response)
+        response[:envelope][:body][:create_pickup_reply] &&
+            %w{SUCCESS WARNING NOTE}.include?(response[:envelope][:body][:create_pickup_reply][:highest_severity])
+      end
+    end
+  end
+end

data/lib/fedex_ship/request/pickup_availability.rb

@@ -0,0 +1,102 @@
+require 'fedex_ship/request/base'
+require 'fedex_ship/request/logs_fedex'
+
+module FedexShip
+  module Request
+    class PickupAvailability < LogsFedex
+
+      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
+        @build_xml = build_xml
+        pickup_serv_log('Final XML Request : ' + @build_xml.to_s)
+        api_url_srv = api_url + "/pickup"
+        pickup_serv_log('URL for API : ' + api_url_srv.to_s)
+        api_response = self.class.post(api_url_srv, :body => build_xml)
+        pickup_serv_log('API Response : ' + api_response.to_s)
+        puts api_response if @debug == true
+        response = parse_response(api_response)
+        if success?(response)
+          pickup_serv_log('Successfully Done : ' + response.to_s)
+          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/v17"
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.Envelope("xmlns" => "http://fedex.com/ws/pickup/v17") {
+            xml.parent.namespace = xml.parent.add_namespace_definition("soapenv", "http://schemas.xmlsoap.org/soap/envelope/")
+            xml['soapenv'].Header {}
+            xml['soapenv'].Body {
+              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 => 'disp', :version => "17"}
+      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[:envelope][:body][:pickup_availability_reply]
+                          [response[:envelope][:body][: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[:envelope][:body][:pickup_availability_reply]
+      end
+
+      # Successful request
+      def success?(response)
+        response[:envelope][:body][:pickup_availability_reply] &&
+            %w{SUCCESS WARNING NOTE}.include?(response[:envelope][:body][:pickup_availability_reply][:highest_severity])
+      end
+    end
+  end
+end