uls 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4c602c4bd5b7ceb3ee7b0378a7a0d66ec59e31e6bb82f29d8f334b7ea86c269
+  data.tar.gz: e7529e3a187621009257ef3b5a623103f8183233bf53d76c62115a538ae9155f
+SHA512:
+  metadata.gz: 329af07c3c6b4aa5636a4d68b9f27b35e2626547be4e666df10b2e2c04cd04791ba0af137d51371209ec75d4bdb16471b51d77a7f9aa859958bdccc195023e20
+  data.tar.gz: 35bcd041e58ad4a0caa83978298152858b558814b8c57dcb46591e9a738cf05189e19edd78995953f9ca6396022e244abc6e6da4666b499b6fb598eb1c5ebe85

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.rspec_status
+.idea
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Editor files
+*.swp
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2
+after_success: bash <(curl -s https://codecov.io/bash)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at garth@codejunkie.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in uls.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    uls (0.2.0)
+      rubyzip (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.4.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubyzip (2.3.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timecop (0.9.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 2.2.33)
+  codecov (~> 0.6.0)
+  pry (~> 0.12.2)
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  timecop (~> 0.9.5)
+  uls!
+
+BUNDLED WITH
+   2.3.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Garth Dubin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+[![Build Status](https://travis-ci.com/gdubin/uls.svg?branch=main)](https://travis-ci.com/gdubin/uls) [![codecov](https://codecov.io/gh/gdubin/uls/branch/main/graph/badge.svg)](https://codecov.io/gh/gdubin/uls)
+
+# ULS
+
+This gem is used for parsing the database/files from the FCC Universal Licensing System.  These files are often relevant to amateur radio enthusiasts.
+
+You may download the source files from the FCC by visiting the [Universal Licensing System Databases](http://wireless.fcc.gov/uls/index.htm?job=transaction&page=weekly) page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uls'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install uls
+
+## Usage
+
+##### Configuration
+
+Configuration of various options are available via the base ULS module.  To configure ULS related settings:
+
+```
+ULS.configure do |config|
+  config.tmpdir = '/your/tmpdir/here'
+end
+```
+
+The options currently available are as follows:
+
+|option|default|description|
+|------|-------|-----------|
+|tmpdir|Dir.tmpdir|A location for ULS database files to be downloaded to and unpacked.  Defaults to whatever the [Dir#tmpdir](https://ruby-doc.org/stdlib-2.5.3/libdoc/tmpdir/rdoc/Dir.html#method-c-tmpdir) is set to for your system.|
+
+##### Retrieving Databases
+
+The FCC splits their data into several categories.  Each category is represented as a class method on `ULS::Retriever`.  From there, you may select either the daily or weekly file for a specific types.  Types are driven by the category but for most categories the types are `applications` or `licenses`.
+
+For example, to download the entire license database for amateur radio:
+
+```
+database = ULS::Retriever.amateur_radio.weekly(:licenses)
+```
+
+The weekly database contains all of the data and is republished weekly.  Daily database updates are also provided that are much smaller and only contain the specified day's data:
+
+```
+database = ULS::Retriever.amateur_radio.daily(:licenses)
+```
+
+The above line will download the previous day's updates.  It also takes a second parameter which corresponds to the [Date#wday](https://apidock.com/ruby/Date/wday) value.  So if you wanted to download last Tuesday's daily license file:
+
+```
+database = ULS::Retriever.amateur_radio.daily(:licenses, 2)
+```
+
+##### Parsing Databases
+
+After you have an available database to work with, you may start interacting with the records within it:
+
+```
+database.name_and_addresses.each_record do |record|
+  # do something
+end
+```
+
+When you're done with a database, you can clean up the extracted files using:
+
+```
+database.clean
+```
+
+If you're completely done with this version of the database then this command will remove the zip file:
+
+```
+database.delete
+```
+
+If you want to do both:
+
+```
+database.delete!
+```
+
+The above will not only remove all the extracted files but also delete the compressed file.
+
+There may be instances where you want to keep the source files around.  A database can be reconstructed from the filesystem by calling:
+
+```
+ULS::Database.new('/path/to/zip/or/extracted/directory')
+```
+
+You may pass the path to the zip file, or the already extracted directory, to interact with the records within.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gdubin/uls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ULS project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/uls/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uls"
+
+# 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/lib/uls/codes/applicant_type.rb

@@ -0,0 +1,22 @@
+module ULS
+  module Codes
+    class ApplicantType < Base
+      define_uls_code 'B', description: 'Amateur Club'
+      define_uls_code 'C', description: 'Corporation'
+      define_uls_code 'D', description: 'General Partnership'
+      define_uls_code 'E', description: 'Limited Partnership'
+      define_uls_code 'F', description: 'Limited Liability Partnership'
+      define_uls_code 'G', description: 'Government Entity'
+      define_uls_code 'H', description: 'Other'
+      define_uls_code 'I', description: 'Individual'
+      define_uls_code 'J', description: 'Joint Venture'
+      define_uls_code 'L', description: 'Limited Liability Company'
+      define_uls_code 'M', description: 'Military Recreation'
+      define_uls_code 'O', description: 'Consortium'
+      define_uls_code 'P', description: 'Partnership'
+      define_uls_code 'R', description: 'RACES'
+      define_uls_code 'T', description: 'Trust'
+      define_uls_code 'U', description: 'Unincorporated Association'
+    end
+  end
+end

data/lib/uls/codes/base.rb

@@ -0,0 +1,43 @@
+module ULS
+  module Codes
+    # A base class to handle the various codes/descriptions that the ULS database
+    # uses throughout their records.
+    class Base
+      attr_accessor :code
+
+      class << self
+        def define_uls_code(code, description:)
+          possible_codes[code] = description
+
+          # Takes the description and turns it into a question mark
+          # method for quick testing.  For example:
+          #
+          # 'Active' -> :active?
+          # 'Pending Legal Status' -> :pending_legal_status?
+          question_method = description.downcase
+          question_method.tr!(' ', '_')
+          question_method += '?'
+          define_method question_method.to_sym do
+            self.code.eql?(code)
+          end
+        end
+
+        def possible_codes
+          @possible_codes ||= {}
+        end
+      end
+
+      def initialize(code = nil)
+        return if code.nil?
+
+        raise ArgumentError, "'#{code}' is an invalid code." unless self.class.possible_codes.include?(code)
+
+        self.code = code
+      end
+
+      def description
+        self.class.possible_codes[code] unless code.nil?
+      end
+    end
+  end
+end

data/lib/uls/codes/entity_type.rb

@@ -0,0 +1,15 @@
+module ULS
+  module Codes
+    class EntityType < Base
+      define_uls_code 'CE', description: 'Transferee Contact'
+      define_uls_code 'CL', description: 'Licensee Contact'
+      define_uls_code 'CR', description: 'Assignor or Transferor Contact'
+      define_uls_code 'CS', description: 'Lessee Contact'
+      define_uls_code 'E', description: 'Transferee'
+      define_uls_code 'L', description: 'Licensee or Assignee'
+      define_uls_code 'O', description: 'Owner'
+      define_uls_code 'R', description: 'Assignor or Transferor'
+      define_uls_code 'S', description: 'Lessee'
+    end
+  end
+end

data/lib/uls/codes/license_status.rb

@@ -0,0 +1,13 @@
+module ULS
+  module Codes
+    class LicenseStatus < Base
+      define_uls_code 'A', description: 'Active'
+      define_uls_code 'C', description: 'Canceled'
+      define_uls_code 'E', description: 'Expired'
+      define_uls_code 'L', description: 'Pending Legal Status'
+      define_uls_code 'P', description: 'Parent Station Canceled'
+      define_uls_code 'T', description: 'Terminated'
+      define_uls_code 'X', description: 'Term Pending'
+    end
+  end
+end

data/lib/uls/codes/status.rb

@@ -0,0 +1,11 @@
+module ULS
+  module Codes
+    class Status < Base
+      # Code value is intentionally blank.  That's how the FCC represents
+      # an active status: blank or null.
+      define_uls_code '', description: 'Active'
+      define_uls_code 'X', description: 'Termination Pending' 
+      define_uls_code 'T', description: 'Terminated' 
+    end
+  end
+end

data/lib/uls/configuration.rb

@@ -0,0 +1,11 @@
+require 'tmpdir'
+
+module ULS
+  class Configuration
+    attr_accessor :tmpdir
+
+    def initialize
+      @tmpdir = Dir.tmpdir
+    end
+  end
+end

data/lib/uls/dat_file.rb

@@ -0,0 +1,43 @@
+module ULS
+  # Used to interact with the FCC DAT file.
+  class DatFile
+    attr_accessor :path
+
+    def initialize(path)
+      self.path = path
+    end
+
+    def each_line(&_block)
+      return unless File.exist?(path)
+
+      File.foreach(path) { |line| yield(line) }
+    end
+
+    def each_record(&_block)
+      return unless File.exist?(path)
+
+      File.foreach(path) do |line|
+        record = line_to_record(line)
+        yield(record)
+      end
+    end
+
+    protected
+
+    def record_class(record_type)
+      case record_type
+      when 'EN'
+        Records::Entity
+      when 'HD'
+        Records::FormPrimary
+      when 'AD'
+        Records::FormSecondary
+      end
+    end
+
+    def line_to_record(line)
+      klass = record_class(line[0..1])
+      klass.new(line) unless klass.nil?
+    end
+  end
+end

data/lib/uls/database.rb

@@ -0,0 +1,72 @@
+require 'zip'
+
+module ULS
+  # Used to interact with the FCC 'database' files.  These files are compressed
+  # files containing several individual pipe-delimited data files.
+  class Database
+    attr_accessor :compressed_file
+
+    # Use to construct an interface to the Database zipfile/directory
+    # retrieved from the FCC.  The filename may either be a zip file,
+    # in which case it will be extracted to the temporary directory, or
+    # may be an already extract directory containing the various 'database'
+    # files.
+    def initialize(filename)
+      path = Pathname.new(filename)
+      if path.directory?
+        @extracted_path = filename
+      else
+        @compressed_file = filename
+      end
+    end
+
+    def name_and_addresses
+      extract unless extracted?
+
+      DatFile.new("#{extracted_path}/EN.dat")
+    end
+
+    def form_primary
+      extract unless extracted?
+
+      DatFile.new("#{extracted_path}/HD.dat")
+    end
+
+    def form_secondary
+      extract unless extracted?
+
+      DatFile.new("#{extracted_path}/AD.dat")
+    end
+
+    def extracted_path
+      @extracted_path ||= "#{ULS.configuration.tmpdir}/uls_#{Time.now.to_i}"
+    end
+
+    def extracted?
+      Dir.exist?(extracted_path)
+    end
+
+    def extract
+      FileUtils.mkdir_p(extracted_path)
+      Zip::File.open(compressed_file) do |opened_file|
+        opened_file.each do |entry|
+          entry.extract("#{extracted_path}/#{entry.name}")
+        end
+      end
+    end
+
+    def clean
+      File.rmdir(extracted_path)
+    end
+
+    def delete
+      File.delete(compressed_file)
+    end
+
+    def delete!
+      clean if extracted?
+
+      delete
+    end
+  end
+end

data/lib/uls/records/base.rb

@@ -0,0 +1,80 @@
+require 'date'
+
+module ULS
+  module Records
+    # The base class for all ULS records we'll be parsing.  This handles some
+    # of the helper methods for defining attributes and actually performing
+    # the parsing after the record is defined.
+    class Base
+      DEFAULT_ATTRIBUTE_OPTIONS = { type: :string }.freeze
+      FIELD_SEPARATOR = '|'.freeze
+      BLANK_RE = /\A[[:space:]]*\z/ # h/t Rails .blank? implementation
+
+      class << self
+        def uls_field_accessor(symbol, options = {})
+          field = { attribute: symbol }
+          field.merge!(options)
+          field = DEFAULT_ATTRIBUTE_OPTIONS.merge(field)
+
+          fields << field
+
+          attr_accessor symbol
+        end
+
+        def fields
+          @fields ||= []
+        end
+      end
+
+      def initialize(line = nil)
+        return if line.nil?
+
+        from_row(line)
+      end
+
+      def from_row(line)
+        values = line.split(FIELD_SEPARATOR)
+        values.shift
+
+
+        values.each_with_index do |value, index|
+          break if index >= self.class.fields.size
+
+          field = self.class.fields[index]
+          setter = "#{field[:attribute]}="
+          value = convert(value, field[:type])
+
+          send(setter, value)
+        end
+      end
+
+      protected
+
+      def convert(value, type)
+        begin
+          return type.new(value) if type.respond_to?(:ancestors) && type.ancestors.include?(ULS::Codes::Base)
+        rescue ArgumentError => e
+          return nil
+        end
+
+        # The FCC uses blank values to represent certain codes so this check is after
+        # any code conversion that may occur.  Beyond the codes, we want to set blanks
+        # to nil since that's what they represent normally.
+        return nil if blank?(value)
+
+        case type
+        when :numeric
+          value.to_i
+        when :date
+          Date.strptime(value, '%m/%d/%Y')
+        else
+          value
+        end
+      end
+
+      def blank?(value)
+        return true if value.nil? || BLANK_RE.match?(value)
+      end
+    end
+  end
+end

data/lib/uls/records/entity.rb

@@ -0,0 +1,32 @@
+module ULS
+  module Records
+    class Entity < Base
+      uls_field_accessor :unique_system_identifier, type: :numeric
+      uls_field_accessor :file_number
+      uls_field_accessor :ebf_number
+      uls_field_accessor :call_sign
+      uls_field_accessor :entity_type, type: ULS::Codes::EntityType
+      uls_field_accessor :licensee_id
+      uls_field_accessor :entity_name
+      uls_field_accessor :first_name
+      uls_field_accessor :middle_name
+      uls_field_accessor :last_name
+      uls_field_accessor :suffix
+      uls_field_accessor :phone
+      uls_field_accessor :fax
+      uls_field_accessor :email
+      uls_field_accessor :street_address
+      uls_field_accessor :city
+      uls_field_accessor :state
+      uls_field_accessor :zipcode
+      uls_field_accessor :po_box
+      uls_field_accessor :attention_line
+      uls_field_accessor :sgin
+      uls_field_accessor :frn
+      uls_field_accessor :applicant_type, type: ULS::Codes::ApplicantType
+      uls_field_accessor :applicant_type_other
+      uls_field_accessor :status, type: ULS::Codes::Status
+      uls_field_accessor :status_date, type: :date
+    end
+  end
+end

data/lib/uls/records/form_primary.rb

@@ -0,0 +1,56 @@
+module ULS
+  module Records
+    # This represents the main form 605 data that carries over to the license.
+    class FormPrimary < Base 
+      uls_field_accessor :unique_system_identifier, type: :numeric
+      uls_field_accessor :uls_file_number
+      uls_field_accessor :ebf_number
+      uls_field_accessor :call_sign
+      uls_field_accessor :license_status, type: ULS::Codes::LicenseStatus
+      uls_field_accessor :radio_service_code
+      uls_field_accessor :grant_date, type: :date
+      uls_field_accessor :expired_date, type: :date
+      uls_field_accessor :cancellation_date, type: :date
+      uls_field_accessor :eligibility_rule_num
+      uls_field_accessor :applicant_type_code_reserved
+      uls_field_accessor :alien
+      uls_field_accessor :alien_government
+      uls_field_accessor :alien_corporation
+      uls_field_accessor :alien_officer
+      uls_field_accessor :alien_control
+      uls_field_accessor :revoked
+      uls_field_accessor :convicted
+      uls_field_accessor :adjudged
+      uls_field_accessor :involved_reserved
+      uls_field_accessor :common_carrier
+      uls_field_accessor :non_common_carrier
+      uls_field_accessor :private_comm
+      uls_field_accessor :fixed
+      uls_field_accessor :mobile
+      uls_field_accessor :radiolocation
+      uls_field_accessor :satellite
+      uls_field_accessor :developmental_or_sta
+      uls_field_accessor :interconnected_service
+      uls_field_accessor :certifier_first_name
+      uls_field_accessor :certifier_mi
+      uls_field_accessor :certifier_last_name
+      uls_field_accessor :certifier_suffix
+      uls_field_accessor :certifier_title
+      uls_field_accessor :gender
+      uls_field_accessor :african_american
+      uls_field_accessor :native_american
+      uls_field_accessor :hawaiian
+      uls_field_accessor :asian
+      uls_field_accessor :white
+      uls_field_accessor :ethnicity
+      uls_field_accessor :effective_date
+      uls_field_accessor :last_action_date
+      uls_field_accessor :auction_id, type: :numeric
+      uls_field_accessor :reg_stat_broad_serv
+      uls_field_accessor :band_manager
+      uls_field_accessor :type_serv_broad_serv
+      uls_field_accessor :alien_ruling
+      uls_field_accessor :licensee_name_change
+    end
+  end
+end

data/lib/uls/records/form_secondary.rb

@@ -0,0 +1,36 @@
+module ULS
+  module Records
+    # This represents the Main Form 605 data that does not carry over to the license.
+    class FormSecondary < Base 
+      uls_field_accessor :unique_system_identifier, type: :numeric
+      uls_field_accessor :uls_file_number
+      uls_field_accessor :ebf_number
+      uls_field_accessor :application_purpose
+      uls_field_accessor :application_status
+      uls_field_accessor :application_fee_exempt
+      uls_field_accessor :regulatory_fee_exempt
+      uls_field_accessor :source
+      uls_field_accessor :requested_expiration_date_mmdd
+      uls_field_accessor :receipt_date
+      uls_field_accessor :notification_code
+      uls_field_accessor :notification_date
+      uls_field_accessor :expanding_area_or_contour
+      uls_field_accessor :change_type
+      uls_field_accessor :original_application_purpose
+      uls_field_accessor :requesting_a_waiver
+      uls_field_accessor :how_many_waivers_requested, type: :numeric
+      uls_field_accessor :any_attachments
+      uls_field_accessor :number_of_requested_sids, type: :numeric
+      uls_field_accessor :fee_control_num
+      uls_field_accessor :date_entered
+      uls_field_accessor :reason
+      uls_field_accessor :frequency_coordination_indicat
+      uls_field_accessor :emergency_sta
+      uls_field_accessor :overall_change_type
+      uls_field_accessor :slow_growth_ind
+      uls_field_accessor :previous_waiver
+      uls_field_accessor :waiver_deferral_fee
+      uls_field_accessor :has_term_pending_ind
+    end
+  end
+end

data/lib/uls/retriever.rb

@@ -0,0 +1,89 @@
+require 'date'
+require 'open-uri'
+
+module ULS
+  class Retriever
+    APPLICATION_PREFIX = 'a'.freeze
+    LICENSE_PREFIX = 'l'.freeze
+
+    SERVICES = {
+      amateur_radio: {
+        filename: {
+          daily: 'am',
+          weekly: 'amat'
+        },
+        records: {
+          applications: APPLICATION_PREFIX,
+          licenses: LICENSE_PREFIX
+        }
+      }
+    }.freeze
+
+    # Different base URLs whether we're looking for the daily updates or the full
+    # weekly downloads.
+    DAILY_BASE_URL = 'ftp://wirelessftp.fcc.gov/pub/uls/daily'.freeze
+    WEEKLY_BASE_URL = 'ftp://wirelessftp.fcc.gov/pub/uls/complete'.freeze
+    
+    attr_accessor :service
+
+    def self.amateur_radio
+      Retriever.new(:amateur_radio)
+    end
+
+    def initialize(service)
+      raise ArgumentError, "Invalid service #{service}" unless services.include?(service)
+
+      self.service = service
+    end
+
+    def weekly_url(type)
+      raise ArgumentError, "Invalid type #{type}" unless types.include?(type)
+
+      prefix = SERVICES[service][:records][type]
+      name = SERVICES[service][:filename][:weekly]
+
+      "#{WEEKLY_BASE_URL}/#{prefix}_#{name}.zip"
+    end
+
+    def weekly(type)
+      url = weekly_url(type)
+      download(url)
+    end
+
+    def daily_url(type, wday = Date.new.prev_day.wday)
+      raise ArgumentError, "Invalid type #{type}" unless types.include?(type)
+
+      abbreviated_day = Date::ABBR_DAYNAMES[wday].downcase
+      prefix = SERVICES[service][:records][type]
+      name = SERVICES[service][:filename][:daily]
+
+      "#{DAILY_BASE_URL}/#{prefix}_#{name}_#{abbreviated_day}.zip"
+    end
+
+    def daily(type, wday = Date.new.prev_day.wday)
+      url = daily_url(type, wday)
+      download(url)
+    end
+
+    def types
+      SERVICES[service][:records].keys
+    end
+
+    def services
+      SERVICES.keys
+    end
+
+    protected
+
+    def download(url)
+      filename = url.split('/').last
+      path = "#{ULS.configuration.tmpdir}/#{filename}"
+
+      File.open(path, 'w') do |file|
+        IO.copy_stream(open(url), file)
+      end
+
+      path
+    end
+  end
+end

data/lib/uls/version.rb

@@ -0,0 +1,3 @@
+module ULS
+  VERSION = "0.2.0"
+end

data/lib/uls.rb

@@ -0,0 +1,34 @@
+require 'uls/version'
+require 'uls/configuration'
+require 'uls/database'
+require 'uls/dat_file'
+require 'uls/retriever'
+require 'uls/codes/base'
+require 'uls/codes/status'
+require 'uls/codes/license_status'
+require 'uls/codes/applicant_type'
+require 'uls/codes/entity_type'
+require 'uls/records/base'
+require 'uls/records/form_primary'
+require 'uls/records/form_secondary'
+require 'uls/records/entity'
+
+# This gem is for parsing the FCC ULS database files available from the FCC website.
+# For additional details, visit http://github.com/gdubin/uls
+module ULS
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure(&_block)
+    yield(configuration)
+  end
+end

data/uls.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "uls/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "uls"
+  spec.version       = ULS::VERSION
+  spec.authors       = ["Garth Dubin"]
+  spec.email         = ["garth@codejunkie.org"]
+
+  spec.summary       = %q{Parsing library for FCC ULS databases.}
+  spec.description   = %q{Handles the parsing of the FCC ULS databases.}
+  spec.homepage      = "http://github.com/gdubin/uls"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 2.2.33"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "codecov", "~> 0.6.0"
+  spec.add_development_dependency "timecop", "~> 0.9.5"
+
+  spec.add_runtime_dependency 'rubyzip', '~> 2.3.0'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: uls
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Garth Dubin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: Handles the parsing of the FCC ULS databases.
+email:
+- garth@codejunkie.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uls.rb
+- lib/uls/codes/applicant_type.rb
+- lib/uls/codes/base.rb
+- lib/uls/codes/entity_type.rb
+- lib/uls/codes/license_status.rb
+- lib/uls/codes/status.rb
+- lib/uls/configuration.rb
+- lib/uls/dat_file.rb
+- lib/uls/database.rb
+- lib/uls/records/base.rb
+- lib/uls/records/entity.rb
+- lib/uls/records/form_primary.rb
+- lib/uls/records/form_secondary.rb
+- lib/uls/retriever.rb
+- lib/uls/version.rb
+- uls.gemspec
+homepage: http://github.com/gdubin/uls
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Parsing library for FCC ULS databases.
+test_files: []