ziptastic 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@ziptastic"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.12.1 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ezekiel Templin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Ziptastic Ruby
+A simple Ruby port of Thomas Schultz's [Ziptastic](https://github.com/daspecster/ziptastic) zip code API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ziptastic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ziptastic
+
+## Usage
+To search against the database locally:
+
+    require 'ziptastic'
+    results = Ziptastic.search("16335")
+      # => [  {:city=>"MEADVILLE", :state=>"PA", :country=>"US"},
+      #       {:city=>"BLOOMING VALLEY", :state=>"PA", :country=>"US"},
+      #       {:city=>"KERRTOWN", :state=>"PA", :country=>"US"} ]
+      
+Local database searches often return multiple results for a single zip code.
+
+Alternatively, an executable is also included that provides a search API via Sinatra:
+
+    $ ziptastic
+    $ curl http://localhost:5678?zip=16335
+      # => {"city":"MEADVILLE","state":"PA","country":"US"}
+
+The web API is compatible with the [example JS script](http://daspecster.github.com/ziptastic/demo.html) provided by Thomas Schultz. You'll just need to update the client URL.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/ziptastic

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/ziptastic')
+require "vegas"
+
+Vegas::Runner.new(Ziptastic::App, "ziptastic")

data/lib/ziptastic.rb

@@ -0,0 +1,32 @@
+require "sqlite3"
+
+module Ziptastic
+  class NotZipCode < StandardError; end
+  
+  DATABASE_PATH = File.expand_path(File.dirname(__FILE__) + "/ziptastic/data/zipcodes.db")  
+  ZIP_DATABASE = SQLite3::Database.open(DATABASE_PATH, :readonly => true, :results_as_hash => true)
+  
+  def self.search(zip_code)
+    search_results = []
+    
+    search_results = search_for_zip_code(zip_code).collect do |row|
+      {:city => row['city'], :state => row['state'], :country => row['country']}
+    end
+        
+    search_results
+  end
+  
+  private
+  def self.search_for_zip_code(zip_code)
+    validate_zip_code(zip_code)
+    ZIP_DATABASE.execute('select City, State, Country from zipcodes where ZipCode=?', zip_code)
+  end
+  
+  def self.validate_zip_code(zip_code)
+    raise NotZipCode, "#{zip_code} is not a zip code!" if zip_code =~ /\D/
+  end
+end
+require "ziptastic/app"
+require "ziptastic/version"
+
+

data/lib/ziptastic/app.rb

@@ -0,0 +1,18 @@
+require "sinatra/base"
+require "sinatra/json"
+require "multi_json"
+
+module Ziptastic
+  class App < Sinatra::Base
+    helpers Sinatra::JSON
+    
+    get '/' do
+      results = Ziptastic.search(params[:zip])
+      if results.any?
+        json results.first
+      else
+        status 404
+      end
+    end
+  end
+end

data/lib/ziptastic/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/ziptastic')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+

data/spec/ziptastic_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Ziptastic do
+  describe "#query" do
+    context "valid zipcode" do 
+      context "w/ results" do      
+        it "should return an array of results" do
+          Ziptastic.search("16335").count.should eq 3
+        end
+      
+        it "each result should have city, state, and country" do
+          meadville = Ziptastic.search("16335")[0]
+          
+          meadville[:city].should eq "MEADVILLE"
+          meadville[:state].should eq "PA"
+          meadville[:country].should eq "US"
+        end
+      end
+      
+      context "no result" do
+        it "should return false" do
+          Ziptastic.search("8675309").should eq []
+        end
+      end
+    end
+        
+    context "invalid zipcode" do
+      it "should return an exception" do
+        expect { Ziptastic.search("16335a") }.to raise_error(Ziptastic::NotZipCode, "16335a is not a zip code!")
+      end
+    end
+  end
+end

data/ziptastic.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ziptastic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ezekiel Templin"]
+  gem.email         = ["zeke@templ.in"]
+  gem.description   = %q{Ruby port of Thomas Schultz's Ziptastic API}
+  gem.summary       = %q{Ruby port of Thomas Schultz's Ziptastic API}
+  gem.homepage      = "https://github.com/ezkl/ziptastic"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ziptastic"
+  gem.require_paths = ["lib"]
+  gem.version       = Ziptastic::VERSION
+  
+  gem.add_dependency("sqlite3", "~> 1.3.5")
+  gem.add_dependency("sinatra")
+  gem.add_dependency("sinatra-contrib")
+  gem.add_dependency("multi_json")
+  gem.add_dependency("vegas")
+  gem.add_development_dependency("rspec", "~> 2.9.0")
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: ziptastic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ezekiel Templin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vegas
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Ruby port of Thomas Schultz's Ziptastic API
+email:
+- zeke@templ.in
+executables:
+- ziptastic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ziptastic
+- lib/ziptastic.rb
+- lib/ziptastic/app.rb
+- lib/ziptastic/data/zipcodes.db
+- lib/ziptastic/version.rb
+- spec/spec_helper.rb
+- spec/ziptastic_spec.rb
+- ziptastic.gemspec
+homepage: https://github.com/ezkl/ziptastic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3288914156171438784
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3288914156171438784
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Ruby port of Thomas Schultz's Ziptastic API
+test_files:
+- spec/spec_helper.rb
+- spec/ziptastic_spec.rb