bullet_train-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1a328cffebe8bbf05bf9d14df56afe1142c64cae544f63cc2a306fa1b999cd8
+  data.tar.gz: 6e0d56ea3c25db247665f92b2c443ab027ad2a14540307ae0e938b4a9ad890cd
+SHA512:
+  metadata.gz: 417fb8b614b5a43313c63f1c12572a5ce26eb604412d04deccade31ba27b22974dd32c08791cb1aba0b5397ddba59d94874a131af11e77ea61080875dc85442c
+  data.tar.gz: dc17c6b4d31ef02c167da2f69262794960e7cd4e1d8bc96142109262c9326a73f7e0cb77998a6854df0eb0cb2c87f1119f4a6ba257c9675beed3a2b487997ca7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Andrew Culver
+
+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,28 @@
+# BulletTrain::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-api"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/account/platform/applications_controller.rb

@@ -0,0 +1,78 @@
+class Account::Platform::ApplicationsController < Account::ApplicationController
+  account_load_and_authorize_resource :application, through: :team, through_association: :platform_applications
+
+  # GET /account/teams/:team_id/platform/applications
+  # GET /account/teams/:team_id/platform/applications.json
+  def index
+    # if you only want these objects shown on their parent's show page, uncomment this:
+    # redirect_to [:account, @team]
+  end
+
+  # GET /account/platform/applications/:id
+  # GET /account/platform/applications/:id.json
+  def show
+  end
+
+  # GET /account/teams/:team_id/platform/applications/new
+  def new
+  end
+
+  # GET /account/platform/applications/:id/edit
+  def edit
+  end
+
+  # POST /account/teams/:team_id/platform/applications
+  # POST /account/teams/:team_id/platform/applications.json
+  def create
+    respond_to do |format|
+      if @application.save
+        format.html { redirect_to [:account, @team, :platform_applications], notice: I18n.t("platform/applications.notifications.created") }
+        format.json { render :show, status: :created, location: [:account, @application] }
+      else
+        format.html { render :new, status: :unprocessable_entity }
+        format.json { render json: @application.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /account/platform/applications/:id
+  # PATCH/PUT /account/platform/applications/:id.json
+  def update
+    respond_to do |format|
+      if @application.update(application_params)
+        format.html { redirect_to [:account, @application], notice: I18n.t("platform/applications.notifications.updated") }
+        format.json { render :show, status: :ok, location: [:account, @application] }
+      else
+        format.html { render :edit, status: :unprocessable_entity }
+        format.json { render json: @application.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /account/platform/applications/:id
+  # DELETE /account/platform/applications/:id.json
+  def destroy
+    @application.destroy
+    respond_to do |format|
+      format.html { redirect_to [:account, @team, :platform_applications], notice: I18n.t("platform/applications.notifications.destroyed") }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def application_params
+    strong_params = params.require(:platform_application).permit(
+      :name,
+      :scopes,
+      :redirect_uri,
+      # 🚅 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.
+
+    strong_params
+  end
+end

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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,8 @@
+class Api::V1::MeEndpoint < Api::V1::Root
+  resource :me do
+    oauth2
+    get "/" do
+      render Api::V1::UserSerializer.new(current_user, include: [:teams, :memberships]).to_json
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+class Api::V1::Root < Api::Base
+  include Api::V1::Defaults
+  include Api::V1::LoadsAndAuthorizesApiResource
+
+  version "v1"
+  use ::WineBouncer::OAuth2
+
+  rescue_from :all do |error|
+    handle_api_error(error)
+  end
+
+  unless scaffolding_things_disabled?
+    mount Api::V1::Scaffolding::AbsolutelyAbstract::CreativeConceptsEndpoint
+    mount Api::V1::Scaffolding::CompletelyConcrete::TangibleThingsEndpoint
+  end
+
+  mount Api::V1::MeEndpoint
+  mount Api::V1::TeamsEndpoint
+  mount Api::V1::Webhooks::Outgoing::EndpointsEndpoint
+  mount Api::V1::Webhooks::Outgoing::DeliveriesEndpoint
+  mount Api::V1::Webhooks::Outgoing::DeliveryAttemptsEndpoint
+  # 🚅 super scaffolding will mount new endpoints above this line.
+
+  route :any, "*path" do
+    raise StandardError, "Unable to find API endpoint"
+  end
+end

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

@@ -0,0 +1,79 @@
+class Api::V1::TeamsEndpoint < Api::V1::Root
+  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)
+      # 🚅 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
+  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

data/app/controllers/api/v1.rb

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

data/app/models/platform/application.rb

@@ -0,0 +1,51 @@
+class Platform::Application < ApplicationRecord
+  self.table_name = "oauth_applications"
+
+  include Doorkeeper::Orm::ActiveRecord::Mixins::Application
+  # 🚅 add concerns above.
+
+  belongs_to :team
+  # 🚅 add belongs_to associations above.
+
+  # 🚅 add has_many associations above.
+
+  # 🚅 add oauth providers above.
+
+  has_one :membership, foreign_key: :platform_agent_of_id, dependent: :nullify
+  has_one :user, foreign_key: :platform_agent_of_id
+  # 🚅 add has_one associations above.
+
+  # 🚅 add scopes above.
+
+  # 🚅 add validations above.
+
+  after_create :create_user_and_membership
+  after_update :update_user_and_membership
+  before_destroy :destroy_user
+  # 🚅 add callbacks above.
+
+  # 🚅 add delegations above.
+
+  def label_string
+    name
+  end
+
+  def create_user_and_membership
+    faux_password = SecureRandom.hex
+    create_user(email: "noreply+#{SecureRandom.hex}@bullettrain.co", password: faux_password, password_confirmation: faux_password, first_name: label_string)
+    create_membership(team: team, user: user)
+    membership.roles << Role.admin
+  end
+
+  def update_user_and_membership
+    user.update(first_name: label_string)
+  end
+
+  def destroy_user
+    former_user = membership.user
+    membership.nullify_user
+    former_user.destroy
+  end
+
+  # 🚅 add methods above.
+end

data/app/views/account/platform/applications/_application.json.jbuilder

@@ -0,0 +1,10 @@
+json.extract! application,
+  :id,
+  :team_id,
+  :name,
+  :scopes,
+  :redirect_uri,
+  # 🚅 super scaffolding will insert new fields above this line.
+  :created_at,
+  :updated_at
+json.url account_platform_application_url(application, format: :json)

data/app/views/account/platform/applications/_breadcrumbs.html.erb

@@ -0,0 +1,8 @@
+<% application ||= @application %>
+<% team ||= @team || application&.team %>
+<%= render 'account/teams/breadcrumbs', team: team %>
+<%= render 'account/shared/breadcrumb', label: t('.label'), url: [:account, team, :platform_applications] %>
+<% if application&.persisted? %>
+  <%= render 'account/shared/breadcrumb', label: application.label_string, url: [:account, application] %>
+<% end %>
+<%= render 'account/shared/breadcrumbs/actions', only_for: 'platform/applications' %>

data/app/views/account/platform/applications/_form.html.erb

@@ -0,0 +1,20 @@
+<%= form_with model: application, url: (application.persisted? ? [:account, application] : [:account, @team, :platform_applications]), local: true, class: 'form' do |form| %>
+  <%= render 'account/shared/forms/errors', form: form %>
+
+  <% with_field_settings form: form do %>
+    <%= render 'shared/fields/text_field', method: :name, options: {autofocus: true} %>
+    <%= render 'shared/fields/text_field', method: :scopes %>
+    <%= render 'shared/fields/text_field', method: :redirect_uri %>
+    <%# 🚅 super scaffolding will insert new fields above this line. %>
+  <% end %>
+
+  <div class="buttons">
+    <%= form.submit (form.object.persisted? ? t('.buttons.update') : t('.buttons.create')), class: "button" %>
+    <% if form.object.persisted? %>
+    <%= link_to t('global.buttons.cancel'), [:account, application], class: "button-secondary" %>
+    <% else %>
+    <%= link_to t('global.buttons.cancel'), [:account, @team, :platform_applications], class: "button-secondary" %>
+    <% end %>
+  </div>
+
+<% end %>

data/app/views/account/platform/applications/_index.html.erb

@@ -0,0 +1,64 @@
+<% team = @team || @team %>
+<% context ||= team %>
+<% collection ||= :platform_applications %>
+<% hide_actions ||= false %>
+<% hide_back ||= false %>
+
+<%= render 'account/shared/box' do |p| %>
+  <% p.content_for :title, t(".contexts.#{context.class.name.underscore}.header") %>
+  <% p.content_for :description do %>
+    <%= t(".contexts.#{context.class.name.underscore}.description#{"_empty" unless applications.any?}") %>
+  <% end %>
+
+  <% p.content_for :table do %>
+    <% if applications.any? %>
+      <table class="table">
+        <thead>
+          <tr>
+            <th><%= t('.fields.name.heading') %></th>
+            <th><%= t('.fields.scopes.heading') %></th>
+            <%# 🚅 super scaffolding will insert new field headers above this line. %>
+            <th><%= t('.fields.created_at.heading') %></th>
+            <th class="text-right"></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% applications.each do |application| %>
+            <% with_attribute_settings object: application do %>
+              <tr data-id="<%= application.id %>">
+                <td><%= render 'shared/attributes/text', attribute: :name, url: [:account, application] %></td>
+                <td><%= render 'shared/attributes/text', attribute: :scopes %></td>
+                <%# 🚅 super scaffolding will insert new fields above this line. %>
+                <td><%= display_date_and_time(application.created_at) %></td>
+                <td class="buttons">
+                  <% unless hide_actions %>
+                    <% if can? :edit, application %>
+                      <%= link_to t('.buttons.shorthand.edit'), [:edit, :account, application], class: 'button-secondary button-smaller' %>
+                    <% end %>
+                    <% if can? :destroy, application %>
+                      <%= button_to t('.buttons.shorthand.destroy'), [:account, application], method: :delete, data: { confirm: t('.buttons.confirmations.destroy', model_locales(application)) }, class: 'button-secondary button-smaller' %>
+                    <% end %>
+                  <% end %>
+                </td>
+              </tr>
+            <% end %>
+          <% end %>
+        </tbody>
+      </table>
+    <% end %>
+  <% end %>
+
+  <% p.content_for :actions do %>
+    <% unless hide_actions %>
+      <% if context == team %>
+        <% if can? :create, Platform::Application.new(team: team) %>
+          <%= link_to t('.buttons.new'), [:new, :account, team, :platform_application], class: "#{first_button_primary(:platform_application)} new" %>
+        <% end %>
+      <% end %>
+
+      <% unless hide_back %>
+        <%= link_to t('global.buttons.back'), [:account, context], class: "#{first_button_primary(:platform_application)} back" %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/_menu_item.html.erb

@@ -0,0 +1,10 @@
+<% if can? :read, Platform::Application.new(team: current_team) %>
+  <%= render 'account/shared/menu/item', {
+    url: main_app.polymorphic_path([:account, current_team, :platform_applications]),
+    label: t('platform/applications.navigation.label'),
+  } do |p| %>
+    <% p.content_for :icon do %>
+      <i class="<%= t('platform/applications.navigation.icon') %>"></i>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/edit.html.erb

@@ -0,0 +1,12 @@
+<%= render 'account/shared/page' do |p| %>
+  <% p.content_for :title, t('.section') %>
+  <% p.content_for :body do %>
+    <%= render 'account/shared/box', divider: true do |p| %>
+      <% p.content_for :title, t('.header') %>
+      <% p.content_for :description, t('.description') %>
+      <% p.content_for :body do %>
+        <%= render 'form', application: @application %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/index.html.erb

@@ -0,0 +1,6 @@
+<%= render 'account/shared/page' do |p| %>
+  <% p.content_for :title, t('.section') %>
+  <% p.content_for :body do %>
+    <%= render 'index', applications: @applications %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @applications, partial: "platform/applications/application", as: :application

data/app/views/account/platform/applications/new.html.erb

@@ -0,0 +1,12 @@
+<%= render 'account/shared/page' do |p| %>
+  <% p.content_for :title, t('.section') %>
+  <% p.content_for :body do %>
+    <%= render 'account/shared/box', divider: true do |p| %>
+      <% p.content_for :title, t('.header') %>
+      <% p.content_for :description, t('.description') %>
+      <% p.content_for :body do %>
+        <%= render 'form', application: @application %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/show.html.erb

@@ -0,0 +1,31 @@
+<%= render 'account/shared/page' do |p| %>
+  <% p.content_for :title, t('.section') %>
+  <% p.content_for :body do %>
+    <%= render 'account/shared/box', divider: true do |p| %>
+      <% p.content_for :title, t('.header') %>
+      <% p.content_for :description do %>
+        <%= t('.description') %>
+        <%= t('.manage_description') if can? :manage, @application %>
+      <% end %>
+
+      <% p.content_for :body do %>
+        <% with_attribute_settings object: @application, strategy: :label do %>
+          <%= render 'shared/attributes/text', attribute: :name %>
+          <%= render 'shared/attributes/code', attribute: :uid %>
+          <%= render 'shared/attributes/code', attribute: :secret %>
+          <%= render 'shared/attributes/text', attribute: :scopes %>
+          <%= render 'shared/attributes/text', attribute: :redirect_uri %>
+          <%# 🚅 super scaffolding will insert new fields above this line. %>
+        <% end %>
+      <% end %>
+
+      <% p.content_for :actions do %>
+        <%= link_to t('.buttons.edit'), [:edit, :account, @application], class: first_button_primary if can? :edit, @application %>
+        <%= button_to t('.buttons.destroy'), [:account, @application], method: :delete, class: first_button_primary, data: { confirm: t('.buttons.confirmations.destroy', model_locales(@application)) } if can? :destroy, @application %>
+        <%= link_to t('global.buttons.back'), [:account, @team, :platform_applications], class: first_button_primary %>
+      <% end %>
+    <% end %>
+
+    <%# 🚅 super scaffolding will insert new children above this line. %>
+  <% end %>
+<% end %>

data/app/views/account/platform/applications/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "platform/applications/application", application: @application

data/config/locales/en/api.en.yml

@@ -0,0 +1,13 @@
+en:
+  api:
+    statuses:
+      200: "Success" # okay
+      201: "Success" # created
+      400: "Missing or Bad Parameters" # bad request
+      401: "Not Authorized" # unauthorized
+      403: "Permission Denied" # forbidden
+      404: "Record Not Found" # not found
+      406: "Validation Errors" # not acceptable
+      422: "Record Not Saved" # unprocessable entity
+      429: "API Rate Limit Exceeded" # too many requests
+      500: "Internal Server Error" # internal server error

data/config/locales/en/platform/applications.en.yml

@@ -0,0 +1,103 @@
+en:
+  platform/applications: &applications
+    label: &label Platform Applications
+    breadcrumbs:
+      label: *label
+    navigation:
+      label: Your Applications
+      icon: fal fa-browser ti ti-plug
+    buttons: &buttons
+      new: Add New Platform Application
+      create: Provision Platform Application
+      edit: Edit Platform Application
+      update: Update Platform Application
+      destroy: Remove Platform Application
+      shorthand:
+        edit: Edit
+        destroy: Delete
+        disconnect: Disconnect
+      confirmations:
+        # TODO customize for your use-case.
+        destroy: Are you sure you want to remove %{application_name}? This will also remove it's associated data. This can't be undone.
+        disconnect: Are you sure you want to disconnect %{application_name}? This might affect an ongoing service provided by %{application_name} and can not be undone.
+    fields: &fields
+      name:
+        _: &name Name
+        label: *name
+        heading: Application Name
+
+      scopes:
+        _: &scopes Scopes
+        label: *scopes
+        heading: *scopes
+        help: Scopes are like permissions. An OAuth application can have read, write, and/or delete access. Separate scopes with spaces. Leave this field blank to use the default scope, e.g. "read". Optional scopes are "write" and "delete".
+
+      redirect_uri:
+        _: &redirect_uri Redirect URI
+        label: *redirect_uri
+        heading: *redirect_uri
+        help: You can leave this field blank.
+
+      uid:
+        heading: Client UID
+
+      secret:
+        heading: Client Secret
+
+      label_string:
+        heading: Application Name
+
+      # 🚅 super scaffolding will insert new fields above this line.
+      created_at:
+        _: &created_at Added
+        label: *created_at
+        heading: *created_at
+      updated_at:
+        _: &updated_at Updated
+        label: *updated_at
+        heading: *updated_at
+    index:
+      section: "%{teams_possessive} Platform Applications"
+      contexts:
+        team:
+          header: Platform Applications
+          description: Below is a list of Platform Applications that have been provisioned for %{team_name}.
+          description_empty: No Platform Applications have been provisioned for %{team_name}.
+      fields: *fields
+      buttons: *buttons
+    show:
+      section: "%{application_name}"
+      header: Platform Application Details
+      description: Below are the details we have for %{application_name}.
+      manage_description: You'll also find options for updating these details or removing %{application_name} from %{team_name} entirely.
+      fields: *fields
+      buttons: *buttons
+    form: &form
+      buttons: *buttons
+      fields: *fields
+    new:
+      section: "New Platform Application for %{team_name}"
+      header: New Platform Application Details
+      description: Please provide the details of the new Platform Application you'd like to provision for %{team_name}.
+      form: *form
+    edit:
+      section: "%{application_name}"
+      header: Edit Platform Application Details
+      description: You can update the details or settings for %{application_name} below.
+      form: *form
+    notifications:
+      created: Platform Application was successfully created.
+      updated: Platform Application was successfully updated.
+      destroyed: Platform Application was successfully destroyed.
+  account:
+    platform:
+      applications: *applications
+  activerecord:
+    attributes:
+      platform/application:
+        name: *name
+        scopes: *scopes
+        redirect_uri: *redirect_uri
+        # 🚅 super scaffolding will insert new activerecord attributes above this line.
+        created_at: *created_at
+        updated_at: *updated_at

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bullet_train/api/engine.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module Api
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bullet_train/api/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module Api
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/api.rb

@@ -0,0 +1,8 @@
+require "bullet_train/api/version"
+require "bullet_train/api/engine"
+
+module BulletTrain
+  module Api
+    # Your code goes here...
+  end
+end

data/lib/tasks/bullet_train/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Bullet Train API
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bullet_train_api_manifest.js
+- app/controllers/account/platform/applications_controller.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/root.rb
+- app/controllers/api/v1/teams_endpoint.rb
+- app/models/platform/application.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
+- app/views/account/platform/applications/_index.html.erb
+- app/views/account/platform/applications/_menu_item.html.erb
+- app/views/account/platform/applications/edit.html.erb
+- app/views/account/platform/applications/index.html.erb
+- app/views/account/platform/applications/index.json.jbuilder
+- app/views/account/platform/applications/new.html.erb
+- app/views/account/platform/applications/show.html.erb
+- app/views/account/platform/applications/show.json.jbuilder
+- config/locales/en/api.en.yml
+- config/locales/en/platform/applications.en.yml
+- config/routes.rb
+- lib/bullet_train/api.rb
+- lib/bullet_train/api/engine.rb
+- lib/bullet_train/api/version.rb
+- lib/tasks/bullet_train/api_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-api
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-api
+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.2.22
+signing_key:
+specification_version: 4
+summary: Bullet Train API
+test_files: []