bullet_train-api 1.2.9 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b3fdf5c4b02d770a18da4612bc302ad25ebc2dbe91fb71457e75e2a9d47702b
-  data.tar.gz: d2e9a87102c8e1fcae0d2c9938a6e5b05e77cc4906c19234c31128f4be556586
+  metadata.gz: a4f8d6d77dec24dd8d2766815d042af01738dca790794a8b25566e7cd856460d
+  data.tar.gz: 9824629fabe7e7c6cbc6ad32aa33c1f15a2d6c96f41549c0222565cdfba4c708
 SHA512:
-  metadata.gz: 57265a7f4ff132ccc4651b9e753a1844b39712777a7f3212dc124747489a6873bcdc1f440449ab0dc4601f888c3306cc0d78032feff19fff9066f312cb5c06b6
-  data.tar.gz: 213ed7b2de13d9305efaa4bb7b4d224c514133425b07d06d4f91f751d36a6bf64022bde0bff1da424ee3fe90161751d050b727069f928a4306311f6892f6b639
+  metadata.gz: 4a2d7f5e1718ab4fc68507c0c63a0ebe19cb3f7ef1c235e05ba96b41c93902f309300778431b4c0b6e66b4b24b9bdbced1761507471ac488ad4dbcd4c9208b82
+  data.tar.gz: b1e2fe3aac4d7e8bfe715b02c1741681fbac2d93a8cb6255bc69b5f8529d5a2ec694690ad2908a83a6788985b3be412de560a1dc0ccc50a1b30ef0dad9b16be8

data/app/controllers/api/open_api_controller.rb

@@ -25,6 +25,10 @@ module OpenApiHelper
     result
   end
 
+  def gem_paths
+    @gem_paths ||= `bundle show --paths`.lines.map { |gem_path| gem_path.chomp }
+  end
+
   def automatic_paths_for(model, parent, except: [])
     output = render("api/#{@version}/open_api/shared/paths", except: except)
     output = Scaffolding::Transformer.new(model.name, [parent&.name]).transform_string(output).html_safe
@@ -33,7 +37,7 @@ module OpenApiHelper
 
   def automatic_components_for(model, locals: {})
     path = "app/views/api/#{@version}"
-    paths = ([path] + `bundle show --paths`.lines.map { |gem_path| "#{gem_path.chomp}/#{path}" })
+    paths = ([path] + gem_paths.map { |gem_path| "#{gem_path}/#{path}" })
     jbuilder = Jbuilder::Schema.renderer(paths, locals: {
       # If we ever get to the point where we need a real model here, we should implement an example team in seeds that we can source it from.
       model.name.underscore.split("/").last.to_sym => model.new,
@@ -50,20 +54,41 @@ module OpenApiHelper
 
     attributes_output = JSON.parse(schema_json)
 
-    strong_params_module = "Api::#{@version.upcase}::#{model.name.pluralize}Controller::StrongParameters".constantize
-    strong_parameter_keys = BulletTrain::Api::StrongParametersReporter.new(model, strong_params_module).report
-    if strong_parameter_keys.last.is_a?(Hash)
-      strong_parameter_keys += strong_parameter_keys.pop.keys
-    end
+    # Rails attachments aren't technically attributes in a model,
+    # so we add the attributes manually to make them available in the API.
+    if model.attachment_reflections.any?
+      model.attachment_reflections.each do |reflection|
+        attribute_name = reflection.first
 
-    parameters_output = JSON.parse(schema_json)
-    parameters_output["required"].select! { |key| strong_parameter_keys.include?(key.to_sym) }
-    parameters_output["properties"].select! { |key, value| strong_parameter_keys.include?(key.to_sym) }
+        attributes_output["properties"][attribute_name] = {
+          "type" => "object",
+          "description" => attribute_name.titleize.to_s
+        }
+
+        attributes_output["example"].merge!({attribute_name.to_s => nil})
+      end
+    end
 
-    (
-      indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3) +
-      indent("    " + parameters_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Parameters:"), 3)
-    ).html_safe
+    if has_strong_parameters?("Api::#{@version.upcase}::#{model.name.pluralize}Controller".constantize)
+      strong_params_module = "Api::#{@version.upcase}::#{model.name.pluralize}Controller::StrongParameters".constantize
+      strong_parameter_keys = BulletTrain::Api::StrongParametersReporter.new(model, strong_params_module).report
+      if strong_parameter_keys.last.is_a?(Hash)
+        strong_parameter_keys += strong_parameter_keys.pop.keys
+      end
+
+      parameters_output = JSON.parse(schema_json)
+      parameters_output["required"].select! { |key| strong_parameter_keys.include?(key.to_sym) }
+      parameters_output["properties"].select! { |key, value| strong_parameter_keys.include?(key.to_sym) }
+
+      (
+        indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3) +
+        indent("    " + parameters_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Parameters:"), 3)
+      ).html_safe
+    else
+
+      indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3)
+        .html_safe
+    end
   end
 
   def paths_for(model)
@@ -76,7 +101,6 @@ module OpenApiHelper
     heading = t("#{current_model.name.underscore.pluralize}.fields.#{attribute}.heading")
     attribute_data = current_model.columns_hash[attribute.to_s]
 
-    # TODO: File fields don't show up in the columns_hash. How should we handle these?
     # Default to `string` when the type returns nil.
     type = attribute_data.nil? ? "string" : attribute_data.type
 
@@ -88,6 +112,13 @@ module OpenApiHelper
     indent(attribute_block.chomp, 2)
   end
   alias_method :parameter, :attribute
+
+  private
+
+  def has_strong_parameters?(controller)
+    methods = controller.action_methods
+    methods.include?("create") || methods.include?("update")
+  end
 end
 
 class Api::OpenApiController < ApplicationController

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

@@ -4,6 +4,10 @@ require "pagy_cursor/pagy/extras/uuid_cursor"
 module Api::Controllers::Base
   extend ActiveSupport::Concern
 
+  # We need this to show custom error that user is not authenticated
+  # neither with Doorkeeper nor with Devise
+  class NotAuthenticatedError < StandardError; end
+
   included do
     include ActionController::Helpers
     helper ApplicationHelper
@@ -42,6 +46,10 @@ module Api::Controllers::Base
       render json: {error: "Not found"}, status: :not_found
     end
 
+    rescue_from NotAuthenticatedError do |exception|
+      render json: {error: "Invalid token or no user signed in"}, status: :unauthorized
+    end
+
     before_action :apply_pagination, only: [:index]
   end
 
@@ -57,14 +65,24 @@ module Api::Controllers::Base
   end
 
   def current_user
-    raise Doorkeeper::Errors::InvalidToken unless doorkeeper_token.present?
+    @current_user ||= if doorkeeper_token
+      User.find_by(id: doorkeeper_token[:resource_owner_id])
+    else
+      warden.authenticate(scope: :user)
+    end
+
     # TODO Remove this rescue once workspace clusters can write to this column on the identity server.
     # TODO Make this logic configurable so that downstream developers can write different methods for this column getting updated.
-    begin
-      doorkeeper_token.update(last_used_at: Time.zone.now)
-    rescue ActiveRecord::StatementInvalid => _
+    if doorkeeper_token
+      begin
+        doorkeeper_token.update(last_used_at: Time.zone.now)
+      rescue ActiveRecord::StatementInvalid => _
+      end
     end
-    @current_user ||= User.find_by(id: doorkeeper_token[:resource_owner_id])
+
+    raise NotAuthenticatedError unless @current_user
+
+    @current_user
   end
 
   def current_team

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

@@ -4,16 +4,28 @@ module Api::V1::Users::ControllerBase
   module StrongParameters
     # Only allow a list of trusted parameters through.
     def user_params
-      strong_params = params.require(:user).permit(
-        *permitted_fields,
+      password_fields = [
+        :password,
+        :current_password,
+        :password_confirmation
+      ]
+      general_fields = [
         :email,
         :first_name,
         :last_name,
         :time_zone,
-        :locale,
-        :current_password,
-        :password,
-        :password_confirmation,
+        :locale
+      ]
+
+      selected_fields = if params.is_a?(BulletTrain::Api::StrongParametersReporter)
+        password_fields + general_fields
+      else
+        (params["commit"] == t(".buttons.update_password")) ? password_fields : general_fields
+      end
+
+      strong_params = params.require(:user).permit(
+        *permitted_fields,
+        *selected_fields,
         # 🚅 super scaffolding will insert new fields above this line.
         *permitted_arrays,
         # 🚅 super scaffolding will insert new arrays above this line.
@@ -50,4 +62,10 @@ module Api::V1::Users::ControllerBase
   # GET /api/v1/users/:id
   def show
   end
+
+  # PUT /api/v1/users/:id
+  # TODO: Implement this!
+  def update
+    raise "Not implemented"
+  end
 end

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

@@ -36,14 +36,7 @@
                     <%= render "shared/tables/checkbox", object: access_token %>
                     <td><%= render 'shared/attributes/code', attribute: :token, secret: true %></td>
                     <td><%= render 'shared/attributes/text', attribute: :description %></td>
-                    <td>
-                      <% if access_token.last_used_at %>
-                        <%= render 'shared/attributes/date_and_time', attribute: :last_used_at %>
-                      <% else %>
-                        <% # TODO Make it so we can just define a `default` key for `last_used_at` in the locale file and it will us that when present. %>
-                        Never
-                      <% end %>
-                    </td>
+                    <td><%= render 'shared/attributes/date_and_time', attribute: :last_used_at %></td>
                     <%# 🚅 super scaffolding will insert new fields above this line. %>
                     <td><%= render 'shared/attributes/date_and_time', attribute: :created_at %></td>
                     <td class="buttons">

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

@@ -3,22 +3,22 @@
   <% p.content_for :body do %>
     <ul class="space-y" data-turbo="false">
       <% @teams.each do |team| %>
-        <li class="bg-white border overflow-hidden sm:rounded-md dark:bg-sealBlue-400">
+        <li class="bg-white border overflow-hidden sm:rounded-md dark:bg-slate-400">
           <% body = capture do %>
             <div class="px-4 py-4 flex items-center sm:pl-8 sm:pr-6">
               <div class="min-w-0 flex-1 sm:flex sm:items-center sm:justify-between">
-                <div class="flex text-xl font-semibold text-blue uppercase group-hover:text-blue-dark tracking-widest dark:text-white">
+                <div class="flex text-xl font-semibold text-blue uppercase group-hover:text-blue-800 tracking-widest dark:text-white">
                   <%= team.name %>
                 </div>
                 <% unless can? :connect, team %>
-                  <div class="ml-5 flex-shrink-0 text-gray-400">
+                  <div class="ml-5 flex-shrink-0 text-slate-400">
                     <%= t(".not_allowed") %>
                   </div>
                 <% end %>
               </div>
               <% if can? :connect, team %>
                 <div class="ml-5 flex-shrink-0">
-                  <svg class="h-5 w-5 text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+                  <svg class="h-5 w-5 text-slate-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
                     <path fill-rule="evenodd" d="M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z" clip-rule="evenodd" />
                   </svg>
                 </div>
@@ -27,11 +27,11 @@
           <% end %>
 
           <% if can? :connect, team %>
-            <%= link_to request.url + "&team_id=#{team.id}", class: "group block hover:bg-gray-50 dark:hover:bg-sealBlue-400 dark:text-sealBlue-800" do %>
+            <%= link_to request.url + "&team_id=#{team.id}", class: "group block hover:bg-slate-50 dark:hover:bg-slate-400 dark:text-slate-800", data: {controller: "connection-workflow", action: "connection-workflow#disableTeamButton"} do %>
               <%= body %>
             <% end %>
           <% else %>
-            <div class="block dark:text-sealBlue-800">
+            <div class="block dark:text-slate-800">
               <%= body %>
             </div>
           <% end %>

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.2.9"
+    VERSION = "1.2.11"
   end
 end

data/lib/bullet_train/api.rb

@@ -30,5 +30,15 @@ module BulletTrain
     def self.all_versions
       (initial_version_numeric..current_version_numeric).map { |version| "v#{version}".to_sym }
     end
+
+    def self.set_configuration(application_class)
+      application_class.config.to_prepare do
+        Doorkeeper::ApplicationController.layout "devise"
+
+        if Doorkeeper::TokensController
+          require_relative "../tokens_controller"
+        end
+      end
+    end
   end
 end

data/lib/tasks/bullet_train/api_tasks.rake

@@ -8,7 +8,8 @@ namespace :bullet_train do
       # Calculate new version.
       initializer_content = File.new("config/initializers/api.rb").readline
       previous_version = initializer_content.scan(/v\d+/).pop
-      new_version = "v#{previous_version.scan(/\d+/).pop.to_i + 1}"
+      new_version_int = previous_version.scan(/\d+/).pop.to_i + 1
+      new_version = "v#{new_version_int}"
 
       # Update initializer.
       File.write("config/initializers/api.rb", initializer_content.gsub(previous_version, new_version))
@@ -70,6 +71,21 @@ namespace :bullet_train do
       end
       Scaffolding::FileManipulator.write("config/routes.rb", updated_file_contents)
 
+      # Update application locale for each locale that exists.
+      I18n.available_locales.each do |lang|
+        file = "config/locales/#{lang}/application.#{lang}.yml"
+        transformer = Scaffolding::Transformer.new("", "")
+
+        if File.exist?(file)
+          transformer.add_line_to_file(
+            file,
+            "#{new_version_int}: #{new_version.upcase}",
+            Scaffolding::Transformer::RUBY_NEW_API_VERSION_HOOK,
+            prepend: true
+          )
+        end
+      end
+
       puts "Finished bumping to #{new_version}"
     end
   end

data/lib/tokens_controller.rb

@@ -0,0 +1,21 @@
+# TODO Is there a better way to implement this?
+# This monkey patch is required to ensure the OAuth2 token includes which team was connected to.
+# It gets required by BulletTrain::Api.set_configuration.
+
+class Doorkeeper::TokensController
+  def create
+    headers.merge!(authorize_response.headers)
+
+    user = if authorize_response.is_a?(Doorkeeper::OAuth::ErrorResponse)
+      nil
+    else
+      User.find(authorize_response.token.resource_owner_id)
+    end
+
+    # Add the selected `team_id` to this response.
+    render json: authorize_response.body.merge(user&.teams&.one? ? {"team_id" => user.team_ids.first} : {}),
+      status: authorize_response.status
+  rescue Doorkeeper::Errors::DoorkeeperError => e
+    handle_token_exception(e)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.11
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -151,17 +151,14 @@ files:
 - app/views/account/platform/access_tokens/index.html.erb
 - app/views/account/platform/access_tokens/new.html.erb
 - app/views/account/platform/access_tokens/show.html.erb
-- 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
 - app/views/account/platform/connections/new.html.erb
 - app/views/api/v1/open_api/shared/_paths.yaml.erb
 - app/views/api/v1/open_api/teams/_paths.yaml.erb
@@ -196,6 +193,7 @@ files:
 - lib/bullet_train/platform.rb
 - lib/bullet_train/platform/connection_workflow.rb
 - lib/tasks/bullet_train/api_tasks.rake
+- lib/tokens_controller.rb
 homepage: https://github.com/bullet-train-co/bullet_train-api
 licenses:
 - MIT
@@ -217,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Bullet Train API

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

@@ -1,9 +0,0 @@
-json.extract! application,
-  :id,
-  :team_id,
-  :name,
-  :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/index.json.jbuilder

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

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

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