bullet_train-api 1.1.15 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14acbfaa73e947b800255ed5e8d31afeaa9d453e7da85ee6f46684bd2f824d8a
-  data.tar.gz: 698e7d97b1c9bce05d5ed049bc8552002b7a769ed97b3f7e7d0690bf6ef19bce
+  metadata.gz: e3cec04f6456085bc115f66416e2f5fcaf249c0685166e8a46a88b79b4bd1978
+  data.tar.gz: 0b14b88a2aa523a9ce4d75de6ce79c4f0e81a46d0394085ca16e6b477bf66037
 SHA512:
-  metadata.gz: 99eef514f9a218014d19576d8b17e0ecff0a475e672922c227a177203c6041e8db178ebc996a090919ffcb47b5b53d0adaadf70344de811501b7d8e4d49a8d09
-  data.tar.gz: 016203f358c8cbb80069d6975ab3d44fbad04ac8fe172ca6ff2f888cf744367f948b06ac8596e9fbd0c4098f54cff2ac13053b332d6ce50a37eca75c597c40da
+  metadata.gz: ae4e8eaf3d5c89797e736de09866fc071427244120ed45b9fdced3881f433e91660e3372dfda36bda508c5af59a2db8ddb4e55354a7fc7dc3344e3a65b0cd106
+  data.tar.gz: 6551bce70c06a57a8b82511db07cbebbebf87f8f385bfb3bd4910166a2d7d5d5c4cbfa7a3c334d9bef1bbaf975eddf75b5a64175a16cae446a85d1cf9460ddd0

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

@@ -21,6 +21,23 @@ class Account::Platform::ApplicationsController < Account::ApplicationController
   def edit
   end
 
+  def provision
+    if ENV["TESTING_PROVISION_KEY"].present? && params[:key] == ENV["TESTING_PROVISION_KEY"]
+      user = User.create(email: "test@#{SecureRandom.hex}.example.com", password: (password = SecureRandom.hex), password_confirmation: password)
+      provision_team = current_user.teams.create(name: "provision-team-#{SecureRandom.hex}", time_zone: user.time_zone)
+      test_application = Platform::Application.new(name: "test-application-#{SecureRandom.hex}", team: provision_team)
+
+      if test_application.save
+        access_token = test_application.create_access_token
+        render json: {message: I18n.t("platform/applications.notifications.test_application_created"), team_id: provision_team.id, access_token: access_token.token}
+      else
+        render json: {errors: test_application.errors, status: :unprocessable_entity}
+      end
+    else
+      render json: {message: I18n.t("platform/applications.notifications.test_application_failure")}
+    end
+  end
+
   # POST /account/teams/:team_id/platform/applications
   # POST /account/teams/:team_id/platform/applications.json
   def create

data/app/controllers/api/open_api_controller.rb

@@ -6,6 +6,7 @@ module OpenApiHelper
     lines.unshift(first_line).join.html_safe
   end
 
+  # TODO: Remove this method? It's not being used anywhere
   def components_for(model)
     for_model model do
       indent(render("api/#{@version}/open_api/#{model.name.underscore.pluralize}/components"), 2)
@@ -73,15 +74,20 @@ module OpenApiHelper
 
   def attribute(attribute)
     heading = t("#{current_model.name.underscore.pluralize}.fields.#{attribute}.heading")
-    # TODO A lot of logic to be done here.
-    indent("#{attribute}:\n  description: \"#{heading}\"\n  type: string", 2)
-  end
-
-  def parameter(attribute)
-    heading = t("#{current_model.name.underscore.pluralize}.fields.#{attribute}.heading")
-    # TODO A lot of logic to be done here.
-    indent("#{attribute}:\n  description: \"#{heading}\"\n  type: string", 2)
+    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
+
+    attribute_block = <<~YAML
+      #{attribute}:
+        description: "#{heading}"
+        type: #{type}
+    YAML
+    indent(attribute_block.chomp, 2)
   end
+  alias_method :parameter, :attribute
 end
 
 class Api::OpenApiController < ApplicationController

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

@@ -4,10 +4,6 @@ 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
@@ -16,14 +12,13 @@ module Api::Controllers::Base
     include Pagy::Backend
 
     before_action :set_default_response_format
-    before_action :doorkeeper_authorize!
     after_action :set_pagination_headers
 
     def modify_url_params(url, new_params)
       uri = URI.parse(url)
       query = Rack::Utils.parse_query(uri.query)
       new_params.each do |key, value|
-        query[key] = value
+        query[key.to_s] = value
       end
       uri.query = Rack::Utils.build_query(query)
       uri.to_s
@@ -35,8 +30,9 @@ module Api::Controllers::Base
       if @pagy.has_more?
         if (collection = instance_variable_get(collection_variable))
           next_cursor = collection.last.id
-          # TODO Probably not great that we're clobbering any `Link` header that might be set.
-          response.headers["Link"] = "<#{modify_url_params(request.url, after: next_cursor)}>; rel=next"
+          link_header = response.headers["Link"]
+          link_value = "<#{modify_url_params(request.url, after: next_cursor)}>; rel=\"next\""
+          response.headers["Link"] = link_header ? "#{link_header}, #{link_value}" : link_value
           response.headers["Pagination-Next"] = next_cursor
         end
       end
@@ -46,10 +42,6 @@ module Api::Controllers::Base
       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
 
@@ -65,7 +57,7 @@ module Api::Controllers::Base
   end
 
   def current_user
-    raise NotAuthenticatedError unless doorkeeper_token.present?
+    raise Doorkeeper::Errors::InvalidToken unless doorkeeper_token.present?
     # 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
@@ -95,8 +87,12 @@ module Api::Controllers::Base
   end
 
   class_methods do
+    def controller_namespace
+      name.split("::").first(2).join("::")
+    end
+
     def regex_to_remove_controller_namespace
-      /^#{name.split("::").first(2).join("::") + "::"}/
+      /^#{controller_namespace + "::"}/
     end
   end
 end

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

@@ -11,6 +11,9 @@ module Api::V1::Users::ControllerBase
         :last_name,
         :time_zone,
         :locale,
+        :current_password,
+        :password,
+        :password_confirmation,
         # 🚅 super scaffolding will insert new fields above this line.
         *permitted_arrays,
         # 🚅 super scaffolding will insert new arrays above this line.

data/app/models/platform/application.rb

@@ -34,7 +34,7 @@ class Platform::Application < ApplicationRecord
   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)
+    create_membership(team: team, user: user, platform_agent: true)
     membership.roles << Role.admin
   end
 

data/app/views/api/v1/open_api/shared/_paths.yaml.erb

@@ -13,22 +13,23 @@
         required: true
         schema:
           type: string
+      - $ref: "#/components/parameters/after"
     responses:
       "404":
         description: "Not Found"
       "200":
         description: "OK"
+        headers:
+          Pagination-Next:
+            $ref: "#/components/headers/PaginationNext"
+          Link:
+            $ref: "#/components/headers/Link"
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                data:
-                  type: array
-                  items:
-                    $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
-                has_more:
-                  type: boolean
+              type: array
+              items:
+                $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
   <% end %>
   <% unless except.include?(:create) %>
   post:
@@ -42,6 +43,17 @@
         required: true
         schema:
           type: string
+    requestBody:
+      description: "Information about a new Tangible Thing"
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              scaffolding_completely_concrete_tangible_thing:
+                type: object
+                $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
     responses:
       "404":
         description: "Not Found"
@@ -50,7 +62,7 @@
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
+              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
   <% end %>
 <% end %>
 <% unless except.include?(:show) && except.include?(:update) && except.include?(:destroy) %>
@@ -81,6 +93,17 @@
     operationId: updateScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - $ref: "#/components/parameters/id"
+    requestBody:
+      description: "Information about updated fields in Tangible Thing"
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              scaffolding_completely_concrete_tangible_thing:
+                type: object
+                $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
     responses:
       "404":
         description: "Not Found"
@@ -89,7 +112,7 @@
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
+              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
   <% end %>
   <% unless except.include?(:destroy) %>
   delete:
@@ -102,7 +125,7 @@
     responses:
       "404":
         description: "Not Found"
-      "200":
-        description: "OK"
+      "204":
+        description: "No Content"
   <% end %>
 <% end %>

data/app/views/api/v1/open_api/teams/_paths.yaml.erb

@@ -4,22 +4,24 @@
       - Teams
     summary: "List Teams"
     operationId: listTeams
+    parameters:
+      - $ref: "#/components/parameters/after"
     responses:
       "404":
         description: "Not Found"
       "200":
         description: "OK"
+        headers:
+          Pagination-Next:
+            $ref: "#/components/headers/PaginationNext"
+          Link:
+            $ref: "#/components/headers/Link"
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                data:
-                  type: array
-                  items:
-                    $ref: "#/components/schemas/TeamAttributes"
-                has_more:
-                  type: boolean
+              type: array
+              items:
+                $ref: "#/components/schemas/TeamAttributes"
 /teams/{id}:
   get:
     tags:
@@ -44,6 +46,17 @@
     operationId: updateTeam
     parameters:
       - $ref: "#/components/parameters/id"
+    requestBody:
+      description: "Information about updated fields in Team"
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              team:
+                type: object
+                $ref: "#/components/schemas/TeamParameters"
     responses:
       "404":
         description: "Not Found"
@@ -52,4 +65,4 @@
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/TeamParameters"
+              $ref: "#/components/schemas/TeamAttributes"

data/app/views/api/v1/open_api/users/_paths.yaml.erb

@@ -4,22 +4,24 @@
       - Users
     summary: "List Users"
     operationId: listUsers
+    parameters:
+      - $ref: "#/components/parameters/after"
     responses:
       "404":
         description: "Not Found"
       "200":
         description: "OK"
+        headers:
+          Pagination-Next:
+            $ref: "#/components/headers/PaginationNext"
+          Link:
+            $ref: "#/components/headers/Link"
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                data:
-                  type: array
-                  items:
-                    $ref: "#/components/schemas/UserAttributes"
-                has_more:
-                  type: boolean
+              type: array
+              items:
+                $ref: "#/components/schemas/UserAttributes"
 /users/{id}:
   get:
     tags:
@@ -44,6 +46,17 @@
     operationId: updateUser
     parameters:
       - $ref: "#/components/parameters/id"
+    requestBody:
+      description: "Information about updated fields in User"
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              user:
+                type: object
+                $ref: "#/components/schemas/UserParameters"
     responses:
       "404":
         description: "Not Found"
@@ -52,4 +65,4 @@
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/UserParameters"
+              $ref: "#/components/schemas/UserAttributes"

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

@@ -81,6 +81,8 @@ en:
       created: Platform Application was successfully created.
       updated: Platform Application was successfully updated.
       destroyed: Platform Application was successfully destroyed.
+      test_application_created: Test Platform Application was successfully created.
+      test_application_failure: You must provide the proper testing provision key to create a test application.
   account:
     platform:
       applications: *applications

data/config/routes.rb

@@ -17,6 +17,10 @@ Rails.application.routes.draw do
     end
   end
 
+  if ENV["TESTING_PROVISION_KEY"].present?
+    get "/testing/provision", to: "account/platform/applications#provision"
+  end
+
   namespace :api do
     match "*version/openapi.yaml" => "open_api#index", :via => :get
 

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.1.15"
+    VERSION = "1.2.1"
   end
 end

data/lib/tasks/bullet_train/api_tasks.rake

@@ -1,4 +1,76 @@
-# desc "Explaining what the task does"
-# task :bullet_train_api do
-#   # Task goes here
-# end
+require "scaffolding"
+require "scaffolding/file_manipulator"
+
+namespace :bullet_train do
+  namespace :api do
+    desc "Bump the current version of application's API"
+    task :bump_version 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}"
+
+      # Update initializer.
+      File.write("config/initializers/api.rb", initializer_content.gsub(previous_version, new_version))
+
+      [
+        "app/controllers/api/#{new_version}",
+        "app/views/api/#{new_version}",
+        "test/controllers/api/#{new_version}"
+      ].each do |dir|
+        Dir.mkdir(dir)
+      end
+
+      files_to_update = [
+        "config/routes/api/#{previous_version}.rb",
+        Dir.glob("app/controllers/api/#{previous_version}/**/*.rb") +
+          Dir.glob("app/views/api/#{previous_version}/**/*.json.jbuilder") +
+          Dir.glob("test/controllers/api/#{previous_version}/**/*.rb")
+      ].flatten
+
+      files_to_update.each do |file_name|
+        previous_file_contents = File.open(file_name).readlines
+        new_file_name = file_name.gsub(previous_version, new_version)
+
+        updated_file_contents = previous_file_contents.map do |line|
+          if line.match?(previous_version)
+            line.gsub(previous_version, new_version)
+          else
+            line.gsub("Api::#{previous_version.upcase}", "Api::#{new_version.upcase}")
+          end
+        end
+
+        # We can't create new files unless each directory under #{api/previous_version}
+        # has been created under the new api directory. For example, we have to create
+        # the `projects` directory before we can create the file `api/v2/projects/pages.json.jbuilder.`
+        new_version_dir, dir_hierarchy = new_file_name.split(/(?<=#{new_version})\//)
+        if dir_hierarchy.present? && dir_hierarchy.match?("/")
+          dir_hierarchy = dir_hierarchy.split("/")
+          dir_hierarchy.inject(new_version_dir) do |base, child_dir_or_file|
+            # Stop making new directories if the string has an extention like ".rb"
+            break if child_dir_or_file.match?(/\./)
+
+            new_hierarchy = "#{base}/#{child_dir_or_file}"
+            Dir.mkdir(new_hierarchy) unless Dir.exist?(new_hierarchy)
+            new_hierarchy
+          end
+        end
+        Scaffolding::FileManipulator.write(new_file_name, updated_file_contents)
+      end
+
+      # Here we make sure config/api/#{new_version}.rb is called from within the main routes file.
+      previous_file_contents = File.open("config/routes.rb").readlines
+      updated_file_contents = previous_file_contents.map do |line|
+        if line.match?("draw \"api/#{previous_version}\"")
+          new_version_draw_line = line.gsub(previous_version, new_version)
+          line + new_version_draw_line
+        else
+          line
+        end
+      end
+      Scaffolding::FileManipulator.write("config/routes.rb", updated_file_contents)
+
+      puts "Finished bumping to #{new_version}"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.1.15
+  version: 1.2.1
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard