geolookup 0.5.10 → 0.6.0

data/lib/geolookup.rb

@@ -1,7 +1,10 @@
-require "geolookup/version"
-require "geolookup/usa/county"
-require "geolookup/usa/state"
-require "geolookup/country"
+require 'geolookup/version'
+require 'geolookup/usa/county'
+require 'geolookup/usa/state'
+require 'geolookup/usa/metro'
+require 'geolookup/country'
+require 'geolookup/usa/areacodes'
+require 'geolookup/usa/zipcodes'
 
 module Geolookup
   ###################################################################

data/lib/geolookup/usa/areacodes.rb

@@ -0,0 +1,16 @@
+module Geolookup
+  module USA
+    module AreaCodes
+
+      AREA_CODE_META_INFO_FILE = 'AREA_CODE_META_INFO.yml'
+
+      def self.to_h
+        @area_codes_hash ||= Geolookup.load_hash_from_file(AREA_CODE_META_INFO_FILE)
+      end
+
+      def self.find(area_code)
+        to_h[area_code.to_s] || {}
+      end
+    end
+  end
+end

data/lib/geolookup/usa/metro.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+module Geolookup
+  module USA
+    module Metro
+      METRO_CODE_TO_NAME_FILE = 'METRO_CODE_TO_NAME.yml'
+
+      @metro_code_to_name
+
+      ###################################################################
+      # self.code_to_name
+      #
+      # Given a metro code output the metro name
+      # Else return nil
+      #
+      # EX: code_to_name(4) => "Abilene"
+      def self.code_to_name(metro_code)
+        @metro_code_to_name ||= Geolookup.load_hash_from_file(METRO_CODE_TO_NAME_FILE)
+        get_value_from_hash(@metro_code_to_name, metro_code.to_s.to_i)
+      end
+
+      ###################################################################
+      # self.get_value_from_hash
+      #
+      # Helper function to reduce code repetition
+      # Given a hash and 1 key returns the value at that hash
+      # Return nil if the either key is not in the hash
+      #
+      # EX: get_value(@metro_code_to_name, 4) => "Abilene"
+      def self.get_value_from_hash(hash, key1)
+        return nil unless hash[key1]
+        hash[key1]
+      end
+
+      private_class_method :get_value_from_hash
+    end
+  end
+end

data/lib/geolookup/usa/state.rb

@@ -118,23 +118,32 @@ module Geolookup
       end
 
       ###################################################################
-      # self.names
+      # self.codes_and_names
       #
-      # Returns an array of state names
+      # Returns a hash of state_codes and names
       #
       def self.codes_and_names
         @codes_and_names ||= Geolookup.load_hash_from_file(STATE_CODE_TO_FULL_FILE)
       end
 
       ###################################################################
-      # self.names
+      # self.codes_and_abbreviations
       #
-      # Returns an array of state names
+      # Returns a hash of state_codes and abbreviations
       #
       def self.codes_and_abbreviations
         @codes_and_abbreviations ||= Geolookup.load_hash_from_file(STATE_CODE_TO_ABBREVIATION_FILE)
       end
 
+      ###################################################################
+      # self.abbreviations_and_names
+      #
+      # Returns a hash of abbreviations and state names
+      #
+      def self.abbreviations_and_names
+        @state_abbreviation_to_name ||= Geolookup.load_hash_from_file(STATE_ABBREVIATION_TO_NAME_FILE)
+      end
+
       ###################################################################
       # self.names
       #

data/lib/geolookup/usa/zipcodes.rb

@@ -0,0 +1,17 @@
+module Geolookup
+  module USA
+    module Zipcodes
+      # In the future if zip information is updated in mysql, the yml can be recreated via the following
+      # zip_lat_long_data = {}
+      # ZipCityGeolocationMapping.find_each {|zip| zip_lat_long_data[zip.zip] = {lat_int: zip.lat_int, long_int: zip.long_int}}
+      # File.open('ZIP_LAT_LONG.yml', "w") {|file| file.puts zip_lat_long_data.to_yaml}
+
+      ZIP_LAT_LONG_FILE = 'ZIP_LAT_LONG.yml'
+
+      def self.lat_long(zipcode)
+        @zip_lat_long_hash ||= Geolookup.load_hash_from_file(ZIP_LAT_LONG_FILE)
+        @zip_lat_long_hash[zipcode.to_i] || {}
+      end
+    end
+  end
+end

data/lib/geolookup/version.rb

@@ -1,3 +1,3 @@
 module Geolookup
-  VERSION = "0.5.10"
+  VERSION = '0.6.0'
 end

data/spec/lib/areacodes_spec.rb

@@ -0,0 +1,17 @@
+describe 'Geolookup::USA::AreaCodes' do
+
+
+  describe 'info' do
+    it 'should return data from the Area Code hash if area code is passed in as a string' do
+      expect(Geolookup::USA::AreaCodes.find('202')).to eql({country: 'US', description: '', service: 'y', state: 'DC', type: 'general purpose code'})
+    end
+
+    it 'should return data from the Area Code hash if area code is passed in as a number' do
+      expect(Geolookup::USA::AreaCodes.find(202)).to eql({country: 'US', description: '', service: 'y', state: 'DC', type: 'general purpose code'})
+    end
+
+    it 'should return an empty hash if there is no area_code data' do
+      expect(Geolookup::USA::AreaCodes.find(2023)).to eql({})
+    end
+  end
+end

data/spec/lib/state_spec.rb

@@ -96,6 +96,14 @@ describe "Geolookup::USA::State" do
     end
   end
 
+  describe "#abbreviations_and_names" do
+    it "should return a Hash where the key is the abbreviation and the value is the state name" do
+      abbreviations_and_names = Geolookup::USA::State.abbreviations_and_names
+      expect(abbreviations_and_names).to be_kind_of(Hash)
+      expect(abbreviations_and_names['AL']).to be_eql('Alabama')
+    end
+  end
+
   describe "#name_to_lat_long" do
     it "should return a lat / long for state name" do
       expect(Geolookup::USA::State.name_to_lat_long("Alabama")).to eql(state_lat_long)

data/spec/lib/zipcodes_spec.rb

@@ -0,0 +1,21 @@
+describe 'Geolookup::USA::Zipcodes' do
+
+
+  describe 'lat_long' do
+    it 'should lat long for integer zipcode' do
+      expect(Geolookup::USA::Zipcodes.lat_long('90012')).to eql({lat_int: 34067827, long_int: -118242233})
+    end
+
+    it 'should lat long for string zipcode' do
+      expect(Geolookup::USA::Zipcodes.lat_long(90012)).to eql({lat_int: 34067827, long_int: -118242233})
+    end
+
+    it 'should not care about leading zeros' do
+      expect(Geolookup::USA::Zipcodes.lat_long(501)).to eql(Geolookup::USA::Zipcodes.lat_long('00501'))
+    end
+
+    it 'should return an empty hash if there is no zipcode data' do
+      expect(Geolookup::USA::Zipcodes.lat_long('900012')).to eql({})
+    end
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: geolookup
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0
 platform: ruby
 authors:
 - Austin Fonacier
 - David Butler
 - Jeffrey Lee
+- Wei Yan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +60,7 @@ email:
 - austin@spokeo.com
 - dwbutler@ucla.edu
 - jlee@spokeo.com
+- wyan@spokeo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,6 +74,7 @@ files:
 - README.md
 - Rakefile
 - geolookup.gemspec
+- lib/data/AREA_CODE_META_INFO.yml
 - lib/data/COUNTRY_CODE_TO_NAME.yml
 - lib/data/COUNTRY_LAT_LONG.yml
 - lib/data/COUNTRY_NAME_TO_CODE.yml
@@ -79,20 +82,27 @@ files:
 - lib/data/COUNTY_IGNORED_STATES.yml
 - lib/data/COUNTY_LAT_LONG.yml
 - lib/data/COUNTY_NAME_TO_CODE.yml
+- lib/data/METRO_CODE_TO_NAME.yml
 - lib/data/STATE_CODE_TO_DISPLAY_NAME.yml
 - lib/data/STATE_CODE_TO_FULL.yml
 - lib/data/STATE_CODE_TO_STATE.yml
 - lib/data/STATE_FULL_STATE_NAMES.yml
 - lib/data/STATE_LAT_LONG.yml
 - lib/data/STATE_NAME_TO_CODE.yml
+- lib/data/ZIP_LAT_LONG.yml
 - lib/geolookup.rb
 - lib/geolookup/country.rb
+- lib/geolookup/usa/areacodes.rb
 - lib/geolookup/usa/county.rb
+- lib/geolookup/usa/metro.rb
 - lib/geolookup/usa/state.rb
+- lib/geolookup/usa/zipcodes.rb
 - lib/geolookup/version.rb
+- spec/lib/areacodes_spec.rb
 - spec/lib/country_spec.rb
 - spec/lib/county_spec.rb
 - spec/lib/state_spec.rb
+- spec/lib/zipcodes_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/spokeo/geolookup
 licenses:
@@ -114,12 +124,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Common geo lookups
 test_files:
+- spec/lib/areacodes_spec.rb
 - spec/lib/country_spec.rb
 - spec/lib/county_spec.rb
 - spec/lib/state_spec.rb
+- spec/lib/zipcodes_spec.rb
 - spec/spec_helper.rb