bullet_train-api 1.0.4 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3193b351fc4f2279c115fb5f0c9b7a4faa716aaf471ef46e1cef99ede8e4f22f
-  data.tar.gz: f1833fdccd067769780ddfb225afa34fb4c41180b710a6c8125d212e14b98ced
+  metadata.gz: a68d08813f7429b8be31aa20cf1eaaaa1294ed3f66fd04e54165d0426bb7df43
+  data.tar.gz: d849b06fd396ad5e466b80493195b337992dd32f649de6e24779c8d142042758
 SHA512:
-  metadata.gz: eb7b59e156cadb8ac52ecc6e5e1dbf3b9d0910a99fcffcb77b3785f8a557e27fda9ab16049afe08cdbfa23d78975980e10ccf03c3b15e667eb88c793990d5af2
-  data.tar.gz: 46aac6d3e39cbc8bd4593f7ee16d77d5669fb582c0949abe6cd78fd5c3d9b6fec07b9aebce72b21d3eac1527446a6902f7d197e894b8c351802adc01c11aceb3
+  metadata.gz: 8a556c8c605e9c2fc8935aeb682d206c6e34908e27a5b140060cf4ddeedd82a8f029c19418b92844c7490af9ee4db878139d196e42361f99ee14ddf5ef65e96a
+  data.tar.gz: 0e101b006c7831c8bb47edc562536e4fab741ac5f656ddef27a1a3c5d9452e6180db96b78e268d6c7677f67dd7466dc7c32de2743e07dc7a1e03d12f37500d96

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

@@ -0,0 +1,30 @@
+module Api::V1::Base
+  extend ActiveSupport::Concern
+
+  included do
+    include Api::V1::Defaults
+    include Api::V1::LoadsAndAuthorizesApiResource
+
+    version "v1"
+    use ::WineBouncer::OAuth2
+
+    rescue_from :all do |error|
+      handle_api_error(error)
+    end
+
+    BulletTrain::Api.endpoints.each do |endpoint_class|
+      mount endpoint_class.constantize
+    end
+  end
+
+  class_methods do
+    # TODO I actually don't know of any way to make this work. This was supposed to be run after all other endpoints
+    # are registered, but I don't know of a way to know when we're done running `initializer` blocks from the engines
+    # a user may have included.
+    def handle_not_found
+      route :any, "*path" do
+        raise StandardError, "Unable to find API endpoint"
+      end
+    end
+  end
+end

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/app/serializers/api/v1/invitation_serializer.rb

@@ -0,0 +1,8 @@
+class Api::V1::InvitationSerializer < Api::V1::ApplicationSerializer
+  include Api::V1::Invitations::SerializerBase
+
+  # The `:id` entries are redundant, but for the moment they help us generate valid code.
+  attributes :id,
+    # 🚅 super scaffolding will insert new fields above this line.
+    :id
+end

data/app/serializers/api/v1/membership_serializer.rb

@@ -0,0 +1,8 @@
+class Api::V1::MembershipSerializer < Api::V1::ApplicationSerializer
+  include Api::V1::Memberships::SerializerBase
+
+  # The `:id` entries are redundant, but for the moment they help us generate valid code.
+  attributes :id,
+    # 🚅 super scaffolding will insert new fields above this line.
+    :id
+end

data/app/serializers/api/v1/team_serializer.rb

@@ -0,0 +1,8 @@
+class Api::V1::TeamSerializer < Api::V1::ApplicationSerializer
+  include Api::V1::Teams::SerializerBase
+
+  # The `:id` entries are redundant, but for the moment they help us generate valid code.
+  attributes :id,
+    # 🚅 super scaffolding will insert new fields above this line.
+    :id
+end

data/app/serializers/api/v1/user_serializer.rb

@@ -0,0 +1,8 @@
+class Api::V1::UserSerializer < Api::V1::ApplicationSerializer
+  include Api::V1::Users::SerializerBase
+
+  # The `:id` entries are redundant, but for the moment they help us generate valid code.
+  attributes :id,
+    # 🚅 super scaffolding will insert new fields above this line.
+    :id
+end

data/app/serializers/concerns/api/v1/invitations/serializer_base.rb

@@ -0,0 +1,17 @@
+module Api::V1::Invitations::SerializerBase
+  extend ActiveSupport::Concern
+
+  included do
+    set_type "invitation"
+
+    attributes :id,
+      :team_id,
+      :email,
+      :from_membership_id,
+      :created_at,
+      :updated_at
+
+    belongs_to :from_membership, serializer: Api::V1::MembershipSerializer
+    has_one :membership, serializer: Api::V1::MembershipSerializer
+  end
+end

data/app/serializers/concerns/api/v1/memberships/serializer_base.rb

@@ -0,0 +1,24 @@
+module Api::V1::Memberships::SerializerBase
+  extend ActiveSupport::Concern
+
+  included do
+    set_type "membership"
+
+    attributes :id,
+      :team_id,
+      :user_id,
+      :invitation_id,
+      :user_first_name,
+      :user_last_name,
+      :user_profile_photo_id,
+      :user_email,
+      :added_by_id,
+      :created_at,
+      :updated_at
+
+    belongs_to :user, serializer: Api::V1::UserSerializer
+    belongs_to :team, serializer: Api::V1::TeamSerializer
+    belongs_to :invitation, serializer: Api::V1::InvitationSerializer
+    belongs_to :added_by, serializer: Api::V1::MembershipSerializer
+  end
+end

data/app/serializers/concerns/api/v1/teams/serializer_base.rb

@@ -0,0 +1,16 @@
+module Api::V1::Teams::SerializerBase
+  extend ActiveSupport::Concern
+
+  included do
+    set_type "team"
+
+    attributes :id,
+      :name,
+      :time_zone,
+      :locale,
+      :created_at,
+      :updated_at
+
+    has_many :scaffolding_absolutely_abstract_creative_concepts, serializer: Api::V1::Scaffolding::AbsolutelyAbstract::CreativeConceptSerializer
+  end
+end

data/app/serializers/concerns/api/v1/users/serializer_base.rb

@@ -0,0 +1,22 @@
+module Api::V1::Users::SerializerBase
+  extend ActiveSupport::Concern
+
+  included do
+    set_type "user"
+
+    attributes :id,
+      :email,
+      :first_name,
+      :last_name,
+      :time_zone,
+      :profile_photo_id,
+      :former_user,
+      :locale,
+      :platform_agent_of_id,
+      :created_at,
+      :updated_at
+
+    has_many :teams, serializer: Api::V1::TeamSerializer
+    has_many :memberships, serializer: Api::V1::MembershipSerializer
+  end
+end

data/lib/bullet_train/api/engine.rb

@@ -11,6 +11,12 @@ require "rack/cors"
 module BulletTrain
   module Api
     class Engine < ::Rails::Engine
+      initializer "bullet_train.api.register_api_endpoints" do |app|
+        if BulletTrain::Api
+          BulletTrain::Api.endpoints << "Api::V1::MeEndpoint"
+          BulletTrain::Api.endpoints << "Api::V1::TeamsEndpoint"
+        end
+      end
     end
   end
 end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.0.4"
+    VERSION = "1.0.8"
   end
 end

data/lib/bullet_train/api.rb

@@ -3,6 +3,6 @@ require "bullet_train/api/engine"
 
 module BulletTrain
   module Api
-    # Your code goes here...
+    mattr_accessor :endpoints, default: []
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.8
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bullet Train API
 email:
 - andrew.culver@gmail.com
@@ -169,9 +183,18 @@ files:
 - app/controllers/api/v1/exceptions_handler.rb
 - app/controllers/api/v1/loads_and_authorizes_api_resource.rb
 - app/controllers/api/v1/me_endpoint.rb
-- app/controllers/api/v1/root.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/serializers/api/v1/invitation_serializer.rb
+- app/serializers/api/v1/membership_serializer.rb
+- app/serializers/api/v1/team_serializer.rb
+- app/serializers/api/v1/user_serializer.rb
+- app/serializers/concerns/api/v1/invitations/serializer_base.rb
+- app/serializers/concerns/api/v1/memberships/serializer_base.rb
+- app/serializers/concerns/api/v1/teams/serializer_base.rb
+- app/serializers/concerns/api/v1/users/serializer_base.rb
 - app/views/account/platform/applications/_application.json.jbuilder
 - app/views/account/platform/applications/_breadcrumbs.html.erb
 - app/views/account/platform/applications/_form.html.erb

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

@@ -1,27 +0,0 @@
-class Api::V1::Root < Api::Base
-  include Api::V1::Defaults
-  include Api::V1::LoadsAndAuthorizesApiResource
-
-  version "v1"
-  use ::WineBouncer::OAuth2
-
-  rescue_from :all do |error|
-    handle_api_error(error)
-  end
-
-  unless scaffolding_things_disabled?
-    mount Api::V1::Scaffolding::AbsolutelyAbstract::CreativeConceptsEndpoint
-    mount Api::V1::Scaffolding::CompletelyConcrete::TangibleThingsEndpoint
-  end
-
-  mount Api::V1::MeEndpoint
-  mount Api::V1::TeamsEndpoint
-  mount Api::V1::Webhooks::Outgoing::EndpointsEndpoint
-  mount Api::V1::Webhooks::Outgoing::DeliveriesEndpoint
-  mount Api::V1::Webhooks::Outgoing::DeliveryAttemptsEndpoint
-  # 🚅 super scaffolding will mount new endpoints above this line.
-
-  route :any, "*path" do
-    raise StandardError, "Unable to find API endpoint"
-  end
-end