fcc 1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a2e65473c73d939b88beed853dfe8cb2ab4bb67684c522996a4b1eb0f8d7f8
-  data.tar.gz: d86f808b6da433d743ac6e2546307cf4bdfeb42ec521796cb78a0ecfffb7da63
+  metadata.gz: d0c284a2224092f6ee580603ca213e6754277f0c205296a606dfa3b1c6d33990
+  data.tar.gz: da7535bfbc0a8f367f24d67f080a939fccced3a545c9f92d749aabf322ce4043
 SHA512:
-  metadata.gz: e6a3bea8e717984ddd25fed17731e3ba06709c70dcb49340a274d148fcdd281e1463baf6483879d9a2427961589f2e0d7af908d8ce4ab6508776c8ba1d80c5e3
-  data.tar.gz: 6da0ba2408b94f8488c45900938d3950e580a5cb71493b942a78696b462f0bc4dee61ea26b5bf4cbd1c54a155ad0b0c5670cde37e90c99ede9581b196cd75586
+  metadata.gz: ef717fe2529d3773b8c68208b6fd3a1a86c6aa270873a9c4d4bf9a9a70caad6808f2e46a137dc1243f47129b15105954817d4217c0504bf3bcfd19d2b7224e09
+  data.tar.gz: 30a58df413f3e68a5a858b2fd24d147c40b3c694f2a12ce0c2275be48a19db0ad12c985f4d669a5a555573cfa6af76ee1186e63373d7607c38af287ad8b637df

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    fcc (1.1)
+    fcc (1.2.0)
       activesupport (>= 6.1)
       httparty (~> 0.18)
+      lightly (~> 0.3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -16,17 +17,18 @@ GEM
       zeitwerk (~> 2.3)
     awesome_print (1.8.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.6)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    lightly (0.3.3)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
-    minitest (5.14.2)
+    mime-types-data (3.2021.0704)
+    minitest (5.14.4)
     multi_xml (0.6.0)
     rake (12.3.3)
     rspec (3.9.0)

data/README.md

@@ -19,28 +19,33 @@ gem install fcc
 ```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
-```
+if station.exists? && station.licensed?
+  #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 initially 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
+  ```
+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 }}`.  
 
 ### Get all station call signs on a particular service (:fm, :am, :tv)
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.2.0

data/fcc.gemspec

@@ -6,7 +6,6 @@ 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"
@@ -20,6 +19,7 @@ Gem::Specification.new do |spec|
   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_dependency "lightly", "~> 0.3.3"
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency 'rspec', '~> 3.9.0'

data/lib/fcc.rb

@@ -6,5 +6,11 @@ require_relative './fcc/station/extended_info'
 require_relative './fcc/station/result_delegate'
 
 module FCC
+  def self.cache
+    @cache ||= Station::Cache.new
+  end
 
+  def self.cache=(cache_service)
+    @cache = cache_service
+  end
 end

data/lib/fcc/station.rb

@@ -18,7 +18,9 @@ module FCC
     end
 
     def self.find(service, call_sign, options = {})
-      Result.new(service, call_sign, options)
+      result = Result.new(service, call_sign, options)
+
+      result if result&.exists?
     end
 
     def self.index(service)
@@ -34,14 +36,12 @@ module FCC
       end
     end
 
-    def self.extended_info_cache(service) 
-      @cache ||= {}
-      @cache[service] ||= Station::Cache.new(service)
-      @cache[service]
+    def self.extended_info_cache
+      @cache ||= Station::Cache.new
     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
+      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 
@@ -57,15 +57,31 @@ module FCC
         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)
-            if result.respond_to?(:to_h)
-              hash[attr] = result.to_h
-            else
-              hash[attr] = result.to_s
-            end
+            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
@@ -78,23 +94,27 @@ module FCC
         @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
-        [latitude.to_f, longitude.to_f].to_json
-      end
-
       def coordinates_url
-        "https://www.google.com/maps/search/#{coordinates[0]},#{coordinates[1]}"
+        "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

data/lib/fcc/station/cache.rb

@@ -1,28 +1,22 @@
 require 'httparty'
-require 'byebug'
 require_relative './extended_info/parser'
+require 'byebug'
+require 'lightly'
 
 module FCC
   module Station
     class Cache
       attr_reader :store
 
-      def initialize(service)
-        @service = service
-        @store = Station::ExtendedInfo.new(@service)
-      end
-
-      def find(fcc_id)
-        results.detect { |r| r[:fcc_id].to_s == fcc_id.to_s }
-      end
-
-      def results
-        #TODO: add redis caching tie-in because this query is molasses
-        @store.all_results.parsed_response
+      def initialize
+        @lightly = Lightly.new dir: "tmp/fcc_#{@service}_data", life: '3d', hash: true
       end
 
-      def inspect
-        "<Cache @service=#{service}>"
+      def fetch key
+        @lightly.get key.to_s do
+          puts "loading up cache with all results"
+          yield
+        end
       end
     end
   end

data/lib/fcc/station/extended_info.rb

@@ -7,7 +7,8 @@ module FCC
     class ExtendedInfo
       include HTTParty
       attr_accessor :results, :service
-      base_uri 'http://transition.fcc.gov/fcc-bin/'
+
+      base_uri 'https://transition.fcc.gov/fcc-bin/'
 
       def initialize(service)
         @service = service
@@ -19,8 +20,8 @@ module FCC
           # call: nil,
           # city: nil,
           # arn: nil,
-          serv: service.to_s.downcase,
-          vac: 3, # licensed records only
+          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',
           # facid: nil,
@@ -42,11 +43,16 @@ module FCC
       end
 
       def all_results
-        @all_results ||= begin
-          puts "charging cache for #{service} extended info"
-          response = self.class.get("/#{service.to_s.downcase}q", @options.merge(query: @query))
-          puts response.request.uri.to_s.gsub('&list=4', '&list=0')
-          response
+        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')
+            response.parsed_response
+          end
+        rescue StandardError => e
+          puts e.message
+          puts e.backtrace
         end
       end
 
@@ -58,13 +64,11 @@ module FCC
         end
 
         begin
-          FCC::Station.extended_info_cache(@service).find(id)
-        rescue Exception => e
+          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')
-          result = response.first
-          result['source_url'] = response.request.uri.to_s.gsub('&list=4', '&list=0')
-          result
+          response&.parsed_response
         end
       end
 

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

@@ -1,5 +1,4 @@
 require 'httparty'
-require 'byebug'
 
 module FCC
   module Station
@@ -16,9 +15,9 @@ module FCC
           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] == "AM" # (Only used for AM)
+          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] == "AM" # (only used for AM)
+          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]

data/lib/fcc/station/index.rb

@@ -1,5 +1,5 @@
 require 'httparty'
-require 'byebug'
+
 module FCC
   module Station
     class Index

data/lib/fcc/station/info.rb

@@ -1,5 +1,4 @@
 require 'httparty'
-require 'byebug'
 
 module FCC
   module Station
@@ -21,7 +20,12 @@ module FCC
              end
 
         response = self.class.get("/api/service/#{service.to_s.downcase}/facility/id/#{id}.json")
-        response['results']['facility']
+
+        begin
+          response['results']['facility']
+        rescue StandardError => e
+          return nil
+        end
       end
     end
   end

data/lib/fcc/station/result_delegate.rb

@@ -1,5 +1,4 @@
 require 'active_support/inflector'
-require 'byebug'
 
 module FCC
   module Station
@@ -9,14 +8,33 @@ module FCC
       end
 
       def method_missing(m, *args, &block)
-        if @result
-          matched_key = @result.keys.detect { |d| m.to_s == d.to_s } || @result.keys.detect { |d| m.to_s == d.underscore.to_s }
-
-          if matched_key
-            @result[matched_key]
-          else
-            super
-          end
+        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

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcc
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeff Keen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-01-30 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: lightly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Searches the FCC's FM, AM, and TV databases