bullet_train-api 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40bc7b779d26dad0888ccb49f7f28a07a0ea038b3f1b22225029a032563af937
-  data.tar.gz: 402a6f89d5537cd1815fd0e22fed93e0dda462c97be190f4fcdc7df529eafb58
+  metadata.gz: 807f6397b8ca4d3ed29c7181d9aa72456630ad6262baeab928637f11858d83f1
+  data.tar.gz: d3db30ae44aa54f4504554a10eadd3570c061a558068b9dba844580bb8fb1b7d
 SHA512:
-  metadata.gz: f1f25622d149fb10bcb5a5ffdb8e36ec868a9f43884708de02508db66e265c4961d62a0c28a7308ffb4087eaae99c0f308c91a98a0511f7297d3ea206142d224
-  data.tar.gz: ca923f4efc9d4b475f2b20e64f00448c4b91d38709073b71fda5cd33de9dbb6565d01cf6a6ddab4a4e4317bfef8135f31f230d9dbc079f8e2dee2cef0c7ffa49
+  metadata.gz: e748b8c2207bc0a43e8cbacfb69e48108fff664298404194299fafa5271d5b330222830bedce8351916096430ef42d83ea9b4af96c647abc9f4996e9e73194f8
+  data.tar.gz: 702abad5b373fe2600f460c26c363a2063082e9cd9fb832b9991d7bf079ba40175e0eba8ef25f2f4a3bf0f9e4b46026e83b1383144cafb0c20789a8c0c7574e2

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

@@ -17,6 +17,30 @@ module Api::Controllers::Base
 
     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
+      end
+      uri.query = Rack::Utils.build_query(query)
+      uri.to_s
+    end
+
+    def set_pagination_headers
+      return unless @pagy
+
+      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"
+          response.headers["Pagination-Next"] = next_cursor
+        end
+      end
+    end
 
     rescue_from CanCan::AccessDenied, ActiveRecord::RecordNotFound do |exception|
       render json: {error: "Not found"}, status: :not_found
@@ -42,7 +66,13 @@ module Api::Controllers::Base
 
   def current_user
     raise NotAuthenticatedError unless doorkeeper_token.present?
-    doorkeeper_token.update(last_used_at: Time.zone.now)
+    # 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
+    end
     @current_user ||= User.find_by(id: doorkeeper_token[:resource_owner_id])
   end
 
@@ -51,10 +81,13 @@ module Api::Controllers::Base
     current_user&.teams&.first
   end
 
+  def collection_variable
+    @collection_variable ||= "@#{self.class.name.split("::").last.gsub("Controller", "").underscore}"
+  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
+    @pagy, collection = pagy_cursor collection, after: params[:after]
     instance_variable_set collection_variable, collection
   end
 

data/app/views/api/v1/platform/access_tokens/index.json.jbuilder

@@ -1,5 +1 @@
-json.data do
-  json.array! @access_tokens, partial: "api/v1/platform/access_tokens/access_token", as: :access_token
-end
-
-render_pagination(json)
+json.array! @access_tokens, partial: "api/v1/platform/access_tokens/access_token", as: :access_token

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

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

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

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

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

@@ -0,0 +1,108 @@
+<% except ||= [] %>
+<% unless except.include?(:index) && except.include?(:create) %>
+/scaffolding/absolutely_abstract/creative_concepts/{absolutely_abstract_creative_concept_id}/completely_concrete/tangible_things:
+  <% unless except.include?(:index) %>
+  get:
+    tags:
+      - "Scaffolding/Completely Concrete/Tangible Things"
+    summary: "List Tangible Things"
+    operationId: listScaffoldingCompletelyConcreteTangibleThings
+    parameters:
+      - name: absolutely_abstract_creative_concept_id
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
+                has_more:
+                  type: boolean
+  <% end %>
+  <% unless except.include?(:create) %>
+  post:
+    tags:
+      - "Scaffolding/Completely Concrete/Tangible Things"
+    summary: "Create Tangible Thing"
+    operationId: createScaffoldingCompletelyConcreteTangibleThings
+    parameters:
+      - name: absolutely_abstract_creative_concept_id
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      "404":
+        description: "Not Found"
+      "201":
+        description: "Created"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
+  <% end %>
+<% end %>
+<% unless except.include?(:show) && except.include?(:update) && except.include?(:destroy) %>
+/scaffolding/completely_concrete/tangible_things/{id}:
+  <% unless except.include?(:show) %>
+  get:
+    tags:
+      - "Scaffolding/Completely Concrete/Tangible Things"
+    summary: "Fetch Tangible Thing"
+    operationId: getScaffoldingCompletelyConcreteTangibleThings
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
+  <% end %>
+  <% unless except.include?(:update) %>
+  put:
+    tags:
+      - "Scaffolding/Completely Concrete/Tangible Things"
+    summary: "Update Tangible Thing"
+    operationId: updateScaffoldingCompletelyConcreteTangibleThings
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
+  <% end %>
+  <% unless except.include?(:destroy) %>
+  delete:
+    tags:
+      - "Scaffolding/Completely Concrete/Tangible Things"
+    summary: "Remove Tangible Thing"
+    operationId: removeScaffoldingCompletelyConcreteTangibleThings
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+  <% end %>
+<% end %>

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

@@ -0,0 +1,55 @@
+/teams:
+  get:
+    tags:
+      - Teams
+    summary: "List Teams"
+    operationId: listTeams
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/TeamAttributes"
+                has_more:
+                  type: boolean
+/teams/{id}:
+  get:
+    tags:
+      - Teams
+    summary: "Fetch Team"
+    operationId: fetchTeam
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TeamAttributes"
+  put:
+    tags:
+      - Teams
+    summary: "Update Team"
+    operationId: updateTeam
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TeamParameters"

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

@@ -0,0 +1,55 @@
+/users:
+  get:
+    tags:
+      - Users
+    summary: "List Users"
+    operationId: listUsers
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/UserAttributes"
+                has_more:
+                  type: boolean
+/users/{id}:
+  get:
+    tags:
+      - Users
+    summary: "Fetch User"
+    operationId: fetchUser
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UserAttributes"
+  put:
+    tags:
+      - Users
+    summary: "Update User"
+    operationId: updateUser
+    parameters:
+      - $ref: "#/components/parameters/id"
+    responses:
+      "404":
+        description: "Not Found"
+      "200":
+        description: "OK"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UserParameters"

data/app/views/api/v2/platform/access_tokens/_access_token.json.jbuilder

@@ -0,0 +1,10 @@
+json.extract! access_token,
+  :id,
+  :application_id,
+  :token,
+  :expires_in,
+  :scopes,
+  :last_used_at,
+  :description,
+  # 🚅 super scaffolding will insert new fields above this line.
+  :created_at

data/app/views/api/v2/platform/access_tokens/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @access_tokens, partial: "api/v2/platform/access_tokens/access_token", as: :access_token

data/app/views/api/v2/platform/access_tokens/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "api/v2/platform/access_tokens/access_token", access_token: @access_token

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

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

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

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

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

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

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

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

data/config/routes.rb

@@ -20,15 +20,17 @@ Rails.application.routes.draw do
   namespace :api do
     match "*version/openapi.yaml" => "open_api#index", :via => :get
 
-    namespace :v1 do
-      shallow do
-        resources :users
-        resources :teams do
-          resources :invitations
-          resources :memberships
-          namespace :platform do
-            resources :applications do
-              resources :access_tokens
+    BulletTrain::Api.all_versions.each do |version|
+      namespace version do
+        shallow do
+          resources :users
+          resources :teams do
+            resources :invitations
+            resources :memberships
+            namespace :platform do
+              resources :applications do
+                resources :access_tokens
+              end
             end
           end
         end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.1.10"
+    VERSION = "1.1.11"
   end
 end

data/lib/bullet_train/api.rb

@@ -16,5 +16,18 @@ module BulletTrain
   module Api
     mattr_accessor :endpoints, default: []
     mattr_accessor :current_version, default: "v1"
+    mattr_accessor :initial_version, default: "v1"
+
+    def self.current_version_numeric
+      current_version.split("v").last.to_i
+    end
+
+    def self.initial_version_numeric
+      initial_version.split("v").last.to_i
+    end
+
+    def self.all_versions
+      (initial_version_numeric..current_version_numeric).map { |version| "v#{version}".to_sym }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.11
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -172,6 +172,16 @@ files:
 - app/views/api/v1/teams/show.json.jbuilder
 - app/views/api/v1/users/index.json.jbuilder
 - app/views/api/v1/users/show.json.jbuilder
+- app/views/api/v2/open_api/shared/_paths.yaml.erb
+- app/views/api/v2/open_api/teams/_paths.yaml.erb
+- app/views/api/v2/open_api/users/_paths.yaml.erb
+- app/views/api/v2/platform/access_tokens/_access_token.json.jbuilder
+- app/views/api/v2/platform/access_tokens/index.json.jbuilder
+- app/views/api/v2/platform/access_tokens/show.json.jbuilder
+- app/views/api/v2/teams/index.json.jbuilder
+- app/views/api/v2/teams/show.json.jbuilder
+- app/views/api/v2/users/index.json.jbuilder
+- app/views/api/v2/users/show.json.jbuilder
 - config/locales/en/api.en.yml
 - config/locales/en/me.en.yml
 - config/locales/en/platform/access_tokens.en.yml