fcc 0.1.0

data/.document

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2-head@fccc

data/Gemfile

@@ -0,0 +1,16 @@
+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.
+
+gem "nokogiri"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Keen
+
+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,28 @@
+= fcc
+
+Queries the FCC database for FM information.
+
+FCC::FM.find("KUT") #=> KUT station info
+
+FCC::AM.find("KLBJ") #=> KLBJ station info
+
+FCC::FM.find_all(:city => "Austin", :state => "TX") #=> [FM::Station, FM::Station, FM::Station]
+
+
+TODO: Dry some of this out.
+
+== Contributing to fcc
+ 
+* 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) 2011 Jeff Keen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+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://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fcc"
+  gem.homepage = "http://github.com/jkeen/fcc"
+  gem.license = "MIT"
+  gem.summary = %Q{Searches the FCC's FM and AM databases}
+  gem.description = %Q{}
+  gem.email = "jeff@keen.me"
+  gem.authors = ["Jeff Keen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fcc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/am.rb

@@ -0,0 +1,126 @@
+require 'open-uri'
+
+module FCC
+  class AM
+    class Station
+      attr_reader :call_letters, :band, :hours, :file_number, :station_class, :fcc_id, :city, :state, :country, :licensed_to, :latitude, :longitude
+      def initialize(*fields)
+        @raw =                fields
+        @call_letters =       fields[0]
+        @frequency =          fields[1]
+        @band =               fields[2]
+        #                     fields[3]  # Not used for AM
+        #                     fields[4]  # Directional Antenna (DA) or NonDirectional (ND)
+        @hours =              fields[5]  # Hours of operation for this record (daytime, nighttime, or unlimited)
+        @domestic_class =     fields[6]  # Domestic US Station class
+        @international_class =fields[7]  # International station class
+        @fm_status =          fields[8]
+        @city =               fields[9]
+        @state =              fields[10]
+        @country =            fields[11]
+        @file_number =        fields[12] # File Number (Application, Construction Permit or License) or Docket Number (Rulemaking)
+        @signal_strength =    fields[13] # Power
+        #                     fields[14] # Not used
+        #                     fields[15] # Not used
+        #                     fields[16] # Not used
+        @fcc_id =             fields[17] # Facility ID Number (unique to each station)
+        @latitude =           latitude(fields[18], fields[19], fields[20], fields[21])
+        @longitude =          longitude(fields[22], fields[23], fields[24], fields[25])
+
+        @licensed_to =        fields[26] # Licensee or Permittee
+        #                     fields[27] # Kilometers distant (radius) from entered latitude, longitude
+        #                     fields[28] # Miles distant (radius) from entered latitude, longitude
+        #                     fields[29] # Azimuth, looking from center Lat, Lon to this record's Lat, Lon
+        #                     fields[30] # Application ID number (from CDBS database)***
+      end
+      
+      private 
+      
+      def longitude(direction, degrees, minutes, seconds)
+        "#{(direction =~ /S/ ? "-" : "")}#{degrees}.#{minutes}"
+      end
+
+      def latitude(direction, degrees, minutes, seconds)
+        "#{(direction =~ /S/ ? "-" : "")}#{degrees}.#{minutes}"
+      end
+
+      def signal_strength(raw_signal)
+        raw_signal.gsub(/\.\s+/, ".0 ") if raw_signal
+      end
+
+      def frequency(freq)
+        freq[/[0-9]+\.?[0-9]/] if freq
+      end
+    end
+
+    BASE_URL = "http://www.fcc.gov/fcc-bin/amq"
+
+    def self.find(call_letters)
+      raise ArgumentError, "no call letters were supplied" if call_letters.nil? || call_letters.strip.length == 0
+
+      find_all(:call_letters => call_letters).first
+    end
+
+    def self.find_all(conditions = {})
+      results = []
+      query(conditions.merge(:band => "AM")) do |feed|
+        feed.each_line do |row|
+          fields = row.split("|").select { |field| (field.strip! && !field.nil?)}
+          results << Station.new(*fields)
+        end
+      end
+      # if call letters are supplied, return matches that match call letters exactly.
+      # FCC does partial matches (from the start of the string), so that "KUT" will return "KUTT", also
+      if conditions[:call_letters]
+        exact_matches =  results.select { |d| d.call_letters == conditions[:call_letters] }
+        results = exact_matches if (exact_matches)
+      end
+
+      #sort by signal strength
+      if results.size > 1
+        results.sort_by { |s| s.signal_strength}.reverse
+      else
+        results
+      end
+    end
+
+    private
+
+    def self.query(conditions = {})
+      query = ""
+      prepare_args(conditions).each { |k,v| query += "#{k}=#{v}&" }
+      url = "#{BASE_URL}?#{query}"
+      feed = open(url)
+      yield feed
+    end
+
+    def self.prepare_args(params)
+      return {
+        :state => params[:state],
+        :call => params[:call_letters],
+        :city => params[:city],
+        :arn => nil,
+        :serv => params[:band],
+        :vac => nil,
+        :freq => params[:frequency] || params[:frequency_lower] || "530",
+        :fre2 => params[:frequency] || params[:frequency_upper] || "1700",
+        :facid => nil,
+        :class => nil,
+        :dkt => nil,
+        :dist => nil,
+        :dlat2 => nil,
+        :dlon2 => nil,
+        :mlon2 => nil,
+        :mlat2 => nil,
+        :slat2 => nil,
+        :slon2 => nil,
+        # :NS => "N",
+        # :e => 9,
+        :EW => "W",
+        :list => 4, # pipe separated output
+        :size => 9
+       }
+    end
+
+  end
+end

data/lib/fcc.rb

@@ -0,0 +1,3 @@
+require 'open-uri'
+require 'fm'
+require 'am'

data/lib/fm.rb

@@ -0,0 +1,144 @@
+require 'open-uri'
+
+module FCC
+  class FM
+    class Station
+      attr_reader :call_letters, :band, :channel, :fm_status, :latitude, :longitude, :file_number, :station_class, :fcc_id, :city, :state, :country, :licensed_to
+      def initialize(*fields)
+        @raw =                fields
+        @call_letters =       fields[0]
+        @frequency =          frequency(fields[1])
+        @band =               fields[2]
+        @channel =            fields[3]
+        #                     fields[4]  # Directional Antenna (DA) or NonDirectional (ND)
+        #                     fields[5]  # (Not Used for FM)
+        @station_class =      fields[6]
+        #                     fields[7]  # (Not Used for FM)
+        @fm_status =          fields[8]
+        @city =               fields[9]
+        @state =              fields[10]
+        @country =            fields[11]
+        @file_number =        fields[12] # File Number (Application, Construction Permit or License) or Docket Number (Rulemaking)
+        @signal_strength =    signal_strength(fields[13]) # Effective Radiated Power -- horizontally polarized  (maximum)
+        #                     fields[14] # Effective Radiated Power -- vertically polarized  (maximum)
+        #                     fields[15] # Antenna Height Above Average Terrain (HAAT) -- horizontal polarization
+        #                     fields[16] # Antenna Height Above Average Terrain (HAAT) -- vertical polarization
+        @fcc_id =             fields[17] # Facility ID Number (unique to each station)
+
+        @latitude =           latitude(fields[18], fields[19], fields[20], fields[21])
+        @longitude =          longitude(fields[22], fields[23], fields[24], fields[25])
+
+        @licensed_to =        fields[26] # Licensee or Permittee
+        #                     fields[27] # Kilometers distant (radius) from entered latitude, longitude
+        #                     fields[28] # Miles distant (radius) from entered latitude, longitude
+        #                     fields[29] # Azimuth, looking from center Lat, Lon to this record's Lat, Lon
+        #                     fields[30] # Antenna Radiation Center Above Mean Sea Level (RCAMSL) - Horizontally Polarized - meters
+        #                     fields[31] # Antenna Radiation Center Above Mean Sea Level (RCAMSL) - Vertically Polarized - meters
+        #                     fields[32] # Directional Antenna ID Number
+        #                     fields[33] # Directional Antenna Pattern Rotation (degrees)
+        #                     fields[34] # Antenna Structure Registration Number
+        #                     fields[35] # Application ID number (from CDBS database)***
+      end
+
+      def good?
+        return false if @call_letters == "NEW"
+        return false if @call_letters == "-"
+        return false if @band != "FM"
+        #@call_letters =~ /^[^0-9]/
+
+        true
+      end
+
+      private
+
+      def longitude(direction, degrees, minutes, seconds)
+        "#{(direction =~ /S/ ? "-" : "")}#{degrees}.#{minutes}"
+      end
+
+      def latitude(direction, degrees, minutes, seconds)
+        "#{(direction =~ /S/ ? "-" : "")}#{degrees}.#{minutes}"
+      end
+
+      def signal_strength(raw_signal)
+        raw_signal.gsub(/\.\s+/, ".0 ") if raw_signal
+      end
+
+      def frequency(freq)
+        freq[/[0-9]+\.?[0-9]/] if freq
+      end
+    end
+
+    BASE_URL = "http://www.fcc.gov/fcc-bin/fmq"
+
+    def self.find(call_letters)
+      raise ArgumentError, "no call letters were supplied" if call_letters.nil? || call_letters.strip.length == 0
+
+      find_all(:call_letters => call_letters).first
+    end
+
+    def self.find_all(conditions = {})
+      results = []
+      query(conditions.merge(:band => "FM")) do |feed|
+        feed.each_line do |row|
+          fields = row.split("|").select { |field| (field.strip! && !field.nil?)}
+          results << Station.new(*fields)
+        end
+      end
+      #remove invalid values, such as "NEW", or "-", stations starting with numbers, and non-FM bands
+      results = results.select(&:good?)
+      # if call letters are supplied, return matches that match call letters exactly.
+      # FCC does a starts_with search, so that "KUT" will return "KUTT", also
+      if conditions[:call_letters]
+        exact_matches =  results.select { |d| d.call_letters == conditions[:call_letters] }
+        results = exact_matches if (exact_matches)
+      end
+
+      results
+      #sort by signal strength
+      if results.size > 1
+        results.sort_by { |s| s.signal_strength}.reverse
+      else
+        results
+      end
+    end
+
+    private
+
+    def self.query(conditions = {})
+      query = ""
+      prepare_args(conditions).each { |k,v| query += "#{k}=#{v}&" }
+      url = "#{BASE_URL}?#{query}"
+      feed = open(url)
+      yield feed
+    end
+
+    def self.prepare_args(params)
+      return {
+        :state => params[:state],
+        :call => params[:call_letters],
+        :city => params[:city],
+        :arn => nil,
+        :serv => params[:band],
+        :vac => nil,
+        :freq => params[:frequency] || params[:frequency_lower] || "0.0",
+        :fre2 => params[:frequency] || params[:frequency_upper] || "108.0",
+        :facid => nil,
+        :class => nil,
+        :dkt => nil,
+        :dist => nil,
+        :dlat2 => nil,
+        :dlon2 => nil,
+        :mlon2 => nil,
+        :mlat2 => nil,
+        :slat2 => nil,
+        :slon2 => nil,
+        # :NS => "N",
+        # :e => 9,
+        :EW => "W",
+        :list => 4, # pipe separated output
+        :size => 9
+       }
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fcc'
+
+class Test::Unit::TestCase
+end

data/test/test_fcc.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFcc < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: fcc
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Keen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-30 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: nokogiri
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  name: shoulda
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+  prerelease: false
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+  prerelease: false
+  name: jeweler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  prerelease: false
+  name: rcov
+  type: :development
+description: ""
+email: jeff@keen.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/am.rb
+- lib/fcc.rb
+- lib/fm.rb
+- test/helper.rb
+- test/test_fcc.rb
+has_rdoc: true
+homepage: http://github.com/jkeen/fcc
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Searches the FCC's FM and AM databases
+test_files: 
+- test/helper.rb
+- test/test_fcc.rb