awesome_usps 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-12
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,38 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/awesome_usps.rb
+lib/awesome_usps/version.rb
+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/international_item.rb
+lib/awesome_usps/international_mail_labels.rb
+lib/awesome_usps/location.rb
+lib/awesome_usps/open_distrubute_priority.rb
+lib/awesome_usps/package.rb
+lib/awesome_usps/service_standard.rb
+lib/awesome_usps/shipping.rb
+lib/awesome_usps/tracking.rb
+lib/awesome_usps/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_awesome_usps.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on awesome_usps, see http://awesome_usps.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,48 @@
+= awesome_usps
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'awesome_usps/version'
+
+AUTHOR = 'Matthew Bergman'  # can also be an array of Authors
+EMAIL = "fotoverite@gmail.com"
+DESCRIPTION = "Ruby wrapper for the various USPS APIs"
+GEM_NAME = 'awesome_usps' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'awesome-usps' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "fotoverite"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = AwesomeUsps::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'awesome_usps documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$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/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/awesome_usps.rb

@@ -0,0 +1,39 @@
+require 'hpricot'
+require 'net/https'
+require 'awesome_usps/package'
+require 'awesome_usps/location'
+require 'awesome_usps/international_item'
+require 'awesome_usps/tracking'
+require 'awesome_usps/shipping'
+require 'awesome_usps/delivery_and_signature_confirmation'
+require 'awesome_usps/service_standard'
+require 'awesome_usps/open_distrubute_Priority'
+require 'awesome_usps/electric_merchandis_return'
+require 'awesome_usps/express_mail'
+require 'awesome_usps/address_verification'
+require 'awesome_usps/international_mail_labels'
+
+
+
+module AwesomeUsps
+  class USPS
+    def initialize(username)
+      @username = validate(username)
+    end
+
+    def validate(param)
+      raise ERROR_MSG if param.blank?
+      param
+    end
+    
+    include Tracking
+    include Shipping
+    include DeliveryAndSignatureConfirmation
+    include ServiceStandard
+    include OpenDistrubutePriority
+    include ElectricMerchandisReturn
+    include ExpressMail
+    include AddressVerification
+    include InternationalMailLabels
+  end
+end

data/lib/awesome_usps/address_verification.rb

@@ -0,0 +1,156 @@
+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)
+    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)
+    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)
+    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)
+    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)
+    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)
+    end
+
+    private
+    # XML from  Builder::XmlMarkup.new
+    def xml_for_address_information_api
+      xm = Builder::XmlMarkup.new
+      xm.tag!("#{@api}", "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"
+              xm.City(l.city)
+              xm.State(l.state)
+            end
+            if @api != "ZipCodeLookupRequest"
+              xm.Zip5(l.zip5)
+              xm.Zip4(l.zip4)
+            end
+          end
+        end
+      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 = []
+      (Hpricot.parse(xml)/:address).each do |address|
+        i+=1
+        h = {}
+        #Check if there was an error in an address element
+        if address.search("error") != []
+          RAILS_DEFAULT_LOGGER.info("Address number #{i} has the error '#{address.search("description").inner_html}' please fix before continuing")
+
+          return "Address number #{i} has the error '#{address.search("description").inner_html}' please fix before continuing"
+        end
+        if address.search("ReturnText") != []
+          h[:verified] = false
+        else
+          h[:verified] =true
+        end
+        address.children.each { |elem| h[elem.name.to_sym] = elem.inner_text unless elem.inner_text.blank? }
+        list_of_verified_addresses << h
+      end
+      #Check if there was an error in the basic XML formating
+      if list_of_verified_addresses == []
+        error =Hpricot.parse(xml)/:error
+        return  error.search("description").inner_html
+      end
+      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

@@ -0,0 +1,160 @@
+module  AwesomeUsps
+  module DeliveryAndSignatureConfirmation
+
+    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 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])
+      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}
+      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"
+        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}"
+      end
+    end
+  end
+end