fcc 0.1.0 → 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1a2e65473c73d939b88beed853dfe8cb2ab4bb67684c522996a4b1eb0f8d7f8
+  data.tar.gz: d86f808b6da433d743ac6e2546307cf4bdfeb42ec521796cb78a0ecfffb7da63
+SHA512:
+  metadata.gz: e6a3bea8e717984ddd25fed17731e3ba06709c70dcb49340a274d148fcdd281e1463baf6483879d9a2427961589f2e0d7af908d8ce4ab6508776c8ba1d80c5e3
+  data.tar.gz: 6da0ba2408b94f8488c45900938d3950e580a5cb71493b942a78696b462f0bc4dee61ea26b5bf4cbd1c54a155ad0b0c5670cde37e90c99ede9581b196cd75586

data/.gitignore

@@ -0,0 +1,41 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+.byebug_history
+.vscode
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -1,16 +1,23 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+git_source(:github) { |repo_name| 'https://github.com/jkeen/fcc' }
 
-gem "nokogiri"
+# Specify your gem's dependencies in popularity.gemspec
+gemspec
 
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end
+#
+# 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"
+#   gem "jeweler"
+# end

data/Gemfile.lock

@@ -1,22 +1,61 @@
+PATH
+  remote: .
+  specs:
+    fcc (1.1)
+      activesupport (>= 6.1)
+      httparty (~> 0.18)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://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)
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.8.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.6)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.2)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  nokogiri
-  rcov
-  shoulda
+  awesome_print
+  bundler (~> 2.1)
+  byebug
+  fcc!
+  rake (~> 12.3.3)
+  rspec (~> 3.9.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,60 @@
+# fcc
+
+Query the FCC database for fm, am, and tv information.
+
+## Install
+
+```
+gem install fcc
+```
+
+## Requirements
+
+* Ruby 2.0.0 or higher
+
+## Examples
+
+#### Get station information by call sign
+
+```ruby
+station = FCC::Station.find(:fm, "KOOP")
+
+#Basic attributes, available quickly because the FCC actually caches these in a CDN: 
+station.id #=> 65320
+station.status #=> LICENSED
+station.rf_channel #=> 219
+station.license_expiration_date #=> "08/01/2021"
+station.facility_type #=> ED
+station.frequency #=> 91.7 
+station.contact #=> <struct FCC::Station::Contact>
+station.owner #=> <struct FCC::Station::Contact>
+station.community #=> <struct FCC::Station::Community city="HORNSBY", state="TX">
+
+#Extended attributes, takes several seconds to load because the FCC is running this endpoint on a 1960s era mainframe operated by trained hamsters
+station.station_class #=> A
+station.signal_strength #=> 3.0 kW
+station.antenna_type #=> ND
+station.effective_radiated_power #=> 3.0 kW
+station.haat_horizontal #=> 26.0
+station.haat_vertical #=> 26.0
+station.latitude #=> "30.266861111111112"
+station.longitude #=> "-97.67444444444445"
+station.file_number #=> BLED-19950103KA
+```
+
+### Get all station call signs on a particular service (:fm, :am, :tv)
+
+```ruby
+results = FCC::Station.index(:fm).results
+#=> [{"id"=>"198674", "callSign"=>"KANC", "frequency"=>"99.7", "activeInd"=>"Y"}, {"id"=>"174558", "callSign"=>"WUMZ", "frequency"=>"91.5", "activeInd"=>"Y"}, {"id"=>"184688", "callSign"=>"WHVC", "frequency"=>"102.5", "activeInd"=>"Y"} .... 
+```
+
+## 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.

data/Rakefile

@@ -7,47 +7,11 @@ rescue Bundler::BundlerError => e
   $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') : ""
+require 'rake'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "fcc #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+RSpec::Core::RakeTask.new(:spec)
+desc 'Runs the specs'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fcc'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fcc.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name = %q{fcc}
+  spec.version = FCC::VERSION
+  spec.authors = ["Jeff Keen"]
+  spec.date = %q{2011-01-30}
+  spec.description = %q{}
+  spec.email = %q{jeff@keen.me}
+  spec.homepage      = "http://github.com/jkeen/fcc"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.homepage = %q{http://github.com/jkeen/fcc}
+  spec.licenses = ["MIT"]
+  spec.rubygems_version = %q{1.4.1}
+  spec.summary = %q{Searches the FCC's FM, AM, and TV databases}
+  spec.add_dependency "activesupport", ">= 6.1"
+  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency "byebug", ">= 0"
+  spec.add_development_dependency "awesome_print", ">= 0"
+end

data/lib/fcc.rb

@@ -1,3 +1,10 @@
-require 'open-uri'
-require 'fm'
-require 'am'
+# frozen_string_literal: true
+require_relative './fcc/station'
+require_relative './fcc/station/cache'
+require_relative './fcc/station/info'
+require_relative './fcc/station/extended_info'
+require_relative './fcc/station/result_delegate'
+
+module FCC
+
+end

data/lib/fcc/station.rb

@@ -0,0 +1,107 @@
+require 'active_support/core_ext/module/delegation'
+require_relative 'station/result_delegate'
+require_relative 'station/extended_info'
+require_relative 'station/index'
+require_relative 'station/info'
+
+module FCC
+  module Station
+    Contact = Struct.new(:name, :title, :address, :address2, :city, :state, :zip_code, :phone, :fax, :email, :website, keyword_init: true)
+    Community = Struct.new(:city, :state, keyword_init: true)
+
+    def self.find_each(service, &block)
+      results = index(service).results
+
+      results.each do |result|
+        yield find(service, result['callSign'])
+      end
+    end
+
+    def self.find(service, call_sign, options = {})
+      Result.new(service, call_sign, options)
+    end
+
+    def self.index(service)
+      case service.to_s.downcase.to_sym
+      when :fm
+        @fm_index ||= Index.new(:fm)
+      when :am
+        @am_index ||= Index.new(:am)
+      when :tv
+        @tv_index ||= Index.new(:tv)
+      else
+        raise "unsupported service #{service}. :fm, :am, and :tv are valid"
+      end
+    end
+
+    def self.extended_info_cache(service) 
+      @cache ||= {}
+      @cache[service] ||= Station::Cache.new(service)
+      @cache[service]
+    end
+
+    class Result
+      EXTENDED_ATTRIBUTES = %i[signal_strength latitude longitude coordinates station_class file_number effective_radiated_power haat_horizontal haat_vertical] # these take a long time to query
+      BASIC_ATTRIBUTES    = %i[id call_sign status rf_channel license_expiration_date facility_type frequency]
+
+      delegate *EXTENDED_ATTRIBUTES, to: :extended_data 
+      delegate *BASIC_ATTRIBUTES, to: :data
+
+      alias_method :channel, :rf_channel
+
+      def initialize(service, call_sign, options = {})
+        @call_sign = call_sign.upcase
+        @service = service
+        @options = options
+
+        data
+      end
+
+      def to_json
+        {}.tap do |hash|
+          [EXTENDED_ATTRIBUTES | BASIC_ATTRIBUTES | %i[contact owner community]].flatten.each do |attr|
+            result = send(attr.to_sym)
+            if result.respond_to?(:to_h)
+              hash[attr] = result.to_h
+            else
+              hash[attr] = result.to_s
+            end
+          end
+        end
+      end
+
+      def owner
+        @owner ||= Contact.new(name: data.partyName, address: data.partyAddress1, address2: data.partyAddress2, city: data.partyCity, state: data.partyState, zip_code: data.partyZip1, phone: data.partyPhone)
+      end
+
+      def community
+        @community ||= Community.new(city: data.communityCity, state: data.communityState)
+      end
+
+      def contact
+        contact = data.mainStudioContact
+        @contact ||= Contact.new(name: contact['contactName'], title: contact['contactTitle'], address: contact['contactAddress1'], address2: contact['contactAddress2'], city: contact['contactCity'], state: contact['contactState'], zip_code: contact['contactZip'], phone: contact['contactPhone'], fax: contact['contactFax'], email: contact['contactEmail'], website: contact['contactWebsite'])
+      end
+
+      def coordinates
+        [latitude.to_f, longitude.to_f].to_json
+      end
+
+      def coordinates_url
+        "https://www.google.com/maps/search/#{coordinates[0]},#{coordinates[1]}"
+      end
+
+      def extended_data_url
+        "https://transition.fcc.gov/fcc-bin/#{@service.to_s.downcase}q?list=4&facid=#{id}"
+      end
+
+      def extended_data
+        @extended_data ||= ResultDelegate.new(ExtendedInfo.new(@service).find(@call_sign))
+      end
+
+      def data
+        @data ||= ResultDelegate.new(Info.new(@service).find(@call_sign))
+      end
+    end
+  end
+end