bullet_train-api 1.1.6 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f474623bb0f011c89b57e3d4b0c6b8dbce5dc388772dfa5373155b2216a39b8e
-  data.tar.gz: cc167320a1f660301b3beab289db2fd29c2c6b72361d47c5276fe24a28f27eec
+  metadata.gz: 780a5449da6bedaab86b5be1a02ceb612585cc766ebcd74ae033821ad8c8c055
+  data.tar.gz: 367778ea70927d9dc9d9f3431e69a75d0993de1e4d8138cb51c686149bf392f0
 SHA512:
-  metadata.gz: cf49807aecaa0e1814fce504b214c41b6606f36dbd69814b520c45eb5ad7bf75af2b593befd2617cff8198572d0a0b3c8256f38aba78dcc5874cbae021939db5
-  data.tar.gz: 1ba92be181ff6faa0bbcfb0e480105e31222076d48bd213710200772403328492391a0247023cb0eff6f4c2b2e1d54f40a1dd8427d57d256ba2d5f91467bebff
+  metadata.gz: abe6b2e6bd9da345bf380c0c11498490f74dc758fb50a05e8b9068a55eca33d01b86bcbcba085317c28bc8ea2b007e148ec020458285a4f7284ec865ee514b34
+  data.tar.gz: f5667fff9265ce6b01b4d48230eb3c7aa6db77121103728a549e5c04968e9c7533cb363e34a100ae5b8ec44969d15f831aeae125ba3b66e542b2c92c63fb9c40

data/app/controllers/api/open_api_controller.rb

@@ -24,6 +24,47 @@ module OpenApiHelper
     result
   end
 
+  def automatic_paths_for(model, parent, except: [])
+    output = render("api/v1/open_api/shared/paths", except: except)
+    output = Scaffolding::Transformer.new(model.name, [parent&.name]).transform_string(output).html_safe
+    indent(output, 1)
+  end
+
+  def automatic_components_for(model, locals: {})
+    extend JbuilderSchema
+
+    schema_json = jbuilder_schema("api/v1/#{model.name.underscore.pluralize}/_#{model.name.underscore.split("/").last}",
+      title: I18n.t("#{model.name.underscore.pluralize}.label"),
+      # TODO Improve this. We don't have a generic description for models we can use here.
+      description: I18n.t("#{model.name.underscore.pluralize}.label"),
+      format: :json,
+      paths: view_paths.map(&:path),
+      model: model,
+      locals: {
+        # If we ever get to the point where we need a real model here, we should implement an example team in seeds that we can source it from.
+        model.name.underscore.split("/").last.to_sym => model.new,
+        # Same here, if we ever need this to be a real object, this should be `test@example.com` with an `SecureRandom.hex` password.
+        :current_user => User.new
+      }.merge(locals))
+
+    attributes_output = JSON.parse(schema_json)
+
+    strong_params_module = "Api::V1::#{model.name.pluralize}Controller::StrongParameters".constantize
+    strong_parameter_keys = BulletTrain::Api::StrongParametersReporter.new(model, strong_params_module).report
+    if strong_parameter_keys.last.is_a?(Hash)
+      strong_parameter_keys += strong_parameter_keys.pop.keys
+    end
+
+    parameters_output = JSON.parse(schema_json)
+    parameters_output["required"].select! { |key| strong_parameter_keys.include?(key.to_sym) }
+    parameters_output["properties"].select! { |key, value| strong_parameter_keys.include?(key.to_sym) }
+
+    (
+      indent(attributes_output.to_yaml.gsub("---", "#{model.name}::Attributes:"), 3) +
+      indent("    " + parameters_output.to_yaml.gsub("---", "#{model.name}::Parameters:"), 3)
+    ).html_safe
+  end
+
   def paths_for(model)
     for_model model do
       indent(render("api/#{@version}/open_api/#{model.name.underscore.pluralize}/paths"), 1)

data/app/views/api/v1/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/Scaffolding::CompletelyConcrete::TangibleThing::Attributes"
+                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/Scaffolding::CompletelyConcrete::TangibleThing::Parameters"
+  <% 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/Scaffolding::CompletelyConcrete::TangibleThing::Attributes"
+  <% 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/Scaffolding::CompletelyConcrete::TangibleThing::Parameters"
+  <% 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/v1/open_api/users/_paths.yaml.erb

@@ -16,7 +16,7 @@
               properties:
                 data:
                   type: array
-                  items: 
+                  items:
                     $ref: "#/components/schemas/User::Attributes"
                 has_more:
                   type: boolean

data/lib/bullet_train/api/strong_parameters_reporter.rb

@@ -0,0 +1,54 @@
+require "pry"
+
+module BulletTrain
+  module Api
+    class StrongParametersReporter
+      def initialize(model, strong_params_module)
+        @model = model
+        @module = strong_params_module
+        @filters = []
+        extend @module
+      end
+
+      def require(namespace)
+        @namespace = namespace
+        self
+      end
+
+      def permit(*filters)
+        @filters = filters
+      end
+
+      def params
+        self
+      end
+
+      def permitted_fields
+        defined?(super) ? super : []
+      end
+
+      def permitted_arrays
+        defined?(super) ? super : {}
+      end
+
+      def process_params(params)
+      end
+
+      # def method_missing(method_name, *args)
+      #   if method_name.match?(/^assign_/)
+      #     # It's typically the second argument that represents the parameter that would be set.
+      #     @filters << args[1]
+      #   else
+      #     raise NoMethodError, message
+      #   end
+      # end
+
+      def report
+        @filters = send("#{@model.name.split("::").last.underscore}_params".to_sym)
+
+        # There's a reason I'm doing it this way.
+        @filters
+      end
+    end
+  end
+end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.1.6"
+    VERSION = "1.1.8"
   end
 end

data/lib/bullet_train/api.rb

@@ -1,11 +1,16 @@
 require "bullet_train/api/version"
 require "bullet_train/api/engine"
+require "bullet_train/api/strong_parameters_reporter"
 
 # require "wine_bouncer"
 require "pagy"
 require "pagy_cursor"
 require "rack/cors"
 require "doorkeeper"
+require "scaffolding"
+require "scaffolding/block_manipulator"
+require "scaffolding/transformer"
+require "jbuilder/schema"
 
 module BulletTrain
   module Api

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.8
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder-schema
+  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'
 - !ruby/object:Gem::Dependency
   name: bullet_train
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +162,7 @@ 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/open_api/index.yaml.erb
+- app/views/api/v1/open_api/shared/_paths.yaml.erb
 - app/views/api/v1/open_api/teams/_paths.yaml.erb
 - app/views/api/v1/open_api/users/_paths.yaml.erb
 - app/views/api/v1/platform/access_tokens/_access_token.json.jbuilder
@@ -165,6 +179,7 @@ files:
 - config/routes.rb
 - lib/bullet_train/api.rb
 - lib/bullet_train/api/engine.rb
+- lib/bullet_train/api/strong_parameters_reporter.rb
 - lib/bullet_train/api/version.rb
 - lib/tasks/bullet_train/api_tasks.rake
 homepage: https://github.com/bullet-train-co/bullet_train-api

data/app/views/api/v1/open_api/index.yaml.erb

@@ -1,29 +0,0 @@
-openapi: 3.1.0
-info:
-  title: Bullet Train API
-  description: |
-    The baseline API of a new Bullet Train application.
-  license: 
-    name: MIT
-    url: https://opensource.org/licenses/MIT
-  version: "<%= @version.upcase %>"
-servers:
-  - url: <%= ENV["BASE_URL"] %>/api/<%= @version %>
-components:
-  schemas:
-    <%= components_for Team %>
-    <%= components_for User %>
-    <%= components_for Scaffolding::CompletelyConcrete::TangibleThing unless scaffolding_things_disabled? %>
-    <%# 🚅 super scaffolding will insert new components above this line. %>
-  parameters:
-    id:
-      name: id
-      in: path
-      required: true
-      schema:
-        type: string
-paths:
-  <%= paths_for Team %>
-  <%= paths_for User %>
-  <%= paths_for Scaffolding::CompletelyConcrete::TangibleThing unless scaffolding_things_disabled? %>
-  <%# 🚅 super scaffolding will insert new paths above this line. %>