fedex-web-services 1.0.42

data/lib/fedex.rb

@@ -0,0 +1,6 @@
+require "fedex/version"
+require "fedex/web_services"
+
+module Fedex
+  require 'fedex/railtie' if defined?(Rails)
+end

data/lib/fedex/railtie.rb

@@ -0,0 +1,9 @@
+module Fedex
+  class Railtie < Rails::Railtie
+    railtie_name :fedex
+
+    rake_tasks do
+      load "fedex/tasks/fedex.rake"
+    end
+  end
+end

data/lib/fedex/tasks/fedex.rake

@@ -0,0 +1,21 @@
+namespace :fedex do
+  desc "Generate the ruby definition files from the FedEx wsdl files"
+  task :generate_definitions do
+    wsdl_dir = ENV['WSDL_DIR']
+    if (!Dir.exist?(wsdl_dir || ""))
+      puts "Set the WSDL_DIR environment variable to location of the Fedex wsdl files"
+    else
+      Fedex::WebServices::Definitions.generate_definitions(
+        File.join(Rails.root, 'lib'),
+        *Dir.glob(File.join(ENV['WSDL_DIR'], '*.wsdl'))
+      )
+
+      File.open(File.join(Rails.root, 'config', 'initializers', 'fedex.rb'), "w") do |file|
+        file.puts "Fedex::WebServices::Definitions.load_definitions('lib')"
+      end
+
+      puts "Added lib/fedex/web_services/definitions/"
+      puts "Added config/initializers/fedex.rb"
+    end
+  end
+end

data/lib/fedex/version.rb

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

data/lib/fedex/web_services.rb

@@ -0,0 +1,10 @@
+require 'fedex/web_services/definitions'
+
+require 'fedex/web_services/request/base'
+require 'fedex/web_services/request/process_shipment'
+require 'fedex/web_services/request/delete_shipment'
+require 'fedex/web_services/request/get_rates'
+
+require 'fedex/web_services/service/base'
+require 'fedex/web_services/service/ship'
+require 'fedex/web_services/service/rate'

data/lib/fedex/web_services/definitions.rb

@@ -0,0 +1,46 @@
+module Fedex
+  module WebServices
+    module Definitions
+      extend(self)
+
+      MODULE_PATH = File.join(%w(fedex web_services definitions))
+
+      def load_definitions(lib_dir)
+        $VERBOSE = $VERBOSE.tap do
+          $VERBOSE = nil
+
+          $:.unshift(lib_dir)
+          $:.unshift(File.join(lib_dir, MODULE_PATH))
+          Dir.glob(File.join(lib_dir, MODULE_PATH, "*DefinitionsDriver.rb")).each do |definition_file|
+            begin
+              require File.join(MODULE_PATH, File.basename(definition_file))
+            rescue Exception
+              raise "Error loading Fedex definition file #{definition_file}: #{$!.message}"
+            end
+          end
+          $:.shift
+          $:.shift
+        end
+      end
+
+      def generate_definitions(lib_dir, *wsdl_files)
+        require 'wsdl/soap/wsdl2ruby'
+        require 'fileutils'
+
+        wsdl_files.each do |wsdl_file|
+          worker = WSDL::SOAP::WSDL2Ruby.new
+          worker.basedir = FileUtils.mkdir_p(File.join(Dir.new(lib_dir), MODULE_PATH)).first
+          worker.location = File.new(wsdl_file).path
+          worker.logger.level = Logger::WARN
+          worker.opt.update(
+            "module_path"      => "Fedex::WebServices::Definitions",
+            "mapping_registry" => nil,
+            "driver"           => nil,
+            "classdef"         => nil
+          )
+          worker.run
+        end
+      end
+    end
+  end
+end

data/lib/fedex/web_services/request/base.rb

@@ -0,0 +1,69 @@
+require 'time'
+
+module Fedex::WebServices
+  module Request
+    class Base
+      include Fedex::WebServices::Definitions
+
+      def initialize(service)
+        @service = service
+      end
+
+      def remote_method
+        raise "remote_method must be implemented by subclasses of Service"
+      end
+
+      private
+        def web_authentication_detail
+          WebAuthenticationDetail.new.tap do |o|
+            o.userCredential = WebAuthenticationCredential.new.tap do |o|
+              o.key      = @service.credentials.key
+              o.password = @service.credentials.password
+            end
+          end
+        end
+
+        def client_detail
+          ClientDetail.new.tap do |o|
+            o.accountNumber = @service.credentials.account_number
+            o.meterNumber   = @service.credentials.meter_number
+          end
+        end
+
+        def version
+          VersionId.new.tap do |o|
+            o.serviceId    = @service.service_id
+            o.major        = 10
+            o.intermediate = 0
+            o.minor        = 0
+          end
+        end
+    end
+  end
+end
+# return
+#
+#
+# ship_service = Fedex::WebServices::Service::Ship.new(creds)
+# a = nil
+# ship_service.delete_shipment('1234', 'GROUND') { |contents| a = contents }
+#
+# # req = FedExRequest.new(credentials).delete_shipment_request('794797411470', TrackingIdType::GROUND)
+# req = FedExRequest.new(credentials).process_shipment
+# ship_port = ShipPortType.new('https://wsbeta.fedex.com:443/web-services')
+# ship_port.wiredump_dev = STDOUT
+#
+# begin
+#   # response = ship_port.deleteShipment(req)
+#   response = ship_port.processShipment(req)
+#   check_response(response)
+# rescue Exception => root_exception
+#   begin
+#     err = RuntimeError.new(root_exception.detail.fault.details.validationFailureDetail.message * ",")
+#     err.set_backtrace([ "#{__FILE__}:#{__LINE__}", *root_exception.backtrace ])
+#   rescue
+#     raise root_exception.message
+#   end
+#
+#   raise err
+# end

data/lib/fedex/web_services/request/delete_shipment.rb

@@ -0,0 +1,27 @@
+module Fedex::WebServices
+  module Request
+    class DeleteShipment < Base
+      attr_accessor :tracking_id
+
+      def initialize(service, tracking_id)
+        super(service)
+        @tracking_id = tracking_id
+      end
+
+      def remote_method
+        :deleteShipment
+      end
+
+      def contents
+        DeleteShipmentRequest.new.tap do |o|
+          o.webAuthenticationDetail = web_authentication_detail
+          o.version                 = version
+          o.clientDetail            = client_detail
+          o.deletionControl         = DeletionControlType::DELETE_ALL_PACKAGES
+
+          o.trackingId = @tracking_id
+        end
+      end
+    end
+  end
+end

data/lib/fedex/web_services/request/get_rates.rb

@@ -0,0 +1,56 @@
+module Fedex::WebServices
+  module Request
+    class GetRates < Base
+
+      def initialize(service, service_type, rate_request_type, shipper, recipient, weight)
+
+        super(service)
+
+        @service_type = service_type
+        @shipper = shipper
+        @recipient = recipient
+        @rate_request_type = rate_request_type
+        @requested_package_line_items = [
+          RequestedPackageLineItem.new.tap do |o|
+            o.groupPackageCount = 1
+            o.sequenceNumber = 1
+            o.weight = weight
+          end
+        ]
+      end
+
+      def remote_method
+        :getRates
+      end
+
+      def contents
+        RateRequest.new.tap do |o|
+          o.webAuthenticationDetail = web_authentication_detail
+          o.version                 = version
+          o.clientDetail            = client_detail
+
+          o.requestedShipment = RequestedShipment.new.tap do |o|
+            o.shipTimestamp = Time.now.iso8601
+            o.serviceType   = @service_type
+            o.packagingType = PackagingType::YOUR_PACKAGING
+
+            o.shipper   = @shipper
+            o.recipient = @recipient
+
+            o.shippingChargesPayment = Payment.new.tap do |o|
+              o.paymentType = PaymentType::SENDER
+              o.payor = Payor.new.tap do |o|
+                o.accountNumber = @service.credentials.account_number
+              end
+            end
+
+            o.rateRequestTypes = [ @rate_request_type ]
+
+            o.packageCount = @requested_package_line_items.size
+            o.requestedPackageLineItems = @requested_package_line_items
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fedex/web_services/request/process_shipment.rb

@@ -0,0 +1,76 @@
+module Fedex::WebServices
+  module Request
+    class ProcessShipment < Base
+
+      def self.mps_requests(service, service_type, shipper, recipient,
+          label_specification, package_weights)
+
+        package_weights.map.with_index do |weight, index|
+          requested_package_line_item = RequestedPackageLineItem.new.tap do |o|
+            o.sequenceNumber = index + 1
+            o.weight = weight
+          end
+
+          ProcessShipment.new(
+            service,
+            service_type,
+            shipper,
+            recipient,
+            label_specification,
+            package_weights.size,
+            [ requested_package_line_item ]
+          )
+        end
+      end
+
+      def initialize(service, service_type, shipper, recipient,
+          label_specification, package_count, requested_package_line_items)
+
+        super(service)
+
+        @service_type = service_type
+        @shipper = shipper
+        @recipient = recipient
+        @label_specification = label_specification
+        @package_count = package_count
+        @requested_package_line_items = requested_package_line_items
+      end
+
+      def remote_method
+        :processShipment
+      end
+
+      def contents
+        ProcessShipmentRequest.new.tap do |o|
+          o.webAuthenticationDetail = web_authentication_detail
+          o.version                 = version
+          o.clientDetail            = client_detail
+
+          o.requestedShipment = RequestedShipment.new.tap do |o|
+            o.shipTimestamp = Time.now.iso8601
+            o.dropoffType   = DropoffType::REGULAR_PICKUP
+            o.serviceType   = @service_type
+            o.packagingType = PackagingType::YOUR_PACKAGING
+
+            o.shipper   = @shipper
+            o.recipient = @recipient
+
+            o.shippingChargesPayment = Payment.new.tap do |o|
+              o.paymentType = PaymentType::SENDER
+              o.payor = Payor.new.tap do |o|
+                o.accountNumber = @service.credentials.account_number
+              end
+            end
+
+            o.labelSpecification = @label_specification
+
+            o.rateRequestTypes = [ RateRequestType::LIST ]
+
+            o.requestedPackageLineItems = @requested_package_line_items
+            o.packageCount = @package_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fedex/web_services/service/base.rb

@@ -0,0 +1,66 @@
+require 'stringio'
+
+module Fedex::WebServices
+  module Service
+    class ServiceException < RuntimeError
+      attr_accessor :details
+    end
+
+    class Base
+      include Fedex::WebServices::Definitions
+      include Fedex::WebServices::Request
+
+      Credentials = Struct.new("Credentials",
+        :account_number, :meter_number, :key, :password, :environment
+      )
+
+      attr_accessor :credentials
+      attr_reader :wiredump
+
+      def initialize(credentials)
+        @credentials = credentials
+      end
+
+      def service_id
+        raise "service_id must be implemented by subclasses of Service"
+      end
+
+      protected
+        def port
+          raise "port must be implemented by subclasses of Service"
+        end
+
+      private
+        def issue_request(request)
+          port = self.port
+          port.wiredump_dev = StringIO.new(@wiredump = "")
+
+          request_contents = request.contents
+          yield(request_contents) if (block_given?)
+
+          port.send(request.remote_method, request_contents).tap do |response|
+            check_response(response)
+          end
+        rescue Exception => root_exception
+          err = ServiceException.new(root_exception.message)
+          err.details = root_exception.detail.fault.details.validationFailureDetail.message rescue nil
+          err.set_backtrace([ "#{__FILE__}:#{__LINE__ + 1}", *root_exception.backtrace ])
+          raise err
+        end
+
+        def check_response(response)
+          error_notifications = response.notifications.reject do |notification|
+            [
+              NotificationSeverityType::SUCCESS,
+              NotificationSeverityType::NOTE,
+              NotificationSeverityType::WARNING
+            ].include?(notification.severity)
+          end
+
+          if (error_notifications.any?)
+            raise error_notifications.map(&:message) * ". "
+          end
+        end
+    end
+  end
+end

data/lib/fedex/web_services/service/rate.rb

@@ -0,0 +1,40 @@
+require 'bigdecimal'
+
+module Fedex::WebServices
+  module Service
+    class Rate < Base
+
+      def get_rates(service_type, rate_request_type, shipper, recipient, weight, &process_contents)
+        request = GetRates.new(self,
+          service_type,
+          rate_request_type,
+          shipper,
+          recipient,
+          weight
+        )
+
+        response = issue_request(request, &process_contents)
+        return [ Rate.rate_for(response, rate_request_type), response ]
+      end
+
+      def service_id
+        :crs
+      end
+
+      def self.rate_for(response, rate_request_type)
+        details = response.rateReplyDetails.first.ratedShipmentDetails.select do |detail|
+          detail.shipmentRateDetail.rateType == "PAYOR_#{rate_request_type}_PACKAGE"
+        end
+
+        details.inject(0) do |acc, detail|
+          acc + BigDecimal.new(detail.shipmentRateDetail.totalNetCharge.amount)
+        end
+      end
+
+      protected
+        def port
+          RatePortType.new('https://wsbeta.fedex.com:443/web-services')
+        end
+    end
+  end
+end

data/lib/fedex/web_services/service/ship.rb

@@ -0,0 +1,83 @@
+require 'bigdecimal'
+require 'base64'
+
+module Fedex::WebServices
+  module Service
+    class Ship < Base
+
+      def service_id
+        :ship
+      end
+
+      def process_shipment(service_type, shipper, recipient,
+          label_specification, package_weights, &process_contents)
+
+        curry_process_contents_callback = ->(request_number) do
+          return ->(request_contents) do
+            process_contents.call(request_contents, request_number) if (process_contents)
+          end
+        end
+
+        requests = ProcessShipment.mps_requests(self,
+          service_type,
+          shipper,
+          recipient,
+          label_specification,
+          package_weights
+        )
+
+        first, rest = requests.first, requests[1..-1]
+
+        first_response = issue_request(first, &curry_process_contents_callback.call(1))
+
+        rest_responses = rest.map.with_index do |request, index|
+          issue_request(request) do |request_contents|
+            request_contents.requestedShipment.masterTrackingId = TrackingId.new.tap do |o|
+              o.trackingNumber = Ship::tracking_number_for(first_response)
+            end
+
+            curry_process_contents_callback.call(index + 2).call(request_contents)
+          end
+        end
+
+        [ first_response, *rest_responses ].map do |response|
+          [
+            self.class.tracking_number_for(response),
+            self.class.label_for(response),
+            self.class.package_rate_for(response),
+            response
+          ]
+        end
+      end
+
+      def delete_shipment(*args, &process_contents)
+        issue_request(DeleteShipment.new(self, *args), &process_contents)
+      end
+
+      def self.label_for(response)
+        label = response.completedShipmentDetail.completedPackageDetails.first.label
+        Base64.decode64(label.parts.map { |p| Base64.decode64(p.image) } * "")
+      end
+
+      def self.tracking_number_for(response)
+        response.completedShipmentDetail.completedPackageDetails[0].trackingIds[0].trackingNumber
+      rescue
+        raise "Unable to extract tracking number from response"
+      end
+
+      def self.package_rate_for(response)
+        response.completedShipmentDetail.completedPackageDetails.first.packageRating.
+            packageRateDetails.inject(0) do |acc, rate|
+              rate.rateType == ReturnedRateType::PAYOR_ACCOUNT_PACKAGE ?
+                  acc + BigDecimal.new(rate.netCharge.amount) :
+                  acc
+            end
+      end
+
+      protected
+        def port
+          ShipPortType.new('https://wsbeta.fedex.com:443/web-services')
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: fedex-web-services
+version: !ruby/object:Gem::Version
+  version: 1.0.42
+  prerelease: 
+platform: ruby
+authors:
+- Brian Abreu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000Z
+dependencies: []
+description: Interfaces with the FedEx web services API to look up shipping rates,
+  generate labels, and cancel shipments
+email:
+- brian@nut.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fedex/railtie.rb
+- lib/fedex/tasks/fedex.rake
+- lib/fedex/version.rb
+- lib/fedex/web_services/definitions.rb
+- lib/fedex/web_services/request/base.rb
+- lib/fedex/web_services/request/delete_shipment.rb
+- lib/fedex/web_services/request/get_rates.rb
+- lib/fedex/web_services/request/process_shipment.rb
+- lib/fedex/web_services/service/base.rb
+- lib/fedex/web_services/service/rate.rb
+- lib/fedex/web_services/service/ship.rb
+- lib/fedex/web_services.rb
+- lib/fedex.rb
+homepage: https://github.com/brewski/fedex-web-services
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fedex-web-services
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provies an interface to the FedEx web services API (version 10)
+test_files: []