fcc 1.1 → 1.3.0

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
@@ -34,74 +38,8 @@ module FCC
       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
+    def self.extended_info_cache
+      @cache ||= Station::Cache.new
     end
   end
 end

data/lib/fcc.rb

@@ -3,8 +3,29 @@ 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
+
+  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.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcc
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeff Keen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-01-30 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,75 +39,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: lightly
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: 0.3.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubyzip
   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: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  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:
@@ -118,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -131,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
@@ -157,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Searches the FCC's FM, AM, and TV databases