fedex-web-services 1.1.51 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06101ed7cbcb38c975dea29b6d42f1f60c056f20
+  data.tar.gz: 40b93297679f25e79fba9217a4a91f7d5d08c773
+SHA512:
+  metadata.gz: 34cd181423a2cdeb1d359216226612366f9b846ab2a569ef31650ffd7081fb944f815afe0421a7137923f6590d02f35a7ad92b54d2bef1a5b8510b1ffefbf6bf
+  data.tar.gz: a03f180826690354ad97a84a7ccb78c41a98baa75c3014488127c4de9b76e53784fb8a0c04ebacf0b5b96bf42d339276870624dc0eba255358aa7a932dfc0b21

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fedex-web-services.gemspec
+gemspec

data/README.md

@@ -0,0 +1,113 @@
+# fedex-web-services
+## Description
+This gem provides an interface to the FedEx web services API.  It supports version 12 of the ship service and version 4 of the close service.
+
+## Testing
+This gem includes a small integration test suite to test several of the API methods in the FedEx sandbox environment. You can run the tests from the source of this gem, or from within a rails application that includes this gem:
+
+```bash
+export FEDEX_ACCOUNT=account FEDEX_METER=meter FEDEX_AUTH_KEY=authkey FEDEX_SECURITY_CODE=code
+bundle exec rake fedex_web_services:test
+```
+
+## Examples
+### Creating a shipment with multiple packages
+
+```ruby
+require 'fedex_web_services'
+
+include FedexWebServices
+include FedexWebServices::Soap
+
+credentials = Api::Credentials.new(
+  ENV.fetch('FEDEX_ACCOUNT'),
+  ENV.fetch('FEDEX_METER'),
+  ENV.fetch('FEDEX_AUTH_KEY'),
+  ENV.fetch('FEDEX_SECURITY_CODE'),
+  :test # or :production
+)
+api = Api.new(credentials)
+
+service = Ship::ServiceType::FEDEX_2_DAY
+
+from = Ship::Party.new.tap do |shipper|
+  shipper.contact = Ship::Contact.new.tap do |contact|
+    contact.personName  = "Joe Shmoe"
+    contact.phoneNumber = "(123) 456 789"
+  end
+
+  shipper.address = Ship::Address.new.tap do |address|
+    address.streetLines         = [ "123 4th St" ]
+    address.city                = "San Luis Obispo"
+    address.stateOrProvinceCode = "CA"
+    address.postalCode          = "93401"
+    address.countryCode         = "US"
+    address.residential         = true
+  end
+end
+
+to = Ship::Party.new.tap do |recipient|
+  recipient.contact = Ship::Contact.new.tap do |contact|
+    contact.personName  = "Ahwahnee Hotel"
+    contact.phoneNumber = "(801) 559-5000"
+  end
+  recipient.address = Ship::Address.new.tap do |address|
+    address.streetLines         = [ "9006 Yosemite Lodge Drive" ]
+    address.city                = "Yosemite National Park"
+    address.stateOrProvinceCode = "CA"
+    address.postalCode          = "95389"
+    address.countryCode         = "US"
+    address.residential         = true
+  end
+end
+
+label_spec = Ship::LabelSpecification.new
+label_spec.labelFormatType = Ship::LabelFormatType::COMMON2D
+label_spec.imageType       = Ship::ShippingDocumentImageType::PDF
+label_spec.labelStockType  = Ship::ShippingDocumentStockType::PAPER_LETTER
+
+weights = [ 10, 55.34, 10.2 ].map do |weight|
+  Ship::Weight.new.tap do |w|
+    w.units = "LB"
+    w.value = weight
+  end
+end
+
+requests = ProcessShipmentRequest.shipment_requests(service, from, to, label_spec, weights)
+requests.each do |request|
+  request.sender_paid!(credentials.account_number)
+  request.list_rate!
+  request.regular_pickup!
+  request.customer_reference!("01234")
+  request.customer_invoice!("56789")
+end
+
+tracking_numbers = api.process_shipments(requests).map do |response|
+  filename = "#{response.tracking_number}.pdf"
+  File.write(filename, response.label)
+  puts "Wrote #{filename}"
+  response.tracking_number
+end
+```
+
+### Canceling a shipment
+
+```ruby
+tracking_numbers.each do |tracking_number|
+  delete_request = DeleteShipmentRequest.new
+  delete_request.delete_all_packages!(tracking_number, Ship::TrackingIdType::EXPRESS)
+  api.delete_shipment(delete_request)
+  puts "Deleted shipment #{tracking_number}"
+end
+```
+
+### Debugging
+You can see the SOAP wiredump by accessing Api#wiredump after issuing a request.
+```ruby
+begin
+  api.process_shipments(...)
+rescue
+  puts api.wiredump
+  raise $!
+end
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob(File.expand_path("../tasks/*.rake", __FILE__)).each(&method(:import))

data/examples/create_shipments.rb

@@ -0,0 +1,81 @@
+require 'fedex_web_services'
+
+include FedexWebServices
+include FedexWebServices::Soap
+
+credentials = Api::Credentials.new(
+  ENV.fetch('FEDEX_ACCOUNT'),
+  ENV.fetch('FEDEX_METER'),
+  ENV.fetch('FEDEX_AUTH_KEY'),
+  ENV.fetch('FEDEX_SECURITY_CODE'),
+  :test # or :production
+)
+api = Api.new(credentials)
+
+service = Ship::ServiceType::FEDEX_2_DAY
+
+from = Ship::Party.new.tap do |shipper|
+  shipper.contact = Ship::Contact.new.tap do |contact|
+    contact.personName  = "Joe Shmoe"
+    contact.phoneNumber = "(123) 456 789"
+  end
+
+  shipper.address = Ship::Address.new.tap do |address|
+    address.streetLines         = [ "123 4th St" ]
+    address.city                = "San Luis Obispo"
+    address.stateOrProvinceCode = "CA"
+    address.postalCode          = "93401"
+    address.countryCode         = "US"
+    address.residential         = true
+  end
+end
+
+to = Ship::Party.new.tap do |recipient|
+  recipient.contact = Ship::Contact.new.tap do |contact|
+    contact.personName  = "Ahwahnee Hotel"
+    contact.phoneNumber = "(801) 559-5000"
+  end
+  recipient.address = Ship::Address.new.tap do |address|
+    address.streetLines         = [ "9006 Yosemite Lodge Drive" ]
+    address.city                = "Yosemite National Park"
+    address.stateOrProvinceCode = "CA"
+    address.postalCode          = "95389"
+    address.countryCode         = "US"
+    address.residential         = true
+  end
+end
+
+label_spec = Ship::LabelSpecification.new
+label_spec.labelFormatType = Ship::LabelFormatType::COMMON2D
+label_spec.imageType       = Ship::ShippingDocumentImageType::PDF
+label_spec.labelStockType  = Ship::ShippingDocumentStockType::PAPER_LETTER
+
+weights = [ 10, 55.34, 10.2 ].map do |weight|
+  Ship::Weight.new.tap do |w|
+    w.units = "LB"
+    w.value = weight
+  end
+end
+
+requests = ProcessShipmentRequest.shipment_requests(service, from, to, label_spec, weights)
+requests.each do |request|
+  request.sender_paid!(credentials.account_number)
+  request.list_rate!
+  request.regular_pickup!
+  request.customer_reference!("01234")
+  request.customer_invoice!("56789")
+end
+
+tracking_numbers = api.process_shipments(requests).map do |response|
+  filename = "#{response.tracking_number}.pdf"
+  File.write(filename, response.label)
+  puts "Wrote #{filename}"
+  response.tracking_number
+end
+
+tracking_numbers.each do |tracking_number|
+  delete_request = DeleteShipmentRequest.new
+  delete_request.delete_all_packages!(tracking_number, Ship::TrackingIdType::EXPRESS)
+  api.delete_shipment(delete_request)
+  puts "Deleted shipment #{tracking_number}"
+end

data/fedex-web-services.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fedex_web_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fedex-web-services"
+  spec.version       = FedexWebServices::VERSION
+  spec.authors       = ["Brian Abreu"]
+  spec.email         = ["brian@nuts.com"]
+  spec.description   = %q{Interfaces with the FedEx SOAP web services API}
+  spec.summary       = %q{Provides an interface to the FedEx web services API}
+  spec.homepage      = "https://github.com/brewski/fedex-web-services"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "soap4r-ng", '~> 2.0'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/fedex_web_services.rb

@@ -0,0 +1,13 @@
+module FedexWebServices
+end
+
+require "fedex_web_services/soap"
+
+require 'fedex_web_services/request'
+require 'fedex_web_services/close_smart_post_request'
+require 'fedex_web_services/delete_shipment_request'
+require 'fedex_web_services/process_shipment_request'
+
+require "fedex_web_services/api"
+
+require "fedex_web_services/railtie" if (defined?(Rails))

data/lib/fedex_web_services/api.rb

@@ -0,0 +1,66 @@
+module FedexWebServices
+  class Api
+    include FedexWebServices::Soap
+
+    class ServiceException < RuntimeError
+      attr_accessor :details
+    end
+
+    Credentials = Struct.new(*%i(account_number meter_number key password environment))
+
+    attr_reader :wiredump
+
+    def initialize(credentials)
+      @credentials = credentials
+      @wiredump = ""
+    end
+
+    def process_shipments(requests)
+      port = Ship::ShipPortType.new(service_url)
+      first_response = nil
+
+      requests.map.with_index do |request, ndx|
+        if (ndx == 0)
+          first_response = issue_request(port, request)
+        else
+          request.for_master_tracking_number!(first_response.tracking_number)
+          issue_request(port, request)
+        end
+      end
+    end
+
+    def delete_shipment(request)
+      issue_request(Ship::ShipPortType.new(service_url), request)
+    end
+
+    def get_rates(request)
+    end
+
+    def close_smart_post(request)
+      issue_request(Close::ClosePortType.new(service_url), request)
+    end
+
+    def service_url
+      @service_url ||= (@credentials.environment.to_sym == :production) ?
+          'https://ws.fedex.com/web-services' :
+          'https://wsbeta.fedex.com/web-services'
+    end
+
+    private
+      def issue_request(port, request)
+        port.wiredump_dev = StringIO.new(request_wiredump = "")
+        request.issue_request(port, @credentials).tap do |response|
+          if (response.errors.any?)
+            raise response.errors.map(&:message) * ". "
+          end
+        end
+      rescue Exception => root_exception
+        raise
+        err = ServiceException.new(root_exception.message)
+        err.details = root_exception.detail.fault.details.validationFailureDetail.message rescue nil
+        raise err
+      ensure
+        @wiredump << request_wiredump if (request_wiredump)
+      end
+  end
+end

data/lib/fedex_web_services/close_smart_post_request.rb

@@ -0,0 +1,23 @@
+module FedexWebServices
+  class CloseSmartPostRequest < Request
+    def initialize
+      @contents = soap_module::SmartPostCloseRequest.new
+    end
+
+    def soap_module
+      FedexWebServices::Soap::Close
+    end
+
+    def remote_method
+      :smartPostClose
+    end
+
+    def service_id
+      :clos
+    end
+
+    def version
+      4
+    end
+  end
+end

data/lib/fedex_web_services/delete_shipment_request.rb

@@ -0,0 +1,31 @@
+module FedexWebServices
+  class DeleteShipmentRequest < Request
+    def initialize
+      @contents = soap_module::DeleteShipmentRequest.new
+    end
+
+    def soap_module
+      FedexWebServices::Soap::Ship
+    end
+
+    def remote_method
+      :deleteShipment
+    end
+
+    def service_id
+      :ship
+    end
+
+    def version
+      12
+    end
+
+    def delete_all_packages!(tracking_number, tracking_number_type)
+      contents.deletionControl = soap_module::DeletionControlType::DELETE_ALL_PACKAGES
+      contents.trackingId = soap_module::TrackingId.new.tap do |ti|
+        ti.trackingNumber = tracking_number
+        ti.trackingIdType = tracking_number_type
+      end
+    end
+  end
+end

data/lib/fedex_web_services/process_shipment_request.rb

@@ -0,0 +1,96 @@
+require 'fedex_web_services/process_shipment_response'
+
+module FedexWebServices
+  class ProcessShipmentRequest < Request
+    def initialize
+      @contents = soap_module::ProcessShipmentRequest.new
+    end
+
+    def soap_module
+      FedexWebServices::Soap::Ship
+    end
+
+    def remote_method
+      :processShipment
+    end
+
+    def service_id
+      :ship
+    end
+
+    def version
+      12
+    end
+
+    def issue_request(port, credentials)
+      ProcessShipmentResponse.new(port.send(remote_method, request_contents(credentials)))
+    end
+
+    def sender_paid!(account_number)
+      mod = self.soap_module
+
+      contents.requestedShipment.shippingChargesPayment = mod::Payment.new.tap do |scp|
+        scp.paymentType = mod::PaymentType::SENDER
+
+        scp.payor = mod::Payor.new
+        scp.payor.responsibleParty = contents.requestedShipment.shipper.dup
+        scp.payor.responsibleParty.accountNumber = account_number
+      end
+    end
+
+    def regular_pickup!
+      contents.requestedShipment.dropoffType = soap_module::DropoffType::REGULAR_PICKUP
+    end
+
+    def list_rate!
+      contents.requestedShipment.rateRequestTypes = [ soap_module::RateRequestType::LIST ]
+    end
+
+    def for_master_tracking_number!(tracking_number)
+      contents.requestedShipment.masterTrackingId = soap_module::TrackingId.new.tap do |ti|
+        ti.trackingNumber = tracking_number
+      end
+    end
+
+    def customer_reference!(reference)
+      mod = self.soap_module
+      ref = mod::CustomerReference.new(mod::CustomerReferenceType::CUSTOMER_REFERENCE, reference)
+
+      contents.requestedShipment.requestedPackageLineItems.customerReferences ||= []
+      contents.requestedShipment.requestedPackageLineItems.customerReferences << ref
+    end
+
+    def customer_invoice!(invoice_number)
+      mod = self.soap_module
+      ref = mod::CustomerReference.new(mod::CustomerReferenceType::INVOICE_NUMBER, invoice_number)
+
+      contents.requestedShipment.requestedPackageLineItems.customerReferences ||= []
+      contents.requestedShipment.requestedPackageLineItems.customerReferences << ref
+    end
+
+    def self.shipment_requests(service_type, from, to, label_specification, package_weights)
+      package_weights.map.with_index do |weight, ndx|
+        new.tap do |request|
+          mod = request.soap_module
+
+          request.contents.requestedShipment = mod::RequestedShipment.new.tap do |rs|
+            rs.shipTimestamp = Time.now.iso8601
+            rs.serviceType   = service_type
+            rs.packagingType = mod::PackagingType::YOUR_PACKAGING
+
+            rs.shipper   = from
+            rs.recipient = to
+
+            rs.labelSpecification = label_specification
+
+            rs.packageCount = package_weights.size
+            rs.requestedPackageLineItems = mod::RequestedPackageLineItem.new.tap do |rpli|
+              rpli.sequenceNumber = ndx + 1
+              rpli.weight = weight
+            end
+          end
+        end
+      end
+    end
+  end
+end