bullet_train-api 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d0d8de58c2132c0e4f9d5f704a8ca8035126f030ccaf711b2b1a27ebf793f6
-  data.tar.gz: 279210193a45516e0e2ffb2d89c6dc5ac82406154dfef7e7ce0c229b8bc621aa
+  metadata.gz: 032d9344239258c4279f3a04e1aecbce98a4ef7f7a74a2c568047b64b348f2f0
+  data.tar.gz: a1d2970d2d64dab6a2e3fd192afda710e150ea7524f1f2635868864b9ccd8025
 SHA512:
-  metadata.gz: 63fe9c16afc1e7d7753504f540304e5d0ed3cfe8812806adbe7f9f52e71ecdc9d2fcbea595968d195d42dd9f7b553af861033d3af6ca5ee1e45aa26d37ac4506
-  data.tar.gz: 572fb40701d7c521c8e03bcff7a2fd5a30295fbba0e3c18e830ea84bc850010bf6cd0b95b1b9219fc0da5903316308257a04b672400d4a6d33761c866ccdfa8a
+  metadata.gz: 7a58f1503b3d11a2c7c46552d91a4e0c40bb9b258945501f4eb8146af4185f97d3ad73d05c729514319e0ad85d28eef71cf3d83024256a59389dfd79ed8d47e1
+  data.tar.gz: 7f44279ae68331a9513bcd4c54572da1ea3a14483ef54e9dccf9b393b30bc80eb73a96e87fb71ded864db3cf55df12eda712c91a80203410fd722cf26b65ec37

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

@@ -1,79 +1,9 @@
 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
+  PARAMS = proc do
+    # 🚅 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
 
-  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
+  include Api::V1::Teams::EndpointBase
 end

data/app/controllers/api.rb

@@ -6,8 +6,12 @@
 
 module Api
   def self.topic
-    path = caller.find { |path| path.include?("controllers/api") && !path.include?("app/controllers/api.rb") }
-    path.split(/\/app\/controllers\/api\/v\d+\//).last.split("_endpoint.").first
+    path = caller.find { |path| (path.include?("controllers/api") || path.include?("app/controllers/concerns/api")) && !path.include?("app/controllers/api.rb") && !path.include?("app/controllers/api/v1/root.rb") && !path.include?("app/controllers/api/base.rb") }
+    if path.include?("controllers/api")
+      path.split(/\/app\/controllers\/api\/v\d+\//).last.split("_endpoint.").first
+    elsif path.include?("app/controllers/concerns/api")
+      path.split(/\/app\/controllers\/concerns\/api\/v\d+\//).last.split("/endpoint_base.").first
+    end
   end
 
   def self.serializer

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

@@ -2,7 +2,6 @@ module Api::V1::Base
   extend ActiveSupport::Concern
 
   included do
-    include Api::V1::Base
     include Api::V1::Defaults
     include Api::V1::LoadsAndAuthorizesApiResource
 

data/app/controllers/concerns/api/v1/teams/endpoint_base.rb

@@ -0,0 +1,87 @@
+module Api::V1::Teams::EndpointBase
+  extend ActiveSupport::Concern
+
+  included do
+    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)
+
+        # TODO I don't like this, but I can't figure out a better way to accomplish the same thing. I'm open to any
+        # suggestions on this. I don't know why `@api.class` returns `Class` but `@api.to_s` returns e.g.
+        # `Api::V1::TeamsEndpoint`, but since we can get the latter, we'll use that to fetch whatever proc is defined
+        # in ADDITIONAL_PARAMS.
+        if defined?(@api.to_s.constantize::PARAMS)
+          instance_eval &@api.to_s.constantize::PARAMS
+        end
+      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
+end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -171,6 +171,7 @@ files:
 - app/controllers/api/v1/me_endpoint.rb
 - app/controllers/api/v1/teams_endpoint.rb
 - app/controllers/concerns/api/v1/base.rb
+- app/controllers/concerns/api/v1/teams/endpoint_base.rb
 - app/models/platform/application.rb
 - app/views/account/platform/applications/_application.json.jbuilder
 - app/views/account/platform/applications/_breadcrumbs.html.erb