bullet_train-api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa6663e2cb44dcb5ee04f1523126af49e244a71168c4be2e4b5333ef957890f
-  data.tar.gz: 6efa8a9d4538ff0a031fba1bbdd8dfa5fdef35f099be7e1045766cb760ca1fed
+  metadata.gz: ad13ea6c52199631e43bc3ef4367f886d64568faea6d88dd3f5f1857bb0416e2
+  data.tar.gz: 90deafe4bb3b6680f0ccaa79e715e66cfcadf247053c651badf489f4ab845e95
 SHA512:
-  metadata.gz: 89cd48b2f9291e06563533ee36d7081176a82ffa97e7c62096477c5cfa97501f83b7f0d1f34bad3d52f22a2b910e75789a320c60e0196b0df4c7073045444a21
-  data.tar.gz: c75051c39a212d6994a7b19ed4fb1df756927d5599c4d2b8e92330855b4cb08e1d7ff5a884902d793d6b878c1d37d77153db3dfa7173ff1f22801b3ff4f245e2
+  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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -120,6 +120,9 @@ files:
 - Rakefile
 - app/assets/config/bullet_train_api_manifest.js
 - app/controllers/account/platform/applications_controller.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/views/account/platform/applications/_application.json.jbuilder
 - app/views/account/platform/applications/_breadcrumbs.html.erb
@@ -132,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