awesome_usps 0.6.0 → 0.9.0

data/History.txt

@@ -1,13 +1,13 @@
-== 0.0.1 2008-08-12
-
-* 1 major enhancement:
-  * Initial release
-
-== 0.6.0 18/8/2008
+**== 0.6.0 18/8/2008
 
 * 2 major improvement
   *	Shipping parse fixed
   * Documentation added
 * 1 bug fixes
   * Shipping canned tests fixed
-  
+  
+
+**== 0.9.0 18/9/2008
+
+* 1 major improvement
+  *	Code Re-factored

data/Manifest.txt

@@ -12,6 +12,7 @@ lib/awesome_usps/address_verification.rb
 lib/awesome_usps/delivery_and_signature_confirmation.rb
 lib/awesome_usps/electric_merchandis_return.rb
 lib/awesome_usps/express_mail.rb
+lib/awesome_usps/gateway.rb
 lib/awesome_usps/international_item.rb
 lib/awesome_usps/international_mail_labels.rb
 lib/awesome_usps/location.rb

data/config/hoe.rb

@@ -67,7 +67,7 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
   end
 
 CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}"
 $hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
 $hoe.rsync_args = '-av --delete --ignore-errors'
 $hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/lib/awesome_usps.rb

@@ -34,5 +34,6 @@ module AwesomeUsps
     include ExpressMail
     include AddressVerification
     include InternationalMailLabels
+    include Gateway
   end
 end

data/lib/awesome_usps/address_verification.rb

@@ -1,82 +1,65 @@
 module AwesomeUsps
   module AddressVerification
-    MAX_RETRIES = 3
-
-    LIVE_DOMAIN = 'production.shippingapis.com'
-    LIVE_RESOURCE = '/ShippingAPI.dll'
-
-    TEST_DOMAIN ='testing.shippingapis.com'
-    TEST_RESOURCE = '/ShippingAPITest.dll'
-
-    API_CODES ={
-      :verify_address => 'Verify',
-      :zip_lookup => 'ZipCodeLookup',
-    :city_state_lookup =>"CityStateLookup"}
-
+   
     # Examines address and fills in missing information. Address must include city & state or the zip to be processed.
     # Can do up to an array of five
     def veryify_address(locations)
-      @locations = locations
-      @locations.to_a if not  @locations.is_a? Array
-      @api = "AddressValidateRequest"
-      request = xml_for_verify_address
-      commit_address_information_request(:verify_address, request ,false)
+      locations = Array(locations) if not locations.is_a? Array
+      api_request = "AddressValidateRequest"
+      request = xml_for_verify_address(api_request, locations)
+      gateway_commit(:verify_address, 'Verify', request, :live)
     end
 
     def zip_lookup(locations)
-      @locations = locations
-      @locations = Array(@locations) if not @locations.is_a? Array
-      @api = "ZipCodeLookupRequest"
-      request = xml_for_address_information_api
-      commit_address_information_request(:zip_lookup, request ,false)
+      locations = Array(locations) if not locations.is_a? Array
+      api_request = "ZipCodeLookupRequest"
+      request = xml_for_address_information_api(api_request, locations)
+      gateway_commit(:zip_lookup, 'ZipCodeLookup',request, :live)
     end
 
     def city_state_lookup(locations)
-      @locations = locations
-      @locations = Array(@locations) if not @locations.is_a? Array
-      @api = "CityStateLookupRequest"
-      request = xml_for_address_information_api
-      commit_address_information_request(:zip_lookup, request ,false)
+      locations = Array(locations) if not locations.is_a? Array
+      api_request = "CityStateLookupRequest"
+      request = xml_for_address_information_api(api_request, locations)
+      gateway_commit(:zip_lookup, 'CityStateLookup', request, :live)
     end
 
-
     def canned_verify_address_test
-      @locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371"   )]
-      @api = "AddressValidateRequest"
-      request = xml_for_address_information_api
-      commit_address_information_request(:verify_address, request ,true)
+      locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371"   )]
+      api_request = "AddressValidateRequest"
+      request = xml_for_address_information_api(api_request, locations)
+      gateway_commit(:verify_address, 'Verify', request, :test)
     end
 
     def canned_zip_lookup_test
-      @locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371"   )]
-      @api = "ZipCodeLookupRequest"
-      request = xml_for_address_information_api
-      commit_address_information_request(:zip_lookup, request ,true)
+      locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371"   )]
+      api_request = "ZipCodeLookupRequest"
+      request = xml_for_address_information_api(api_request, locations)
+      gateway_commit(:zip_lookup, 'ZipCodeLookup', request, :test)
     end
 
     def canned_city_state_lookup_test
-      @locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371"   )]
-      @api = "CityStateLookupRequest"
-      request = xml_for_address_information_api
-      commit_address_information_request(:zip_lookup, request ,true)
+      locations = [Location.new(:address2 => "6406 Ivy Lane", :city =>"Greenbelt", :state => "MD"), Location.new(:address2=>"8 Wildwood Drive", :city => "Old Lyme",:state => "CT", :zip5 => "06371")]
+      api_request = "CityStateLookupRequest"
+      request = xml_for_address_information_api(api_request, locations)
+      gateway_commit(:zip_lookup, 'CityStateLookup', request, :test)
     end
 
-    private
     # XML from  Builder::XmlMarkup.new
-    def xml_for_address_information_api
+    def xml_for_address_information_api(api_request, locations)
       xm = Builder::XmlMarkup.new
-      xm.tag!("#{@api}", "USERID"=>"#{@username}") do
-        @locations.each_index do |id|
-          l=@locations[id]
+      xm.tag!("#{api_request}", "USERID"=>"#{@username}") do
+        locations.each_index do |id|
+          l=locations[id]
           xm.Address("ID" => "#{id}") do
             xm.FirmName(l.firm_name)
             xm.Address1(l.address1)
             xm.Address2(l.address2)
-            if @api !="CityStateLookupRequest"
+            if api_request !="CityStateLookupRequest"
               xm.City(l.city)
               xm.State(l.state)
             end
-            if @api != "ZipCodeLookupRequest"
+            if api_request != "ZipCodeLookupRequest"
               xm.Zip5(l.zip5)
               xm.Zip4(l.zip4)
             end
@@ -85,10 +68,8 @@ module AwesomeUsps
       end
     end
 
-
     # Parses the XML into an array broken up by each address.
     # For verify_address :verified will be false if multiple address were found.
-
     def parse_address_information(xml)
       i = 0
       list_of_verified_addresses = []
@@ -117,40 +98,5 @@ module AwesomeUsps
       return list_of_verified_addresses
     end
 
-
-
-    def commit_address_information_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
-        parse_address_information(response.body)
-      else
-        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response}")
-      end
-    end
-
   end
 end

data/lib/awesome_usps/delivery_and_signature_confirmation.rb

@@ -1,160 +1,99 @@
 module  AwesomeUsps
   module DeliveryAndSignatureConfirmation
+      def delivery_confirmation_label(origin, destination, service_type, image_type, label_type=1, api_request = "DeliveryConfirmationV3.0Request", options={})
+        request = confirmation_xml(api_request, origin, destination, service_type, image_type, label_type, options)
+        #YES THE API IS THAT STUPID THAT WE MUST PASS WHAT TYPE OF MIME TYPE!
+        commit_confirmation_xml(:delivery, 'DeliveryConfirmationV3', request,:ssl, image_type)
+      end
 
-    MAX_RETRIES = 3
-
-    LIVE_DOMAIN = 'secure.shippingapis.com'
-    LIVE_RESOURCE = '/ShippingAPI.dll'
-
-    API_CODES = {:delivery =>'DeliveryConfirmationV3',
-      :delivery_confirmation_certify => "DelivConfirmCertifyV3",
-      :signature => "SignatureConfirmationV3",
-    :signature_confirmation_certify => "SignatureConfirmCertifyV3"}
-
-    def delivery_confirmation_label(origin, destination, service_type, image_type, label_type=1, options={})
-      @origin = origin
-      @destination = destination
-      @service_type = service_type
-      @image_type =image_type
-      @label_type = label_type
-      @options = options
-      @api = "DeliveryConfirmationV3.0Request"
-      request = confirmation_xml
-      #YES THE API IS THAT STUPID THAT WE MUST PASS WHAT TYPE OF MIME TYPE!
-      commit_confirmation_xml(:delivery, request, image_type, false)
-    end
-
-    def signature_confirmation_label(origin, destination, service_type, image_type, label_type=1, options={})
-      @origin = origin
-      @destination = destination
-      @service_type = service_type
-      @image_type =image_type
-      @label_type = label_type
-      @options = options
-      @api = "SignatureConfirmationV3.0Request"
-      request = confirmation_xml
-      #YES THE API IS THAT STUPID THAT WE MUST PASS WHAT TYPE OF MIME TYPE!
-      commit_confirmation_xml(:signature, request, image_type, false)
-    end
-
-    
-
-    def canned_delivery_confirmation_label_test
-      @origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
-      @destination =Location.new( :name=> "Joe Customer",  :address2 =>"136 Linwood Plz",  :state => 'NJ', :city => 'Fort Lee', :zip5 => "07024")
-      @service_type = "Priority"
-      @image_type ="PDF"
-      @label_type = 1
-      @options = {:weight => 2}
-      @api = "DelivConfirmCertifyV3.0Request"
-      request = confirmation_xml
-      commit_confirmation_xml(:delivery_confirmation_certify, request, @image_type, true)
-    end
-
-
+      def signature_confirmation_label(origin, destination, service_type, image_type, label_type=1,
+        api_request = "SignatureConfirmationV3.0Request", options={})
+        request = confirmation_xml(api_request, origin, destination, service_type, image_type, label_type, options)
+        #YES THE API IS THAT STUPID THAT WE MUST PASS WHAT TYPE OF MIME TYPE!
+        commit_confirmation_xml(:signature, 'SignatureConfirmationV3', request, :ssl, image_type)
+      end
 
-    def canned_signature_confirmation_label_test
-      @origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
-      @destination =Location.new( :name=> "Joe Customer",  :address2 =>"136 Linwood Plz",  :state => 'NJ', :city => 'Fort Lee', :zip5 => "07024")
-      @service_type = "Priority"
-      @image_type ="PDF"
-      @label_type = 1
-      @options = {:weight => 2}
-      @api = "SignatureConfirmCertifyV3.0Request"
-      request = confirmation_xml
-      commit_confirmation_xml(:signature_confirmation_certify, request, @image_type, true)
-    end
 
-    private
-    def confirmation_xml
-      xm = Builder::XmlMarkup.new
-      xm.tag!(@api, "USERID"=>"#{@username}") do
-        xm.Option(@label_type)
-        xm.ImageParameters #Will be used in the future. Is a required tag.
-        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.ToName(@destination.name)
-        xm.ToFirm(@destination.firm_name)
-        xm.ToAddress1(@destination.address1)
-        xm.ToAddress2(@destination.address2)
-        xm.ToCity(@destination.city)
-        xm.ToState(@destination.state)
-        xm.ToZip5(@destination.zip5)
-        xm.ToZip4(@destination.zip4)
-        xm.WeightInOunces(@options[:weight_in_ounces])
-        xm.ServiceType(@service_type)
-        xm.SeparateReceiptPage(@options[:seperate])
-        xm.POZipCode(@options[:po_zip_code])
-        xm.ImageType(@image_type)
-        xm.LabelDate(@options[:label_date])
-        xm.CustomerRefNo(@options[:customer_reference_number])
-        xm.AddressServiceRequested(@options[:address_service])
-        xm.SenderName(@options[:sender_name])
-        xm.SenderEMail(@options[:sender_email])
-        xm.RecipientName(@options[:recipient_name])
-        xm.RecipientEmail(@options[:recipient_email])
+      def canned_delivery_confirmation_label_test
+        origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
+        destination =Location.new( :name=> "Joe Customer",  :address2 =>"136 Linwood Plz",  :state => 'NJ', :city => 'Fort Lee', :zip5 => "07024")
+        service_type = "Priority"
+        image_type ="PDF"
+        label_type = 1
+        options = {:weight => 2}
+        api_request = "DelivConfirmCertifyV3.0Request"
+        request = confirmation_xml(api_request, origin, destination, service_type, image_type, label_type, options)
+        gateway_commit(:delivery_confirmation_certify,'DelivConfirmCertifyV3', request, :ssl, image_type)
       end
-    end
 
-    def parse_confirmation_label(xml, image_type)
-      if image_type == "TIF"
-        image_type = "image/tif"
-      else
-        image_type = "application/pdf"
-      end
-      parse = Hpricot.parse(xml)/:error
-      if parse != []
-        RAILS_DEFAULT_LOGGER.info "#{xml}"
-        return (Hpricot.parse(xml)/:description).inner_html
-      else
-        number = Hpricot.parse(xml)/:deliveryconfirmationnumber
-        label = Hpricot.parse(xml)/:deliveryconfirmationlabel
-        return {:image_type => image_type, :number => number.inner_html, :label => label.inner_html}
+      def canned_signature_confirmation_label_test
+        origin = Location.new( :name=> "John Smith",  :address2 => "6406 Ivy Lane",  :state => 'MD', :city => 'Greenbelt', :zip5 => '20770')
+        destination =Location.new( :name=> "Joe Customer",  :address2 =>"136 Linwood Plz",  :state => 'NJ', :city => 'Fort Lee', :zip5 => "07024")
+        service_type = "Priority"
+        image_type ="PDF"
+        label_type = 1
+        options = {:weight => 2}
+        api_request = "SigConfirmCertifyV3.0Request"
+        request = confirmation_xml(api_request, origin, destination, service_type, image_type, label_type, options)
+        gateway_commit(:signature_confirmation_certify, 'SignatureConfirmationCertifyV3', request, :ssl, image_type)
       end
-    end
-
 
-    def commit_confirmation_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"
+      private
+      def confirmation_xml(api_request, origin, destination, service_type, image_type, label_type, options)
+        xm = Builder::XmlMarkup.new
+        xm.tag!(api_request, "USERID"=>"#{@username}") do
+          xm.Option(label_type)
+          xm.ImageParameters #Will be used in the future. Is a required tag.
+          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.ToName(destination.name)
+          xm.ToFirm(destination.firm_name)
+          xm.ToAddress1(destination.address1)
+          xm.ToAddress2(destination.address2)
+          xm.ToCity(destination.city)
+          xm.ToState(destination.state)
+          xm.ToZip5(destination.zip5)
+          xm.ToZip4(destination.zip4)
+          xm.WeightInOunces(options[:weight_in_ounces])
+          xm.ServiceType(service_type)
+          xm.SeparateReceiptPage(options[:seperate])
+          xm.POZipCode(options[:po_zip_code])
+          xm.ImageType(image_type)
+          xm.LabelDate(options[:label_date])
+          xm.CustomerRefNo(options[:customer_reference_number])
+          xm.AddressServiceRequested(options[:address_service])
+          xm.SenderName(options[:sender_name])
+          xm.SenderEMail(options[:sender_email])
+          xm.RecipientName(options[:recipient_name])
+          xm.RecipientEMail(options[:recipient_email])
         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_confirmation_label(response.body, image_type)
-      else
-        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response}")
-        return "USPS plugin settings are wrong #{response}"
+      def parse_confirmation_label(action, xml, image_type)
+        if image_type == "TIF"
+          image_type = "image/tif"
+        else
+          image_type = "application/pdf"
+        end
+        parse = Hpricot.parse(xml)/:error
+        if parse != []
+          RAILS_DEFAULT_LOGGER.info "#{xml}"
+          return (Hpricot.parse(xml)/:description).inner_html
+        elsif action == :signature_confirmation_certify || :signature
+          number = Hpricot.parse(xml)/:signatureconfirmationnumber
+          label = Hpricot.parse(xml)/:signatureconfirmationlabel
+          return {:image_type => image_type, :number => number.inner_html, :label => label.inner_html}
+        else
+          number = Hpricot.parse(xml)/:deliveryconfirmationnumber
+          label = Hpricot.parse(xml)/:deliveryconfirmationlabel
+          return {:image_type => image_type, :number => number.inner_html, :label => label.inner_html}
+        end
       end
-    end
   end
 end