fcc 1.0.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad1777d7ebc8dd8c084af0608f12814e2ae110003ba57a0114ae3cfb9626bb9d
-  data.tar.gz: d0efadd9bc218bd07d680368cf199c35c718e3b5f14e2129c26589991ba8cf20
+  metadata.gz: c1a2e65473c73d939b88beed853dfe8cb2ab4bb67684c522996a4b1eb0f8d7f8
+  data.tar.gz: d86f808b6da433d743ac6e2546307cf4bdfeb42ec521796cb78a0ecfffb7da63
 SHA512:
-  metadata.gz: 125643a4dc0d324d6cced8e1f0414a3a09ea7b6b5c3c40f6afba233bfa393c3d43db81b0eafa102230c30934abf3192f1002cc2b0052ca494e699feec3daa3dd
-  data.tar.gz: '0982811e500c437b802b7e01507e99b2ed91a930f01de49552bbef730449daff7069a479c8e2fec527963874780a7411068812c5242c6b6194eea5320f90a9a6'
+  metadata.gz: e6a3bea8e717984ddd25fed17731e3ba06709c70dcb49340a274d148fcdd281e1463baf6483879d9a2427961589f2e0d7af908d8ce4ab6508776c8ba1d80c5e3
+  data.tar.gz: 6da0ba2408b94f8488c45900938d3950e580a5cb71493b942a78696b462f0bc4dee61ea26b5bf4cbd1c54a155ad0b0c5670cde37e90c99ede9581b196cd75586

data/Gemfile

@@ -2,10 +2,22 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| 'https://github.com/jkeen/fcc' }
 
-# Specify your gem's dependencies in fcc.gemspec
+# 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 "awesome_print", require: true
-#   gem "byebug", require: true
+#   gem "shoulda", ">= 0"
+#   gem "bundler"
+#   gem "jeweler"
 # end

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    fcc (1.4.0)
+    fcc (1.1)
       activesupport (>= 6.1)
       httparty (~> 0.18)
-      lightly (~> 0.3.3)
-      logger
-      rubyzip (~> 2.3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    concurrent-ruby (1.2.0)
-    diff-lcs (1.5.0)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.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.12.0)
+    i18n (1.8.6)
       concurrent-ruby (~> 1.0)
-    lightly (0.3.3)
-    logger (1.5.3)
-    mini_mime (1.1.2)
-    minitest (5.17.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)
@@ -42,15 +42,17 @@ 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.6)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   bundler (~> 2.1)
+  byebug
   fcc!
   rake (~> 12.3.3)
   rspec (~> 3.9.0)

data/README.md

@@ -2,9 +2,6 @@
 
 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
 
 ```
@@ -15,78 +12,35 @@ gem install fcc
 
 * Ruby 2.0.0 or higher
 
+## Examples
+
 #### Get station information by call sign
 
 ```ruby
 station = FCC::Station.find(:fm, "KOOP")
 
-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
-
-
-  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 }}`.  
+#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)
 

data/VERSION

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

data/fcc.gemspec

@@ -6,6 +6,7 @@ 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"
@@ -19,10 +20,9 @@ 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_dependency "rubyzip", "~> 2.3.2"
-  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,34 +1,28 @@
 require 'httparty'
-require_relative './parsers/extended_info'
-require 'lightly'
-require 'logger'
+require 'byebug'
+require_relative './extended_info/parser'
 
 module FCC
   module Station
     class Cache
       attr_reader :store
 
-      def initialize
-        @lightly = Lightly.new(life: '3d', hash: true).tap do |cache|
-          cache.prune
-        end
+      def initialize(service)
+        @service = service
+        @store = Station::ExtendedInfo.new(@service)
       end
 
-      def flush
-        @lightly.flush
+      def find(fcc_id)
+        results.detect { |r| r[:fcc_id].to_s == fcc_id.to_s }
       end
 
-      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
+      def results
+        #TODO: add redis caching tie-in because this query is molasses
+        @store.all_results.parsed_response
+      end
+
+      def inspect
+        "<Cache @service=#{service}>"
       end
     end
   end

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

@@ -0,0 +1,66 @@
+require 'httparty'
+require 'byebug'
+
+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] == "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[: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/extended_info.rb

@@ -1,27 +1,26 @@
 require 'httparty'
-require_relative './parsers/extended_info'
+require 'byebug'
+require_relative './extended_info/parser'
 
 module FCC
   module Station
     class ExtendedInfo
       include HTTParty
       attr_accessor :results, :service
-
-      base_uri 'https://fcc-cache.b-cdn.net/fcc-bin/'
+      base_uri 'http://transition.fcc.gov/fcc-bin/'
 
       def initialize(service)
         @service = service
         @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
-          status: 3, # licensed records only
+          serv: service.to_s.downcase,
+          vac: 3, # licensed records only
           # freq: @service.to_sym == :fm ? '87.1' : '530',
           # fre2: @service.to_sym == :fm ? '107.9' : '1700',
           # facid: nil,
@@ -43,38 +42,33 @@ 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))
-            FCC.log(response.request.uri.to_s.gsub('&list=4', '&list=0'))
-            response.parsed_response
-          end
-        rescue StandardError => e
-          FCC.error(e.message)
-          FCC.error(e.backtrace)
+        @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
         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
-          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 })
+          id = FCC::Station.index(@service).call_sign_to_id(id_or_call_sign)
         end
-      end
 
-      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
+        begin
+          FCC::Station.extended_info_cache(@service).find(id)
+        rescue Exception => 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
+        end
       end
-      
-      parser FCC::Station::Parsers::ExtendedInfo
+
+      parser FCC::Station::ExtendedInfoParser
     end
   end
 end

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

data/lib/fcc/station/result_delegate.rb

@@ -0,0 +1,24 @@
+require 'active_support/inflector'
+require 'byebug'
+
+module FCC
+  module Station
+    class ResultDelegate
+      def initialize(result)
+        @result = result
+      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
+        end
+      end
+    end
+  end
+end

data/lib/fcc/station.rb

@@ -1,17 +1,13 @@
 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, :country, :zip_code, :phone, :fax, :email, :website, keyword_init: true)
-    Community = Struct.new(:city, :state, :country, keyword_init: true)
+    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
@@ -38,8 +34,74 @@ module FCC
       end
     end
 
-    def self.extended_info_cache
-      @cache ||= Station::Cache.new
+    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

data/lib/fcc.rb

@@ -3,29 +3,8 @@ require_relative './fcc/station'
 require_relative './fcc/station/cache'
 require_relative './fcc/station/info'
 require_relative './fcc/station/extended_info'
-require_relative './fcc/station/record_delegate'
+require_relative './fcc/station/result_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.0.0'
+  VERSION = '1.1'
 end