zipcoder 0.1.0

data/lib/ext/integer.rb

@@ -0,0 +1,8 @@
+class Integer
+
+  def zip_info(**kwargs)
+    string = self.to_s.rjust(5, '0')
+    string.zip_info(**kwargs)
+  end
+
+end

data/lib/ext/string.rb

@@ -0,0 +1,34 @@
+require_relative "../zipcoder"
+
+class String
+
+  def zip_info(**kwargs)
+    info = Zipcoder.zip_lookup[self]
+
+    # Filter to the included keys
+    if kwargs[:keys] != nil
+      new_info = {}
+      kwargs[:keys].each { |k| new_info[k] = info[k] }
+      info = new_info
+    end
+
+    info
+  end
+
+  def city_info(**kwargs)
+    # Cleanup "self"
+    key = self.delete(' ').upcase
+
+    info = Zipcoder.city_lookup[key]
+
+    # Filter to the included keys
+    if kwargs[:keys] != nil
+      new_info = {}
+      kwargs[:keys].each { |k| new_info[k] = info[k] }
+      info = new_info
+    end
+
+    info
+  end
+
+end

data/lib/zipcoder/version.rb

@@ -0,0 +1,3 @@
+module Zipcoder
+  VERSION = "0.1.0"
+end

data/lib/zipcoder.rb

@@ -0,0 +1,32 @@
+require "zipcoder/version"
+require "ext/string"
+require "ext/integer"
+require "yaml"
+
+module Zipcoder
+
+  # Data Structure Load and Lookup
+  @@zip_lookup = nil
+  def self.zip_lookup
+    self.load_data if @@zip_lookup == nil
+    @@zip_lookup
+  end
+
+  @@city_lookup = nil
+  def self.city_lookup
+    self.load_data if @@city_lookup == nil
+    @@city_lookup
+  end
+
+  # Loads the data into memory
+  def self.load_data
+    this_dir = File.expand_path(File.dirname(__FILE__))
+
+    zip_lookup = File.join(this_dir, 'data', 'zip_lookup.yml')
+    @@zip_lookup = YAML.load(File.open(zip_lookup))
+
+    city_lookup = File.join(this_dir, 'data', 'city_lookup.yml')
+    @@city_lookup = YAML.load(File.open(city_lookup))
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CODECOV_TOKEN']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "zipcoder"
+

data/spec/zipcoder_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe Zipcoder do
+  before(:all) {
+    described_class.load_data
+  }
+
+  it "has a version number" do
+    expect(Zipcoder::VERSION).not_to be nil
+  end
+
+  describe("String") do
+    describe "zip lookup" do
+      it "returns the info for a particular zip_code" do
+        zip_info = "78748".zip_info
+        expect(zip_info[:city]).to eq("AUSTIN")
+        expect(zip_info[:state]).to eq("TX")
+        expect(zip_info[:zip]).to eq("78748")
+        expect(zip_info[:lat]).to eq(30.26)
+        expect(zip_info[:long]).to eq(-97.74)
+      end
+
+      it "only returns specified keys" do
+        zip_info = "78748".zip_info(keys: [:city, :state])
+        expect(zip_info[:city]).to eq("AUSTIN")
+        expect(zip_info[:state]).to eq("TX")
+        expect(zip_info[:zip]).to be_nil
+        expect(zip_info[:lat]).to be_nil
+        expect(zip_info[:long]).to be_nil
+      end
+    end
+
+    describe "city lookup" do
+      it "returns the info for a particular city" do
+        city_info = "Austin, TX".city_info
+        expect(city_info[:city]).to eq("AUSTIN")
+        expect(city_info[:state]).to eq("TX")
+        expect(city_info[:zips].count).to eq(81)
+        expect(city_info[:lats].count).to eq(81)
+        expect(city_info[:longs].count).to eq(81)
+      end
+      it "only returns specified keys" do
+        city_info = "Austin, TX".city_info(keys: [:zips, :city])
+        expect(city_info[:city]).to eq("AUSTIN")
+        expect(city_info[:state]).to be_nil
+        expect(city_info[:zips].count).to eq(81)
+        expect(city_info[:lats]).to be_nil
+        expect(city_info[:longs]).to be_nil
+      end
+    end
+  end
+
+  describe("Integer") do
+    it "returns the info for a particular zip_code" do
+      zip_info = 78748.zip_info
+      expect(zip_info[:city]).to eq("AUSTIN")
+      expect(zip_info[:state]).to eq("TX")
+      expect(zip_info[:zip]).to eq("78748")
+      expect(zip_info[:lat]).to eq(30.26)
+      expect(zip_info[:long]).to eq(-97.74)
+    end
+
+    it "zero pads the zip code when using an integer" do
+      zip_info = 705.zip_info
+      expect(zip_info[:city]).to eq("AIBONITO")
+    end
+  end
+end

data/zipcoder.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zipcoder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zipcoder"
+  spec.version       = Zipcoder::VERSION
+  spec.authors       = ["Eric Chapman"]
+  spec.email         = ["eric.chappy@gmail.com"]
+
+  spec.summary       = %q{Converts zip codes to cities, lat/long, and vice-versa}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/ericchapman/zipcoder'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.5.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codecov'
+  spec.required_ruby_version = '>= 2.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: zipcoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric.chappy@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/data/city_lookup.yml
+- lib/data/zip_lookup.yml
+- lib/data/zipcode.csv
+- lib/ext/integer.rb
+- lib/ext/string.rb
+- lib/zipcoder.rb
+- lib/zipcoder/version.rb
+- spec/spec_helper.rb
+- spec/zipcoder_spec.rb
+- zipcoder.gemspec
+homepage: https://github.com/ericchapman/zipcoder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Converts zip codes to cities, lat/long, and vice-versa
+test_files:
+- spec/spec_helper.rb
+- spec/zipcoder_spec.rb