awesome_usps 0.5.0

data/lib/awesome_usps/shipping.rb

@@ -0,0 +1,236 @@
+module AwesomeUsps
+  module Shipping
+
+    MAX_RETRIES = 3
+
+    ORIGIN_ZIP = "07024" #User should change this
+
+    LIVE_DOMAIN = 'production.shippingapis.com'
+    LIVE_RESOURCE = '/ShippingAPI.dll'
+
+    TEST_DOMAINS = { #indexed by security; e.g. TEST_DOMAINS[USE_SSL[:rates]]
+      true => 'secure.shippingapis.com',
+      false => 'testing.shippingapis.com'
+    }
+
+    TEST_RESOURCE = '/ShippingAPITest.dll'
+
+    API_CODES = {
+      :us_rates => 'RateV3',
+      :world_rates => 'IntlRate',
+      :test => 'CarrierPickupAvailability'
+    }
+
+    USE_SSL = {
+      :tracking => false,
+      :test => true
+    }
+    CONTAINERS = {
+      :envelope => 'Flat Rate Envelope',
+      :box => 'Flat Rate Box'
+    }
+    MAIL_TYPES = {
+      :package => 'Package',
+      :postcard => 'Postcards or aerogrammes',
+      :matter_for_the_blind => 'Matter for the blind',
+      :envelope => 'Envelope'
+    }
+    PACKAGE_PROPERTIES = {
+      'ZipOrigination' => :origin_zip,
+      'ZipDestination' => :destination_zip,
+      'Pounds' => :pounds,
+      'Ounces' => :ounces,
+      'Container' => :container,
+      'Size' => :size,
+      'Machinable' => :machinable,
+      'Zone' => :zone,
+      'Postage' => :postage,
+      'Restrictions' => :restrictions
+    }
+    POSTAGE_PROPERTIES = {
+      'MailService' => :service,
+      'Rate' => :rate
+    }
+    US_SERVICES = {
+      :first_class => 'FIRST CLASS',
+      :priority => 'PRIORITY',
+      :express => 'EXPRESS',
+      :bpm => 'BPM',
+      :parcel => 'PARCEL',
+      :media => 'MEDIA',
+      :library => 'LIBRARY',
+      :all => 'ALL'
+    }
+
+    #Determins size of package automatically. Taken from Active_Shipping
+    def size_code_for(package)
+      total = package.inches(:length) + package.inches(:girth)
+      if total <= 84
+        return 'REGULAR'
+      elsif total <= 108
+        return 'LARGE'
+      else # <= 130
+        return 'OVERSIZE'
+      end
+    end
+
+    # options Are?
+    def domestic_rates(destination_zip, packages, options={})
+      @packages = Array(packages)
+      @destination_zip = destination_zip
+      @options = options
+      request = xml_for_us
+      tracking_commit(:us_rates, request ,false)
+    end
+
+    # options Are?
+    def world_rates(country, packages, options={})
+      @packages = Array(packages)
+      @country = country
+      @options = options
+      request = xml_for_world
+      tracking_commit(:world_rates, request ,false)
+    end
+    
+    private
+    # XML built with Build:XmlMarkup
+    def xml_for_us
+      xm = Builder::XmlMarkup.new
+      xm.RateV3Request("USERID"=>"#{@username}") do
+        @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.Pounds("0")
+            xm.Ounces("#{'%0.1f' % [p.ounces,1].max}")
+            if p.options[:container] and [nil,:all,:express,:priority].include? p.service
+              xm.Container(CONTAINERS[p.options[:container]])
+            end
+            xm.Size(size_code_for(p))
+            xm.Width(p.inches(:width))
+            xm.Length(p.inches(:length))
+            xm.Height(p.inches(:height))
+            xm.Girth(p.inches(:girth))
+            xm.Machinable((p.options[:machinable] ? true : false).to_s.upcase)
+          }
+        end
+      end
+    end
+
+    # XML built with Build:XmlMarkup
+    def xml_for_world
+      xm = Builder::XmlMarkup.new
+      xm.IntlRateRequest("USERID"=>"#{@username}") do
+        @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)
+          }
+        end
+      end
+    end
+
+
+    # Returns the sent xml as a hash orgainzied by each package and service type.
+    # example
+    # {Package1 =>{'First Class' => "1.90"}Package2 => {'First Class' => "26.90" }
+
+    def parse_us(xml)
+      domestic_rate_hash = Hash.new
+      i= 0
+      Hpricot.parse(xml).search('package').each do |package|
+        i+=1
+        #This will return the first error description found in response xml.
+        #TODO find way to return all errors.
+        if package.search("error") != []
+          RAILS_DEFAULT_LOGGER.info("package number #{i} has the error #{package.search("description").inner_html} please fix before continuing")
+
+          return "package number #{i} has the error #{package.search("description").inner_html} please fix before continuing"
+        end
+        #Initializing hash for each package. Is there a better way I wonder.
+        domestic_rate_hash["Package#{i}"] = {}
+        #Going through each package and finding the rate.
+        package.search("postage").each do |services|
+          mailservice=services.search("mailservice")
+          rate = services.search("rate")
+          domestic_rate_hash["Package#{i}"][mailservice.inner_html] = rate.inner_html
+        end
+      end
+      if domestic_rate_hash == {}
+        domestic_rate_hash = Hpricot.parse(xml).search('description').inner_html
+      end
+      return domestic_rate_hash
+    end
+    
+    def parse_world(xml)
+      international_rate_hash = Hash.new
+      i= 0
+      Hpricot.parse(xml).search('package').each do |package|
+        i+=1
+        #This will return the first error description found in response xml.
+        #TODO find way to return all errors.
+        if package.search("error") != []
+          RAILS_DEFAULT_LOGGER.info("package number #{i} has the error #{package.search("description").inner_html} please fix before continuing")
+
+          return "package number #{i} has the error #{package.search("description").inner_html} please fix before continuing"
+        end
+        #Initializing hash for each package. Is there a better way I wonder.
+        international_rate_hash["Package#{i}"] = {}
+        #Going through each package and finding the rate.
+        package.search("service").each do |services|
+          svcdescription=services.search("svcdescription")
+          rate = services.search("postage")
+          international_rate_hash["Package#{i}"][svcdescription.inner_html] = rate.inner_html
+        end
+      end
+      if international_rate_hash == {}
+        international_rate_hash = Hpricot.parse(xml).search('description').inner_html
+      end
+      return international_rate_hash
+    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 = 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, 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
+

data/lib/awesome_usps/tracking.rb

@@ -0,0 +1,88 @@
+module AwesomeUsps
+  module Tracking
+    MAX_RETRIES = 3
+
+    LIVE_DOMAIN = 'production.shippingapis.com'
+    LIVE_RESOURCE = '/ShippingAPI.dll'
+
+    TEST_DOMAIN ='testing.shippingapis.com'
+    TEST_RESOURCE = '/ShippingAPITest.dll'
+
+    API_CODE ='TrackV2'
+
+    # Takes your package tracking number and returns information for the USPS web API
+    def track(tracking_number)
+      @tracking_number = tracking_number
+      request = xml_for_tracking
+      commit(:tracking, request ,false)
+    end
+
+    def canned_tracking
+      @tracking_number = "EJ958083578US"
+      request = xml_for_tracking
+      commit(:tracking, request ,true)
+    end
+
+    # XML from a straight string.
+    # "<TrackFieldRequest USERID='#{@username}'><TrackID ID='#{@tracking_number}'></TrackID></TrackFieldRequest>"
+    def xml_for_tracking
+      xm = Builder::XmlMarkup.new
+      xm.TrackFieldRequest("USERID" =>"#{@username}") do
+        xm.TrackID("ID"=> "#{@tracking_number}")
+      end
+    end
+
+    # Parses the XML into an array broken up by each event.
+    # Example of returned array
+    def parse(xml)
+      event_list = []
+      parse = Hpricot.parse(xml)/:trackdetail
+      if parse == []
+        RAILS_DEFAULT_LOGGER.info "#{xml}"
+        return (Hpricot.parse(xml)/:description).inner_html
+      else
+        parse.each do |detail|
+          h = {}
+          detail.children.each { |elem| h[elem.name.to_sym] = elem.inner_text unless elem.inner_text.blank? }
+          event_list << h
+        end
+      end
+      event_list
+    end
+
+    private
+    def commit(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_CODE, '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, Net::HTTPRedirection
+        parse(response.body)
+      else
+        RAILS_DEFAULT_LOGGER.warn("USPS plugin settings are wrong #{response}")
+      end
+    end
+
+  end
+end

data/lib/awesome_usps/version.rb

@@ -0,0 +1,9 @@
+module AwesomeUsps
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/awesome_usps.rb'}"
+puts "Loading awesome_usps gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'awesome_usps' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'awesome_usps'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = AwesomeUsps::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)