auto_location 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 359aa8c98ff9ccd1e212dddaa598dca4ec48384c
-  data.tar.gz: 254b94ae7b961d7b515d4e8eeb90bdcaf3ec04e1
+  metadata.gz: 7e21890a7f28d651b1c1021d50ec103a895acb76
+  data.tar.gz: 37ce8ddf9551f18fd6c3e99f827f66f5b9e332b5
 SHA512:
-  metadata.gz: 74c715a0a2c6b082e7667212d58fb0e275e885550217cf1430244a9b38b9989f5c56e180504c2ef0e6c554bc34adc524756d86825732563c7d59d64b624bfee4
-  data.tar.gz: 0a2f40b4f5d03e7240d03dc94c6a94f5b34169b8b5d7248b2360e8a620581eaae2d157d5345e840a00a2c9774a468b120669c233d09fb3c41e82e4fb92e40256
+  metadata.gz: c9a1335bcda168bc529c9a9f8051e3ebaea1ce66d275257dbc5902f18f402fd41d1316636747ba8ae712be575fee302be5a8208d2fae7daf4a867e3555185778
+  data.tar.gz: 48ed6d4fb1da74ec01cb474b157dbcefb0b8b982315d8e69423f9fc315651dd293b5539549b0cc50723968712268f868c972c9a3e96661d969ce89401425e3bf

data/README.md

@@ -1 +1,37 @@
 # AutoLoc
+If a string contains a US zipcode/city/state, this gem will convert it into a parsed ruby object including a valid location.
+
+# Install
+Add the following into your Rails Gemfile
+```ruby
+  gem 'auto_location'
+```
+Then run bundler to install
+```ruby
+  $ bundle 
+  or 
+  $ bundle install
+```
+Or install directly on command line
+```ruby
+  $ gem install auto_location
+```
+
+# Usage Example
+After the gem is installed, in Ruby Code:
+```ruby
+ '95129'.validated_location => {location: {zipcode: '95129', city: "San Jose", state: "CA"}, type: 'zipcode'}
+ 'San Jose, CA'.validated_location => {location: {city: "San Jose", state: "CA"}, type: 'city'}
+ 'CA'.validated_location => {location: 'CA', type: 'state'}
+```
+The string can also include some unuseful info:
+```ruby
+  'San Jose, Wait! Where am I???'.validated_location => {location: {city: "San Jose", state: "CA"}, type: 'city'}
+```
+If the string is not able to be parsed:
+```ruby
+  '1428 random text, 35000, San Josa, CC'.validated_location => {error: "Location Not Found"}
+```
+
+# Notice
+The geo location data in the gem doesn't contain all location in US, and some of the parsing logic may not meet your requirement. But! We will make it better!

data/data/counties.csv

@@ -0,0 +1 @@
+Autauga County,AL

data/lib/auto_location.rb

@@ -5,11 +5,12 @@ else
   require 'faster_csv'
 end
 
-require 'auto_location/string'
+require 'auto_location/string.rb'
 
 module AutoLocation
   city_file = File.open(File.join(File.dirname(__FILE__), '..', 'data', 'cities.csv'))
   state_file = File.open(File.join(File.dirname(__FILE__), '..', 'data', 'states.csv'))
+  county_file = File.open(File.join(File.dirname(__FILE__), '..', 'data', 'counties.csv'))
 
   csv_method = lambda{ |x| RUBY_VERSION.to_f >= 1.9 ? CSV.read(x) : FasterCSV.parse(x) }
   # regular expressions for city: CITY_NAME_PART1.*PART2.*....*STATE.*
@@ -21,8 +22,8 @@ module AutoLocation
                 ]
               end
   @cities_hash ||= Hash[(csv_method.call(city_file)).map do |x|
-                [(x[2] + ', ' + x[1]).upcase, [x[2], x[1]]]
-              end]
+                     [(x[2] + ', ' + x[1]).upcase, [x[2], x[1]]]
+                   end]
   @zips   ||= Hash[(csv_method.call(city_file)).map do |x|
                 [x[0].to_i, [x[2], x[1]]]
               end]
@@ -31,6 +32,16 @@ module AutoLocation
                 x[0] = state.upcase
                 x << state
               end]
+  @counties ||= csv_method.call(county_file).map do |x|
+                  [ Regexp.new(((x[0].split(/[\s\,]/).map(&:strip) << ('(' + x[1] + ')')).join('.*') + '*.*').upcase),
+                    x[0],
+                    x[1]
+                  ]
+                end
+  @counties_hash ||= Hash[(csv_method.call(county_file)).map do |x|
+                       [(x[0] + ', ' + x[1]).upcase, [x[0], x[1]]]
+                     end]
+
   # default result if zipcode, city, state search all failed
   @not_found_location ||= {error: "Location Not Found"}.freeze
 
@@ -51,6 +62,14 @@ module AutoLocation
       @states
     end
 
+    def counties
+      @counties
+    end
+
+    def counties_hash
+      @counties_hash
+    end
+
     def not_found_location
       @not_found_location
     end

data/lib/auto_location/string.rb

@@ -4,7 +4,7 @@ class String
     # If search includes valid zipcode, return zipcode
     # If zipcode doesn't exist, do city search.
     # If city doesn't exist, do state search.
-    zipcode(self) || city_perfect_match(self) || city(self) || state(self) || AutoLocation.not_found_location
+    zipcode(self) || city_perfect_match(self) || county_perfect_match(self) || city_or_county(self) || state(self) || AutoLocation.not_found_location
   end
 
   # Check if zipcode exists
@@ -22,6 +22,14 @@ class String
     result == nil ? false : { location: {city: result[0], state: result[1]}, type: 'city' }
   end
 
+  def city_or_county(input)
+    city_res = city(input)
+    county_res = county(input)
+    return county_res if city_res == false
+    return city_res if county_res == false
+    city_res[:location][:city].split(' ').length >= county_res[:location][:county].split(' ').length ? city_res : county_res
+  end
+
   # Find a city with the search string
   def city(city)
     city = city.upcase
@@ -43,4 +51,20 @@ class String
     end
     false
   end
+
+  def county(county)
+    county = county.upcase
+    results = []
+    AutoLocation.counties.find_all do |row|
+      results << row unless county[row[0]] == nil
+    end
+    result = results == [] ? nil : results.max {|a,b| a[1].length <=> b[1].length}
+    result == nil ? false : { location: {county: result[1], state: result[2]}, type: 'county' }
+  end
+
+  def county_perfect_match(county)
+    county = county.upcase
+    result = AutoLocation.counties_hash[county]
+    result == nil ? false : { location: {county: result[0], state: result[1]}, type: 'county' }
+  end
 end

data/lib/auto_location/version.rb

@@ -1,3 +1,3 @@
 module AutoLocation
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/spec/lib/auto_location_spec.rb

@@ -21,6 +21,10 @@ describe 'auto location parse location from string' do
     {location: 'California', type: 'state'}
   end
 
+  let(:valid_county_response) do
+    { location: {county: 'Orange County', state: 'CA'}, type: 'county' }
+  end
+
   describe 'get zipcode' do
     it 'when input contains valid zipcode' do
       expect('string'.zipcode('hello world, San Jose, CA, 95129')).to eq(valid_zip_code_response)
@@ -53,6 +57,23 @@ describe 'auto location parse location from string' do
     end
   end
 
+  describe 'get county' do
+    it 'when input contains valid county' do
+      expect('string'.county('1428 downtown south, Orange County CA')).to eq(valid_county_response)
+      expect('string'.county('Orange some text County, some textCA')).to eq(valid_county_response)
+      expect('string'.county('orangecountyca')).to eq(valid_county_response)
+      expect('string'.county('some text orange some text county some text')).to eq(valid_county_response)
+    end
+
+    it 'when input does not contain valid county' do
+      expect('string'.county('1428 orancoutttttt')).to be_falsey
+    end
+
+    it 'when input perfectly matches to a county' do
+      expect('string'.county_perfect_match('Orange County, CA')).to eq(valid_county_response)
+    end
+  end
+
   describe 'get state' do
     it 'when input contains valid state' do
       expect('string'.state('ca')).to eq(valid_state_response_short)
@@ -69,6 +90,12 @@ describe 'auto location parse location from string' do
     end
   end
 
+  describe 'get city or county' do
+    it 'when county matches longer than city' do
+      expect('string'.city_or_county('some Orange County, CA')).to eq(valid_county_response)
+    end
+  end
+
   describe 'get validated location' do
     it 'when input contains valid zip' do
       expect('1428 downtown south San Jose, 95129, San Jose, CA'.validated_location).to eq(valid_zip_code_response)
@@ -78,6 +105,10 @@ describe 'auto location parse location from string' do
       expect('1428 downtown south San Jose, 35000, San Jose, CA'.validated_location).to eq(valid_city_response)
     end
 
+    it 'when input contains valid county' do
+      expect('1428 downtown, some text, Orange County, CA'.validated_location).to eq(valid_county_response)
+    end
+
     it 'when input contains valid state' do
       expect('1428 random text, 35000, San Josa, CA'.validated_location).to eq(valid_state_response_short)
     end
@@ -85,5 +116,13 @@ describe 'auto location parse location from string' do
     it 'when input contains no valid location' do
       expect('1428 random text, 35000, San Josa, CC'.validated_location).to eq(not_found_location_response)
     end
+
+    it 'when input contains pure state' do
+      expect('CA'.validated_location).to eq(valid_state_response_short)
+    end
+
+    it 'county messed up test' do
+      expect('adfsafasfa OrangeCOuntyCA dfsafasfs'.validated_location).to eq(valid_county_response)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_location
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Lu Zou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv
@@ -68,6 +68,7 @@ files:
 - Rakefile
 - auto_location.gemspec
 - data/cities.csv
+- data/counties.csv
 - data/states.csv
 - data/zips.csv
 - lib/auto_location.rb