fcc 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad1777d7ebc8dd8c084af0608f12814e2ae110003ba57a0114ae3cfb9626bb9d
+  data.tar.gz: d0efadd9bc218bd07d680368cf199c35c718e3b5f14e2129c26589991ba8cf20
+SHA512:
+  metadata.gz: 125643a4dc0d324d6cced8e1f0414a3a09ea7b6b5c3c40f6afba233bfa393c3d43db81b0eafa102230c30934abf3192f1002cc2b0052ca494e699feec3daa3dd
+  data.tar.gz: '0982811e500c437b802b7e01507e99b2ed91a930f01de49552bbef730449daff7069a479c8e2fec527963874780a7411068812c5242c6b6194eea5320f90a9a6'

data/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+---
+name: Generate New Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        run: node_modules/.bin/semantic-release

data/.github/workflows/tests.yml

@@ -0,0 +1,53 @@
+name: Tests
+on: 
+  push:
+  pull_request:
+concurrency:
+  group: ci-tests-${{ github.ref }}-1
+  cancel-in-progress: true
+jobs:
+  test:
+    name: Run Tests
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest ]
+        ruby: [ '2.7' ]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - uses: actions/cache@v3
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle Install
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+
+    - name: Run RSpec
+      run: bundle exec rspec -f j -o tmp/rspec_results.json -f p
+
+    - name: RSpec Report
+      uses: SonicGarden/rspec-report-action@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        json-path: tmp/rspec_results.json
+      if: always()
+  publish:
+    name: Release
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    needs: [test]
+    steps:
+      - name: Dispatch Release
+        uses: benc-uk/workflow-dispatch@v1
+        with:
+          workflow: Generate New Release
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+fcc changelog
+
+# 1.0.0 (2023-02-12)
+
+## [1.4.0](https://github.com/jkeen/fcc/compare/v1.4.0...v1.3.0) (2022-11-25)
+
+
+## [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

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

data/Gemfile.lock

@@ -1,22 +1,59 @@
+PATH
+  remote: .
+  specs:
+    fcc (1.4.0)
+      activesupport (>= 6.1)
+      httparty (~> 0.18)
+      lightly (~> 0.3.3)
+      logger
+      rubyzip (~> 2.3.2)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    nokogiri (1.4.4)
-    rake (0.8.7)
-    rcov (0.9.9)
-    shoulda (2.11.3)
+    activesupport (7.0.4.2)
+      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)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    lightly (0.3.3)
+    logger (1.5.3)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    rubyzip (2.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  nokogiri
-  rcov
-  shoulda
+  bundler (~> 2.1)
+  fcc!
+  rake (~> 12.3.3)
+  rspec (~> 3.9.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,106 @@
+# fcc
+
+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
+
+```
+gem install fcc
+```
+
+## Requirements
+
+* Ruby 2.0.0 or higher
+
+#### 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 }}`.  
+
+### Get all station call signs on a particular service (:fm, :am, :tv)
+
+```ruby
+results = FCC::Station.index(:fm).results
+#=> [{"id"=>"198674", "callSign"=>"KANC", "frequency"=>"99.7", "activeInd"=>"Y"}, {"id"=>"174558", "callSign"=>"WUMZ", "frequency"=>"91.5", "activeInd"=>"Y"}, {"id"=>"184688", "callSign"=>"WHVC", "frequency"=>"102.5", "activeInd"=>"Y"} .... 
+```
+
+## Contributing to fcc
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -7,47 +7,11 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "fcc"
-  gem.homepage = "http://github.com/jkeen/fcc"
-  gem.license = "MIT"
-  gem.summary = %Q{Searches the FCC's FM and AM databases}
-  gem.description = %Q{}
-  gem.email = "jeff@keen.me"
-  gem.authors = ["Jeff Keen"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rake'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "fcc #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+RSpec::Core::RakeTask.new(:spec)
+desc 'Runs the specs'
+task default: :spec

data/bin/console

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

data/bin/setup

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

data/fcc.gemspec

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

data/lib/fcc/station/cache.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+require_relative './parsers/extended_info'
+require 'lightly'
+require 'logger'
+
+module FCC
+  module Station
+    class Cache
+      attr_reader :store
+
+      def initialize
+        @lightly = Lightly.new(life: '3d', hash: true).tap do |cache|
+          cache.prune
+        end
+      end
+
+      def flush
+        @lightly.flush
+      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
+      end
+    end
+  end
+end

data/lib/fcc/station/extended_info.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+require_relative './parsers/extended_info'
+
+module FCC
+  module Station
+    class ExtendedInfo
+      include HTTParty
+      attr_accessor :results, :service
+
+      base_uri 'https://fcc-cache.b-cdn.net/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
+          # freq: @service.to_sym == :fm ? '87.1' : '530',
+          # fre2: @service.to_sym == :fm ? '107.9' : '1700',
+          # facid: nil,
+          # class: nil,
+          # dkt:   nil,
+          # dist:  nil,
+          # dlat2: nil,
+          # dlon2: nil,
+          # mlon2: nil,
+          # mlat2: nil,
+          # slat2: nil,
+          # slon2: nil,
+          # NS: "N",
+          # e: 9,
+          # EW: 'W',
+          list: 4, # pipe separated output
+          size: 9
+        }
+      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)
+        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 })
+        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
+      end
+      
+      parser FCC::Station::Parsers::ExtendedInfo
+    end
+  end
+end

data/lib/fcc/station/index.rb

@@ -0,0 +1,39 @@
+require 'httparty'
+
+module FCC
+  module Station
+    class Index
+      include HTTParty
+      base_uri 'publicfiles.fcc.gov'
+
+      attr_accessor :service
+
+      def initialize(service)
+        @service = service
+      end
+
+      def call_sign_to_id(call_sign)
+        found = results.detect do |hash|
+          hash['callSign'] == call_sign.upcase
+        end
+
+        found ||= results.detect do |hash|
+          hash['callSign'] == "#{call_sign.upcase}-#{service.to_s.upcase}"
+        end
+
+        found['id'] if found
+      end
+
+      def inspect
+        "<Station::Index @results=[#{results.size}]>"
+      end
+
+      def results
+        @results ||= begin
+          response = self.class.get("/api/service/#{service.to_s.downcase}/facility/getall.json")
+          response.parsed_response['results']['facilityList']
+        end
+      end
+    end
+  end
+end

data/lib/fcc/station/info.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+
+module FCC
+  module Station
+    class Info
+      include HTTParty
+      base_uri 'publicfiles.fcc.gov'
+
+      attr_accessor :results, :service
+
+      def initialize(service)
+        @service = service
+      end
+
+      def find(id_or_call_sign, options = {})
+        id = if id_or_call_sign =~ /^\d+$/
+               id_or_call_sign
+             else
+               Station.index(service).call_sign_to_id(id_or_call_sign)
+             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
+      end
+    end
+  end
+end