ntsb 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa271e31e982d9ea5a2aebb9ffd45480a6c877d7f4e0dcaea61986eb24445e8e
+  data.tar.gz: 2b8bb52694e1da70c14a720b2c0d5d266710b68b6a7e5f8c64dc4dafda412af0
+SHA512:
+  metadata.gz: 77a4e8a249d380cc56a1be4debb09164a5750d5cea1852968a9f5f60c77c1276ae10113e34b67f0ed9076c3e2e50c2a9c81906015a9466364b4e7ef718993187
+  data.tar.gz: e3bcf20e831d3acfa9011b093faad034582fad2e60d7c4948b126d23030198f0f968e4c14663e233b2133e30b67fd9848774d405caec7358ea41df63d99c6aa0

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check [Keep a Changelog](http://keepachangelog.com).
+
+## [Unreleased]
+
+## 0.9.0 - 2026-10-05
+
+* [FEATURE] The `ntsb` command
+
+  `ntsb -n 2632l` prints every event the NTSB recorded for an N-number, and `--json` the same
+  as JSON.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2026 Claudio Baccigalupo
+
+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,42 @@
+# ntsb
+
+The `ntsb` command: every accident and incident the NTSB recorded for an aircraft, read in a
+terminal.
+
+```bash
+ntsb -n 2632l          # every event naming N2632L, each table of it, codes explained
+ntsb -n 2632l --json   # the same, as JSON
+```
+
+The answers come from a copy of the NTSB's database refreshed every night, at
+https://accidents.easyfaa.com. `NTSB_URL` names another one. Each address may ask 20 times a
+minute and 200 times a day.
+
+An NTSB record names the N-number the aircraft had then: an N-number the FAA has since given
+another aircraft lists that aircraft's events too.
+
+## How to install
+
+```bash
+gem install ntsb
+```
+
+```ruby
+# Gemfile
+gem 'ntsb', '~> 0.9'
+```
+
+`~> 0.9` takes every 0.x from 0.9 on and never 1.0: until 1.0, a minor version may change what the command prints.
+
+For the FAA's registry and Airworthiness Directives, see the `faa` command (`gem install easyfaa`).
+
+## Development
+
+```bash
+bin/setup        # the bundle
+bundle exec rake # the suite at 100% line coverage, and RuboCop
+```
+
+## License
+
+[MIT](MIT-LICENSE).

data/exe/ntsb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'ntsb'
+
+exit NTSB::CLI.new(ARGV).run

data/lib/ntsb/cli.rb

@@ -0,0 +1,64 @@
+require 'net/http'
+
+module NTSB
+  # The `ntsb` command: what the NTSB publishes about the events of an N-number
+  # (`ntsb -n 2632l`), as text, or as JSON with `--json`.
+  class CLI
+    # Each option, and the page it asks for.
+    PAGES = { '-n' => 'N' }.freeze
+
+    # What `ntsb --help` prints.
+    USAGE = <<~TEXT.freeze
+      Usage: ntsb -n N-NUMBER [--json]   every accident and incident the NTSB recorded for it
+             ntsb --version
+
+      Reads NTSB_URL, where the data is served (#{URL} unless set).
+    TEXT
+
+    # @param args [Array<String>] command-line arguments.
+    # @param out [IO] where the answer is printed.
+    # @param err [IO] where a problem is printed.
+    def initialize(args, out: $stdout, err: $stderr)
+      @args = args
+      @out = out
+      @err = err
+    end
+
+    # Prints what was asked for.
+    # @return [Integer] exit status: 0 when it was found, 1 otherwise.
+    def run
+      option, number, format = @args
+      if %w[-v --version].include?(option) then answer "ntsb #{VERSION}"
+      elsif PAGES.key?(option) && number then fetch PAGES[option], number, format
+      else answer USAGE, status: option.nil? || %w[-h --help].include?(option) ? 0 : 1
+      end
+    end
+
+  private
+
+    def fetch(page, number, format)
+      extension = format == '--json' ? 'json' : 'txt'
+      response = Net::HTTP.get_response URI("#{url}/#{page}/#{escape number}.#{extension}")
+      case response
+        when Net::HTTPSuccess then answer response.body
+        when Net::HTTPNotFound then problem "The NTSB records nothing under #{number}."
+        when Net::HTTPTooManyRequests then problem 'Too many requests: try again in a minute.'
+        else problem "#{url} answered #{response.code}."
+      end
+    end
+
+    def escape(number) = URI.encode_www_form_component(number)
+
+    def url = ENV.fetch('NTSB_URL', URL).chomp('/')
+
+    def answer(text, status: 0)
+      @out.puts text
+      status
+    end
+
+    def problem(text)
+      @err.puts text
+      1
+    end
+  end
+end

data/lib/ntsb/version.rb

@@ -0,0 +1,4 @@
+module NTSB
+  # Version of the gem, read by the gemspec and printed by `ntsb --version`.
+  VERSION = '0.9.0'.freeze
+end

data/lib/ntsb.rb

@@ -0,0 +1,9 @@
+require 'ntsb/version'
+
+# What the NTSB publishes about the accidents and incidents of an aircraft, read in a terminal.
+module NTSB
+  # Where the NTSB's data is served, unless NTSB_URL says otherwise.
+  URL = 'https://accidents.easyfaa.com'.freeze
+end
+
+require 'ntsb/cli'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: ntsb
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- claudiob
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: "`ntsb -n 2632l` prints every event the NTSB recorded for an N-number,
+  every table of each, as the NTSB published it."
+email:
+- claudiob@users.noreply.github.com
+executables:
+- ntsb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- exe/ntsb
+- lib/ntsb.rb
+- lib/ntsb/cli.rb
+- lib/ntsb/version.rb
+homepage: https://github.com/easyfaa/ntsb
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/easyfaa/ntsb
+  changelog_uri: https://github.com/easyfaa/ntsb/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/ntsb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: 'The ntsb command: every accident and incident the NTSB recorded for an aircraft.'
+test_files: []