usps_standardizer 0.1.2 → 0.2.0

data/.gitignore

@@ -5,4 +5,5 @@ pkg/*
 .rvmrc
 *~
 docs
+.idea/
 

data/README.rdoc

@@ -5,6 +5,17 @@
   $ require 'usps_standardizer'
   $ gem install usps_standardizer
 
+== Configuration
+
+=== Caching
+
+It’s a good idea, when relying on any external service, to cache retrieved data.
+When implemented correctly it improves your app’s response time and stability.
+It’s easy to cache usps results with USPSStandardizer, just configure a cache store:
+
+  $ USPSStandardizer::Configuration.cache = Redis.new
+  $ USPSStandardizer::Configuration.cache_prefix = "wyw"
+
 == Usage
 
   $ result = USPSStandardizer.lookup_for(:address => '6216 eddington drive', :state => 'oh', :city => 'middletown')

data/lib/usps_standardizer/cache.rb

@@ -0,0 +1,50 @@
+module USPSStandardizer
+  class Cache
+
+    def initialize(store, prefix)
+      @store = store
+      @prefix = prefix
+    end
+
+    def [](url)
+      interpret store[key_for(url)]
+    end
+
+    def []=(url, value)
+      store[key_for(url)] = value
+    end
+
+    def expire(url)
+      if url == :all
+        urls.each{ |u| expire(u) }
+      else
+        expire_single_url(url)
+      end
+    end
+
+
+    private
+
+    attr_reader :prefix, :store
+
+    def key_for(url)
+      [prefix, url].join
+    end
+
+    def keys
+      store.keys.select{ |k| k.match /^#{prefix}/ and interpret(store[k]) }
+    end
+
+    def urls
+      keys.map{ |k| k[/^#{prefix}(.*)/, 1] }
+    end
+
+    def interpret(value)
+      value == "" ? nil : value
+    end
+
+    def expire_single_url(url)
+      store.del(key_for(url))
+    end
+  end
+end

data/lib/usps_standardizer/configuration.rb

@@ -0,0 +1,33 @@
+module USPSStandardizer
+  class Configuration
+
+    def self.options_and_defaults
+      [
+        [:timeout, 5],
+
+        # cache object (must respond to #[], #[]=, and #keys)
+        [:cache, nil],
+
+        # prefix (string) to use for all cache keys
+        [:cache_prefix, "usps:"]
+      ]
+    end
+
+    # define getters and setters for all configuration settings
+    self.options_and_defaults.each do |option, default|
+      class_eval(<<-END, __FILE__, __LINE__ + 1)
+
+        @@#{option} = default unless defined? @@#{option}
+
+        def self.#{option}
+          @@#{option}
+        end
+
+        def self.#{option}=(obj)
+          @@#{option} = obj
+        end
+
+      END
+    end
+  end
+end

data/lib/usps_standardizer/version.rb

@@ -1,8 +1,8 @@
 module USPSStandardizer
   module Version
     MAJOR  = 0
-    MINOR  = 1
-    PATCH   = 2
+    MINOR  = 2
+    PATCH   = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/usps_standardizer/zip_lookup.rb

@@ -4,6 +4,9 @@ require 'mechanize'
 
 module USPSStandardizer
 
+  #TODO: Change from 'mechanize' to 'net/hhtp'
+  #TODO: Implement 'timeout'
+
   class ZipLookup
 
     attr_accessor :address, :state, :city, :zipcode
@@ -17,6 +20,12 @@ module USPSStandardizer
     end
 
     def std_address
+
+      if(cache and response = cache[redis_key(@address)])
+        address, city, state, county, zipcode = response.split('::')
+        return {:address => address, :city => city, :state => state, :county => county, :zipcode => zipcode}
+      end
+
       return {} unless (content = get_std_address_content)
 
       content.gsub!(/\t|\n|\r/, '')
@@ -26,18 +35,21 @@ module USPSStandardizer
 
       raw_matches.inject({}) do |results, raw_match|
         if raw_match[0] =~ /mailingIndustryPopup2\(([^\)]*)/i
-          @county = $1.split(',')[1].gsub(/'/, '')
+          @r_county = $1.split(',')[1].gsub(/'/, '')
         end
 
-        @address, city_state_zipcode = Sanitize.clean(raw_match[0],
+        @r_address, city_state_zipcode = Sanitize.clean(raw_match[0],
                                                      :remove_contents => true,
                                                      :elements => %w[br]
                                       ).strip.split('<br>')
         if city_state_zipcode.sub_nonascii(' ').squeeze!(' ') =~ /^(.*)\s+(\w\w)\s(\d{5})(-\d{4})?/i
-          @city, @state, @zipcode = $1, $2, $3
+          @r_city, @r_state, @r_zipcode = $1, $2, $3
         end
 
-        results = {:address => @address, :city => @city, :state => @state, :county => @county, :zipcode => @zipcode}
+        results = {:address => @r_address, :city => @r_city, :state => @r_state, :county => @r_county, :zipcode => @r_zipcode}
+        if cache
+          cache[redis_key(@address)] = "#{@r_address}::#{@r_city}::#{@r_state}::#{@r_county}::#{@r_zipcode}"
+        end
         results
       end
     end
@@ -56,6 +68,15 @@ module USPSStandardizer
       return false unless @mechanize.page.search('p.mainRed').empty?
       @mechanize.page.body
     end
+
+    def cache
+      USPSStandardizer.cache
+    end
+
+    private
+    def redis_key(address)
+      address.downcase.gsub(' ', '_')
+    end
   end
 end
 

data/lib/usps_standardizer.rb

@@ -1,12 +1,27 @@
 # -*- encoding : utf-8 -*-
 require 'mechanize'
+
+#TODO: Improve documentation
 module USPSStandardizer
   autoload :Version, "usps_standardizer/version"
   autoload :ZipLookup, "usps_standardizer/zip_lookup"
+  autoload :Configuration, "usps_standardizer/configuration"
+  autoload :Cache, "usps_standardizer/cache"
+
+  class << self
+
+    def lookup_for(options, mechanize = Mechanize.new)
+      z = ZipLookup.new(options, mechanize)
+      z.std_address
+    end
+
+    def cache
+      if @cache.nil? and store = Configuration.cache
+        @cache = Cache.new(store, Configuration.cache_prefix)
+      end
+      @cache
+    end
 
-  def self.lookup_for(options, mechanize = Mechanize.new)
-    z = USPSStandardizer::ZipLookup.new(options, mechanize)
-    z.std_address
   end
 
 end

data/spec/usps_standardizer_spec.rb

@@ -6,6 +6,24 @@ describe USPSStandardizer do
     USPSStandardizer::Version::STRING.should match(/^\d+\.\d+\.\d+$/)
   end
 
+  describe "configuration" do
+    context "cache" do
+      it " should be nil as default" do
+        USPSStandardizer::Configuration.cache.should == nil
+      end
+    end
+    context "cache prefix" do
+      it "should be usps: as default" do
+        USPSStandardizer::Configuration.cache_prefix.should == 'usps:'
+      end
+    end
+    context "timeout" do
+      it "should be 5 seconds as default" do
+        USPSStandardizer::Configuration.timeout.should == 5
+      end
+    end
+  end
+
   it "standards an address on usps website" do
     result = USPSStandardizer.lookup_for(:address => '6216 eddington drive', :state => 'oh', :city => 'middletown')
     result[:address].should == '6216 EDDINGTON ST'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps_standardizer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-10-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &71382600 !ruby/object:Gem::Requirement
+  requirement: &72995970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *71382600
+  version_requirements: *72995970
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &71382350 !ruby/object:Gem::Requirement
+  requirement: &72995720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *71382350
+  version_requirements: *72995720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &71382120 !ruby/object:Gem::Requirement
+  requirement: &72995490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *71382120
+  version_requirements: *72995490
 description: Ruby class to standardize U.S. postal addresses by referencing the U.S.
   Postal Service's web site
 email:
@@ -58,6 +58,8 @@ files:
 - README.rdoc
 - Rakefile
 - lib/usps_standardizer.rb
+- lib/usps_standardizer/cache.rb
+- lib/usps_standardizer/configuration.rb
 - lib/usps_standardizer/version.rb
 - lib/usps_standardizer/zip_lookup.rb
 - spec/fixtures/content.html