bullet_train-api 1.0.16 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0157f585b4b46527c96b9e0fd98d29b2a86c39df341e8158e0ba4b0843a415f
-  data.tar.gz: a930f8262c209e4707eb7f5edf14f3c3e1537416359387337b5645356222584e
+  metadata.gz: ad13ea6c52199631e43bc3ef4367f886d64568faea6d88dd3f5f1857bb0416e2
+  data.tar.gz: 90deafe4bb3b6680f0ccaa79e715e66cfcadf247053c651badf489f4ab845e95
 SHA512:
-  metadata.gz: 32183bf8e9287a558bcb9b9982140c1b050370709f551f9fe6bc8a47f012acd51f98a99f70962e4e71a2f40b23fc86406f5f20f5570ef3af4bb6fa1678bc1ec5
-  data.tar.gz: 6fcce88fc1035aa09f4f55f9ac380ae63de0acc4bb01f3661d9e8a38cd07bc5cfc7a5dd14f41cff082b840251947ddba13d13946c7f96e16fa0315a6a1033b53
+  metadata.gz: a254ff4f0174985973a4ac4c1b28d4d6d20cc547633a34da3277393d46470485f623126f5560425b5e1e124a8832a360e9a4f9ab343a6d8704bb9669553edaed
+  data.tar.gz: 3a726a97a5070fdfbb092b6437e90c7019de0fd9a256bcffa035cbdcb5496ee5ac9e2212ef499297686fed843d2fba87cc47984c60199253ca685d1b96d91cfe

data/app/controllers/concerns/api/controllers/base.rb

@@ -0,0 +1,69 @@
+require "pagy_cursor/pagy/extras/cursor"
+require "pagy_cursor/pagy/extras/uuid_cursor"
+
+module Api::Controllers::Base
+  extend ActiveSupport::Concern
+
+  # TODO Why doesn't `before_action :doorkeeper_authorize!` throw an exception?
+  class NotAuthenticatedError < StandardError
+  end
+
+  included do
+    include ActionController::Helpers
+    helper ApplicationHelper
+
+    include LoadsAndAuthorizesResource
+    include Pagy::Backend
+
+    before_action :set_default_response_format
+    before_action :doorkeeper_authorize!
+
+    rescue_from CanCan::AccessDenied, ActiveRecord::RecordNotFound do |exception|
+      render json: {error: "Not found"}, status: :not_found
+    end
+
+    rescue_from NotAuthenticatedError do |exception|
+      render json: {error: "Invalid token"}, status: :unauthorized
+    end
+
+    before_action :apply_pagination, only: [:index]
+  end
+
+  def permitted_fields
+    []
+  end
+
+  def permitted_arrays
+    {}
+  end
+
+  def process_params(strong_params)
+  end
+
+  def current_user
+    raise NotAuthenticatedError unless doorkeeper_token.present?
+    @current_user ||= User.find_by(id: doorkeeper_token[:resource_owner_id])
+  end
+
+  def current_team
+    # Application agents are users but only have one team.
+    current_user&.teams&.first
+  end
+
+  def apply_pagination
+    collection_variable = "@#{self.class.name.split("::").last.gsub("Controller", "").underscore}"
+    collection = instance_variable_get collection_variable
+    @pagy, collection = pagy_cursor collection
+    instance_variable_set collection_variable, collection
+  end
+
+  def set_default_response_format
+    request.format = :json
+  end
+
+  class_methods do
+    def regex_to_remove_controller_namespace
+      /^#{name.split("::").first(2).join("::") + "::"}/
+    end
+  end
+end

data/app/controllers/concerns/api/v1/teams/controller_base.rb

@@ -0,0 +1,49 @@
+module Api::V1::Teams::ControllerBase
+  extend ActiveSupport::Concern
+
+  module StrongParameters
+    # Only allow a list of trusted parameters through.
+    def team_params
+      strong_params = params.require(:team).permit(
+        *permitted_fields,
+        :name,
+        :time_zone,
+        :locale,
+        # 🚅 super scaffolding will insert new fields above this line.
+        *permitted_arrays,
+        # 🚅 super scaffolding will insert new arrays above this line.
+      )
+
+      process_params(strong_params)
+
+      strong_params
+    end
+  end
+
+  included do
+    load_and_authorize_resource :team, class: "Team", prepend: true,
+      member_actions: (defined?(MEMBER_ACTIONS) ? MEMBER_ACTIONS : []),
+      collection_actions: (defined?(COLLECTION_ACTIONS) ? COLLECTION_ACTIONS : [])
+
+    private
+
+    include StrongParameters
+  end
+
+  # GET /api/v1/teams
+  def index
+  end
+
+  # GET /api/v1/teams/:id
+  def show
+  end
+
+  # PATCH/PUT /api/v1/teams/:id
+  def update
+    if @team.update(team_params)
+      render :show
+    else
+      render json: @team.errors, status: :unprocessable_entity
+    end
+  end
+end

data/app/controllers/concerns/api/v1/users/controller_base.rb

@@ -0,0 +1,42 @@
+module Api::V1::Users::ControllerBase
+  extend ActiveSupport::Concern
+
+  module StrongParameters
+    # Only allow a list of trusted parameters through.
+    def user_params
+      strong_params = params.require(:user).permit(
+        *permitted_fields,
+        :email,
+        :first_name,
+        :last_name,
+        :time_zone,
+        :locale,
+        # 🚅 super scaffolding will insert new fields above this line.
+        *permitted_arrays,
+        # 🚅 super scaffolding will insert new arrays above this line.
+      )
+
+      process_params(strong_params)
+
+      strong_params
+    end
+  end
+
+  included do
+    load_and_authorize_resource :user, class: "User", prepend: true,
+      member_actions: (defined?(MEMBER_ACTIONS) ? MEMBER_ACTIONS : []),
+      collection_actions: (defined?(COLLECTION_ACTIONS) ? COLLECTION_ACTIONS : [])
+
+    private
+
+    include StrongParameters
+  end
+
+  # GET /api/v1/users
+  def index
+  end
+
+  # GET /api/v1/users/:id
+  def show
+  end
+end

data/app/views/api/v1/teams/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.data do
+  json.array! @teams, partial: "api/v1/teams/team", as: :team
+end
+
+render_pagination(json)

data/app/views/api/v1/teams/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "api/v1/teams/team", team: @team

data/app/views/api/v1/users/index.json.jbuilder

@@ -0,0 +1,5 @@
+json.data do
+  json.array! @users, partial: "api/v1/users/user", as: :user
+end
+
+render_pagination(json)

data/app/views/api/v1/users/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "api/v1/users/user", user: @user

data/config/routes.rb

@@ -1,4 +1,18 @@
 Rails.application.routes.draw do
   use_doorkeeper
-  mount Api::Base, at: "/api"
+
+  namespace :api do
+    namespace :v1 do
+      shallow do
+        resources :users
+        resources :teams do
+          resources :invitations
+          resources :memberships
+          namespace :platform do
+            resources :applications
+          end
+        end
+      end
+    end
+  end
 end

data/lib/bullet_train/api/engine.rb

@@ -1,22 +1,9 @@
-require "grape"
-require "grape-cancan"
-require "grape_jsonapi"
-require "grape-swagger"
-require "grape_on_rails_routes"
-# require "wine_bouncer"
 require "pagy"
-require "api-pagination"
 require "rack/cors"
 
 module BulletTrain
   module Api
     class Engine < ::Rails::Engine
-      initializer "bullet_train.api.register_api_endpoints" do |app|
-        if BulletTrain::Api
-          BulletTrain::Api.endpoints << "Api::V1::MeEndpoint"
-          BulletTrain::Api.endpoints << "Api::V1::TeamsEndpoint"
-        end
-      end
     end
   end
 end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.0.16"
+    VERSION = "1.1.1"
   end
 end

data/lib/bullet_train/api.rb

@@ -1,20 +1,15 @@
 require "bullet_train/api/version"
 require "bullet_train/api/engine"
 
-require "grape"
-require "grape-cancan"
-require "grape_jsonapi"
-require "grape-swagger"
-require "grape_on_rails_routes"
 # require "wine_bouncer"
 require "pagy"
-require "api-pagination"
+require "pagy_cursor"
 require "rack/cors"
-require "jsonapi/serializer"
 require "doorkeeper"
 
 module BulletTrain
   module Api
     mattr_accessor :endpoints, default: []
+    mattr_accessor :current_version, default: "v1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-07 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -30,84 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-- !ruby/object:Gem::Dependency
-  name: grape
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-- !ruby/object:Gem::Dependency
-  name: grape-cancan
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: grape-jsonapi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: grape-swagger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: grape_on_rails_routes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: api-pagination
+  name: pagy_cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jsonapi-serializer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: doorkeeper
   requirement: !ruby/object:Gem::Requirement
@@ -204,26 +120,10 @@ files:
 - Rakefile
 - app/assets/config/bullet_train_api_manifest.js
 - app/controllers/account/platform/applications_controller.rb
-- app/controllers/api.rb
-- app/controllers/api/base.rb
-- app/controllers/api/model_parser.rb
-- app/controllers/api/v1.rb
-- app/controllers/api/v1/defaults.rb
-- app/controllers/api/v1/exceptions_handler.rb
-- app/controllers/api/v1/loads_and_authorizes_api_resource.rb
-- app/controllers/api/v1/me_endpoint.rb
-- app/controllers/api/v1/teams_endpoint.rb
-- app/controllers/concerns/api/v1/base.rb
-- app/controllers/concerns/api/v1/teams/endpoint_base.rb
+- app/controllers/concerns/api/controllers/base.rb
+- app/controllers/concerns/api/v1/teams/controller_base.rb
+- app/controllers/concerns/api/v1/users/controller_base.rb
 - app/models/platform/application.rb
-- app/serializers/api/v1/invitation_serializer.rb
-- app/serializers/api/v1/membership_serializer.rb
-- app/serializers/api/v1/team_serializer.rb
-- app/serializers/api/v1/user_serializer.rb
-- app/serializers/concerns/api/v1/invitations/serializer_base.rb
-- app/serializers/concerns/api/v1/memberships/serializer_base.rb
-- app/serializers/concerns/api/v1/teams/serializer_base.rb
-- app/serializers/concerns/api/v1/users/serializer_base.rb
 - app/views/account/platform/applications/_application.json.jbuilder
 - app/views/account/platform/applications/_breadcrumbs.html.erb
 - app/views/account/platform/applications/_form.html.erb
@@ -235,6 +135,10 @@ files:
 - app/views/account/platform/applications/new.html.erb
 - app/views/account/platform/applications/show.html.erb
 - app/views/account/platform/applications/show.json.jbuilder
+- app/views/api/v1/teams/index.json.jbuilder
+- app/views/api/v1/teams/show.json.jbuilder
+- app/views/api/v1/users/index.json.jbuilder
+- app/views/api/v1/users/show.json.jbuilder
 - config/locales/en/api.en.yml
 - config/locales/en/me.en.yml
 - config/locales/en/platform/applications.en.yml

data/app/controllers/api/base.rb

@@ -1,31 +0,0 @@
-require "grape-swagger"
-require_relative "../api"
-
-class Api::Base < Grape::API
-  content_type :jsonapi, "application/vnd.api+json"
-  formatter :json, Grape::Formatter::Jsonapi
-  formatter :jsonapi, Grape::Formatter::Jsonapi
-  format :jsonapi
-  default_error_formatter :json
-
-  mount Api::V1::Root
-
-  # Swagger docs are available at `/api/docs/swagger.json`.
-  add_swagger_documentation \
-    api_version: "v1",
-    array_use_braces: true,
-    base_path: "/api",
-    doc_version: "1.0",
-    endpoint_auth_wrapper: ::WineBouncer::OAuth2,
-    hide_documentation_path: true,
-    info: {
-      title: I18n.t("application.name"),
-      description: I18n.t("application.description")
-    },
-    mount_path: "/docs/swagger"
-
-  # TODO Reintroduce this once we've got `context` in current attributes.
-  # before do
-  #   Current.context = :api
-  # end
-end

data/app/controllers/api/model_parser.rb

@@ -1,42 +0,0 @@
-class Api::ModelParser < GrapeSwagger::Jsonapi::Parser
-  attr_reader :model, :endpoint
-
-  alias_method :schema, :call
-
-  def initialize(model, endpoint)
-    @model = model
-    @endpoint = endpoint
-  end
-
-  def call
-    # first let's grab the schema generated by the JSON:API parser
-    schema_json = schema.to_json
-
-    # From Nick Schneble:
-
-    # we can easily override these types for our API endpoints in the documentation
-    # but we can't do the same thing for the relationship objects that are auto-generated
-    # thus the fancy affair below
-
-    # if you want to learn more about what's happening here, read these:
-    # https://stackoverflow.com/a/17918118/1322386
-    # https://swagger.io/docs/specification/data-models/data-types/
-
-    # Swagger 3.0 only supports a subset of Ruby data types
-    schema_json.gsub!("\"type\":\"binary\"", "\"type\":\"string\", \"format\":\"binary\"")
-    schema_json.gsub!("\"type\":\"date\"", "\"type\":\"string\", \"format\":\"date\"")
-    schema_json.gsub!("\"type\":\"datetime\"", "\"type\":\"string\", \"format\":\"date-time\"")
-    schema_json.gsub!("\"type\":\"decimal\"", "\"type\":\"number\", \"format\":\"double\"")
-    schema_json.gsub!("\"type\":\"float\"", "\"type\":\"number\", \"format\":\"float\"")
-    schema_json.gsub!("\"type\":\"bigint\"", "\"type\":\"integer\", \"format\":\"int64\"")
-    schema_json.gsub!("\"type\":\"primary_key\"", "\"type\":\"integer\", \"format\":\"int64\"")
-    schema_json.gsub!("\"type\":\"references\"", "\"type\":\"object\"")
-    schema_json.gsub!("\"type\":\"text\"", "\"type\":\"string\"")
-    schema_json.gsub!("\"type\":\"time\"", "\"type\":\"string\", \"format\":\"time\"")
-    schema_json.gsub!("\"type\":\"timestamp\"", "\"type\":\"string\", \"format\":\"timestamp\"")
-    schema_json.gsub!("\"type\":\"json\"", "\"type\":\"array\", \"items\":{\"type\":\"string\"}")
-
-    # returns a Hash as if nothing fancy happened
-    JSON.parse(schema_json)
-  end
-end

data/app/controllers/api/v1/defaults.rb

@@ -1,36 +0,0 @@
-module Api::V1::Defaults
-  extend ActiveSupport::Concern
-
-  included do
-    before do
-      header["Access-Control-Allow-Origin"] = "*"
-      header["Access-Control-Request-Method"] = "*"
-    end
-
-    helpers do
-      def current_token
-        doorkeeper_access_token
-      end
-
-      def current_user
-        resource_owner
-      end
-
-      def current_scopes
-        current_token.scopes
-      end
-
-      def current_team
-        current_user.current_team
-      end
-
-      def current_membership
-        current_user.memberships.where(team: current_team).first
-      end
-
-      def current_locale
-        current_user.locale || current_team.locale || "en"
-      end
-    end
-  end
-end

data/app/controllers/api/v1/exceptions_handler.rb

@@ -1,50 +0,0 @@
-module Api::V1::ExceptionsHandler
-  extend ActiveSupport::Concern
-
-  included do
-    helpers do
-      def record_not_saved(model)
-        handle_api_error(ActiveRecord::RecordNotSaved.new(model.errors.full_messages.first), :unprocessable_entity)
-      end
-
-      def handle_api_error(error, status = nil)
-        error!("Something rather unexpected has occurred", 500) unless error
-
-        error_class = error.class.name
-        status_code = convert_status_symbol_to_integer(status) if status # allows an explicit status to be defined
-
-        message = error.message # works fine for most errors
-        message = "OAuth error: #{error}" if /WineBouncer::Errors/.match?(error_class)
-        message = "Route error: #{error}" if /CanCan::AccessDenied/.match?(error_class)
-
-        if /OAuthUnauthorizedError/.match?(error_class)
-          error!(message, status_code || 401) # unauthorized
-        elsif /OAuthForbiddenError/.match?(error_class) || /CanCan::AccessDenied/.match?(error_class)
-          error!(message, status_code || 403) # forbidden
-        elsif /RecordNotFound/.match?(error_class) || /unable to find/i.match?(message)
-          error!(message, status_code || 404) # not found
-        elsif /Grape::Exceptions::ValidationErrors/.match?(error_class)
-          error!(message, status_code || 406) # not acceptable
-        else
-          Rails.logger.error message unless Rails.env.test?
-
-          options = {error: message}
-          options[:trace] = error.backtrace[0, 10] unless Rails.env.production?
-
-          status_code = status_code || error.try(:status) || 500 # internal server error
-
-          Rack::Response.new(options.to_json, status_code, {
-            "Content-Type" => "application/json",
-            "Access-Control-Allow-Origin" => "*",
-            "Access-Control-Request-Method" => "*"
-          }).finish
-        end
-      end
-
-      def convert_status_symbol_to_integer(status)
-        # defaults to an internal server error if the status code can't be found
-        Rack::Utils::SYMBOL_TO_STATUS_CODE[status] || 500
-      end
-    end
-  end
-end

data/app/controllers/api/v1/loads_and_authorizes_api_resource.rb

@@ -1,42 +0,0 @@
-module Api::V1::LoadsAndAuthorizesApiResource
-  extend ActiveSupport::Concern
-
-  included do
-    helpers do
-      def load_and_authorize_api_resource(api_resource_class)
-        raise unless api_resource_class.present?
-
-        instance_variable_name = "@#{api_resource_class.name.demodulize.underscore}"
-        instance_variable_collection_name = instance_variable_name.pluralize
-
-        options = route.settings[:api_resource_options] || {permission: :read, skip_authorize: false}
-
-        permission = options[:permission]
-        skip_authorize = options[:skip_authorize]
-
-        api_resource_params = declared(params, include_missing: false)
-        api_resource_param_id = api_resource_params[:id]
-        api_resource_params_other_ids = api_resource_params.select { |param, value|
-          /_id$/i.match?(param)
-        }
-
-        all_accessible_api_resources = api_resource_class.accessible_by(current_ability, permission)
-
-        if api_resource_param_id.present? # :read, :update, :delete
-          instance_variable_set(instance_variable_name, all_accessible_api_resources.find(api_resource_param_id))
-        elsif permission.eql? :create
-          instance_variable_set(instance_variable_name, api_resource_class.new(api_resource_params))
-        elsif permission.eql? :read
-          all_accessible_api_resources = all_accessible_api_resources.where(api_resource_params_other_ids) if api_resource_params_other_ids.present?
-          instance_variable_set(instance_variable_collection_name, all_accessible_api_resources)
-          skip_authorize = true # can't use CanCan to authorize collections
-        end
-
-        eval "authorize! :#{permission}, #{instance_variable_name}" unless skip_authorize
-      rescue ActiveRecord::RecordNotFound
-        # the default RecordNotFound message includes the raw SQL... which feels bad
-        handle_api_error(ActiveRecord::RecordNotFound.new("The id #{api_resource_param_id} could not be found."))
-      end
-    end
-  end
-end

data/app/controllers/api/v1/me_endpoint.rb

@@ -1,9 +0,0 @@
-class Api::V1::MeEndpoint < Api::V1::Root
-  resource :me, desc: Api.title(:actions) do
-    desc Api.title(:show), &Api.show_desc
-    oauth2
-    get do
-      render current_user, include: [:teams, :memberships], serializer: "Api::V1::UserSerializer", adapter: :attributes
-    end
-  end
-end

data/app/controllers/api/v1/teams_endpoint.rb

@@ -1,9 +0,0 @@
-class Api::V1::TeamsEndpoint < Api::V1::Root
-  PARAMS = proc do
-    # 🚅 super scaffolding will insert new fields above this line.
-    # 🚅 super scaffolding will insert new arrays above this line.
-    # 🚅 super scaffolding will insert processing for new fields above this line.
-  end
-
-  include Api::V1::Teams::EndpointBase
-end

data/app/controllers/api/v1.rb

@@ -1,4 +0,0 @@
-require "api"
-
-module Api::V1
-end

data/app/controllers/api.rb

@@ -1,96 +0,0 @@
-# We have to do this because there are a couple of different Grape contexts where you're trying to define something
-# for a model's API representation, but the execution context doesn't have access to the endpoint object you're
-# defining things for. I understand the design thinking that caused that situation, but unfortunately for us we just
-# have to brute force our way around it for now. In doing so, we're implementing something not unlike the magic of the
-# `t` helper in Rails views.
-
-module Api
-  def self.topic
-    path = caller.find { |path| (path.include?("controllers/api") || path.include?("app/controllers/concerns/api")) && !path.include?("app/controllers/api.rb") && !path.include?("app/controllers/api/v1/root.rb") && !path.include?("app/controllers/api/base.rb") }
-    if path.include?("controllers/api")
-      path.split(/\/app\/controllers\/api\/v\d+\//).last.split("_endpoint.").first
-    elsif path.include?("app/controllers/concerns/api")
-      path.split(/\/app\/controllers\/concerns\/api\/v\d+\//).last.split("/endpoint_base.").first
-    end
-  end
-
-  def self.serializer
-    # TODO This could be smart enough to figure out if `V1` is accurate, as well.
-    "Api::V1::#{Api.topic.classify}Serializer"
-  end
-
-  def self.status(code)
-    I18n.t("api.statuses.#{code}")
-  end
-
-  def self.title(path)
-    I18n.t("#{topic}.api.#{path}")
-  end
-
-  def self.heading(path)
-    I18n.t("#{topic}.api.fields.#{path}.heading")
-  end
-
-  def self.show_desc
-    proc do
-      success code: 200, model: Api.serializer, message: Api.status(200)
-      failure [
-        {code: 401, message: Api.status(401)}, # unauthorized
-        {code: 403, message: Api.status(403)}, # forbidden
-        {code: 404, message: Api.status(404)}, # not found
-        {code: 429, message: Api.status(429)} # too many requests
-      ]
-      produces ["application/vnd.api+json"]
-    end
-  end
-
-  def self.index_desc
-    proc do
-      success code: 200, model: Api.serializer, message: Api.status(200)
-      failure [
-        {code: 401, message: Api.status(401)}, # unauthorized
-        {code: 429, message: Api.status(429)} # too many requests
-      ]
-      produces ["application/vnd.api+json"]
-      is_array true
-    end
-  end
-
-  def self.create_desc
-    proc do
-      success code: 201, model: Api.serializer, message: Api.status(201)
-      failure [
-        {code: 400, message: Api.status(400)}, # bad request
-        {code: 401, message: Api.status(401)}, # unauthorized
-        {code: 403, message: Api.status(403)}, # forbidden
-        {code: 406, message: Api.status(406)}, # not acceptable
-        {code: 422, message: Api.status(422)}, # unprocessable entity
-        {code: 429, message: Api.status(429)} # too many requests
-      ]
-      consumes ["application/json", "multipart/form-data"]
-      produces ["application/vnd.api+json"]
-    end
-  end
-
-  def self.update_desc
-    proc do
-      success code: 200, model: Api.serializer, message: Api.status(200)
-      failure [
-        {code: 400, message: Api.status(400)}, # bad request
-        {code: 401, message: Api.status(401)}, # unauthorized
-        {code: 403, message: Api.status(403)}, # forbidden
-        {code: 404, message: Api.status(404)}, # not found
-        {code: 406, message: Api.status(406)}, # not acceptable
-        {code: 422, message: Api.status(422)}, # unprocessable entity
-        {code: 429, message: Api.status(429)} # too many requests
-      ]
-      consumes ["application/json", "multipart/form-data"]
-      produces ["application/vnd.api+json"]
-    end
-  end
-
-  def self.destroy_desc
-    # TODO We don't have anything for this, but we want to make sure it's easy to roll out updates going forward.
-    proc {}
-  end
-end

data/app/controllers/concerns/api/v1/base.rb

@@ -1,37 +0,0 @@
-module Api::V1::Base
-  extend ActiveSupport::Concern
-
-  included do
-    include Api::V1::Defaults
-    include Api::V1::LoadsAndAuthorizesApiResource
-    include Api::V1::ExceptionsHandler
-
-    version "v1"
-
-    use ::WineBouncer::OAuth2, message: "Doorkeeper OAuth2 Authentication"
-
-    rescue_from :all do |error|
-      handle_api_error(error)
-    end
-
-    BulletTrain::Api.endpoints.each do |endpoint_class|
-      mount endpoint_class.constantize
-    end
-
-    after_validation do
-      # Ensure responses never get cached.
-      header "Cache-Control", "no-store"
-    end
-  end
-
-  class_methods do
-    # TODO I actually don't know of any way to make this work. This was supposed to be run after all other endpoints
-    # are registered, but I don't know of a way to know when we're done running `initializer` blocks from the engines
-    # a user may have included.
-    def handle_not_found
-      route :any, "*path" do
-        raise StandardError, "Unable to find API endpoint"
-      end
-    end
-  end
-end

data/app/controllers/concerns/api/v1/teams/endpoint_base.rb

@@ -1,87 +0,0 @@
-module Api::V1::Teams::EndpointBase
-  extend ActiveSupport::Concern
-
-  included do
-    helpers do
-      params :id do
-        requires :id, type: Integer, allow_blank: false, desc: Api.heading(:id)
-      end
-
-      params :team do
-        optional :name, type: String, allow_blank: false, desc: Api.heading(:name)
-        optional :locale, type: String, desc: Api.heading(:locale)
-
-        # TODO I don't like this, but I can't figure out a better way to accomplish the same thing. I'm open to any
-        # suggestions on this. I don't know why `@api.class` returns `Class` but `@api.to_s` returns e.g.
-        # `Api::V1::TeamsEndpoint`, but since we can get the latter, we'll use that to fetch whatever proc is defined
-        # in ADDITIONAL_PARAMS.
-        if defined?(@api.to_s.constantize::PARAMS)
-          instance_eval(&@api.to_s.constantize::PARAMS)
-        end
-      end
-    end
-
-    resource :teams, desc: Api.title(:actions) do
-      after_validation do
-        load_and_authorize_api_resource Team
-      end
-
-      desc Api.title(:index), &Api.index_desc
-      oauth2
-      paginate per_page: 100
-      get "/" do
-        @paginated_teams = paginate @teams
-        render @paginated_teams, serializer: Api.serializer, adapter: :attributes
-      end
-
-      desc Api.title(:show), &Api.show_desc
-      params do
-        use :id
-      end
-      oauth2
-      route_param :id do
-        get do
-          render @team, serializer: Api.serializer
-        end
-      end
-
-      desc Api.title(:create), &Api.create_desc
-      params do
-        use :team
-      end
-      route_setting :api_resource_options, permission: :create
-      oauth2 "write"
-      post "/" do
-        if @team.save
-          # sets the team creator as the default admin
-          @team.memberships.create(user: current_user, roles: [Role.admin])
-
-          current_user.current_team = @team
-          current_user.former_user = false
-          current_user.save
-
-          render @team, serializer: Api.serializer
-        else
-          record_not_saved @team
-        end
-      end
-
-      desc Api.title(:update), &Api.update_desc
-      params do
-        use :id
-        use :team
-      end
-      route_setting :api_resource_options, permission: :update
-      oauth2 "write"
-      route_param :id do
-        put do
-          if @team.update(declared(params, include_missing: false))
-            render @team, serializer: Api.serializer
-          else
-            record_not_saved @team
-          end
-        end
-      end
-    end
-  end
-end

data/app/serializers/api/v1/invitation_serializer.rb

@@ -1,8 +0,0 @@
-class Api::V1::InvitationSerializer < Api::V1::ApplicationSerializer
-  include Api::V1::Invitations::SerializerBase
-
-  # The `:id` entries are redundant, but for the moment they help us generate valid code.
-  attributes :id,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :id
-end

data/app/serializers/api/v1/membership_serializer.rb

@@ -1,8 +0,0 @@
-class Api::V1::MembershipSerializer < Api::V1::ApplicationSerializer
-  include Api::V1::Memberships::SerializerBase
-
-  # The `:id` entries are redundant, but for the moment they help us generate valid code.
-  attributes :id,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :id
-end

data/app/serializers/api/v1/team_serializer.rb

@@ -1,8 +0,0 @@
-class Api::V1::TeamSerializer < Api::V1::ApplicationSerializer
-  include Api::V1::Teams::SerializerBase
-
-  # The `:id` entries are redundant, but for the moment they help us generate valid code.
-  attributes :id,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :id
-end

data/app/serializers/api/v1/user_serializer.rb

@@ -1,8 +0,0 @@
-class Api::V1::UserSerializer < Api::V1::ApplicationSerializer
-  include Api::V1::Users::SerializerBase
-
-  # The `:id` entries are redundant, but for the moment they help us generate valid code.
-  attributes :id,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :id
-end

data/app/serializers/concerns/api/v1/invitations/serializer_base.rb

@@ -1,17 +0,0 @@
-module Api::V1::Invitations::SerializerBase
-  extend ActiveSupport::Concern
-
-  included do
-    set_type "invitation"
-
-    attributes :id,
-      :team_id,
-      :email,
-      :from_membership_id,
-      :created_at,
-      :updated_at
-
-    belongs_to :from_membership, serializer: Api::V1::MembershipSerializer
-    has_one :membership, serializer: Api::V1::MembershipSerializer
-  end
-end

data/app/serializers/concerns/api/v1/memberships/serializer_base.rb

@@ -1,24 +0,0 @@
-module Api::V1::Memberships::SerializerBase
-  extend ActiveSupport::Concern
-
-  included do
-    set_type "membership"
-
-    attributes :id,
-      :team_id,
-      :user_id,
-      :invitation_id,
-      :user_first_name,
-      :user_last_name,
-      :user_profile_photo_id,
-      :user_email,
-      :added_by_id,
-      :created_at,
-      :updated_at
-
-    belongs_to :user, serializer: Api::V1::UserSerializer
-    belongs_to :team, serializer: Api::V1::TeamSerializer
-    belongs_to :invitation, serializer: Api::V1::InvitationSerializer
-    belongs_to :added_by, serializer: Api::V1::MembershipSerializer
-  end
-end

data/app/serializers/concerns/api/v1/teams/serializer_base.rb

@@ -1,16 +0,0 @@
-module Api::V1::Teams::SerializerBase
-  extend ActiveSupport::Concern
-
-  included do
-    set_type "team"
-
-    attributes :id,
-      :name,
-      :time_zone,
-      :locale,
-      :created_at,
-      :updated_at
-
-    has_many :scaffolding_absolutely_abstract_creative_concepts, serializer: Api::V1::Scaffolding::AbsolutelyAbstract::CreativeConceptSerializer
-  end
-end

data/app/serializers/concerns/api/v1/users/serializer_base.rb

@@ -1,22 +0,0 @@
-module Api::V1::Users::SerializerBase
-  extend ActiveSupport::Concern
-
-  included do
-    set_type "user"
-
-    attributes :id,
-      :email,
-      :first_name,
-      :last_name,
-      :time_zone,
-      :profile_photo_id,
-      :former_user,
-      :locale,
-      :platform_agent_of_id,
-      :created_at,
-      :updated_at
-
-    has_many :teams, serializer: Api::V1::TeamSerializer
-    has_many :memberships, serializer: Api::V1::MembershipSerializer
-  end
-end