bullet_train-api 1.3.12 → 1.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3f4bc85eee46e974027a4e3062c8642d3cbfd61de61fd4e5d914610342afa8
-  data.tar.gz: 363ebf0b3de0337a5f547acfb31a1ac379e1857ad519a87ad6627ac3a6dbe685
+  metadata.gz: 1afcea46978b7420ab6561c17b1d55c03cc01a85be1ca29b3bd384e371a10e5c
+  data.tar.gz: 26f2e5abb15ef1359f5a846232ba0c953aa31a60100466a5c4594d27eb9d0e44
 SHA512:
-  metadata.gz: 3d512b05c4161761e82d32e631798de6da994083844ff4790af692befff26360687f8448041465a2d8ef145e4a83893e7fc6363ded748fa418fbc6e43f4c5b82
-  data.tar.gz: 3d3ca7931fc4b782e767c9a17e080ebc1c42c4410ada2ff2cb1030ecb4122934fd04deddb8fc8aea8d0dadb02a2042a44f9d98e9767ca9428d69a53da94f1ae8
+  metadata.gz: 2728e7625569f7a11eea0b36840d9bbc5b95a727f5fc369d7a575b092a2ece1048fd93993a798868b94a755ceec55f12504fc8eee2bb3bb24be0acad1d2c752d
+  data.tar.gz: cb185815afbab983770c746ccddd676956d1d8f502f795504a54d20e48c1d810a0073e1208648488d2bade4807e9323a6c1e9e37dbb38da2c1d806f0d35dc156

data/app/helpers/api/open_api_helper.rb

@@ -40,24 +40,10 @@ module Api
       # There are some placeholders specific to this method that we still need to transform.
       model_symbol = model.name.underscore.tr("/", "_").to_sym
 
-      if (get_example = FactoryBot.get_example(model_symbol, version: @version))
-        output.gsub!("🚅 get_example", get_example)
-      end
-
-      if (post_parameters = FactoryBot.post_parameters(model_symbol, version: @version))
-        output.gsub!("🚅 post_parameters", post_parameters)
-      end
-
-      if (post_examples = FactoryBot.post_examples(model_symbol, version: @version))
-        output.gsub!("🚅 post_examples", post_examples)
-      end
-
-      if (put_parameters = FactoryBot.put_parameters(model_symbol, version: @version))
-        output.gsub!("🚅 put_parameters", put_parameters)
-      end
-
-      if (put_example = FactoryBot.put_example(model_symbol, version: @version))
-        output.gsub!("🚅 put_example", put_example)
+      FactoryBot::ExampleBot::REST_METHODS.each do |method|
+        if (code = FactoryBot.send(method, model_symbol, version: @version))
+          output.gsub!("🚅 #{method}", code)
+        end
       end
 
       indent(output, 1)
@@ -74,7 +60,7 @@ module Api
       }.merge(locals))
 
       schema_json = jbuilder.json(
-        model.new,
+        FactoryBot.example(model.model_name.param_key.to_sym) || model.new,
         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"),
@@ -106,7 +92,8 @@ module Api
 
         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) }
+        parameters_output["properties"].select! { |key| strong_parameter_keys.include?(key.to_sym) }
+        parameters_output["example"]&.select! { |key, value| strong_parameter_keys.include?(key.to_sym) && value.present? }
 
         (
           indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3) +

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

@@ -12,7 +12,7 @@
         in: path
         required: true
         schema:
-          type: string
+          type: integer
       - $ref: "#/components/parameters/after"
     responses:
       "404":
@@ -31,7 +31,7 @@
               items:
                 $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              🚅 get_example
+              🚅 get_examples
   <% end %>
   <% unless except.include?(:create) %>
   post:
@@ -44,7 +44,7 @@
         in: path
         required: true
         schema:
-          type: string
+          type: integer
     requestBody:
       description: "Information about a new Tangible Thing"
       required: true
@@ -68,7 +68,7 @@
             schema:
               $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              🚅 post_examples
+              🚅 post_example
   <% end %>
 <% end %>
 <% unless except.include?(:show) && except.include?(:update) && except.include?(:destroy) %>

data/lib/bullet_train/api/example_bot.rb

@@ -39,7 +39,9 @@ module FactoryBot
       objects
     end
 
-    %i[get_examples get_example post_examples post_parameters put_example put_parameters patch_example patch_parameters].each do |method|
+    REST_METHODS = %i[get_examples get_example post_example post_parameters put_example put_parameters patch_example patch_parameters]
+
+    REST_METHODS.each do |method|
       define_method(method) do |model, **options|
         _path_examples(method.to_s, model, **options)
       end
@@ -53,6 +55,8 @@ module FactoryBot
     end
 
     def reset_tables!
+      # This is only availble for postgres
+      return unless ActiveRecord::Base.connection.respond_to?(:reset_pk_sequence!)
       @tables_to_reset.each do |name|
         ActiveRecord::Base.connection.reset_pk_sequence!(name) if ActiveRecord::Base.connection.table_exists?(name)
       end
@@ -67,8 +71,17 @@ module FactoryBot
           clone.send("#{name}=", associations)
           @tables_to_reset << name
         elsif %i[belongs_to has_one].include?(reflection.macro)
-          clone.send("#{name}=", instance.send(name).clone)
-          @tables_to_reset << name.pluralize
+          # Calling e.g. address.team= throws an error,
+          # if address has_one team through person
+          # and person has_one team through company
+          # and company belongs_to team
+          # so the resulting error will be caught here and a warning logged.
+          begin
+            clone.send("#{name}=", instance.send(name).clone)
+            @tables_to_reset << name.pluralize
+          rescue ActiveRecord::HasOneThroughNestedAssociationsAreReadonly
+            Rails.logger.warn("ExampleBot.deep_clone ignored setting #{name} of #{instance}")
+          end
         end
       end
 
@@ -86,7 +99,7 @@ module FactoryBot
       else
         template, class_name, var_name, values = _set_values("get_example", model)
 
-        unless %w[example examples].include?(method.split("_").last)
+        if method.end_with?("parameters")
           if has_strong_parameters?("::Api::#{version.upcase}::#{class_name.pluralize}Controller".constantize)
             strong_params_module = "::Api::#{version.upcase}::#{class_name.pluralize}Controller::StrongParameters".constantize
             strong_parameter_keys = BulletTrain::Api::StrongParametersReporter.new(class_name.constantize, strong_params_module).report
@@ -99,6 +112,9 @@ module FactoryBot
             parameters_output = JSON.parse(output)
             parameters_output&.select! { |key| strong_parameter_keys.include?(key.to_sym) }
 
+            # Wrapping the example as parameters should be wrapped with the model name:
+            parameters_output = {model.to_s => parameters_output}
+
             return indent(parameters_output.to_yaml.delete_prefix("---\n"), 6).html_safe
           end
           return nil

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.3.12"
+    VERSION = "1.3.14"
   end
 end

data/lib/bullet_train/api.rb

@@ -14,6 +14,7 @@ require "scaffolding"
 require "scaffolding/block_manipulator"
 require "scaffolding/transformer"
 require "jbuilder/schema"
+require "jbuilder/values_transformer"
 
 module BulletTrain
   module Api

data/lib/jbuilder/values_transformer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "jbuilder"
+
+module ValuesTransformer
+  def _set_value(key, value)
+    value = value.body if value.is_a?(ActionText::RichText)
+
+    super(key, value)
+  end
+end
+
+::Jbuilder.prepend ValuesTransformer

data/lib/tasks/bullet_train/api_tasks.rake

@@ -128,5 +128,21 @@ namespace :bullet_train do
         puts "Failed to download the OpenAPI Document. Status code: #{response.status}"
       end
     end
+
+    desc "Export the OpenAPI schema for the application"
+    task export_openapi_schema: :environment do
+      @version = BulletTrain::Api.current_version
+      File.open("openapi-#{Time.now.strftime("%Y%m%d-%H%M%S")}.yaml", "w+") do |f|
+        f.binmode
+        f.write(
+          ApplicationController.renderer.render(
+            template: "api/#{@version}/open_api/index",
+            layout: false,
+            format: :text,
+            assigns: {version: @version}
+          )
+        )
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.3.12
+  version: 1.3.14
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +212,7 @@ files:
 - lib/bullet_train/api/version.rb
 - lib/bullet_train/platform.rb
 - lib/bullet_train/platform/connection_workflow.rb
+- lib/jbuilder/values_transformer.rb
 - lib/tasks/bullet_train/api_tasks.rake
 - lib/tokens_controller.rb
 homepage: https://github.com/bullet-train-co/bullet_train-core/tree/main/bullet_train-api