ups_shipping 1.0.0

data/lib/ups_shipping.rb

@@ -0,0 +1,190 @@
+require "nokogiri"
+require "httparty"
+require 'ups_shipping/address'
+require 'ups_shipping/organization'
+require 'ups_shipping/package'
+require 'ups_shipping/pickup'
+
+module Shipping
+
+  VERSION = '1.0.0'
+
+  class UPS
+
+    TEST_URL = "https://wwwcie.ups.com"
+    LIVE_URL = "https://onlinetools.ups.com"
+
+    class Http
+      include HTTParty
+      base_uri LIVE_URL
+
+      def initialize(access_request, options={})
+        @access_request = access_request
+
+        if (options[:test])
+          self.class.base_uri TEST_URL
+        end
+      end
+
+      def commit(url, request)
+        request = @access_request + request
+        self.class.post(url, :body => request).parsed_response
+      end
+    end
+
+    def initialize(user, password, license, options={})
+      @options = options
+      @shipper = options[:shipper]
+      @access_request = access_request(user, password, license)
+      @http = Http.new(@access_request, :test => @options[:test])
+
+      @services = {
+          "01" => "Next Day Air",
+          "02" => "2nd Day Air",
+          "03" => "Ground",
+          "07" => "Express",
+          "08" => "Expedited",
+          "11" => "UPS Standard",
+          "12" => "3 Day Select",
+          "13" => "Next Day Air Saver",
+          "14" => "Next Day Air Early AM",
+          "54" => "Express Plus",
+          "59" => "2nd Day Air A.M.",
+          "65" => "UPS Saver",
+          "82" => "UPS Today Standard",
+          "83" => "UPS Today Dedicated Courier",
+          "84" => "UPS Today Intercity",
+          "85" => "UPS Today Express",
+          "86" => "UPS Today Express Saver"
+      }
+
+    end
+
+    def validate_address(address)
+      validate_request = Nokogiri::XML::Builder.new do |xml|
+        xml.AddressValidationRequest {
+          xml.Request {
+            xml.RequestAction "XAV"
+            xml.RequestOption "3"
+          }
+          xml.AddressKeyFormat {
+            xml.AddressLine address.address_line[0]
+            xml.PoliticalDivision2 address.city
+            xml.PoliticalDivision1 address.state
+            xml.PostcodePrimaryLow address.zip
+            xml.CountryCode address.country
+          }
+        }
+      end
+      @http.commit("/ups.app/xml/XAV", validate_request.to_xml)
+    end
+
+    def find_rates(package, origin, destination, options={})
+      rate_request = Nokogiri::XML::Builder.new do |xml|
+        xml.RatingServiceSelectionRequest {
+          xml.Request {
+            xml.RequestAction "Rate"
+            xml.RequestOption "Rate"
+          }
+          if options[:pickup]
+            @options[:pickup].build_type(xml)
+          end
+          @shipper.build(xml, "Shipper")
+          destination.build(xml, "ShipTo")
+          origin.build(xml, "ShipFrom")
+          xml.PaymentInformation {
+            xml.Prepaid {
+              xml.BillShipper {
+                xml.AccountNumber "Ship Number"
+              }
+            }
+          }
+          package.build(xml)
+        }
+      end
+      @http.commit("/ups.app/xml/Rate", rate_request.to_xml)
+    end
+
+    def request_shipment(package, origin, destination, service, options={})
+      shipment_request = Nokogiri::XML::Builder.new do |xml|
+        xml.ShipmentConfirmRequest {
+          xml.Request {
+            xml.RequestAction "ShipConfirm"
+            xml.RequestOptions "validate"
+          }
+          if options[:label]
+            xml.LabelSpecification {
+              xml.LabelPrintMethod {
+                xml.Code "GIF"
+                xml.Description "gif file"
+              }
+              xml.HTTPUserAgent "Mozilla/4.5"
+              xml.LabelImageFormat {
+                xml.Code "GIF"
+                xml.Description "gif"
+              }
+            }
+          end
+          @shipper.build(xml, "Shipper")
+          destination.build(xml, "ShipTo")
+          origin.build(xml, "ShipFrom")
+          xml.PaymentInformation {
+            xml.Prepaid {
+              xml.BillShipper {
+                xml.AccountNumber "Ship Number"
+              }
+            }
+          }
+          xml.Service {
+            xml.Code service
+            xml.Description @services[service]
+          }
+          package.build(xml)
+        }
+      end
+      @http.commit("/ups.app/xml/ShipConfirm", shipment_request.to_xml)
+    end
+
+    def cancel_shipment(shipment_id)
+      cancel_request = Nokogiri::XML::Builder.new do |xml|
+        xml.VoidShipmentRequest {
+          xml.Request {
+            xml.RequestAction "1"
+            xml.RequestOption "1"
+          }
+          xml.ShipmentIdentificationNumber shipment_id
+        }
+      end
+      @http.commit("/ups.app/xml/Void", cancel_request.to_xml)
+    end
+
+    def track_shipment(tracking_number)
+      track_request = Nokogiri::XML::Builder.new do
+        TrackRequest {
+          Request {
+            RequestAction "Track"
+            RequestOption "activity"
+          }
+          TrackingNumber tracking_number
+        }
+      end
+
+      @http.commit("/ups.app/xml/Track", track_request.to_xml)
+    end
+
+
+    private
+    def access_request(user, password, license)
+      access_request = Nokogiri::XML::Builder.new do
+        AccessRequest {
+          AccessLicenseNumber license
+          UserId user
+          Password password
+        }
+      end
+
+      access_request.to_xml
+    end
+
+  end
+end

data/lib/ups_shipping/address.rb

@@ -0,0 +1,39 @@
+require "nokogiri"
+
+module Shipping
+  class Address
+    ADDRESS_TYPES = %w{residential commercial po_box}
+    attr_accessor :address_lines
+                  :city
+                  :state
+                  :zip
+                  :country
+                  :type
+
+    def initialize(options={})
+      @address_lines = options[:address_lines]
+      @city = options[:city]
+      @state = options[:state]
+      @zip = options[:zip]
+      @country = options[:country]
+      @type = options[:type]
+    end
+
+    def build(xml)
+      xml.Address {
+        xml.AddressLine1 @address_lines[0]
+        xml.City @city
+        xml.StateProvinceCode @state
+        xml.PostalCode @zip
+        xml.CountryCode @country
+      }
+    end
+
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new do |xml|
+        build(xml)
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/ups_shipping/organization.rb

@@ -0,0 +1,39 @@
+require "nokogiri"
+
+module Shipping
+  class Organization
+    attr_accessor :name
+                  :phone
+                  :email
+                  :address
+                  :shipper_number
+
+
+    def initialize(options={})
+      @name = options[:name]
+      @phone = options[:phone]
+      @address = options[:address]
+      if options[:shipper_number]
+        @shipper_number = options[:shipper_number]
+      end
+    end
+
+    def build(xml, rootname)
+      xml.send(rootname) {
+        xml.CompanyName @name
+        xml.PhoneNumber @phone
+        if @shipper_number
+          xml.ShipperNumber @shipper_number
+        end
+        @address.build(xml)
+      }
+    end
+
+    def to_xml(rootname)
+      builder = Nokogiri::XML::Builder.new do |xml|
+        build(xml, rootname)
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/ups_shipping/package.rb

@@ -0,0 +1,45 @@
+require "nokogiri"
+
+module Shipping
+  class Package
+    attr_accessor :large
+                  :weight
+                  :description
+                  :monetary_value
+
+    def initialize(options={})
+      @large = options[:large]
+      @weight = options[:weight]
+      @description = options[:description]
+      @monetary_value = options[:monetary_value]
+    end
+
+    def build(xml)
+      xml.Package {
+        xml.PackagingType {
+          xml.Code "02"
+          xml.Description "Customer Supplied"
+        }
+        xml.Description @description
+        xml.ReferenceNumber {
+          xml.Code "00"
+          xml.Value "Package"
+        }
+        xml.PackageWeight {
+          xml.UnitOfMeasurement
+          xml.Weight @weight
+        }
+        if @large
+          xml.LargePackageIndicator
+        end
+      }
+    end
+
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new do |xml|
+        build(xml)
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/ups_shipping/pickup.rb

@@ -0,0 +1,49 @@
+require "nokogiri"
+
+module Shipping
+  class Pickup
+    attr_accessor :address_lines
+    :pickup_day
+    :contact_method
+    :type
+
+    def initialize(options={})
+      @type = options[:type]
+      if options[:pickup_day]
+        @pickup_day = options[:pickup_day]
+      end
+      if options[:contact_method]
+        @contact_method = options[:contact_method]
+      end
+
+      @pickupTypes = {
+          "01" => "Daily Pickup",
+          "03" => "Customer Counter",
+          "06" => "One Time Pickup",
+          "07" => "On Call Air",
+          "19" => "Letter Center",
+          "20" => "Air Service Center"
+      }
+    end
+
+    def build_schedule(xml)
+      xml.OnCallAir {
+        xml.Schedule {
+          if @pickup_day
+            xml.PickupDay @pickup_day
+          end
+          if @contact_method
+            xml.Method @contact_method
+          end
+        }
+      }
+    end
+
+    def build_type(xml)
+      xml.PickupType {
+        xml.Code type
+        xml.Description @pickupTypes[type]
+      }
+    end
+  end
+end

data/spec/ups_shipping_spec.rb

@@ -0,0 +1,42 @@
+require "rspec"
+require "ups_shipping"
+require "address"
+require "organization"
+
+describe Shipping::UPS do
+  before(:all) do
+    @ups = Shipping::UPS.new("deanchen", "Transcriptic#1", "EC96D31A8D672E28", :test => true)
+    @address = Shipping::Address.new(
+        :address_lines => ["1402 Faber St."],
+        :city => "Durham",
+        :state => "NC",
+        :zip => "27705",
+        :country => "US"
+    )
+  end
+  it "address object" do
+    @address.to_xml.gsub(/^\s+/, "").gsub(/\s+$/, $/).should == '
+      <?xml version="1.0"?>
+      <Address>
+        <AddressLine1>1402 Faber St.</AddressLine1>
+        <City>Durham</City>
+        <StateProvinceCode>NC</StateProvinceCode>
+        <PostalCode>27705</PostalCode>
+        <CountryCode>US</CountryCode>
+      </Address>
+      '.gsub(/^\s+/, "").gsub(/\s+$/, $/)
+  end
+  it "organization object" do
+    @organization = Shipping::Organization.new(
+        :name => "Transcriptic",
+        :phone => "1233455678",
+        :address => @address
+    )
+    puts @organization.to_xml("Shipper")
+  end
+  it "#track_shipment" do
+    tracking_result = @ups.track_shipment("1ZXX31290231000092")
+    tracking_result.should have_key("TrackResponse")
+    tracking_result["TrackResponse"]["Response"]["ResponseStatusCode"].should == "1"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: ups_shipping
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Transcriptic, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70314021897160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314021897160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70314021896740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314021896740
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70314021896320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314021896320
+description: UPS shipping gem for integrating UPS's API into a Ruby script.
+email: team@transcriptic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ups_shipping.rb
+- lib/ups_shipping/address.rb
+- lib/ups_shipping/organization.rb
+- lib/ups_shipping/package.rb
+- lib/ups_shipping/pickup.rb
+- spec/ups_shipping_spec.rb
+homepage: http://www.github.com/transcriptic/ups-shipping
+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: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: UPS shipping API integration.
+test_files: []
+has_rdoc: