fcc 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed6aee05400375a29f67c500080cb21647f11ad018e3d9dc5091bb73e44eeed1
-  data.tar.gz: 8c116d81d2c374d1e7488564453cfd1fa34305901ce8529d4f99b0ac4bf1d187
+  metadata.gz: 0a40f16f549528352153a0d8fb4c1bed24c966b9c3647ae7aee71f46b419920f
+  data.tar.gz: db47ff830e6c821ffce6fa3c07bd1bb75f34dfb60ca1ffd85566cf6cb95ce7a4
 SHA512:
-  metadata.gz: ef246a70b27c0496fab4bf78ccf3d7df93c55867edd699cb39a62309055ecb510f5c550f4e0faa7bcef39b57c878d972316a634cc1e2ba1adc1bec77b317d66f
-  data.tar.gz: a426466aa4a0de582fb198e16e2214690c4a4960bbfec971dc0e3e864dd29c4e45c50ed283c8ca532f6074a64c48d06d526bbee07fbd9309553b165c8601d60f
+  metadata.gz: 14d033f2b67c0d3a1e8528fd2d4d787c3bf1be01e2f438feb0df731a0d39e5ab6695e721e4b292e2561efb6374591080186b20eff77b82c26f3fcb8df5556ddd
+  data.tar.gz: 0a9da9bf1d013f096a6c9eb4cc798b8cf98546024702e7c774fe0303d82800a6f1235a0303438b6162585a6673bcd2d6cb7d7e0aadf0b4406bcfa87dc8273f2b

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+fcc changelog
+
+## [1.3.0](https://github.com/jkeen/fcc/compare/v1.3.0...v1.2.1) (2022-07-10)
+
+- Combine data from multiple sources to get a full picture of the station data (transition api, public api, LMS csv files)
+- Now includes related transmitters, repeaters, low power stations, etc

data/Gemfile

@@ -5,19 +5,7 @@ git_source(:github) { |repo_name| 'https://github.com/jkeen/fcc' }
 # Specify your gem's dependencies in popularity.gemspec
 gemspec
 
-#
-# 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"
+#   gem "awesome_print", require: true
+#   gem "byebug", require: true
 # end

data/Gemfile.lock

@@ -1,34 +1,34 @@
 PATH
   remote: .
   specs:
-    fcc (1.2.1)
+    fcc (1.3.0)
       activesupport (>= 6.1)
       httparty (~> 0.18)
       lightly (~> 0.3.3)
+      logger
+      rubyzip
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.3)
       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.9)
-    diff-lcs (1.4.4)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     lightly (0.3.3)
-    mime-types (3.3.1)
+    logger (1.5.0)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
-    minitest (5.14.4)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.2)
     multi_xml (0.6.0)
     rake (12.3.3)
     rspec (3.9.0)
@@ -44,17 +44,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
+    rubyzip (2.3.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print
   bundler (~> 2.1)
-  byebug
   fcc!
   rake (~> 12.3.3)
   rspec (~> 3.9.0)

data/README.md

@@ -2,6 +2,9 @@
 
 Query the FCC database for fm, am, and tv information.
 
+
+This gem uses the new FCC apis and the old FCC apis and combines records to be the most complete version possible. The old (transition.fcc.gov) API provides way more data than the new one does.
+
 ## Install
 
 ```
@@ -12,8 +15,6 @@ gem install fcc
 
 * Ruby 2.0.0 or higher
 
-## Examples
-
 #### Get station information by call sign
 
 ```ruby
@@ -41,9 +42,49 @@ if station.exists? && station.licensed?
   station.latitude #=> "30.266861111111112"
   station.longitude #=> "-97.67444444444445"
   station.file_number #=> BLED-19950103KA
+
+
+  station.to_json #=> 
+                [{:band=>"FM",
+                :signal_strength=>"3.0 kW",
+                :latitude=>"30.266861111111112",
+                :longitude=>"-97.67444444444445",
+                :station_class=>"A",
+                :file_number=>"BLED-19950103KA",
+                :effective_radiated_power=>"3.0 kW",
+                :haat_horizontal=>"26.0",
+                :haat_vertical=>"26.0",
+                :antenna_type=>"ND",
+                :operating_hours=>nil,
+                :licensed_to=>"TEXAS EDUCATIONAL BROADCASTING CO-OPERATIVE, INC.",
+                :city=>"HORNSBY",
+                :state=>"TX",
+                :country=>"US",
+                :id=>"65320",
+                :call_sign=>"KOOP",
+                :status=>"LICENSED",
+                :rf_channel=>"219",
+                :license_expiration_date=>"08/01/2029",
+                :facility_type=>"ED",
+                :frequency=>"91.7",
+                :contact=>
+                 {:name=>"Federico Pacheco",
+                  :title=>"",
+                  :address=>"3823 Airport Blvd. Suite B",
+                  :address2=>"",
+                  :city=>"Austin",
+                  :state=>"TX",
+                  :zip_code=>"78722",
+                  :phone=>"(512)472-1369",
+                  :fax=>"",
+                  :email=>"federico.pacheco@koop.org",
+                  :website=>"koop.org"},
+                :owner=>{:name=>"TEXAS EDUCATIONAL BROADCASTING CO-OPERATIVE, INC.", :city=>"AUSTIN", :state=>"TX", :phone=>"(512)472-1369"},
+                :community=>{:city=>"HORNSBY", :state=>"TX"}}]
   ```
 end
 
+
 ### Caching
 Extended attributes take several seconds to load from transition.fcc.gov. In order to work around this, we query the entire dataset and then cache the result locally for 3 days (using the lightly gem). To use your own cache, set `FCC.cache=` to your cache class (Rails.cache, maybe?) which should have a #fetch method that should take a key and a block like `cache.fetch(key) { // yield for expensive fetch }}`.  
 

data/fcc.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 6.1"
   spec.add_dependency "httparty", "~> 0.18"
   spec.add_dependency "lightly", "~> 0.3.3"
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "logger"
   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/station/cache.rb

@@ -1,6 +1,7 @@
 require 'httparty'
-require_relative './extended_info/parser'
+require_relative './parsers/extended_info'
 require 'lightly'
+require 'logger'
 
 module FCC
   module Station
@@ -8,13 +9,25 @@ module FCC
       attr_reader :store
 
       def initialize
-        @lightly = Lightly.new dir: "tmp/fcc_#{@service}_data", life: '3d', hash: true
+        @lightly = Lightly.new(life: '3d', hash: true).tap do |cache|
+          cache.prune
+        end
+      end
+
+      def flush
+        @lightly.flush
       end
 
-      def fetch key
-        @lightly.get key.to_s do
-          puts "loading up cache with all results"
-          yield
+      def fetch(key)
+        FCC.log("Retreiving #{key} from cache")
+        @lightly.get(key.to_s) do
+          FCC.log "Loading up the cache with results for key: #{key}. This might take a minute…"
+          value = yield
+          if value && value.present?
+            value
+          else
+            nil
+          end
         end
       end
     end

data/lib/fcc/station/extended_info.rb

@@ -1,5 +1,5 @@
 require 'httparty'
-require_relative './extended_info/parser'
+require_relative './parsers/extended_info'
 
 module FCC
   module Station
@@ -14,12 +14,13 @@ module FCC
         @options = {
           follow_redirects: true
         }
+        
         @query = {
           # state: nil,
           # call: nil,
           # city: nil,
           # arn: nil,
-          serv: service.to_s.downcase, # Only return primary main records, no backup transmitters, etc… for now
+          # serv: service.to_s.downcase, # Only return primary main records, no backup transmitters, etc… for now
           status: 3, # licensed records only
           # freq: @service.to_sym == :fm ? '87.1' : '530',
           # fre2: @service.to_sym == :fm ? '107.9' : '1700',
@@ -42,36 +43,39 @@ module FCC
       end
 
       def all_results
+
         begin
           cache_key = "#{self.class.instance_variable_get('@default_options')[:base_uri]}/#{@service.to_s.downcase}q"
           FCC.cache.fetch cache_key do
             response = self.class.get("/#{service.to_s.downcase}q", @options.merge(query: @query))
-            puts response.request.uri.to_s.gsub('&list=4', '&list=0')
+            FCC.log(response.request.uri.to_s.gsub('&list=4', '&list=0'))
             response.parsed_response
           end
         rescue StandardError => e
-          puts e.message
-          puts e.backtrace
+          FCC.error(e.message)
+          FCC.error(e.backtrace)
         end
       end
 
       def find(id_or_call_sign)
         if id_or_call_sign =~ /^\d+$/
           id = id_or_call_sign
+          all_results.filter { |r| r[:fcc_id].to_s == id.to_s } || find_directly({ facid: id_or_call_sign })
         else
-          id = FCC::Station.index(@service).call_sign_to_id(id_or_call_sign)
-        end
-
-        begin
-          all_results.filter { |r| r[:fcc_id].to_s == id.to_s }
-        rescue StandardError => e
-          response = self.class.get("/#{service.to_s.downcase}q", @options.merge(query: @query.merge(facid: id)))
-          puts response.request.uri.to_s.gsub('&list=4', '&list=0')
-          response&.parsed_response
+          all_results.filter { |r| 
+            r[:call_sign].to_s == id_or_call_sign.to_s || r[:call_sign].to_s.upcase =~ Regexp.new("^#{id_or_call_sign.upcase}[-—–][A-Z0-9]+$")
+          } || find_directly({ call: id_or_call_sign })
         end
       end
 
-      parser FCC::Station::ExtendedInfoParser
+      def find_directly(options)
+
+        response = self.class.get("/#{service.to_s.downcase}q", @options.merge(query: @query.merge(options)))
+        FCC.log response.request.uri.to_s.gsub('&list=4', '&list=0')
+        response.parsed_response
+      end
+      
+      parser FCC::Station::Parsers::ExtendedInfo
     end
   end
 end

data/lib/fcc/station/info.rb

@@ -22,7 +22,10 @@ module FCC
         response = self.class.get("/api/service/#{service.to_s.downcase}/facility/id/#{id}.json")
 
         begin
-          response['results']['facility']
+          body = response['results']['facility']
+          body['band'] = service.to_s.upcase.to_s
+
+          body
         rescue StandardError => e
           return nil
         end

data/lib/fcc/station/lms_data.rb

@@ -0,0 +1,139 @@
+require 'httparty'
+require 'open-uri'
+require 'net/http'
+require 'uri'
+require 'date'
+require_relative './parsers/lms_data'
+
+module FCC
+  module Station
+    class LmsData
+      BASE_URI = 'https://enterpriseefiling.fcc.gov/dataentry/api/download/dbfile'
+      # include HTTParty
+
+      def find_all_related(call_sign: )
+        stations = find_related_stations(call_sign: call_sign)
+        translators = find_translators_for(call_sign: stations.keys)
+        stations.merge(translators)
+      end
+
+      def find_translators_for(call_sign: )
+        call_signs = [call_sign].flatten
+
+        records = common_station_data.entries.select do |entry|
+          call_signs.any? { |call_sign| call_signs_match?(call_sign, entry['callsign']) }
+        end 
+
+        facility_ids = records.map { |r| r['facility_id'] }.uniq.compact
+
+        matched_facilities = facilities.entries.select do |facility|
+          facility_ids.include?(facility['primary_station']) #{}|| facility_ids.include?(facility['facility_id'])
+        end
+
+        {}.tap do |hash|
+          matched_facilities.each do |record|
+            hash[record['callsign']] = record['facility_id']
+          end
+        end
+      end
+
+      def find_related_stations(call_sign: )
+        call_signs = [call_sign].flatten
+
+        records = common_station_data.entries.select do |entry|
+          call_signs.any? { call_signs_match?(call_sign, entry['callsign']) }
+        end
+
+        correlated_app_ids = records.map { |m| m['eeo_application_id'] }
+        matches = common_station_data.entries.select do |entry|
+          correlated_app_ids.include?(entry['eeo_application_id'])
+        end
+
+        {}.tap do |hash|
+          matches.each do |record|
+            hash[record['callsign']] = record['facility_id']
+          end
+        end
+      end
+
+      def facilities
+        @facilities ||= read(:facility)
+      end
+
+      def common_station_data
+        @common_station_data ||= read(:common_station)
+      end
+
+      def find_facilities(facility_ids:, call_signs: [])
+        matched_facilities = facilities.entries.select do |facility|
+          facility_ids.include?(facility['primary_station']) || facility_ids.include?(facility['facility_id']) || call_signs.include?(facility['callsign'])
+        end
+
+        {}.tap do |hash|
+          matched_facilities.each do |record|
+            hash[record['callsign']] = record['facility_id']
+          end
+        end
+      end
+
+      def find_call_signs(call_signs:)
+        common_station_data.entries.select do |entry|
+          call_signs.any? do |call_sign|
+            call_signs_match?(call_sign, entry['callsign'])
+          end
+        end
+      end
+
+      def read(file_name)
+        key = "#{lms_date}-#{file_name}"
+        remote_url = URI("#{BASE_URI}/#{lms_date}/#{file_name}.zip")
+        FCC.log remote_url
+        contents = FCC.cache.fetch key do
+          begin
+            temp_file = http_download_uri(remote_url)
+            break if temp_file.empty?
+
+            contents = ""
+            Zip::File.open_buffer(temp_file) do |zf| 
+              contents = zf.read(zf.entries.first)
+              break
+            end
+
+            value = contents
+          rescue Exception => e
+            FCC.error(e.message)
+            value = nil
+          ensure
+            value
+          end
+        end
+
+        if contents
+          CSV.parse(contents, col_sep: '|', headers: true)
+        end
+      end
+
+      protected
+
+      def call_signs_match?(ours, theirs)
+        theirs.to_s.upcase.to_s == ours.to_s.upcase.to_s || theirs.to_s.upcase =~ Regexp.new("^#{ours.to_s.upcase}[-—–][A-Z0-9]+$")
+      end
+
+      def http_download_uri(uri)
+        FCC.log 'Downloading ' + uri.to_s
+        begin
+          Tempfile.create { HTTParty.get(uri)&.body }
+        rescue Exception => e
+          FCC.error "=> Exception: '#{e}'. Skipping download."
+
+          raise e
+          return false
+        end
+      end
+
+      def lms_date
+        Date.today.strftime('%m-%d-%Y')
+      end
+    end
+  end
+end

data/lib/fcc/station/parsers/extended_info.rb

@@ -0,0 +1,78 @@
+require 'httparty'
+
+module FCC
+  module Station
+    module Parsers
+      class ExtendedInfo < HTTParty::Parser
+        def parse
+          results = []
+          body.each_line do |row|
+            attrs = {}
+            attrs[:raw] = row
+            fields = row.split('|').slice(1...-1).collect(&:strip).map { |v| v == '-' ? "" : v }
+
+            attrs[:call_sign]                = fields[0]
+            attrs[:frequency]                = parse_frequency(fields[1])
+            attrs[:band]                     = fields[2]
+            attrs[:channel]                  = fields[3]
+            attrs[:antenna_type]             = fields[4] # Directional Antenna (DA) or NonDirectional (ND)
+            attrs[:operating_hours]          = fields[5] if fields[5] && attrs[:band]&.upcase == "AM" # (Only used for AM)
+            attrs[:station_class]            = fields[6]
+            attrs[:region_2_station_class]   = fields[7] if fields[7] && attrs[:band]&.upcase == "AM" # (only used for AM)
+            attrs[:status]                   = fields[8]
+            attrs[:city]                     = fields[9]
+            attrs[:state]                    = fields[10]
+            attrs[:country]                  = fields[11]
+            attrs[:file_number]              = fields[12]  #File Number (Application, Construction Permit or License) or
+            attrs[:signal_strength]          = parse_signal_strength(fields[13]) # Effective Radiated Power --
+            attrs[:effective_radiated_power] = parse_signal_strength(fields[14]) # Effective Radiated Power -- vertically polarized (maximum)
+            attrs[:haat_horizontal]          = fields[15] # Antenna Height Above Average Terrain (HAAT) -- horizontal polarization
+            attrs[:haat_vertical]            = fields[16] # Antenna Height Above Average Terrain (HAAT) -- vertical polarization
+            attrs[:fcc_id]                   = fields[17] # Facility ID Number (unique to each station)
+            attrs[:latitude]                 = parse_latitude(fields[18], fields[19], fields[20], fields[21])
+            attrs[:longitude]                = parse_longitude(fields[22], fields[23], fields[24], fields[25])
+            attrs[:licensed_to]              = fields[26] # Licensee or Permittee
+
+            results << attrs
+          end
+
+          results
+        end
+
+        def parse_longitude(direction, degrees, minutes, seconds)
+          decimal_degrees = degrees.to_i + (minutes.to_f / 60) + (seconds.to_f / 3600)
+
+          "#{direction =~ /W/ ? '-' : ''}#{decimal_degrees}"
+        end
+
+        def parse_latitude(direction, degrees, minutes, seconds)
+          decimal_degrees = degrees.to_i + (minutes.to_f / 60) + (seconds.to_f / 3600)
+
+          "#{direction =~ /S/ ? '-' : ''}#{decimal_degrees}"
+        end
+
+        def parse_signal_strength(power_string)
+          return unless power_string.present?
+
+          number, unit = power_string.strip.scan(/^([0-9.]+)\s+(\w+)$?/).flatten
+          multiplier   = case unit&.downcase
+                          when "w"
+                            1
+                          when "kw"
+                            1000
+                          when "mw"
+                            1000000
+                          else
+                            1
+                         end
+      
+          number.to_f * multiplier
+        end
+
+        def parse_frequency(freq)
+          freq.to_f
+        end
+      end
+    end
+  end
+end

data/lib/fcc/station/parsers/lms_data.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+
+module FCC
+  module Station
+    module Parsers
+      class LmsData < HTTParty::Parser
+        def parse
+          body
+        end
+      end
+    end
+  end
+end

data/lib/fcc/station/record_delegate.rb

@@ -0,0 +1,121 @@
+require 'active_support/inflector'
+
+module FCC
+  module Station
+    class RecordDelegate
+      def initialize(result)
+        @result = result
+      end
+
+      def method_missing(m, *args, &block)
+        return find_result(@result, m) unless @result.is_a?(Array)
+        return find_result(@result.first, m) if @result.size == 1
+
+        filtered_results = @result.filter { |result|
+          result[:status] == 'LIC' # Licensed only, no construction permits
+        }
+
+        filtered_results = filtered_results.collect { |res|
+          find_result(res, m)
+        }.uniq
+
+        filtered_results.size == 1 ? filtered_results.first : filtered_results
+      end
+
+      def to_json
+        return {}.tap do |record|
+          [Station::Result::EXTENDED_ATTRIBUTES | Station::Result::BASIC_ATTRIBUTES].flatten.each do |attr|
+            record[attr.to_sym] = send(attr.to_sym)
+          end
+
+          %i[contact owner community].each do |attr|
+            result = send(attr.to_sym)
+            next unless result
+
+            record[attr] ||= if result.is_a?(Struct)
+                               result.to_h.compact
+                             elsif result.is_a?(Array) && result.compact.size > 0
+                               result
+                             elsif result.present?
+                               result.to_s
+                             end
+          end
+        end
+      end
+
+      def has_data?
+        @result.present?
+      end
+
+      def id
+        super || send(:fcc_id)
+      end
+
+      def frequency
+        super&.to_f
+      end
+
+      def rf_channel
+        super || send(:channel)
+      end
+
+      def operating_hours
+        super&.downcase
+      end
+
+      def owner
+        @owner ||= begin
+          contact = Contact.new(
+            name: party_name || licensed_to,
+            address: party_address_1, 
+            address2: party_address_2, 
+            city: (party_city || city), 
+            state: (party_state || state), 
+            zip_code: party_zip_1,
+            country: country,
+            phone: party_phone
+          )
+
+          contact if contact.to_h.compact.any?
+        end
+      end
+
+      def community
+        @community ||= begin
+          community = Community.new(city: community_city || city, state: community_state || state, country: country)
+          community if community.to_h.compact.any?
+        end
+      end
+
+      def contact
+        contact = main_studio_contact
+
+        return unless contact
+        @contact ||= begin
+          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'])
+          contact if contact.to_h.compact.any?
+        end
+      end
+
+      def inspect
+        "<RecordDelegate:[#{band}] #{frequency} #{call_sign} — #{community.city} #{community.state} />"
+      end
+
+      private
+
+      def find_key(result, name)
+        result&.keys&.detect { |d| name.to_s == d.to_s } || result&.keys&.detect { |d| name.to_s == d.to_s.underscore }
+      end
+
+      def find_result(result, name)
+        matched_key = find_key(result, name)
+
+        if matched_key
+          result[matched_key]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fcc/station/record_group.rb

@@ -0,0 +1,49 @@
+require 'active_support/inflector'
+
+module FCC
+  module Station
+    class RecordGroup
+      def initialize(results = [])
+        @results = results.map do |result| 
+          result.is_a?(RecordDelegate) ? result : RecordDelegate.new(result)
+        end
+      end
+
+      def to_json
+        return {}.tap do |record|
+          [Station::Result::EXTENDED_ATTRIBUTES | Station::Result::BASIC_ATTRIBUTES].flatten.each do |attr|
+            record[attr.to_sym] = result_attribute(attr.to_sym)
+          end
+
+          %i[contact owner community].each do |attr|
+            result = result_attribute(attr.to_sym)
+            next unless result
+
+            record[attr] ||= if result.is_a?(Struct)
+                               result.to_h.compact
+                             elsif result.is_a?(Array) && result.compact.size > 0
+                               result
+                             elsif result.present?
+                               result.to_s
+                             end
+          end
+        end
+      end
+
+      def result_attribute(attr)
+        @results.collect { |r| r.send(attr.to_sym) }.compact.first
+      end
+
+      def method_missing(m, *args, &block)
+        result = result_attribute(m.to_sym)
+
+        if result.is_a?(Array) && result.size == 1 
+          result = result.first
+        end
+
+        result
+      end
+
+    end
+  end
+end

data/lib/fcc/station/result.rb

@@ -0,0 +1,178 @@
+require 'zip'
+
+module FCC
+  module Station
+    class Result
+      EXTENDED_ATTRIBUTES = %i[band signal_strength latitude longitude station_class file_number effective_radiated_power haat_horizontal haat_vertical antenna_type operating_hours licensed_to city state country] # these take a long time to query
+      BASIC_ATTRIBUTES    = %i[id call_sign status rf_channel license_expiration_date facility_type frequency band]
+
+      def initialize(service, call_sign, options = {})
+        @call_sign = call_sign.upcase
+        @service = service
+        @options = options
+
+        data
+
+        self
+      end
+
+      def details_available?
+        exists? && data.latitude.present?
+      end
+
+      def licensed?
+        exists? && data.status == 'LICENSED' && data.license_expiration_date && Time.parse(data.license_expiration_date) > Time.now
+      end
+
+      def exists?
+        grouped_records.any?
+      end
+
+      def to_json(*_args)
+        [].tap do |records|
+          grouped_records.each do |rg|
+            records << rg.to_json
+          end
+        end.flatten.compact.uniq
+      end
+
+      def coordinates_url
+        "https://www.google.com/maps/search/#{latitude},#{longitude}" if latitude.present? && longitude.present?
+      end
+
+      def extended_data_url
+        "https://transition.fcc.gov/fcc-bin/#{@service.to_s.downcase}q?list=4&facid=#{id}"
+      end
+
+      def enterprise_data_url
+        "https://enterpriseefiling.fcc.gov/dataentry/public/tv/publicFacilityDetails.html?facilityId=#{id}"
+      end
+
+      def data
+        @data ||= RecordDelegate.new(Info.new(@service).find(@call_sign))
+      end
+      alias public_data data
+
+      def grouped_records
+        grouped = all_records.group_by do |record|
+          [record.id, record.call_sign, record.band, record.frequency].compact.join('/')
+        end
+
+        [].tap do |res|
+          grouped.each do |_key, values|
+            res << RecordGroup.new(values)
+          end
+        end
+      end
+      alias records grouped_records
+
+      def all_records
+        [public_records, transition_records, related_translators].flatten.compact.filter { |f| f.has_data? }
+      end
+
+      def related_translators
+        @related_translators ||= begin
+          records = lms_data.find_translators_for(call_sign: @call_sign)
+          records.keys.map do |call|
+            RecordDelegate.new(ExtendedInfo.new(@service).find(call))
+          end.select { |f| f.status.upcase == "LIC" }
+        end
+      end
+
+      def related_stations
+        @related_stations ||= begin
+          records = lms_data.find_related_stations(call_sign: @call_sign)
+          records.keys.map do |call|
+            RecordDelegate.new(ExtendedInfo.new(@service).find(call))
+          end.select { |f| f.status.upcase == "LIC" }      
+        end
+      end
+
+      def related
+        @related ||= begin
+          records = lms_data.find_all_related(call_sign: @call_sign)
+          records.keys.map do |call|
+            ExtendedInfo.new(@service).find(call).collect do |info|
+              RecordDelegate.new(info)
+            end
+          end.flatten.select { |f| f.status.upcase == "LIC" }
+        end
+      end
+
+      def print_broadcast_summary
+        FCC.log "[primary]"
+        transition_records.each do |record|
+          FCC.log "[#{record.band}] #{record.frequency} #{record.call_sign} — #{record.community.city} #{record.community.state}"
+        end
+
+        FCC.log "[translators]"
+        related_translators.each do |record|
+          FCC.log "[#{record.band}] #{record.frequency} #{record.call_sign} — #{record.community.city} #{record.community.state}"
+        end
+
+        FCC.log "[related stations]"
+        related_stations.each do |record|
+          FCC.log "[#{record.band}] #{record.frequency} #{record.call_sign} — #{record.community.city} #{record.community.state}"
+        end
+
+        FCC.log "[all related]"
+        related.each do |record|
+          FCC.log "[#{record.band}] #{record.frequency} #{record.call_sign} — #{record.community.city} #{record.community.state}"
+        end
+
+        nil
+      end
+
+      def lms_data
+        @lms_data ||= LmsData.new
+      end
+
+      def call_signs_match?(ours, theirs)
+        theirs.to_s.upcase.to_s == ours.to_s.upcase.to_s || theirs.to_s.upcase =~ Regexp.new("^#{ours.to_s.upcase}[-—–][A-Z0-9]+$")
+      end
+
+      private
+
+      def public_records
+        public_data_info.map { |r| RecordDelegate.new(r) }
+      end
+
+      def transition_records
+        transition_data_info.map { |r| RecordDelegate.new(r) }
+      end
+
+      def related_records
+        results = related.keys.collect do |call_sign|
+          RecordDelegate.new(ExtendedInfo.new(@service).find(call_sign))
+        end
+      end
+
+      def public_data_info
+        @public_data_info ||= [Info.new(@service).find(@call_sign)]
+      end
+
+      def transition_data_info
+        @transition_data_info ||= ExtendedInfo.new(@service).find(@call_sign)
+      end
+
+      def method_missing(m, *_args)
+        service = if @service == :fm
+                    fm_record = grouped_records.find { |gr| FCC::FM_FULL_SERVICE == gr.band.upcase }
+                    fm_low_power = grouped_records.find { |gr| FCC::FM_LOW_POWER == gr.band.upcase }
+                    fm_booster = grouped_records.find { |gr| FCC::FM_BOOSTER == gr.band.upcase }
+                    fm_translator = grouped_records.find { |gr| FCC::FM_TRANSLATOR == gr.band.upcase }
+
+                    [fm_record, fm_low_power, fm_booster, fm_translator].compact.find { |r| r.send(m.to_sym) }
+                  else
+                    grouped_records.find { |r| r.send(m.to_sym) }
+                  end
+
+        result = service.send(m.to_sym) if service
+
+        result = result.first if result.is_a?(Array) && result.size == 1
+
+        result
+      end
+    end
+  end
+end

data/lib/fcc/station.rb

@@ -1,13 +1,17 @@
 require 'active_support/core_ext/module/delegation'
-require_relative 'station/result_delegate'
 require_relative 'station/extended_info'
+require_relative 'station/cache'
 require_relative 'station/index'
 require_relative 'station/info'
+require_relative 'station/result'
+require_relative 'station/lms_data'
+require_relative 'station/record_group'
+require_relative 'station/record_delegate'
 
 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)
+    Contact = Struct.new(:name, :title, :address, :address2, :city, :state, :country, :zip_code, :phone, :fax, :email, :website, keyword_init: true)
+    Community = Struct.new(:city, :state, :country, keyword_init: true)
 
     def self.find_each(service, &block)
       results = index(service).results
@@ -18,9 +22,7 @@ module FCC
     end
 
     def self.find(service, call_sign, options = {})
-      result = Result.new(service, call_sign, options)
-
-      result if result&.exists?
+      Result.new(service, call_sign, options)
     end
 
     def self.index(service)
@@ -39,89 +41,5 @@ module FCC
     def self.extended_info_cache
       @cache ||= Station::Cache.new
     end
-
-    class Result
-      EXTENDED_ATTRIBUTES = %i[signal_strength latitude longitude station_class file_number effective_radiated_power haat_horizontal haat_vertical antenna_type] # 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 details_available?
-        exists? && data.latitude.present?
-      end
-
-      def licensed?
-        exists? && data.status == 'LICENSED' && data.license_expiration_date && Time.parse(data.license_expiration_date) > Time.now
-      end
-
-      def exists?
-        data.instance_variable_get('@result')
-      end
-
-      def to_json
-        {}.tap do |hash|
-          [EXTENDED_ATTRIBUTES | BASIC_ATTRIBUTES | %i[contact owner community]].flatten.each do |attr|
-            result = send(attr.to_sym)
-            next unless result
-
-            hash[attr] = if result.is_a?(Struct)
-                          result.to_h
-                         elsif result.is_a?(Array) && result.compact.size > 0
-                          result
-                         elsif result.present?
-                          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 operating_hours
-        extended_data.am_operating_time if @service == :am
-      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_url
-        "https://www.google.com/maps/search/#{latitude},#{longitude}" if latitude.present? && longitude.present?
-      end
-
-      def extended_data_url
-        "https://transition.fcc.gov/fcc-bin/#{@service.to_s.downcase}q?list=4&facid=#{id}"
-      end
-
-      def enterprise_data_url
-        "https://enterpriseefiling.fcc.gov/dataentry/public/tv/publicFacilityDetails.html?facilityId=#{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

data/lib/fcc.rb

@@ -3,9 +3,14 @@ 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'
+require_relative './fcc/station/record_delegate'
 
 module FCC
+  FM_FULL_SERVICE = 'FM'
+  FM_LOW_POWER = 'FL'
+  FM_BOOSTER = 'FB'
+  FM_TRANSLATOR = 'FX'
+
   def self.cache
     @cache ||= Station::Cache.new
   end
@@ -13,4 +18,14 @@ module FCC
   def self.cache=(cache_service)
     @cache = cache_service
   end
+
+  def self.log(message)
+    @logger ||= Logger.new($stdout)
+    @logger.info(message)
+  end
+
+  def self.error(message)
+    @error_logger ||= Logger.new($stderr)
+    @error_logger.error(message)
+  end
 end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FCC
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcc
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeff Keen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,75 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
 description: ''
 email: jeff@keen.me
 executables:
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -145,10 +146,14 @@ files:
 - lib/fcc/station.rb
 - lib/fcc/station/cache.rb
 - lib/fcc/station/extended_info.rb
-- lib/fcc/station/extended_info/parser.rb
 - lib/fcc/station/index.rb
 - lib/fcc/station/info.rb
-- lib/fcc/station/result_delegate.rb
+- lib/fcc/station/lms_data.rb
+- lib/fcc/station/parsers/extended_info.rb
+- lib/fcc/station/parsers/lms_data.rb
+- lib/fcc/station/record_delegate.rb
+- lib/fcc/station/record_group.rb
+- lib/fcc/station/result.rb
 - lib/version.rb
 - spec/fcc_spec.rb
 - spec/spec_helper.rb
@@ -171,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Searches the FCC's FM, AM, and TV databases

data/lib/fcc/station/extended_info/parser.rb

@@ -1,65 +0,0 @@
-require 'httparty'
-
-module FCC
-  module Station
-    class ExtendedInfoParser < HTTParty::Parser
-      def parse
-        results = []
-        body.each_line do |row|
-          attrs = {}
-          attrs[:raw] = row
-          fields = row.split('|').slice(1...-1).collect(&:strip).map { |v| v == '-' ? "" : v }
-
-          attrs[:call_sign]                = fields[0]
-          attrs[:frequency]                = parse_frequency(fields[1])
-          attrs[:band]                     = fields[2]
-          attrs[:channel]                  = fields[3]
-          attrs[:antenna_type]             = fields[4] # Directional Antenna (DA) or NonDirectional (ND)
-          attrs[:am_operating_time]        = fields[5] if fields[5] && attrs[:band]&.upcase == "AM" # (Only used for AM)
-          attrs[:station_class]            = fields[6]
-          attrs[:region_2_station_class]   = fields[7] if fields[7] && attrs[:band]&.upcase == "AM" # (only used for AM)
-          attrs[:status]                   = fields[8]
-          attrs[:city]                     = fields[9]
-          attrs[:state]                    = fields[10]
-          attrs[:country]                  = fields[11]
-          attrs[:file_number]              = fields[12]  #File Number (Application, Construction Permit or License) or
-          attrs[:signal_strength]          = parse_signal_strength(fields[13]) # Effective Radiated Power --
-          attrs[:effective_radiated_power] = parse_signal_strength(fields[14]) # Effective Radiated Power -- vertically polarized (maximum)
-          attrs[:haat_horizontal]          = fields[15] # Antenna Height Above Average Terrain (HAAT) -- horizontal polarization
-          attrs[:haat_vertical]            = fields[16] # Antenna Height Above Average Terrain (HAAT) -- vertical polarization
-          attrs[:fcc_id]                   = fields[17] # Facility ID Number (unique to each station)
-          attrs[:latitude]                 = parse_latitude(fields[18], fields[19], fields[20], fields[21])
-          attrs[:longitude]                = parse_longitude(fields[22], fields[23], fields[24], fields[25])
-          attrs[:licensed_to]              = fields[26] # Licensee or Permittee
-
-          results << attrs
-        end
-
-        results
-      end
-
-      def parse_longitude(direction, degrees, minutes, seconds)
-        decimal_degrees = degrees.to_i + (minutes.to_f / 60) + (seconds.to_f / 3600)
-
-        "#{direction =~ /W/ ? '-' : ''}#{decimal_degrees}"
-      end
-
-      def parse_latitude(direction, degrees, minutes, seconds)
-        decimal_degrees = degrees.to_i + (minutes.to_f / 60) + (seconds.to_f / 3600)
-
-        "#{direction =~ /S/ ? '-' : ''}#{decimal_degrees}"
-      end
-
-      def parse_signal_strength(raw_signal)
-        if raw_signal
-          parsed_signal = raw_signal[/[0-9]+\.?[0-9]?/]
-          "#{parsed_signal.to_f} #{raw_signal.scan(/\w+$/).first}"
-        end
-      end
-
-      def parse_frequency(freq)
-        freq.to_f
-      end
-    end
-  end
-end

data/lib/fcc/station/result_delegate.rb

@@ -1,42 +0,0 @@
-require 'active_support/inflector'
-
-module FCC
-  module Station
-    class ResultDelegate
-      def initialize(result)
-        @result = result
-      end
-
-      def method_missing(m, *args, &block)
-        return find_result(@result, m) unless @result.is_a?(Array)
-        return find_result(@result.first, m) if @result.size == 1
-
-        filtered_results = @result.filter { |result|
-          result[:status] == 'LIC' # Licensed only, no construction permits
-        }
-
-        filtered_results = filtered_results.collect { |res|
-          find_result(res, m)
-        }.uniq
-
-        filtered_results.size == 1 ? filtered_results.first : filtered_results
-      end
-
-      private
-
-      def find_key(result, name)
-        result.keys.detect { |d| name.to_s == d.to_s } || result.keys.detect { |d| name.to_s == d.to_s.underscore }
-      end
-
-      def find_result(result, name)
-        matched_key = find_key(result, name)
-
-        if matched_key
-          result[matched_key]
-        else
-          nil
-        end
-      end
-    end
-  end
-end