hamfinder 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ae413fae85a09aa7ae2408ace383eebfaae8f86
-  data.tar.gz: 900b14febd85244a36819dafadefea1d87e27502
+  metadata.gz: fe4d63b3c0d14740d88adb2fa45e50b15339d809
+  data.tar.gz: aedd8fa4043c82027aa00d49951b8e15b2f17dfd
 SHA512:
-  metadata.gz: b382f04feefba07a6a054206d3f0351fe34466bf0e5bf278e21751034b54975b71ba14b5b0fa04301d97314f93b75405c06fa0f39eb0aa8c7f16e3a8dea78df2
-  data.tar.gz: 12b51aeabb7a572a6a9a0e91a2dd0e3b2cbb875c307767055f0f70b5c4414b4b26a112576d72ecf68c32ff2d7dc9df20205ce1f24ce53216c8d94cff535e1295
+  metadata.gz: 107e3a50229ca9236f097892f6754f3cca24d807e6aa4a295b1189978b2e85185f693850ec91748c7052c6b122e9a40e720bc2e67695b95e593925f055f547ee
+  data.tar.gz: 0d736a56ea51150e63193b81141d8a20d98fff2525263ae8d4a86ca6e427869c9a1a941a8b819ca4f98ec8c75225a560ba88641330f2af840d38561e1ed8f0a7

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    hamfinder (0.1.1)
+    hamfinder (0.2.2)
+      json (~> 1.8)
       nokogiri (~> 1.6)
 
 GEM
@@ -13,13 +14,13 @@ GEM
       url
     diff-lcs (1.2.5)
     docile (1.1.5)
-    json (2.0.2)
+    json (1.8.3)
     mini_portile2 (2.1.0)
     nokogiri (1.6.8)
       mini_portile2 (~> 2.1.0)
       pkg-config (~> 1.1.7)
     pkg-config (1.1.7)
-    rake (11.2.2)
+    rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)

data/README.md

@@ -1,4 +1,5 @@
-# HAMfinder   [![Build Status](https://travis-ci.org/jasonallenphotography/HAMfinder_gem.svg?branch=master)](https://travis-ci.org/jasonallenphotography/HAMfinder_gem)  [![codecov](https://codecov.io/gh/jasonallenphotography/HAMfinder_gem/branch/master/graph/badge.svg)](https://codecov.io/gh/jasonallenphotography/HAMfinder_gem)
+# HAMfinder   [![Build Status](https://travis-ci.org/jasonallenphotography/HAMfinder_gem.svg?branch=master)](https://travis-ci.org/jasonallenphotography/HAMfinder_gem)  [![codecov](https://codecov.io/gh/jasonallenphotography/HAMfinder_gem/branch/master/graph/badge.svg)](https://codecov.io/gh/jasonallenphotography/HAMfinder_gem)  [![Gem Version](https://badge.fury.io/rb/hamfinder.svg)](https://badge.fury.io/rb/hamfinder) [![Dependency Status](https://gemnasium.com/badges/github.com/jasonallenphotography/HAMfinder_gem.svg)](https://gemnasium.com/github.com/jasonallenphotography/HAMfinder_gem)
+
 
 
 HAMfinder is a Ruby gem built to make developing Ruby on Rails-based amateur radio programs easier to develop.
@@ -38,7 +39,63 @@ Or install it yourself as:
 
 ## Usage
 
-COMING SOON! Check back after Wednesday, 14 September, 2016.
+When using HAMfinder, you must first instantiate a new parser in your application:
+
+```ruby
+parser = Hamfinder::Parser.new
+```
+
+Now you can use your parser's query method to retrieve data according to your provided parameters.
+
+```ruby
+@results = parser.query( zip:"11232", radius:5, band:"2m" )
+```
+
+The `.query()` method accepts the following options:
+* zip
+* radius
+* band
+
+
+The `zip` parameter must be a valid 5 digit US postal zip code passed as a string (i.e. `zip:"22181"`).
+
+The `radius` parameter (in miles) must be an integer greater than 0 and less than or equal to 200 (i.e. `radius:50`). If no radius is entered as a parameter the default is a radius of 10 miles, roughly the maximum distance a low powered handheld radio can reach on 2m band.
+
+The `band` parameter specifies the frequency band you wish to query, and must be passed as a string. `band` accepts the following values, or defaults to `2m`:
+* `"10m"`
+* `"6m"`
+* `"2m"`
+* `"1.25m"`
+* `"70cm"`
+* `"33cm"` 
+* `"23cm"`  
+
+Examples of output:
+```ruby
+#10m band repeaters within 5 miles of 20009, Washington DC
+puts parser.query( zip:"20009", band:"10m", radius:5 )
+=> ["NO REPEATERS FOUND WITHIN 5 MILES of 38.9191485, -77.0362967."]
+
+#2m band repeaters within 2 miles of 20009, Washington DC
+puts parser.query( zip:"20009", radius:2 )
+=> { :W3DOS=>{:frequency=>"145.1900", :offset=>"-0.6MHz", :tone=>"151.4", :call=>"W3DOS", 
+              :location=>"Washington,HarryS.TrumanBuilding", :state=>"DC", :usage=>"OPEN", 
+              :voip=>"", :distance=>"1.7", :direction=>"S"}, 
+     :W3AGB=>{:frequency=>"147.3600", :offset=>"+0.6MHz", :tone=>"", :call=>"W3AGB",
+              :location=>"Washington", :state=>"DC", :usage=>"OPEN",
+              :voip=>"", :distance=>"1.7", :direction=>"S"},
+     :K4DCA=>{:frequency=>"145.1100", :offset=>"-0.6MHz", :tone=>"CC1", :call=>"K4DCA", 
+              :location=>"Washington", :state=>"DC", :usage=>"OPEN",
+              :voip=>"", :distance=>"0.8", :direction=>"S"},
+     :K3MRC=>{:frequency=>"145.4300", :offset=>"-0.6MHz", :tone=>"114.8", :call=>"K3MRC", 
+              :location=>"Washington,D.C.", :state=>"DC", :usage=>"OPEN", 
+              :voip=>"", :distance=>"1.7", :direction=>"S"} }
+
+#2m band repeaters within a default 10 miles of 20009, Washington DC     
+puts parser.query( zip:"20009" )
+=> {:W4HFH=>{:frequency=>"147.3150", :offset=>"+0.6MHz", :tone=>"107.2", :call=>"W4HFH", 
+             ...
+```
 
 ## Contributing
 

data/hamfinder.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jasoncaryallen@gmail.com"]
 
   spec.summary       = %q{Return queried HAM radio repeater stations}
-  spec.description   = %q{Querying Repeaterbook.com's data using application-defined criteria, this gem returns a collection of repeaters matching the criteria as JSON objects - conveniently named by their callsigns!}
+  spec.description   = %q{Querying Repeaterbook.com's data using application-defined criteria, this gem returns a collection of repeaters matching the criteria as JSON - conveniently sorted by proximity!}
   spec.homepage      = "https://github.com/jasonallenphotography/HAMfinder_gem"
   spec.license       = "MIT"
 
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency("json", "~> 1.8")
   spec.add_dependency("nokogiri", "~> 1.6")
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/hamfinder.rb

@@ -2,7 +2,7 @@ require "hamfinder/version"
 
 module Hamfinder
 	class Parser
-		def query(options = {})
+		def self.query(options = {})
 			band = band_selection(options[:band])
 			options[:radius] ? radius = set_radius(options[:radius]) : radius = "&distance=10&Dunit=m"
 			zip = set_zip(options[:zip])
@@ -12,7 +12,7 @@ module Hamfinder
 
 		private
 
-		def parse(url)
+		def self.parse(url)
 			# Captures the queried URL from Repeaterbook.com
 			doc = Nokogiri::HTML(open(url))
 
@@ -30,12 +30,13 @@ module Hamfinder
 			else
 		  	tidy_tds = sanitize(all_tds)
 		  	repeater_array = organize(tidy_tds)
+		  	repeater_array.sort! {|x,y| x[8].to_f <=> y[8].to_f }
 		  	generate_JSON(repeater_array)
 			end
 		end
 
 		# returns band parameter for URL
-		def band_selection(band)
+		def self.band_selection(band)
 			case band
 				when "10m"   
 					return "&band=29"
@@ -57,7 +58,7 @@ module Hamfinder
 		end
 
 		# returns only valid user-defined radius OR 25mi for radius parameter for URL
-		def set_radius(radius)
+		def self.set_radius(radius)
 			if radius > 0 && radius <= 200
 				return "&distance=#{radius}&Dunit=m"
 			else
@@ -66,14 +67,14 @@ module Hamfinder
 		end
 
 		# returns city parameter for URL
-		def set_zip(zip)
+		def self.set_zip(zip)
 			return "city=#{zip}"
 		end
 
 		# Sanitizes non-breaking space characters,
 		# linebreaks, and spaces throughout table data
 		# introduced by source
-		def sanitize(collection)
+		def self.sanitize(collection)
 		  collection.each do |td|
 		    td.gsub!("\u00A0", "")
 		    td.gsub!("\n", "")
@@ -83,7 +84,7 @@ module Hamfinder
 
 		# Organizes the data from the orphaned <td>s 
 		# by row into an array
-		def organize(collection)
+		def self.organize(collection)
 			data = []
 		    until collection.empty?
 		      row = collection.shift(11)
@@ -94,8 +95,9 @@ module Hamfinder
 		end
 
 		# Parse to JSON FORMAT and return
-		def generate_JSON(data)
+		def self.generate_JSON(data)
 			output = {}
+			index = 0
 				data.each do |repeater|
 		     r = {frequency: "#{repeater[0]}",
 				      offset:    "#{repeater[1]}",
@@ -107,10 +109,11 @@ module Hamfinder
 				      voip:      "#{repeater[7]}",
 				      distance:  "#{repeater[8]}",
 				      direction: "#{repeater[9]}"}
-				output[repeater[3].to_sym] = r
+				output[index.to_s.to_sym] = r
+				index +=1
 				end
-			output
+			output.to_json
 		end
 
 	end #parser
-end #module
+end #module

data/lib/hamfinder/version.rb

@@ -1,3 +1,3 @@
 module Hamfinder
-  VERSION = "0.1.2"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hamfinder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Jason Allen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -67,8 +81,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Querying Repeaterbook.com's data using application-defined criteria,
-  this gem returns a collection of repeaters matching the criteria as JSON objects
-  - conveniently named by their callsigns!
+  this gem returns a collection of repeaters matching the criteria as JSON - conveniently
+  sorted by proximity!
 email:
 - jasoncaryallen@gmail.com
 executables: []