ups_pickup 0.0.1

data/lib/schema/UPSSecurity.xsd

@@ -0,0 +1,23 @@
+<xsd:schema targetNamespace="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0" xmlns:upss="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+	<xsd:element name="UPSSecurity">
+		<xsd:complexType>
+			<xsd:sequence>
+				<xsd:element name="UsernameToken">
+					<xsd:complexType>
+						<xsd:sequence>
+							<xsd:element name="Username" type="xsd:string"/>
+							<xsd:element name="Password" type="xsd:string"/>
+						</xsd:sequence>
+					</xsd:complexType>
+				</xsd:element>
+				<xsd:element name="ServiceAccessToken">
+					<xsd:complexType>
+						<xsd:sequence>
+							<xsd:element name="AccessLicenseNumber" type="xsd:string"/>
+						</xsd:sequence>
+					</xsd:complexType>
+				</xsd:element>
+			</xsd:sequence>
+		</xsd:complexType>
+	</xsd:element>
+</xsd:schema>

data/lib/schema/common.xsd

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- edited with XML Spy v4.1 U (http://www.xmlspy.com) by Rajendra Upadhya (UPS GACOR850393,) -->
+<!-- edited with XMLSpy v2006 sp2 U (http://www.altova.com) by MC (United Parcel Service) -->
+<xsd:schema targetNamespace="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ups="http://www.ups.com/XMLSchema" xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0" elementFormDefault="qualified">
+	<xsd:element name="Request" type="common:RequestType"/>
+	<xsd:element name="Response" type="common:ResponseType"/>
+	<xsd:element name="ClientInformation" type="common:ClientInformationType"/>
+	
+	<xsd:complexType name="ClientInformationType">
+		<xsd:sequence>
+			<xsd:element name="Property" minOccurs="0" maxOccurs="unbounded">
+				<xsd:complexType>
+					<xsd:simpleContent>
+						<xsd:extension base="xsd:string">
+							<xsd:attribute name="Key" type="xsd:string" use="required"/>
+						</xsd:extension>
+					</xsd:simpleContent>
+				</xsd:complexType>
+			</xsd:element>
+		</xsd:sequence>
+	</xsd:complexType>
+	
+	<xsd:complexType name="RequestType">
+		<xsd:sequence>
+			<xsd:element name="RequestOption" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
+			<xsd:element name="TransactionReference" type="common:TransactionReferenceType" minOccurs="0"/>
+		</xsd:sequence>
+	</xsd:complexType>
+	<xsd:complexType name="TransactionReferenceType">
+		<xsd:sequence>
+			<xsd:element name="CustomerContext" type="xsd:string" minOccurs="0"/>
+			<xsd:element name="TransactionIdentifier" type="xsd:string" minOccurs="0" ups:usage="notused"/>
+		</xsd:sequence>
+	</xsd:complexType>
+	<xsd:complexType name="ResponseType">
+		<xsd:sequence>
+			<xsd:element name="ResponseStatus" type="common:CodeDescriptionType"/>
+			<xsd:element name="Alert" type="common:CodeDescriptionType" minOccurs="0" maxOccurs="unbounded"/>
+			<xsd:element name="TransactionReference" type="common:TransactionReferenceType" minOccurs="0"/>
+		</xsd:sequence>
+	</xsd:complexType>
+	<xsd:complexType name="CodeDescriptionType">
+		<xsd:sequence>
+			<xsd:element name="Code" type="xsd:string"/>
+			<xsd:element name="Description" type="xsd:string"/>
+		</xsd:sequence>
+	</xsd:complexType>
+</xsd:schema>

data/lib/ups_pickup.rb

@@ -0,0 +1,18 @@
+require 'pry'
+require 'savon'
+require 'httparty'
+require "ups_pickup/version"
+require "ups_pickup/pickup_request"
+require "ups_pickup/error_response"
+require "ups_pickup/shipper"
+require "ups_pickup/address"
+require "ups_pickup/fault_response"
+require "ups_pickup/pickup_creation"
+require "ups_pickup/pickup_creation_success"
+require "ups_pickup/pickup_piece"
+require "ups_pickup/pickup_cancel"
+require "ups_pickup/pickup_cancel_success"
+
+module UpsPickup
+  # Your code goes here...
+end

data/lib/ups_pickup/address.rb

@@ -0,0 +1,63 @@
+module UpsPickup
+  
+  class Address
+   
+    attr_accessor :address_line,:city, :state, :country,:postal_code,:country_code
+    def initialize(options={})
+      options ||={}
+      @address_line = options[:address_line]
+      @city = options[:city]
+      @state = options[:state]
+      @postal_code = options[:postal_code]
+      #@country = options[:country_code]
+      @country_code = options[:country_code] || "US"
+    end
+
+    def to_ups_hash
+      {
+      "ns2:AddressLine"=>@address_line,
+      "ns2:City"=>@city,
+      "ns2:StateProvince"=>@state,
+      "ns2:PostalCode"=>@postal_code,
+      "ns2:CountryCode"=>@country_code
+      }
+    end
+  end 
+
+  class PickupAddress < Address
+    ADDRESS_TYPES = {:residential=>"Y",:commercial=>"N"} 
+    attr_accessor :company_name,:contact_name,:room,:floor , :residential_indicator,:pickup_point,:phone_number,:extension
+    def initialize(options={})
+      super(options)
+      @company_name =options[:company_name]
+      @contact_name = options[:contact_name]
+      @room = options[:room]
+      @floor = options[:floor]
+      @residential_indicator = options[:residential_indicator] || "N" #ADDRESS_TYPES[options[:type]]
+      @pickup_point = options[:pickup_point]
+      @phone_number = options[:phone_number]
+      @extension = options[:extension]
+
+    end
+    def to_ups_hash
+      {
+        "ns2:CompanyName"=>@company_name,
+        "ns2:ContactName"=>@contact_name, 
+        "ns2:AddressLine"=>@address_line,
+        "ns2:Floor"=>@floor,
+        "ns2:Room"=>@room,
+        "ns2:City"=>@city,
+        "ns2:StateProvince"=>@state,
+        "ns2:PostalCode"=>@postal_code,
+        "ns2:CountryCode"=>@country_code,
+        "ns2:ResidentialIndicator"=>@residential_indicator,
+        "ns2:PickupPoint"=>@pickup_point,
+        "ns2:Phone"=>{
+          "ns2:Number"=>@phone_number,
+          "ns2:Extension"=>@extension
+        }
+
+      }
+    end
+  end
+end  

data/lib/ups_pickup/error_response.rb

@@ -0,0 +1,18 @@
+require 'ups_pickup/util'
+module UpsPickup
+  class ErrorResponse
+    include Util
+    attr_accessor :error_code,:severity,:description
+    # currently building for error 
+    def initialize(response)
+      response_hash = response.to_hash
+
+      @severity = response_hash.deep_fetch(:severity)
+      @error_code = response_hash.deep_fetch(:code)
+      @description =response_hash.deep_fetch(:description)
+    end
+
+    
+
+  end
+end

data/lib/ups_pickup/fault_response.rb

@@ -0,0 +1,12 @@
+module UpsPickup
+  class FaultResponse < ErrorResponse
+    attr_accessor :response
+    def initialize(client,response)
+      fault_client = client  
+      fault_client.config.raise_errors = false
+      @response = Savon::SOAP::Response.new(fault_client.config,response.http)
+      
+    end
+
+  end
+end

data/lib/ups_pickup/pickup_cancel.rb

@@ -0,0 +1,51 @@
+
+module UpsPickup
+  class PickupCancel < PickupRequest
+    def initialize(user_name, password, license, options={})
+      super(user_name, password, license, options)  
+      @cancel_by = options[:cancel_by] || "02"
+      @prn = options[:prn]
+    end
+
+    def to_ups_hash
+      {
+        "ns2:CancelBy"=>@cancel_by,
+        "ns2:PRN"=>@prn
+      }
+    end
+    
+    def build_request
+      self.to_ups_hash
+    end
+
+    def commit
+      begin
+        @client_response = @client.request  :ns2,"PickupCancelRequest" do
+          #soap.namespaces["xmlns:S"] = "http://schemas.xmlsoap.org/soap/envelope/"
+          #soap.namespaces["xmlns:upss"] = "http://www.ups.com/XMLschema/XOLTWS/UPSS/v1.0"
+          #soap.namespaces["xmlns:ns1"] = "http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
+          soap.namespaces["xmlns:ns3"] = "http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
+          soap.namespaces["xmlns:ns2"] = "http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1"
+        #  soap.header = SOAP_HEADER1
+          soap.header = access_request
+          soap.body = build_request
+        end
+      rescue Savon::SOAP::Fault => fault
+        @client_response = fault
+      rescue Savon::Error => error
+        @client_response = error   
+      end  
+      build_response
+    end
+
+    def build_response
+      if success?
+        @response = UpsPickup::PickupCancelSuccess.new(@client_response) 
+      elsif soap_fault?
+        fault_response = UpsPickup::FaultResponse.new(@client,@client_response)
+        @error = UpsPickup::ErrorResponse.new(fault_response.response)
+      end  
+    end
+  end
+end
+

data/lib/ups_pickup/pickup_cancel_success.rb

@@ -0,0 +1,13 @@
+module UpsPickup
+  class PickupCancelSuccess
+    include Util
+    attr_accessor :response_status,:code,:description,:pickup_type
+    def initialize(response)
+      response_hash = response.to_hash
+      @response_status = response_hash.deep_fetch(:response_status)
+      @code = response_hash.deep_fetch(:code)
+      @description = response_hash.deep_fetch(:description)
+      @pickup_type = response_hash.deep_fetch(:pickup_type)
+    end
+  end
+end

data/lib/ups_pickup/pickup_creation.rb

@@ -0,0 +1,141 @@
+require 'ups_pickup/util'
+module UpsPickup
+  class PickupCreation < PickupRequest
+    include Util
+    attr_accessor  :response,:error
+    def initialize(user_name, password, license, options={})
+      super(user_name, password, license, options)  
+      @rate_pickup_indicator = set_yes_or_no_option(@options[:rate_pickup_indicator]) 
+      # iF any one packge is above 70lbs or 32 kg then its true
+      @over_weight_indicator = set_yes_or_no_option(@options[:rate_pickup_indicator]) 
+      @reference_number = @options[:reference_number]
+      @special_instruction = @options[:special_instruction]
+      @pickup_address = UpsPickup::PickupAddress.new(options)
+      @shipper = UpsPickup::Shipper.new(options)
+      @alternate_address_indicator = @options[:alternate_address_indicator].nil? ? "N" : @options[:alternate_address_indicator] 
+      @pickup_pieces = set_pickup_piece
+      set_weight
+      set_pickup_date_info
+      set_payment_method
+      set_notification
+      set_undelivered_email
+    end
+    #options=>{:pickup_piece=>{:service_code=>,:qty}}
+    # or options=>{:pickup_piece=>[{:service_code=>,:qty},{:service_code=>,:qty}]}
+
+    #TODO need to check wether savon is iterating array or not
+    def set_pickup_piece
+      if @options[:pickup_piece]
+        if @options[:pickup_piece].is_a?(Array)
+          @options[:pickup_piece].each do |pp|
+            @pickup_pieces << Ups::PickupPiece.new(pp)
+          end
+        elsif @options[:pickup_piece].is_a?(Hash)
+          @pickup_pieces =[UpsPickup::PickupPiece.new(@options[:pickup_piece])]  
+        end
+      else
+        @pickup_pieces =[UpsPickup::PickupPiece.new(@options)]    
+      end
+    end   
+    def pickup_piece_ups_hash
+      pickup_hashes = []
+      if @pickup_pieces
+        @pickup_pieces.flatten.each do |pp|
+        
+          pickup_hashes<< [pp.to_ups_hash]
+        end 
+      end
+      pickup_hashes.flatten
+    end
+
+    def set_weight
+      @weight = @options[:weight]
+      #LBS or KGS
+      @unit_of_weight = @options[:unit_of_weight] || "LBS"
+    end
+
+    def set_pickup_date_info
+      @close_time = @options[:close_time]
+      @ready_time = @options[:ready_time]
+      @pickup_date = Date.parse(@options[:pickup_date]).strftime("%Y%m%d")
+    end
+    # The payment method to pay for this on call pickup. 
+    #  00 = No payment needed
+    #  01 = Pay by shipper account
+    #  03 = Pay by charge card
+    #  04 = Pay by tracking number
+    #  05 = Pay by check or money order 
+    def set_payment_method
+      @payment_method = options[:payment_method] if !options[:payment_method].nil? && [0,1,2,3,4,5].include?(options[:payment_method].to_i)
+      @payment_method ||="00"
+    end
+    
+    # it might be an array of email address or single email address
+    # max allowed limit is 5
+    def set_notification
+      @confirmation_email_address = [@options[:confirmation_email_address]][0...5].flatten.uniq.compact
+    end
+
+    def set_undelivered_email
+      @undelivered_email
+    end
+
+    def build_request
+      {
+        "ns2:Request"=>{
+        "ns2:RequestOption"=>"1"
+        },
+        "ns2:RatePickupIndicator"=>@rate_pickup_indicator,
+
+        "ns2:Shipper"=>@shipper.to_ups_hash,
+        "ns2:PickupDateInfo"=>{
+          "ns2:CloseTime"=>@close_time,
+          "ns2:ReadyTime" => @ready_time,
+          "ns2:PickupDate" =>@pickup_date
+        },
+        "ns2:PickupPiece"=>pickup_piece_ups_hash,
+        "ns2:PickupAddress"=>@pickup_address.to_ups_hash,
+        "ns2:AlternateAddressIndicator"=>@alternate_address_indicator,
+        "ns2:PaymentMethod"=>@payment_method,
+        "ns2:OverweightIndicator"=>@over_weight_indicator,
+        "ns2:SpecialInstruction"=>@special_instruction,
+        "ns2:ReferenceNumber"=>@reference_number,
+        "ns2:Notfication"=>{
+          "ns2:ConfirmationEmailAddress"=>@confirmation_email_address
+        }
+      }
+    end
+
+    def commit
+      begin
+        @client_response = @client.request  :ns2,"PickupCreationRequest" do
+          #soap.namespaces["xmlns:S"] = "http://schemas.xmlsoap.org/soap/envelope/"
+          #soap.namespaces["xmlns:upss"] = "http://www.ups.com/XMLschema/XOLTWS/UPSS/v1.0"
+          #soap.namespaces["xmlns:ns1"] = "http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
+          soap.namespaces["xmlns:ns3"] = "http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
+          soap.namespaces["xmlns:ns2"] = "http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1"
+        #  soap.header = SOAP_HEADER1
+          soap.header = access_request
+          soap.body = build_request
+        end
+      rescue Savon::SOAP::Fault => fault
+        @client_response = fault
+      rescue Savon::Error => error
+        @clien_response = error   
+      end  
+      build_response
+    end
+
+    def build_response
+      if success?
+        @response = UpsPickup::PickupCreationSuccess.new(@client_response) 
+      elsif soap_fault?
+        fault_response = UpsPickup::FaultResponse.new(@client,@client_response)
+        @error = UpsPickup::ErrorResponse.new(fault_response.response)
+      end  
+    end
+    
+    
+
+  end
+end

data/lib/ups_pickup/pickup_creation_success.rb

@@ -0,0 +1,13 @@
+require 'ups_pickup/util'
+module UpsPickup
+  class PickupCreationSuccess
+    include Util
+    attr_accessor :prn,:rate_status,:success_code
+    def initialize(response)
+      response_hash = response.to_hash
+      @prn = response_hash.deep_fetch(:prn)
+      @rate_status = response_hash.deep_fetch(:rate_status)
+      @success_code = response_hash.deep_fetch(:code)
+    end
+  end
+end

data/lib/ups_pickup/pickup_piece.rb

@@ -0,0 +1,20 @@
+module UpsPickup
+  class PickupPiece
+    #attr_accessor :service_code
+    def initialize(options={})
+      @service_code = options[:service_code] || "001"
+      @quantity =options[:quantity] || "1"
+      @destination_country_code = options[:destination_country_code] || "US"
+      @container_code = options[:container_code] || "01"
+    end
+
+    def to_ups_hash
+      {
+        "ns2:ServiceCode"=>@service_code,
+        "ns2:Quantity" =>@quantity,
+        "ns2:DestinationCountryCode"=>@destination_country_code,
+        "ns2:ContainerCode"=>@container_code
+      }  
+    end
+  end
+end

data/lib/ups_pickup/pickup_request.rb

@@ -0,0 +1,69 @@
+
+module UpsPickup
+  class PickupRequest 
+    LIVE_URL = "https://onlinetools.ups.com/webservices/Pickup"
+    TEST_URL= "https://wwwcie.ups.com/webservices/Pickup"
+    include HTTParty
+    base_uri LIVE_URL
+    attr_accessor  :user_name,:password,:license,:options,:client,:client_response,:response,:error
+    def initialize(user_name, password, license, options={})
+      @user_name,@password,@license,@options = user_name,password,license,options  
+      @client=Savon::Client.new(File.expand_path("../../schema/Pickup.wsdl", __FILE__))
+      @request_body = {}
+      set_wsdl_endpoint
+      set_soap_namespace
+      if (options[:test] == true)
+        self.class.base_uri TEST_URL
+      elsif options[:url] && [LIVE_URL,TEST_URL].include?(options[:url])
+        self.class.base_uri options[:url]
+      end
+    
+      
+    end
+
+    
+    # For Test environment set test url
+    def set_wsdl_endpoint
+      if @options[:test] == true
+       @client.wsdl.endpoint = TEST_URL
+      else 
+        @client.wsdl.endpoint = LIVE_URL
+      end   
+    end
+    # Set name space
+    # ns2 for pickup 
+    def set_soap_namespace
+    
+      # @client.wsdl.namespaces["xmlns:ns2"] = "http://www.ups.com/XMLSchema/XOLTWS/Pickup/v1.1"
+      # @client.wsdl.namespaces["xmlns:ns3"] = "http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
+    end
+
+    #Set security passed in client request block
+    def access_request
+     {   
+      "ns3:UPSSecurity" => {
+        "ns3:UsernameToken"=>{
+          "ns3:Username"=>@user_name,
+          "ns3:Password" => @password
+        },
+        "ns3:ServiceAccessToken"=>{
+          "ns3:AccessLicenseNumber"=> @license
+        }
+        }
+      } 
+    end
+    def soap_fault?
+      @client_response.is_a?(Savon::SOAP::Fault)
+    end
+
+    def http_error?
+      @client_response.is_a?(Savon::Error)
+    end
+
+    def success?
+      @client_response.is_a?(Savon::SOAP::Response)
+    end
+  end
+end
+
+# pickup = Ups::PickupRequest.new("contego.mtaylor","C0nt3g0!","6C82D38E41F9C600")