simple_shipping 0.4.6

data/lib/simple_shipping/ups/ship_accept_request.rb

@@ -0,0 +1,21 @@
+module SimpleShipping::Ups
+  # Shipping accept request.
+  class ShipAcceptRequest < Request
+    def initialize(credentials, shipment_digest, options = {})
+      @credentials     = credentials
+      @shipment_digest = shipment_digest
+      @options         = options
+      @type            = :prcoess_ship_accept
+    end
+
+    # :nodoc:
+    def body
+      { 'common:Request' => {
+          'common:RequestOption' => REQUEST_OPTION
+        },
+        'ShipmentDigest' => @shipment_digest,
+        :order!          => ['common:Request', 'ShipmentDigest']
+      }
+    end
+  end
+end

data/lib/simple_shipping/ups/ship_accept_response.rb

@@ -0,0 +1,6 @@
+# A wrapper for UPS response
+module SimpleShipping::Ups
+  # Response to {ShipAcceptRequest}.
+  class ShipAcceptResponse < Response
+  end
+end

data/lib/simple_shipping/ups/ship_client.rb

@@ -0,0 +1,70 @@
+module SimpleShipping::Ups
+  # Required credentials:
+  # * _username_
+  # * _password_
+  # * _access_license_number_
+  #
+  # = Usage
+  #  client = SimpleShipping::Ups::ShipClient.new(:username              => "USER NAME",
+  #                                             :password              => "PASSWORD",
+  #                                             :access_license_number => "LICENSE NUMBER")
+  #  client.request(shipper, recipient, package) # => #<SimpleShipping::Ups::Response ...>
+  class ShipClient < Client
+    set_required_credentials :username, :password, :access_license_number
+
+    set_wsdl_document       File.join(SimpleShipping::WSDL_DIR, "ups/Ship.wsdl")
+    set_production_address  "https://onlinetools.ups.com/webservices/Ship"
+    set_testing_address     "https://wwwcie.ups.com/webservices/Ship"
+
+    # @param shipper   [::SimpleShipping::Party]
+    # @param recipient [::SimpleShipping::Party]
+    # @param package   [::SimpleShipping::Package]
+    # @param options   [Hash] ({})
+    #
+    # @return [::SimpleShipping::ShipmentResponse]
+    #
+    # @raise [::SimpleShipping::RequestError] in case of SOAP errors
+    def shipment_request(shipper, recipient, package, options = {})
+      shipment = create_shipment(shipper, recipient, package, options)
+      request  = ShipmentRequest.new(@credentials, shipment, options)
+      execute(request)
+    end
+
+    # Send shipment confirmation request.
+    def ship_confirm_request(shipper, recipient, package, options = {})
+      shipment = create_shipment(shipper, recipient, package, options)
+      request  = ShipConfirmRequest.new(@credentials, shipment, options)
+      execute(request)
+    end
+
+
+    # Perform shipping accept request.
+    def ship_accept_request(shipment_digest, options = {})
+      request  = ShipAcceptRequest.new(@credentials, shipment_digest, options)
+      execute(request)
+    end
+
+    # @param [Hash] options Savon client options
+    def client_options(options = {})
+      super.deep_merge(
+        :namespaces => {
+          # Savon parses have WSDL instead of XMLSchema which is not accepted by UPS
+          # So we have to again set namespace explicitly :( -- aignatev 20130204
+          'xmlns:ship' => "http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0"
+        }
+      )
+    end
+    protected :client_options
+
+
+    # Perform ShipmentRequest to UPS service.
+    def execute(request)
+      savon_response = @client.call(request.type, :message => request.body)
+      log_response(savon_response)
+      request.response(savon_response)
+    rescue Savon::SOAPFault => e
+      raise SimpleShipping::RequestError.new(e)
+    end
+    private :execute
+  end
+end

data/lib/simple_shipping/ups/ship_confirm_request.rb

@@ -0,0 +1,22 @@
+module SimpleShipping::Ups
+  # Request to verify a shipment was delivered.
+  class ShipConfirmRequest < Request
+    def initialize(credentials, shipment, options = {})
+      @credentials = credentials
+      @shipment    = shipment
+      @options     = options
+      @type        = :process_ship_confirm
+    end
+
+    # Builds a request from {Shipment shipment} object.
+    def body
+      { 'common:Request' => {
+          'common:RequestOption' => REQUEST_OPTION
+        },
+        'Shipment'           => ShipmentBuilder.build(@shipment, @options),
+        'LabelSpecification' => label_specification,
+        :order!              => ['common:Request', 'Shipment', 'LabelSpecification']
+      }
+    end
+  end
+end

data/lib/simple_shipping/ups/ship_confirm_response.rb

@@ -0,0 +1,6 @@
+# A wrapper for a UPS response.
+module SimpleShipping::Ups
+  # Response to {ShipConfirmResponse}.
+  class ShipConfirmResponse < Response
+  end
+end

data/lib/simple_shipping/ups/shipment_builder.rb

@@ -0,0 +1,66 @@
+module SimpleShipping::Ups
+  # Builds shipment element for UPS SOAP service.
+  class ShipmentBuilder < SimpleShipping::Abstract::Builder
+    # The type of payment for this shipment.
+    PAYMENT_TYPE = '01' # 01 - Transportation, 02 - Duties and Taxes
+
+    # Service codes in UPS terminology.
+    SERVICE_TYPES = {:next_day_air            => '01',
+                     :second_day_air          => '02',
+                     :ground                  => '03',
+                     :express                 => '07',
+                     :expedited               => '08',
+                     :standard                => '11',
+                     :three_day_select        => '12',
+                     :next_day_air_saver      => '13',
+                     :next_day_air_early_am   => '14',
+                     :express_plus            => '54',
+                     :second_day_air_am       => '59',
+                     :saver                   => '65',
+                     :today_standard          => '82',
+                     :today_dedicated_courier => '83',
+                     :today_intercity         => '84',
+                     :today_express           => '85',
+                     :today_express_saver     => '86'}
+
+    set_default_opts :service_type => :second_day_air
+
+    # Return a hash for Savon representing a shipment model.
+    def build
+      { 'Shipper'            => PartyBuilder.build(@model.shipper, :shipper => true),
+        'ShipTo'             => PartyBuilder.build(@model.recipient),
+        'PaymentInformation' => build_payment_info,
+        'Service'            => build_service,
+        'Package'            => PackageBuilder.build(@model.package),
+        :order! => ['Shipper', 'ShipTo', 'PaymentInformation', 'Service', 'Package'] }
+    end
+
+    # Return the PaymentInformation hash.
+    def build_payment_info
+      {'ShipmentCharge' => build_shipment_charge }
+    end
+
+    # Return the shipment charge for the PaymentInformation hash.
+    def build_shipment_charge
+      result = {'Type' => PAYMENT_TYPE, :order! => ['Type']}
+      if @model.payor == :shipper
+        result['BillShipper'] = {'AccountNumber' => @model.shipper.account_number}
+        result[:order!] << 'BillShipper'
+      else
+        result['BillReceiver'] = {'AccountNumber' => @model.recipient.account_number}
+        result[:order!] << 'BillReceiver'
+      end
+      result
+    end
+
+    # Return the hash representing the Service.
+    def build_service
+      {'Code' => SERVICE_TYPES[@opts[:service_type]]}
+    end
+
+    # Validate that the service type is included.
+    def validate
+      validate_inclusion_of(:service_type, SERVICE_TYPES)
+    end
+  end
+end

data/lib/simple_shipping/ups/shipment_request.rb

@@ -0,0 +1,22 @@
+module SimpleShipping::Ups
+  # Shipment request model.
+  class ShipmentRequest < Request
+    def initialize(credentials, shipment, options = {})
+      @credentials = credentials
+      @shipment    = shipment
+      @options     = options
+      @type        = :process_shipment
+    end
+
+    # Builds a request from {Shipment shipment} object.
+    def body
+      { 'common:Request' => {
+          'common:RequestOption' => REQUEST_OPTION
+        },
+        'Shipment'           => ShipmentBuilder.build(@shipment, @options),
+        'LabelSpecification' => label_specification,
+        :order!              => ['common:Request', 'Shipment', 'LabelSpecification']
+      }
+    end
+  end
+end

data/lib/simple_shipping/ups/shipment_response.rb

@@ -0,0 +1,6 @@
+# A wrapper for a UPS ShipmentResponse.
+module SimpleShipping::Ups
+  # Response to ShipmentRequest.
+  class ShipmentResponse < Response
+  end
+end

data/lib/simple_shipping/ups/void_client.rb

@@ -0,0 +1,50 @@
+module SimpleShipping::Ups
+  # Required credentials:
+  # * _username_
+  # * _password_
+  # * _access_license_number_
+  #
+  # = Usage
+  #  client = SimpleShipping::Ups::VoidClient.new(:username              => "USER NAME",
+  #                                               :password              => "PASSWORD",
+  #                                               :access_license_number => "LICENSE NUMBER")
+  #  client.request(shipper, recipient, package) # => #<SimpleShipping::Ups::Response ...>
+  class VoidClient < Client
+    set_required_credentials :username, :password, :access_license_number
+
+    set_wsdl_document       File.join(SimpleShipping::WSDL_DIR, "ups/Void.wsdl")
+    set_production_address  "https://onlinetools.ups.com/webservices/Void"
+    set_testing_address     "https://wwwcie.ups.com/webservices/Void"
+
+    # Build VoidRequest and perform the request.
+    #
+    # @param shipment_identification_number [String]
+    # @param options [Hash]
+    def void_request(shipment_identification_number, options = {})
+      request = VoidRequest.new(@credentials, shipment_identification_number, options)
+      execute(request)
+    end
+
+    # @param [Hash] options Savon client options
+    def client_options(options = {})
+      super.deep_merge(
+        :namespaces => {
+          # Savon parses have WSDL instead of XMLSchema which is not accepted by UPS
+          # So we have to again set namespace explicitly :( -- aignatev 20130204
+          'xmlns:void' => "http://www.ups.com/XMLSchema/XOLTWS/Void/v1.1"
+        }
+      )
+    end
+    protected :client_options
+
+    # Perform ShipmentRequest to UPS service.
+    def execute(request)
+      savon_response = @client.call(request.type, :message => request.body)
+      log_response(savon_response)
+      request.response(savon_response)
+    rescue Savon::SOAPFault => err
+      raise SimpleShipping::RequestError.new(err)
+    end
+    private :execute
+  end
+end

data/lib/simple_shipping/ups/void_request.rb

@@ -0,0 +1,42 @@
+module SimpleShipping::Ups
+  # UPS request to void shipment.
+  class VoidRequest < Request
+
+    # @param credentials [Hash]
+    # @param shipment_identification_number [String]
+    # @param options [Hash]
+    def initialize(credentials, shipment_identification_number, options = {})
+      @credentials                    = credentials
+      @shipment_identification_number = shipment_identification_number
+      @tracking_number                = options[:tracking_number]
+      @options                        = options
+      @type                           = :process_void
+    end
+
+    # Build a request from a {Shipment shipment} object.
+    def body
+      {
+        'common:Request' => {
+          'common:RequestOption' => REQUEST_OPTION
+        },
+        'VoidShipment' => void_shipment,
+        :order!        => ['common:Request', 'VoidShipment']
+      }
+    end
+
+    # Data for VoidShipment.
+    #
+    # @return [Hash]
+    def void_shipment
+      data = { 'ShipmentIdentificationNumber' => @shipment_identification_number }
+
+      if @tracking_number
+        data['TrackingNumber'] = @tracking_number
+        data[:order!]          = ['ShipmentIdentificationNumber', 'TrackingNumber']
+      end
+
+      data
+    end
+    private :void_shipment
+  end
+end

data/lib/simple_shipping/ups/void_response.rb

@@ -0,0 +1,6 @@
+# A wrapper for a UPS response.
+module SimpleShipping::Ups
+  # Response to VoidRequest.
+  class VoidResponse < Response
+  end
+end

data/lib/tasks/demo.rake

@@ -0,0 +1,58 @@
+namespace :demo do
+  task :environment do
+    require 'rubygems'
+    require 'bundler'
+    Bundler.require
+
+    $LOAD_PATH.unshift File.expand_path('../../', __FILE__)
+
+    require 'simple_shipping'
+    require 'RMagick'
+  end
+
+
+  namespace :fedex do
+    desc 'Call real FedEx API with shipment_request'
+    task :shipment_request, [:credentials_file, :output_filename] => :environment do |task, args|
+      args.with_defaults(:output_filename => File.join(Dir.tmpdir, 'fedex_shipment_request_output.png'))
+
+      credentials = YAML.load_file(args[:credentials_file])['fedex'].symbolize_keys!
+
+      demo = SimpleShipping::Demo::Fedex.new(credentials)
+      resp = demo.shipment_request
+      img  = Magick::Image.read_inline(resp.label_image_base64).first
+
+      img.write(args[:output_filename])
+      puts "Label received. #{args[:output_filename]} written"
+    end
+  end
+
+  namespace :ups do
+    desc 'Call real UPS API with shipment_request'
+    task :shipment_request, [:credentials_file, :output_filename] => :environment do |task, args|
+      args.with_defaults(:output_filename => File.join(Dir.tmpdir, 'ups_shipment_request_output.png'))
+
+      credentials = YAML.load_file(args[:credentials_file])['ups'].symbolize_keys!
+
+      demo = SimpleShipping::Demo::Ups.new(credentials)
+
+      resp = demo.shipment_request
+      img  = Magick::Image.read_inline(resp.label_image_base64).first
+
+      img.write(args[:output_filename])
+      puts "Label received. #{args[:output_filename]} written"
+    end
+
+    desc 'Call real UPS API with void_request'
+    task :void_request, [:credentials_file] => :environment do |task, args|
+      credentials = YAML.load_file(args[:credentials_file])['ups'].symbolize_keys!
+      demo        = SimpleShipping::Demo::Ups.new(credentials)
+
+      begin
+        resp = demo.void_request
+      rescue SimpleShipping::RequestError => exc
+        raise exc unless exc.message =~ /No shipment found within the allowed void period/
+      end
+    end
+  end
+end

data/script/ups_certification.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'simple_shipping'
+require 'simple_shipping/ups'
+require 'RMagick'
+require 'fileutils'
+require 'forgery'
+require 'yaml'
+
+package_path_base = File.expand_path('../ups_certification_package/', __FILE__)
+FileUtils.rm_rf(package_path_base) if File.directory?(package_path_base)
+
+# YAML file with credentials
+unless credentials_file = ARGV.pop
+  abort "Usage:\n  #{$0} <PATH_TO_CREDENTIALS.yml>"
+end
+
+CREDENTIALS    = YAML.load_file(credentials_file )['ups'].symbolize_keys!
+ACCOUNT_NUMBER = CREDENTIALS.delete(:account_number)
+
+5.times do |iteration|
+  package_path = File.join(package_path_base, iteration.to_s)
+  FileUtils.mkdir_p(package_path)
+
+  shipper_address = SimpleShipping::Address.new(
+    :country_code => 'US',
+    :state_code   => 'IL',
+    :postal_code  => '60201',
+    :city         => Forgery::Address.city,
+    :street_line  => Forgery::Address.street_address
+  )
+  shipper_contact = SimpleShipping::Contact.new(
+    :person_name  => Forgery::Name.full_name,
+    :phone_number => Forgery::Address.phone
+  )
+  shipper = SimpleShipping::Party.new(
+    :address        => shipper_address,
+    :contact        => shipper_contact,
+    :account_number => ACCOUNT_NUMBER
+  )
+  recipient_address = SimpleShipping::Address.new(
+    :country_code => 'US',
+    :state_code   => 'SC',
+    :postal_code  => '29072',
+    :city         => Forgery::Address.city,
+    :street_line  => Forgery::Address.street_address
+  )
+  recipient_contact = SimpleShipping::Contact.new(
+    :person_name  => Forgery::Name.full_name,
+    :phone_number => Forgery::Address.phone
+  )
+  recipient = SimpleShipping::Party.new(
+    :address => recipient_address,
+    :contact => recipient_contact
+  )
+  package = SimpleShipping::Package.new(
+    :weight         => 0.5,
+    :packaging_type => :envelope,
+    :insured_value  => iteration * 250.0,
+    :declared_value => iteration * 250.0
+  )
+
+  confirm_path = File.join(package_path, "confirm")
+  FileUtils.mkdir_p(confirm_path)
+
+  confirm_client = SimpleShipping::Ups::ShipClient.new(
+    :debug       => true,
+    :debug_path  => confirm_path,
+    :credentials => CREDENTIALS
+  )
+
+  puts "CONFIRM REQUEST #{iteration}"
+  confirm = confirm_client.ship_confirm_request(shipper, recipient, package)
+
+  accept_path = File.join(package_path, "accept")
+  FileUtils.mkdir_p(accept_path)
+  accept_client = SimpleShipping::Ups::ShipClient.new(
+    :debug       => true,
+    :debug_path  => accept_path,
+    :credentials => CREDENTIALS
+  )
+
+  puts "ACCEPT REQUEST #{iteration}"
+  accept = accept_client.ship_accept_request(confirm.digest)
+
+  puts "SAVING LABEL HTML"
+  File.open(File.join(package_path, "label.html"), "w") {|f| f.write accept.label_html}
+
+  puts "SAVING LABEL GIF"
+  image_name = "label#{accept.tracking_number}.gif"
+  img        = Magick::Image.read_inline(accept.label_image_base64).first
+  img.write(File.join(package_path, image_name))
+
+
+  # Apparently, the HTML version is OK:
+  # http://www.corecommerce.com/kb/328/ups_label_certification_requiring_39th_file
+  if accept.receipt_html
+    puts "SAVING HIGH VALUE REPORT HTML"
+    File.open(File.join(package_path, "high_value_report.html"), "w") {|f| f.write accept.receipt_html}
+  end
+end
+
+VOID_NUMBERS = [
+  # A successful XML response will be returned for a shipment level void request.
+  ['1ZISDE016691676846'],
+  # A successful XML response will be returned for a shipment level void request.
+  ['1Z2220060290602143'],
+  # A successful XML response will be returned for a package level void request. The request will void the package in the shipment.
+  ['1Z2220060294314162', '1Z2220060291994175'],
+  # A successful XML response will be returned for a package level void request. The request will void the package in the shipment. .
+  ['1Z2220060292690189', '1Z2220060292002190'],
+
+  # Multiple tracking numbers for each shipment identifier. These don't seem to
+  # work, but implementing them is unnecessary.
+
+  # A successful XML response will be returned for a package level void request. The request will void all the packages.
+  # ['1ZISDE016691609089', '1ZISDE016694068891'],
+  # A successful XML response will be returned for a package level void request. The request will void all the packages.
+  # ['1ZISDE016691609089', '1ZISDE016690889305'],
+  # A successful XML response will be returned with a partial void for a package level void request. The request will void package 1Z2220060293874210 but package 1Z2220060292634221 cannot be voided.
+  # ['1Z2220060290530202', '1Z2220060293874210'],
+  # A successful XML response will be returned with a partial void for a package level void request. The request will void package 1Z2220060293874210 but package 1Z2220060292634221 cannot be voided.
+  # ['1Z2220060290530202', '1Z2220060292634221']
+]
+
+VOID_NUMBERS.each do |identifier, tracking_number|
+  package_path = File.join(package_path_base, "void/#{identifier}")
+  FileUtils.mkdir_p(package_path)
+
+  void_client = SimpleShipping::Ups::VoidClient.new(
+    :debug       => true,
+    :debug_path  => package_path,
+    :credentials => CREDENTIALS
+  )
+  puts "VOID REQUEST: #{identifier}"
+  void_client.void_request(identifier, :tracking_number => tracking_number)
+end