zipcode_locator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5b78f7c08e8e1715f181247b4b24728c5335978
-  data.tar.gz: 7f4503ecef0674087a4a6e5186eaba61e0354095
+  metadata.gz: 18e1a78bbee3dc754fee59d8fb53a4b89dbb9042
+  data.tar.gz: 50c3a34be10c188853778359bcc5c46435d83bb2
 SHA512:
-  metadata.gz: 1661b93313b0c54893858787bf05ea5b38803bf0171181596ceca9951de8c3be271a7c6d7bfee0516012bf4151910c04e8e0850349e36a13400290800edcbc5c
-  data.tar.gz: fb6df51d021c55d8567299c42a9fa6aac8dd7f6ca04357caca5ba46b2df26ed36cb2e988d92b0ebfc21430bad0b4349a686335679e6b0019bf2e14f136a97818
+  metadata.gz: 28077b809b6b21c955fda7dfbf8d0c7dc812b3b07f1c08cf144200f85e68f2ef5f5e8a3370f371b59f1d74da601be055f1d2d8fb907c329155e199d2acaa49cc
+  data.tar.gz: 5b8fa97fa956a88b86776a443b9e65165b13bcf79878c598f94c8f25c2f4e4c3c3007cf53a42d4f40fa96b19cbeb365d8888217c515d6f4fa423f0e18ac0c578

data/Gemfile

@@ -14,4 +14,5 @@ group :development do
   gem 'vcr'
   gem 'webmock'
   gem 'httparty'
+  gem 'nokogiri'
 end

data/Gemfile.lock

@@ -87,6 +87,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   httparty
   jeweler (~> 2.0.1)
+  nokogiri
   rdoc (~> 3.12)
   shoulda
   simplecov

data/README.rdoc

@@ -1,6 +1,81 @@
 = zipcode_locator
 
-Description goes here.
+Get Zipcodes and Location info by using ZipCode APIS.
+
+= Usage
+
+To use this gem, first you need to register your application at Zipcode API
+visit https://www.zipcodeapi.com/Register, give your application name and email, then obtain an apikey which can be used to communicate with zipcode apis.
+
+apikey = "xxxxxxxx"
+
+then, 
+
+  	$ gem install zipcode_locator
+
+	$ @object = ZipcodeLocator.new(apikey)
+
+= Zipcode Locator methods
+
+	zipcode_locator supports different units and reposnse formats, To get repsonse in particular format with a particulat unit, you can pass these as an optional parameter
+
+	optional parameter includes unit and format for the request.
+
+	unit can be any of these availble units  "km", "mile", "degree", and "radians"
+
+	format can be 'json', 'xml', and 'csv'
+
+	$ options = { :unit => "km", :format => "json" }
+
+== Zipcode Distance
+
+	$ zipcode1 = 10001
+	$ zipcode2 = 10005
+
+  	$ @object.distance_between_zipcodes(zipcode1, zipcode2, options)
+
+== Zipcodes By Radius
+
+	$ zipcode = 10001
+	$ radius = 5
+
+  	$ @object.get_zipcodes_by_radius(zipcode, radius, options)
+
+== Find close Zipcodes
+
+	$ zipcodes = "10001, 10005"
+
+	or
+
+	$ zipcodes = [10001, 10005]
+	$ distance = 5
+
+  	$ @object.find_close_zipcodes(zipcodes, distance, options)
+
+== Zipcode to Location info
+
+	$ zipcode = 10005
+
+  	$ @object.zipcode_location_info(zipcode, options)
+
+== Multi Zipcodes to Location info
+
+	$ zipcodes = "10001, 10005"
+
+	or
+
+	$ zipcodes = [10001, 10005]
+
+  	$ @object.multi_zipcodes_location_info(zipcodes, options)
+
+== Location to Zipcodes
+
+	$ city = "Brooklyn"
+	$ state = "NY"
+
+  	$ @object.get_zipcodes_by_locations(city, state, options)
+
+
 
 == Contributing to zipcode_locator
  

data/Rakefile

@@ -17,7 +17,7 @@ Jeweler::Tasks.new do |gem|
   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.summary = %Q{Get Zipcodes and Location info by using ZipCode APISe}
   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"]

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/zipcode_locator.rb

@@ -1,61 +1,60 @@
 require 'zipcode_locator/unit'
-
-require 'httparty'
+require 'zipcode_locator/format'
+require 'zipcode_locator/response'
+require 'zipcode_locator/locator'
 
 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
+	def distance_between_zipcodes(zip_code1, zip_code2, options = {})
+		options = {} unless options.is_a? Hash
+		unit, format = Locator.init(options[:unit], options[:format])
 		url = "http://www.zipcodeapi.com/rest/#{@api_key}/distance.#{format}/#{zip_code1}/#{zip_code2}/#{unit}"
-		JSON.parse(HTTParty.get(url).body)
+		response = Locator.get_response(url, format)
 	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
+	def get_zipcodes_by_radius(zip_code, radius, options = {})
+		options = {} unless options.is_a? Hash
+		unit, format = Locator.init(options[:unit], options[:format])
 		url = "http://www.zipcodeapi.com/rest/#{@api_key}/radius.#{format}/#{zip_code}/#{radius}/#{unit}"
-		JSON.parse(HTTParty.get(url).body)
+		response = Locator.get_response(url, format)
 	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(',')
+	def find_close_zipcodes(zip_codes, distance, options = {})
+		options = {} unless options.is_a? Hash
+		unit, format = Locator.init(options[:unit], options[:format])
+		zip_codes = [zip_codes].flatten.join(',')
 		url = "http://www.zipcodeapi.com/rest/#{@api_key}/match-close.#{format}/#{zip_codes}/#{distance}/#{unit}"
-		JSON.parse(HTTParty.get(url).body)
+		response = Locator.get_response(url, format)
 	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
+	def zipcode_location_info(zip_code, options = {})
+		options = {} unless options.is_a? Hash
+		unit, format = Locator.init(options[:unit], options[:format])
 		url = "http://www.zipcodeapi.com/rest/#{@api_key}/info.#{format}/#{zip_code}/#{unit}"
-		JSON.parse(HTTParty.get(url).body)
+		response = Locator.get_response(url, format)
 	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(',')
+	def multi_zipcodes_location_info(zip_codes, options = {})
+		options = {} unless options.is_a? Hash
+		unit, format = Locator.init(options[:unit], options[:format])
+		zip_codes = [zip_codes].flatten.join(',')
 		url = "http://www.zipcodeapi.com/rest/#{@api_key}/multi-info.#{format}/#{zip_codes}/#{unit}"
-		JSON.parse(HTTParty.get(url).body)
+		response = Locator.get_response(url, format)
 	end
 
-	def get_zipcodes_by_locations(city, state)
+	def get_zipcodes_by_locations(city, state, options = {})
+		options = {} unless options.is_a? Hash
 		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)
+		format = Format.set(options[:format])
+		url = "http://www.zipcodeapi.com/rest/#{@api_key}/city-zips.#{format}/#{city}/#{state}"
+		response = Locator.get_response(url, format)
 	end
 
 end

data/lib/zipcode_locator/format.rb

@@ -0,0 +1,17 @@
+module Format
+	DEFAULT_FORMAT = "json"
+	AVAILABLE_FORMATS = ["json", "xml", "csv"]
+
+	def self.default_format
+		DEFAULT_FORMAT
+	end
+
+	def self.available_formats
+		AVAILABLE_FORMATS
+	end
+
+	def self.set(format)
+		AVAILABLE_FORMATS.include?(format) ? format : DEFAULT_FORMAT
+	end
+end
+

data/lib/zipcode_locator/locator.rb

@@ -0,0 +1,21 @@
+require 'zipcode_locator/unit'
+require 'zipcode_locator/format'
+require 'zipcode_locator/response'
+
+module Locator
+
+	def self.init(unit, format)
+		[Unit.set(unit), Format.set(format)]
+	end
+
+	def self.get_response(url, format)
+		case format
+		when "json"
+			Response.json(url)
+		when "xml"
+			Response.xml(url)
+		when "csv"
+			Response.csv(url)
+		end
+	end
+end

data/lib/zipcode_locator/response.rb

@@ -0,0 +1,37 @@
+require 'httparty'
+require 'nokogiri'
+
+module Response
+
+	ERROR_JSON_RESPONSE = { status: 400, message: "error" }
+	ERROR_XML_RESPONSE = "<?xml version=\"1.0\"?>\n<response>\n  <status>400</status>\n<message>error</message>\n</response>\n"
+	ERROR_CSV_RESPONSE = "status,message\n400,error\n"
+
+	def self.json(url)
+		zipcode_response = HTTParty.get(url)
+		if zipcode_response.code == 200
+			JSON.parse(zipcode_response.body)
+		else
+			ERROR_JSON_RESPONSE
+		end
+	end
+
+	def self.xml(url)
+		zipcode_response = HTTParty.get(url)
+		if zipcode_response.code == 200
+			Nokogiri::XML(zipcode_response.body).to_xml
+		else
+			ERROR_XML_RESPONSE
+		end
+	end
+
+	def self.csv(url)
+		zipcode_response = HTTParty.get(url)
+		if zipcode_response.code == 200
+			zipcode_response.body
+		else
+			ERROR_CSV_RESPONSE
+		end
+	end
+end
+

data/lib/zipcode_locator/unit.rb

@@ -1,14 +1,17 @@
-	
-	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
+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
+
+	def self.set(unit)
+		AVAILABLE_UNITS.include?(unit) ? unit : DEFAULT_UNIT
 	end
+end
 

data/test/helper.rb

@@ -34,7 +34,7 @@ require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'locator'
+require 'zipcode_locator'
 
 class Minitest::Test
 end

data/test/test_zipcode_locator.rb

@@ -46,7 +46,7 @@ class TestZipcodeLocator < Minitest::Test
 	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)
+			res = @@loc.multi_zipcodes_location_info([10001, 10005])
 			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

data/zipcode_locator.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: zipcode_locator 0.1.1 ruby lib
+# stub: zipcode_locator 0.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "zipcode_locator"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["anildias"]
-  s.date = "2016-03-10"
+  s.date = "2016-03-14"
   s.description = "Locate place with the help of Zip code API within a given distance by inputting zipcode"
   s.email = "anildiasdavis@gmail.com"
   s.extra_rdoc_files = [
@@ -27,6 +27,9 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/zipcode_locator.rb",
+    "lib/zipcode_locator/format.rb",
+    "lib/zipcode_locator/locator.rb",
+    "lib/zipcode_locator/response.rb",
     "lib/zipcode_locator/unit.rb",
     "test/helper.rb",
     "test/test_zipcode_locator.rb",
@@ -41,7 +44,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/anildias/zipcode_locator"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.3"
-  s.summary = "Locate place with the help of Zip code API within a given distance by inputting zipcode"
+  s.summary = "Get Zipcodes and Location info by using ZipCode APISe"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -55,6 +58,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<vcr>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -64,6 +68,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<vcr>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -74,6 +79,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<vcr>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipcode_locator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - anildias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: Locate place with the help of Zip code API within a given distance by
   inputting zipcode
 email: anildiasdavis@gmail.com
@@ -139,6 +153,9 @@ files:
 - Rakefile
 - VERSION
 - lib/zipcode_locator.rb
+- lib/zipcode_locator/format.rb
+- lib/zipcode_locator/locator.rb
+- lib/zipcode_locator/response.rb
 - lib/zipcode_locator/unit.rb
 - test/helper.rb
 - test/test_zipcode_locator.rb
@@ -172,6 +189,5 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: Locate place with the help of Zip code API within a given distance by inputting
-  zipcode
+summary: Get Zipcodes and Location info by using ZipCode APISe
 test_files: []