easyfaa 0.90.0 → 1.0.0

data/config/aircraft_avatars.yml

@@ -0,0 +1,26 @@
+# The single-engine airplane families easyFAA tells apart by make and model ("Cessna 172N",
+# "Piper PA-18-150", "Van's RV-8"), tried in this order, the first pattern found in the name
+# winning. A name no pattern finds is drawn high-wing, as the commonest. Case is ignored.
+fixed-wing-drone:
+  - v-?bat|zipline|\buav\b|\buas\b|unmanned|drone
+biplane:
+  - stearman|\bpt-?1[37]\b|\bn2s\b|pitts|\bs-?[12][abcs]?\b|waco|great lakes|starduster|skybolt|acro ?sport
+  - hatz|miniplane|christen|eagle ii|\bultimate\b|tiger moth|\bjungmann
+ag-plane:
+  - air tractor|\bat-?[3-8]\d\d|thrush|\bs-?2r|ag-?cat|g-?164|\bpa-?25|pawnee|\bpa-?36|ag ?(wagon|truck|husky)|\b188\b
+floatplane:
+  - \blake\b|\bla-?(4|250)|searey|sea rey|icon a5|seawind|\bg-?(21|44|73)\b|goose|widgeon|seabee|rc-?3\b|skimmer|catalina
+low-wing-tailwheel:
+  - \brv-?[3468]\b(?!a)|\bat-?6\b|\bt-?6\b|\bsnj\b|harvard|\bp-?51\b|mustang|\bpt-?(19|22|26)\b|\bextra\b|\bea-?300
+  - edge 540|\bgiles\b|\blaser\b|\bcap ?(10|21|23)|\bsu-?(26|29|31)\b|\bt-?28\b
+high-wing-tailwheel:
+  - \bj-?[2345]\b|\bpa-?(11|12|14|16|17|18|20)\b|cub|aeronca|champ|citabria|decathlon|scout|\b7[acegk]c|\b8kcab
+  - taylorcraft|\bbc-?12|cessna (a)?1(20|40|70|80|85|95)|\b(a)?185|maule|husky|\baviat\b|stinson|luscombe|kitfox|savage
+  - \bm-?[4-7]\b|helio|courier|\bdhc-?2\b|beaver|\bl-?(2|3|4|16|19)\b|bird ?dog|super ?cub|carbon ?cub|backcountry
+low-wing-retractable:
+  - mooney|\bm20|(beech|raytheon|textron|hawker).*\b[a-v]?(33|35|36)[a-z]?\b|bonanza|debonair|\bpa-?(24|28r|30|32r|39|46)\b|comanche|arrow|saratoga
+  - lance|\bt-?34\b|meridian|malibu|mirage|navion|\bm-?18|\bb-?24r|sierra|swift|\bgc-?1|viking|\b17-?3\d|bellanca 14
+low-wing:
+  - \bpa-?(28|32|38)\b|cherokee|warrior|archer|cadet|tomahawk|cirrus|\bsr-?2[02]|\bda-?(20|40)|diamond|katana
+  - \baa-?(1|5)|grumman|tiger|cheetah|traveler|musketeer|sundowner|\bbe-?23|\bc-?23\b|\brv-?\d+|ercoupe|aircoupe|\balon\b
+  - lancair|glasair|sonex|zenith|\bch-?[67]\d\d|tecnam|evektor|sportstar|\bsr-?20

data/lib/easyfaa/engine.rb

@@ -0,0 +1,26 @@
+# rails/engine alone raises NoMethodError: railtie.rb calls delegate_missing_to too early.
+require 'rails'
+
+module EasyFAA
+  # Hooks the gem into a host app: its error pages and its helpers. The easy design system's
+  # stylesheets, scripts, fonts and icons are under `app/assets`, which the host's asset
+  # pipeline reads as its own: `stylesheet_link_tag "easy/tokens"`.
+  class Engine < ::Rails::Engine
+    # The same page for 400, 404, 422 and 500 on every app (EasyFAA::ErrorsController), unless
+    # the host has already named an exceptions app of its own, and the page it shows while it
+    # is down at the path Heroku and a reader expect.
+    initializer 'easyfaa.errors' do |app|
+      app.config.exceptions_app ||= app.routes
+      app.routes.prepend do
+        %w[400 404 422 500].each do |status|
+          get status, to: 'easyfaa/errors#show', defaults: { status: status.to_i }
+        end
+        get 'down.html', to: 'easyfaa/errors#down', format: false
+      end
+    end
+
+    initializer 'easyfaa.helpers' do
+      ActiveSupport.on_load(:action_view) { include EasyFAA::EasyHelper }
+    end
+  end
+end

data/lib/easyfaa/version.rb

@@ -1,4 +1,4 @@
-module Easyfaa
-  # Version of the gem, read by the gemspec and printed by `faa --version`.
-  VERSION = '0.90.0'.freeze
+module EasyFAA
+  # Version of the gem, read by the gemspec and by hosts checking compatibility.
+  VERSION = '1.0.0'
 end

data/lib/easyfaa.rb

@@ -1,9 +1,18 @@
-require 'easyfaa/version'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/inflector'
 
-# What the FAA publishes about an aircraft or an Airworthiness Directive, read in a terminal.
-module Easyfaa
-  # Where the FAA's data is served, unless EASYFAA_URL says otherwise.
-  URL = 'https://data.easyfaa.com'.freeze
-end
+# FAA in capitals: Rails camelizes the gem's folders (easyfaa/) by this, to load and route them.
+ActiveSupport::Inflector.inflections(:en) { it.acronym 'EasyFAA' }
+
+require_relative 'easyfaa/version'
+require_relative 'easyfaa/engine'
 
-require 'easyfaa/cli'
+# easyFAA's front end: the easy design system every app's pages are drawn with (its layout,
+# stylesheets, scripts, fonts, icons and partials), the error pages every app shows, and the
+# marks the apps are known by inside the house.
+module EasyFAA
+  # The site an error page names, in its title, its one link and the maintenance message, as
+  # `[name, url]` for the request: an app that is not easyFAA's own names itself,
+  # `EasyFAA.site = ->(request) { ['easyAnnual', 'https://easyannual.com/'] }`.
+  mattr_accessor :site, default: ->(_request) { ['easyFAA', 'https://easyfaa.com/'] }
+end

metadata

@@ -1,36 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: easyfaa
 version: !ruby/object:Gem::Version
-  version: 0.90.0
+  version: 1.0.0
 platform: ruby
 authors:
 - claudiob
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: "`faa -n 170ad` prints what the FAA registry keeps about an N-number,
-  and `faa -ad 2020-12-12` what the FAA published about an Airworthiness Directive."
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+description: 'The easy design system every easyFAA page is drawn with: its layout,
+  stylesheets, scripts, fonts, icons and partials, and the error pages every app shows.'
 email:
-- claudiob@users.noreply.github.com
-executables:
-- faa
+- info@easyfaa.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
-- exe/faa
+- app/assets/fonts/easy/outfit-latin-ext.woff2
+- app/assets/fonts/easy/outfit-latin.woff2
+- app/assets/images/easy/favicon.ico
+- app/assets/images/easy/favicon.svg
+- app/assets/images/easy/sprite.svg
+- app/assets/javascripts/easy/add_rows.js
+- app/assets/javascripts/easy/flyer.js
+- app/assets/javascripts/easy/highlight.js
+- app/assets/javascripts/easy/konami.js
+- app/assets/javascripts/easy/modal.js
+- app/assets/javascripts/easy/pin_code.js
+- app/assets/javascripts/easy/report_sort.js
+- app/assets/javascripts/easy/rotating_placeholder.js
+- app/assets/javascripts/easy/step_foot.js
+- app/assets/javascripts/easy/switches.js
+- app/assets/javascripts/easy/switches_address.js
+- app/assets/javascripts/easy/tabs.js
+- app/assets/javascripts/easy/theme.js
+- app/assets/stylesheets/easy/base.css
+- app/assets/stylesheets/easy/components.css
+- app/assets/stylesheets/easy/layout.css
+- app/assets/stylesheets/easy/tokens.css
+- app/controllers/easyfaa/errors_controller.rb
+- app/helpers/easyfaa/easy_helper.rb
+- app/models/aircraft_avatar.rb
+- app/views/easy/_ad_card.html.erb
+- app/views/easy/_ad_list.html.erb
+- app/views/easy/_flyer.html.erb
+- app/views/easy/_logo.html.erb
+- app/views/easy/_modal.html.erb
+- app/views/easy/_part_tabs.html.erb
+- app/views/easy/_pin_code.html.erb
+- app/views/easy/_report_head.html.erb
+- app/views/easy/mailer/_button.html.erb
+- app/views/easy/mailer/_card.html.erb
+- app/views/easy/mailer/_code.html.erb
+- app/views/easy/mailer/_code.text.erb
+- app/views/easy/mailer/_frame.html.erb
+- app/views/easy/mailer/_text.html.erb
+- app/views/easyfaa/errors/show.html.erb
+- app/views/layouts/easy/site.html.erb
+- app/views/layouts/easyfaa/errors.html.erb
+- config/aircraft_avatars.yml
 - lib/easyfaa.rb
-- lib/easyfaa/cli.rb
+- lib/easyfaa/engine.rb
 - lib/easyfaa/version.rb
-homepage: https://github.com/easyfaa/faa
+homepage: https://easyfaa.com/design
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/easyfaa/faa
-  changelog_uri: https://github.com/easyfaa/faa/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/easyfaa/easyfaa/tree/main/design
+  changelog_uri: https://github.com/easyfaa/easyfaa/blob/main/design/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/easyfaa
 rdoc_options: []
 require_paths:
@@ -39,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
-summary: 'The faa command: what the FAA publishes about an aircraft or an AD.'
+summary: The front end every easyFAA app shares.
 test_files: []

data/exe/faa

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

data/lib/easyfaa/cli.rb

@@ -1,65 +0,0 @@
-require 'net/http'
-
-module Easyfaa
-  # The `faa` command: what the FAA publishes about an N-number (`faa -n 170ad`) or an AD
-  # (`faa -ad 2020-12-12`), as text, or as JSON with `--json`.
-  class CLI
-    # Each option, and the page it asks for.
-    PAGES = { '-n' => 'N', '-ad' => 'AD' }.freeze
-
-    # What `faa --help` prints.
-    USAGE = <<~TEXT.freeze
-      Usage: faa -n N-NUMBER [--json]     what the FAA registry keeps about an aircraft
-             faa -ad AD-NUMBER [--json]   what the FAA published about an Airworthiness Directive
-             faa --version
-
-      Reads EASYFAA_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 "faa #{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 FAA publishes 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('EASYFAA_URL', URL).chomp('/')
-
-    def answer(text, status: 0)
-      @out.puts text
-      status
-    end
-
-    def problem(text)
-      @err.puts text
-      1
-    end
-  end
-end