zipcode_locator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5b78f7c08e8e1715f181247b4b24728c5335978
+  data.tar.gz: 7f4503ecef0674087a4a6e5186eaba61e0354095
+SHA512:
+  metadata.gz: 1661b93313b0c54893858787bf05ea5b38803bf0171181596ceca9951de8c3be271a7c6d7bfee0516012bf4151910c04e8e0850349e36a13400290800edcbc5c
+  data.tar.gz: fb6df51d021c55d8567299c42a9fa6aac8dd7f6ca04357caca5ba46b2df26ed36cb2e988d92b0ebfc21430bad0b4349a686335679e6b0019bf2e14f136a97818

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem 'vcr'
+  gem 'webmock'
+  gem 'httparty'
+end

data/Gemfile.lock

@@ -0,0 +1,94 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashdiff (0.3.0)
+    hashie (3.4.3)
+    highline (1.7.8)
+    httparty (0.13.5)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rake (10.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    safe_yaml (1.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (3.0.1)
+    webmock (1.24.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  httparty
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 anildias
+
+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.rdoc

@@ -0,0 +1,19 @@
+= zipcode_locator
+
+Description goes here.
+
+== Contributing to zipcode_locator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2016 anildias. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "zipcode_locator"
+  gem.homepage = "http://github.com/anildias/zipcode_locator"
+  gem.license = "MIT"
+  gem.summary = %Q{Locate place with the help of Zip code API within a given distance by inputting zipcode}
+  gem.description = %Q{Locate place with the help of Zip code API within a given distance by inputting zipcode}
+  gem.email = "anildiasdavis@gmail.com"
+  gem.authors = ["anildias"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "locator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/zipcode_locator/unit.rb

@@ -0,0 +1,14 @@
+	
+	module Unit
+		DEFAULT_UNIT = "km"
+		AVAILABLE_UNITS = ["km", "mile", "radians", "degrees"]
+
+		def self.default_unit
+			DEFAULT_UNIT
+		end
+
+		def self.available_units
+			AVAILABLE_UNITS
+		end
+	end
+

data/lib/zipcode_locator.rb

@@ -0,0 +1,61 @@
+require 'zipcode_locator/unit'
+
+require 'httparty'
+
+class ZipcodeLocator
+	DEFAULT_UNIT = "km"
+	DEFAULT_FORMAT = "json"
+	AVAILABLE_UNITS = ["km", "mile", "radians", "degrees"]
+	AVAILABLE_FORMATS = ["json", "xml", "csv"]
+
+	def initialize(api_key)
+		@api_key = api_key
+	end
+
+	def distance_between_zipcodes(zip_code1, zip_code2, unit = nil, format = nil)
+		format = AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+		unit =  AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/distance.#{format}/#{zip_code1}/#{zip_code2}/#{unit}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+	def get_zipcodes_by_radius(zip_code, radius, unit = nil, format = nil)
+		format = AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+		unit =  AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/radius.#{format}/#{zip_code}/#{radius}/#{unit}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+	# zip_codes = array of zipcodes
+	def find_close_zipcodes(zip_codes, distance, unit = nil, format = nil)
+		format = AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+		unit =  AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
+		zip_codes = zip_codes.join(',')
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/match-close.#{format}/#{zip_codes}/#{distance}/#{unit}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+	def zipcode_location_info(zip_code, unit = nil, format = nil)
+		format = AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+		unit =  AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/info.#{format}/#{zip_code}/#{unit}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+	# zip_codes = array of zipcodes
+	def multi_zipcodes_location_info(zip_codes, unit = nil, format = nil)
+		format = AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+		unit =  AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
+		zip_codes = zip_codes.join(',')
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/multi-info.#{format}/#{zip_codes}/#{unit}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+	def get_zipcodes_by_locations(city, state)
+		city = city.delete(' ')
+		state = state.delete(' ')
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/city-zips.#{DEFAULT_FORMAT}/#{city}/#{state}"
+		JSON.parse(HTTParty.get(url).body)
+	end
+
+end

data/test/helper.rb

@@ -0,0 +1,40 @@
+require 'simplecov'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "test/vcr_cassettes"
+  config.hook_into :webmock # or :fakeweb
+end
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'locator'
+
+class Minitest::Test
+end

data/test/test_zipcode_locator.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+class TestZipcodeLocator < Minitest::Test
+
+	@@loc = ZipcodeLocator.new('3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X')
+
+	def test_distance_between_zipcodes()
+		test_zipcode1 = 10001
+		test_zipcode2 = 10005
+		VCR.use_cassette("distance_between_zipcodes", :record => :new_episodes) do
+			res = @@loc.distance_between_zipcodes(10001, 10005)
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/distance.json/#{test_zipcode1}/#{test_zipcode2}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+	def test_get_zipcodes_by_radius()
+		test_zipcode = 10001
+		test_radius = 5
+		VCR.use_cassette("get_zipcodes_by_radius", :record => :new_episodes) do
+			res = @@loc.get_zipcodes_by_radius(10001, 5)
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/radius.json/#{test_zipcode}/#{test_radius}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+	def test_find_close_zipcodes()
+		test_zipcodes = "10001,10005"
+		test_distance = 5
+		VCR.use_cassette("close_zipcodes", :record => :new_episodes) do
+			res = @@loc.find_close_zipcodes([10001, 10005], 5)
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/match-close.json/#{test_zipcodes}/#{test_distance}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+	def test_zipcode_location_info()
+		test_zipcode = 10001
+		VCR.use_cassette("zipcode_location_info", :record => :new_episodes) do
+			res = @@loc.zipcode_location_info(10001)
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/info.json/#{test_zipcode}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+	def test_multi_zipcodes_location_info()	
+		test_zipcodes = "10001,10005"
+		VCR.use_cassette("multi_zipcodes_location_info", :record => :new_episodes) do
+			res = @@loc.multi_zipcodes_location_info([10001, 10005], 5)
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/multi-info.json/#{test_zipcodes}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+	def test_get_zipcodes_by_locations()
+		test_city = "NewYork"
+		test_state = "NY"
+		VCR.use_cassette("zipcode_by_location", :record => :new_episodes) do
+			res = @@loc.get_zipcodes_by_locations("NewYork", "NY")
+			response = Net::HTTP.get_response(URI("http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/city-zips.json/#{test_city}/#{test_state}/km"))
+			assert_equal res, JSON.parse(response.body)
+		end
+	end
+
+end

data/test/vcr_cassettes/close_zipcodes.yml

@@ -0,0 +1,155 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/match-close.json/10001,10005/5/km
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 08 Mar 2016 11:34:06 GMT
+      Server:
+      - Apache/2.4.16 (Amazon) OpenSSL/1.0.1k-fips PHP/5.5.29
+      X-Powered-By:
+      - PHP/5.5.29
+      Content-Length:
+      - '2'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: "[]"
+    http_version: 
+  recorded_at: Tue, 08 Mar 2016 11:34:06 GMT
+- request:
+    method: get
+    uri: http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/match-close.json/10001,10005/5/km
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - www.zipcodeapi.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 08 Mar 2016 11:35:38 GMT
+      Server:
+      - Apache/2.4.16 (Amazon) OpenSSL/1.0.1k-fips PHP/5.5.29
+      X-Powered-By:
+      - PHP/5.5.29
+      Content-Length:
+      - '2'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: "[]"
+    http_version: 
+  recorded_at: Tue, 08 Mar 2016 11:35:39 GMT
+- request:
+    method: get
+    uri: http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/multi-info.json/10001,10005/km
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - www.zipcodeapi.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 08 Mar 2016 11:39:13 GMT
+      Server:
+      - Apache/2.4.16 (Amazon) OpenSSL/1.0.1k-fips PHP/5.5.29
+      X-Powered-By:
+      - PHP/5.5.29
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '300'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"10001":{"zip_code":"10001","lat":40.75065,"lng":-73.996924,"city":"New
+        York","state":"NY","timezone":{"timezone_identifier":"America\/New_York","timezone_abbr":"EST","utc_offset_sec":-18000,"is_dst":"F"},"acceptable_city_names":[{"city":"Empire
+        State","state":"NY"},{"city":"G P O","state":"NY"},{"city":"Greeley Square","state":"NY"},{"city":"Macys
+        Finance","state":"NY"},{"city":"Manhattan","state":"NY"}]},"10005":{"zip_code":"10005","lat":40.706015,"lng":-74.008959,"city":"New
+        York","state":"NY","timezone":{"timezone_identifier":"America\/New_York","timezone_abbr":"EST","utc_offset_sec":-18000,"is_dst":"F"},"acceptable_city_names":[{"city":"Manhattan","state":"NY"},{"city":"Nyc","state":"NY"},{"city":"Wall
+        Street","state":"NY"}]}}'
+    http_version: 
+  recorded_at: Tue, 08 Mar 2016 11:39:14 GMT
+- request:
+    method: get
+    uri: http://www.zipcodeapi.com/rest/3YJBA4WF9vpMJWjnh0otcznhkPzlsuRwtB74F4KOz9Bj6VGnV4Q8EepY3Zkwtc2X/multi-info.json/10001,10005/km
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - www.zipcodeapi.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 08 Mar 2016 11:48:12 GMT
+      Server:
+      - Apache/2.4.16 (Amazon) OpenSSL/1.0.1k-fips PHP/5.5.29
+      X-Powered-By:
+      - PHP/5.5.29
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '300'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"10001":{"zip_code":"10001","lat":40.75065,"lng":-73.996924,"city":"New
+        York","state":"NY","timezone":{"timezone_identifier":"America\/New_York","timezone_abbr":"EST","utc_offset_sec":-18000,"is_dst":"F"},"acceptable_city_names":[{"city":"Empire
+        State","state":"NY"},{"city":"G P O","state":"NY"},{"city":"Greeley Square","state":"NY"},{"city":"Macys
+        Finance","state":"NY"},{"city":"Manhattan","state":"NY"}]},"10005":{"zip_code":"10005","lat":40.706015,"lng":-74.008959,"city":"New
+        York","state":"NY","timezone":{"timezone_identifier":"America\/New_York","timezone_abbr":"EST","utc_offset_sec":-18000,"is_dst":"F"},"acceptable_city_names":[{"city":"Manhattan","state":"NY"},{"city":"Nyc","state":"NY"},{"city":"Wall
+        Street","state":"NY"}]}}'
+    http_version: 
+  recorded_at: Tue, 08 Mar 2016 11:48:12 GMT
+recorded_with: VCR 3.0.1