awesome_usps 0.6.0 → 0.9.0

data/lib/awesome_usps/open_distrubute_priority.rb

@@ -1,70 +1,54 @@
 module  AwesomeUsps
   module OpenDistrubutePriority
-
-    MAX_RETRIES = 3
-
-    LIVE_DOMAIN = 'secure.shippingapis.com'
-    LIVE_RESOURCE = '/ShippingAPI.dll'
-
-
-    API_CODES = {:open_distrubute_priority => "OpenDistributePriority",
-    :open_distribute_priority_certify => "OpenDistributePriorityCertify"}
-
-    def open_distrubute_priority_label(orgin, destination, package_weight_in_ounces,  mail_type, image_type, label_type=1, options={})
-      @package_weight_in_ounces = package_weight_in_ounces
-      @origin = origin
-      @destination = destination
-      @mail_type = mail_type
-      @image_type = image_type
-      @options =options
-      @api = "OpenDistributePriorityRequest"
-      request = open_distrubute_priority_xml
+    def open_distrubute_priority_label(origin, destination, package_weight_in_ounces,  mail_type, image_type, label_type=1, api_requst = "OpenDistributePriorityRequest", options={})
+      request = open_distrubute_priority_xml(api_requst, origin, destination, package_weight_in_ounces,  mail_type, image_type, label_type, options)
       #YES THE API IS THAT STUPID THAT WE MUST PASS WHAT TYPE OF MIME TYPE!
-      commit_open_distrubute_priority_xml(:open_distrubute_priority, request, image_type, false)
+      gateway_commit(:open_distrubute_priority, 'OpenDistributePriority', request, :ssl, image_type)
     end
 
     def canned_open_distrubute_priority_label_test
-      @origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
-      @destination =Location.new( :name=> "Fairfax Post Office",  :address2 =>"10660 Page Ave",  :state => 'VA', :city => 'Fairfax', :zip5 => "22030", :facility_type => "DDU")
-      @mail_type = "Letters"
-      @image_type = "PDF"
-      @package_weight_in_ounces = 1
-      @options = {:address_service => true, :permit_number => "21718", :permit_zip => "07204"}
-      @api = "OpenDistributePriorityCertifyRequest"
-      request= open_distrubute_priority_xml
-      commit_open_distrubute_priority_xml(:open_distribute_priority_certify, request, @image_type, true)
+      origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
+      destination =Location.new( :name=> "Fairfax Post Office",  :address2 =>"10660 Page Ave",  :state => 'VA', :city => 'Fairfax', :zip5 => "22030", :facility_type => "DDU")
+      mail_type = "Letters"
+      image_type = "PDF"
+      package_weight_in_ounces = 1
+      options = {:address_service => true, :permit_number => "21718", :permit_zip => "07204"}
+      api_requst = "OpenDistributePriorityCertifyRequest"
+      label_type=1
+      request= open_distrubute_priority_xml(api_requst, origin, destination, package_weight_in_ounces,  mail_type, image_type, label_type, options)
+      gateway_commit(:open_distribute_priority_certify, 'OpenDistributePriorityCertify', request, :ssl, image_type)
     end
 
     private
-    def open_distrubute_priority_xml
+    def open_distrubute_priority_xml(api_requst, origin, destination, package_weight_in_ounces,  mail_type, image_type, label_type, options)
       xm = Builder::XmlMarkup.new
-      xm.tag!("#{@api}", "USERID"=>"#{@username}") do
-        xm.PermitNumber(@options[:permit_number])
-        xm.PermitIssuingPOZip5(@options[:permit_zip])
-        xm.FromName(@origin.name)
-        xm.FromFirm(@origin.firm_name)
-        xm.FromAddress1(@origin.address1) #Used for an apartment or suite number. Yes the API is a bit fucked.
-        xm.FromAddress2(@origin.address2)
-        xm.FromCity(@origin.city)
-        xm.FromState(@origin.state)
-        xm.FromZip5(@origin.zip5)
-        xm.FromZip4(@origin.zip4)
-        xm.POZipCode(@options[:po_zip_code])
-        xm.ToFacilityName(@destination.name)
-        xm.ToFacilityAddress1(@destination.address1)
-        xm.ToFacilityAddress2(@destination.address2)
-        xm.ToFacilityCity(@destination.city)
-        xm.ToFacilityState(@destination.state)
-        xm.ToFacilityZip5(@destination.zip5)
-        xm.ToFacilityZip4(@destination.zip4)
-        xm.FacilityType(@destination.facility_type)
-        xm.MailClassEnclosed(@mail_type)
-        xm.MailClassOther(@options[:other])
+      xm.tag!("#{api_requst}", "USERID"=>"#{@username}") do
+        xm.PermitNumber(options[:permit_number])
+        xm.PermitIssuingPOZip5(options[:permit_zip])
+        xm.FromName(origin.name)
+        xm.FromFirm(origin.firm_name)
+        xm.FromAddress1(origin.address1) #Used for an apartment or suite number. Yes the API is a bit fucked.
+        xm.FromAddress2(origin.address2)
+        xm.FromCity(origin.city)
+        xm.FromState(origin.state)
+        xm.FromZip5(origin.zip5)
+        xm.FromZip4(origin.zip4)
+        xm.POZipCode(options[:po_zip_code])
+        xm.ToFacilityName(destination.name)
+        xm.ToFacilityAddress1(destination.address1)
+        xm.ToFacilityAddress2(destination.address2)
+        xm.ToFacilityCity(destination.city)
+        xm.ToFacilityState(destination.state)
+        xm.ToFacilityZip5(destination.zip5)
+        xm.ToFacilityZip4(destination.zip4)
+        xm.FacilityType(destination.facility_type)
+        xm.MailClassEnclosed(mail_type)
+        xm.MailClassOther(options[:other])
         xm.WeightInPounds("0")
-        xm.WeightInOunces(@package_weight_in_ounces)
-        xm.ImageType(@image_type)
-        xm.SeparateReceiptPage(@options[:seperate])
-        xm.LabelDate(@options[:label_date])
+        xm.WeightInOunces(package_weight_in_ounces)
+        xm.ImageType(image_type)
+        xm.SeparateReceiptPage(options[:seperate])
+        xm.LabelDate(options[:label_date])
         xm.AllowNonCleansedFacilityAddr("false")
       end
     end
@@ -80,48 +64,11 @@ module  AwesomeUsps
         RAILS_DEFAULT_LOGGER.info "#{xml}"
         return (Hpricot.parse(xml)/:description).inner_html
       else
-        number = Hpricot.parse(xml)/:openDistributeprioritynumber
+        number = Hpricot.parse(xml)/:opendistributeprioritynumber
         label = Hpricot.parse(xml)/:opendistributeprioritylabel
         return {:image_type => image_type, :number => number.inner_html, :label => label.inner_html}
       end
     end
-
-    def commit_open_distrubute_priority_xml(action, request, image_type, test=false)
-      retries = MAX_RETRIES
-      begin
-        #If and when their testing resource works again this will be useful tertiary command
-        url = URI.parse("https://#{LIVE_DOMAIN}#{LIVE_RESOURCE}")
-        req = Net::HTTP::Post.new(url.path)
-        req.set_form_data({'API' => API_CODES[action], 'XML' => request})
-        response = Net::HTTP.new(url.host, 443)
-        response.use_ssl
-        response.open_timeout = 5
-        response.read_timeout = 5
-        response.use_ssl = true
-        response.start
-
-      rescue Timeout::Error
-        if retries > 0
-          retries -= 1
-          retry
-        else
-          RAILS_DEFAULT_LOGGER.warn "The connection to the remote server timed out"
-          return "We appoligize for the inconvience but our USPS service is busy at the moment. To retry please refresh the browser"
-        end
-      rescue SocketError
-        RAILS_DEFAULT_LOGGER.error "There is a socket error with USPS plugin"
-        return "We appoligize for the inconvience but there is a problem with our server. To retry please refresh the browser"
-      end
-
-      response = response.request(req)
-      case response
-      when Net::HTTPSuccess
-
-        parse_open_distrubute_priority(response.body, image_type)
-      else
-        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response.body}")
-        return "USPS plugin settings are wrong #{response.body}"
-      end
-    end
+    
   end
 end

data/lib/awesome_usps/service_standard.rb

@@ -1,72 +1,59 @@
 module AwesomeUsps
   module ServiceStandard
-    MAX_RETRIES = 3
-
-    LIVE_DOMAIN = 'production.shippingapis.com'
-    LIVE_RESOURCE = '/ShippingAPI.dll'
-
-    TEST_DOMAIN ='testing.shippingapis.com'
-    TEST_RESOURCE = '/ShippingAPITest.dll'
-
-    API_CODES ={
-      :priority_mail => 'PriorityMail',
-      :standard => 'StandardB',
-      :express => 'ExpressMailCommitment'
-    }
-
     # Takes your package tracking number and returns information for the USPS web API
-    def priority_mail_estimated_time(origin, destination)
-      @origin = orgin
-      @destination=destination
-      request = xml_for_estimated_time_for_delivery("PriorityMailRequest")
-      commit_service_standard_request(:priority_mail, request ,false)
+    def priority_mail_estimated_time(origin, destination, api_request="PriorityMailRequest")
+      origin = orgin
+      destination=destination
+      request = xml_for_estimated_time_for_delivery(api_request, origin, destination)
+      commit_service_standard_request(:priority_mail, 'PriorityMail', request , :live)
     end
 
-    def standard_mail_estimated_time(origin, destination)
-      @origin = orgin
-      @destination=destination
-      request = xml_for_estimated_time_for_delivery("StandardBRequest")
-      commit_service_standard_request(:standard, request ,false)
+    def standard_mail_estimated_time(origin, destination, api_request='StandardBRequest')
+      origin = orgin
+      destination=destination
+      request = xml_for_estimated_time_for_delivery(api_request, origin, destination)
+      gateway_commit(:standard, 'StandardB', request, :live)
     end
 
-    def express_mail_commitment(origin, destination, date=nil)
-      @origin = orgin
-      @destination=destination
-      @date = date
-      request = xml_for_estimated_time_for_delivery("ExpressMailCommitmentRequest")
-      commit_service_standard_request(:express, request ,false)
+    def express_mail_commitment(origin, destination, date=nil, api_request='ExpressMailCommitmentRequest')
+      xml_for_estimated_time_for_delivery(api_request, origin, destination, date)
+      gateway_commit(:express, 'ExpressMailCommitment', request, :live)
     end
 
     def canned_standard_mail_estimated_time_test
-      @origin =  Location.new(  :zip5 => '4')
-      @destination = Location.new( :zip5 => '4')
-      request = xml_for_estimated_time_for_delivery("PriorityMailRequest")
-      commit_service_standard_request(:priority_mail, request ,true)
+      origin =  Location.new(  :zip5 => '4')
+      destination = Location.new( :zip5 => '4')
+      api_request="StandardBRequest"
+      request = xml_for_estimated_time_for_delivery(api_request, origin, destination)
+      gateway_commit(:priority_mail, 'PriorityMail', request,  :test)
     end
 
     def canned_priority_mail_estimated_time_test
-      @origin =  Location.new(  :zip5 => '4')
-      @destination = Location.new( :zip5 => '4')
-      request = xml_for_estimated_time_for_delivery("PriorityMailRequest")
-      commit_service_standard_request(:standard, request ,true)
+      origin =  Location.new(  :zip5 => '4')
+      destination = Location.new( :zip5 => '4')
+      api_request="PriorityMailRequest"
+      request = xml_for_estimated_time_for_delivery(api_request, origin, destination)
+      gateway_commit(:standard, 'StandardB',  request,  :test)
     end
 
     def canned_express_mail_commitment_test
-      @origin= Location.new(  :zip5 =>'20770')
-      @destination=Location.new( :zip5 =>'11210')
-      @date = '05-Aug-2004'
-      request = xml_for_estimated_time_for_delivery("ExpressMailCommitmentRequest")
-      commit_service_standard_request(:express, request ,true)
+      origin= Location.new(  :zip5 =>'20770')
+      destination=Location.new( :zip5 =>'11210')
+      date = '05-Aug-2004'
+      api_request = 'ExpressMailCommitmentRequest'
+      request = xml_for_estimated_time_for_delivery(api_request, origin, destination, date)
+      gateway_commit(:express, 'ExpressMailCommitment', request,  :test)
     end
 
     # XML from a straight string.
-    # "<TrackFieldRequest USERID='#{@username}'><TrackID ID='#{@tracking_number}'></TrackID></TrackFieldRequest>"
-    def xml_for_estimated_time_for_delivery(type_of_request)
+    def xml_for_estimated_time_for_delivery(api_request, origin, destination, date=nil)
       xm = Builder::XmlMarkup.new
-      xm.tag!(type_of_request, "USERID"=>"#{@username}") do
-        xm.OriginZIP(@origin.zip5)
-        xm.DestinationZIP(@destination.zip5)
-        xm.Date(@date) if type_of_request == "ExpressMailCommitmentRequest"
+      xm.tag!(api_request, "USERID"=>"#{@username}") do
+        xm.OriginZIP(origin.zip5)
+        xm.DestinationZIP(destination.zip5)
+        if api_request == 'ExpressMailCommitmentRequest'
+          xm.Date(date)
+        end
       end
     end
 
@@ -100,44 +87,7 @@ module AwesomeUsps
         return   location_list
       end
     end
-
-    private
-    def commit_service_standard_request(action, request, test = false)
-      retries = MAX_RETRIES
-      begin
-        url = URI.parse(test ? "http://#{TEST_DOMAIN}#{TEST_RESOURCE}" : "http://#{LIVE_DOMAIN}#{LIVE_RESOURCE}")
-        req = Net::HTTP::Post.new(url.path)
-        req.set_form_data({'API' => API_CODES[action], 'XML' => request})
-        response = Net::HTTP.new(url.host, url.port)
-        response.open_timeout = 5
-        response.read_timeout = 5
-        response.start
-      rescue Timeout::Error
-        if retries > 0
-          retries -= 1
-          retry
-        else
-          RAILS_DEFAULT_LOGGER.warn "The connection to the remote server timed out"
-          return "We appoligize for the inconvience but our USPS service is busy at the moment. To retry please refresh the browser"
-
-        end
-      rescue SocketError
-        RAILS_DEFAULT_LOGGER.error "There is a socket error with USPS plugin"
-        return "We appoligize for the inconvience but there is a problem with our server. To retry please refresh the browser"
-      end
-
-      response = response.request(req)
-      case response
-      when Net::HTTPSuccess
-        if action == :express
-          parse_express(response.body)
-        else
-          parse_service(response.body)
-        end
-      else
-        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response}")
-      end
-    end
+   
 
   end
 end

data/lib/awesome_usps/shipping.rb

@@ -1,17 +1,5 @@
 module AwesomeUsps
   module Shipping
-
-
-    MAX_RETRIES = 3
-
-    LIVE_DOMAIN = 'production.shippingapis.com'
-    LIVE_RESOURCE = '/ShippingAPI.dll'
-
-    API_CODES = {
-      :us_rates => 'RateV3',
-      :world_rates => 'IntlRate',
-    }
-
     CONTAINERS = {
       :envelope => 'Flat Rate Envelope',
       :box => 'Flat Rate Box'
@@ -52,28 +40,21 @@ module AwesomeUsps
 
     # options Are?
     def domestic_rates(origin_zip, destination_zip, packages, options={})
-      @origin_zip = origin_zip
-      @packages = packages
-      Array(@packages)  if not @packages.is_a? Array
-      @destination_zip = destination_zip
-      @options = options
-      request = xml_for_us
-      tracking_commit(:us_rates, request ,false)
+      Array(packages)  if not packages.is_a? Array
+      request = xml_for_us(origin_zip, destination_zip, packages, options)
+      gateway_commit(:us_rates, 'RateV3', request, :live)
     end
 
     # options Are?
-    def world_rates(country, packages, options={})
-      @packages = packages
-      Array(@packages)  if not @packages.is_a? Array
-      @country = country
-      @options = options
-      request = xml_for_world
-      tracking_commit(:world_rates, request ,false)
+    def world_rates(country, packages, api_request='IntlRate', options={})
+      Array(packages)  if not packages.is_a? Array
+      request = xml_for_world(country, packages, options)
+      gateway_commit(:world_rates, 'IntlRate', request, :live)
     end
 
     def canned_domestic_rates_test
-      @origin_zip = "07024"
-      @packages =[
+      origin_zip = "07024"
+      packages =[
         Package.new(  100,
         [93,10],
         :cylinder => true),
@@ -82,15 +63,16 @@ module AwesomeUsps
         [15, 10, 4.5],
         :units => :imperial)
       ]
-      @destination_zip = "10010"
-      @options = {}
-      request = xml_for_us
-      tracking_commit(:us_rates, request ,false)
+      destination_zip = "10010"
+      options = {}
+      request = xml_for_us(origin_zip, destination_zip, packages, options)
+      gateway_commit(:us_rates, 'RateV3', request, :live)
     end
 
 
     def canned_world_rates_test
-      @packages =  [
+      api_request='IntlRate'
+      packages =  [
         Package.new(  100,
         [93,10],
         :cylinder => true),
@@ -99,10 +81,10 @@ module AwesomeUsps
         [15, 10, 4.5],
         :units => :imperial)
       ]
-      @country = "Japan"
-      @options ={}
-      request = xml_for_world
-      tracking_commit(:world_rates, request ,false)
+      country = "Japan"
+      options ={}
+      request = xml_for_world(country, packages, options)
+      gateway_commit(:world_rates,'IntlRate', request, :live)
     end
 
     private
@@ -120,15 +102,15 @@ module AwesomeUsps
     end
 
     # XML built with Build:XmlMarkup
-    def xml_for_us
+    def xml_for_us(origin_zip, destination_zip, packages, options)
       xm = Builder::XmlMarkup.new
       xm.RateV3Request("USERID"=>"#{@username}") do
-        @packages.each_index do |id|
-          p = @packages[id]
+        packages.each_index do |id|
+          p = packages[id]
           xm.Package("ID" => "#{id}") {
-            xm.Service("#{US_SERVICES[@options[:service]] || :all}")
-            xm.ZipOrigination(@origin_zip)
-            xm.ZipDestination(@destination_zip)
+            xm.Service("#{US_SERVICES[options[:service]] || :all}")
+            xm.ZipOrigination(origin_zip)
+            xm.ZipDestination(destination_zip)
             xm.Pounds("0")
             xm.Ounces("#{'%0.1f' % [p.ounces,1].max}")
             if p.options[:container] and [nil,:all,:express,:priority].include? p.service
@@ -146,17 +128,17 @@ module AwesomeUsps
     end
 
     # XML built with Build:XmlMarkup
-    def xml_for_world
+    def xml_for_world(country, packages, options)
       xm = Builder::XmlMarkup.new
       xm.IntlRateRequest("USERID"=>"#{@username}") do
-        @packages.each_index do |id|
-          p = @packages[id]
+        packages.each_index do |id|
+          p = packages[id]
           xm.Package("ID" => "#{id}") {
             xm.Pounds("0")
             xm.Ounces("#{'%0.1f' % [p.ounces,1].max.ceil}")
             xm.MailType("#{MAIL_TYPES[p.options[:mail_type]] || 'Package'}")
             xm.ValueOfContents(p.value / 100.0) if p.value && p.currency == 'USD'
-            xm.Country(@country)
+            xm.Country(country)
           }
         end
       end
@@ -224,41 +206,5 @@ module AwesomeUsps
       return international_rate_array
     end
 
-    def tracking_commit(action, request, test = false)
-      retries = MAX_RETRIES
-      begin
-        url = URI.parse("http://#{LIVE_DOMAIN}#{LIVE_RESOURCE}")
-        req = Net::HTTP::Post.new(url.path)
-        req.set_form_data({'API' => API_CODES[action], 'XML' => request})
-        response = Net::HTTP.new(url.host, url.port)
-        response.open_timeout = 2
-        response.read_timeout = 2
-        response.start
-      rescue Timeout::Error
-        if retries > 0
-          retries -= 1
-          retry
-        else
-          RAILS_DEFAULT_LOGGER.warn "The connection to the remote server timed out"
-          return "We appoligize for the inconvience but our USPS service is busy at the moment. To retry please refresh the browser"
-        end
-      rescue SocketError
-        RAILS_DEFAULT_LOGGER.error "There is a socket error with USPS plugin"
-        return "We appoligize for the inconvience but there is a problem with our server. To retry please refresh the browser"
-      end
-
-      response = response.request(req)
-      case response
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        if (action == :us_rates)
-          parse_us(response.body)
-        else
-          parse_world(response.body)
-        end
-      else
-        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response}")
-        return "USPS plugin settings are wrong #{response}"
-      end
-    end
   end
 end