bullet_train-api 1.2.23 → 1.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52964332e89aebd4034e1a1d6da5f4e96065920023b79a002360787140845d2c
-  data.tar.gz: 969c41617e73866c1fca4658846bc95a425dfb86e608f9f1687dc295a24248b6
+  metadata.gz: 87ee8b24dbab751228f331fe26950afa6fe93f3525092767831bd9659ed5d6f5
+  data.tar.gz: 1f5f064679487f87b01e5d5940efc121b72f5dbe86586b8bd07e63b83406b3f9
 SHA512:
-  metadata.gz: 39313d6d4963ec35c2b606d5bd967b1f04668dfc47de6269271b80450b9e5c5de872f93fa0b4bc8f194fe3ebc25a5507b523d2bf512a09401c8f1bb62b131c95
-  data.tar.gz: 19b9778baedbea755ab32b48b192b7141408a9b4467447a49631d9b5ab550651da37cb31628c4792882c44e059e790db4d42e621d0f4fcb61b8e9b7e38de56ee
+  metadata.gz: 897ae05b0fd124b0418ee6e242e570d7f20b76aafdc29b1ebcae3a44b76621f095f319ad00a7306edcf01f99b87b9b830289f38834dd3e7ab5aee92276629477
+  data.tar.gz: a5a7f22e19bb8137c60b814343a79a11905cc9e26c76f45691e5d9edb07d1cd13b18f2cd540f6d41f114d21c4c7f2761680f624bc39a378009d9a8772e0f180e

data/app/helpers/api/open_api_helper.rb

@@ -33,6 +33,30 @@ module Api
     def automatic_paths_for(model, parent, except: [])
       output = render("api/#{@version}/open_api/shared/paths", except: except)
       output = Scaffolding::Transformer.new(model.name, [parent&.name]).transform_string(output).html_safe
+
+      # There are some placeholders specific to this method that we still need to transform.
+      model_symbol = model.name.underscore.tr("/", "_")
+
+      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)
+      end
+
       indent(output, 1)
     end
 

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

@@ -31,7 +31,7 @@
               items:
                 $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              <%= FactoryBot.get_example(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+              🚅 get_example
   <% end %>
   <% unless except.include?(:create) %>
   post:
@@ -57,7 +57,7 @@
                 type: object
                 $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
           example:
-            <%= FactoryBot.post_parameters(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+            🚅 post_parameters
     responses:
       "404":
         description: "Not Found"
@@ -68,7 +68,7 @@
             schema:
               $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              <%= FactoryBot.post_examples(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+              🚅 post_examples
   <% end %>
 <% end %>
 <% unless except.include?(:show) && except.include?(:update) && except.include?(:destroy) %>
@@ -91,7 +91,7 @@
             schema:
               $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              <%= FactoryBot.get_example(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+              🚅 get_example
   <% end %>
   <% unless except.include?(:update) %>
   put:
@@ -113,7 +113,7 @@
                 type: object
                 $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingParameters"
           example:
-            <%= FactoryBot.put_parameters(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+            🚅 put_parameters
     responses:
       "404":
         description: "Not Found"
@@ -124,7 +124,7 @@
             schema:
               $ref: "#/components/schemas/ScaffoldingCompletelyConcreteTangibleThingAttributes"
             example:
-              <%= FactoryBot.put_example(:scaffolding_completely_concrete_tangible_thing, version: @version) %>
+              🚅 put_example
   <% end %>
   <% unless except.include?(:destroy) %>
   delete:

data/lib/bullet_train/api/example_bot.rb

@@ -48,8 +48,13 @@ module FactoryBot
     private
 
     def factory(model)
+      # TODO Why do we sometimes get a real object here and sometimes just a model name as a symbol?
+      unless model.is_a?(String)
+        model = model.name.underscore.tr("/", "_").to_sym
+      end
+
       factories = FactoryBot.factories.instance_variable_get(:@items).keys
-      factories.include?("#{model}_example") ? "#{model}_example" : model
+      factories.include?("#{model}_example") ? "#{model}_example".to_sym : model
     end
 
     def reset_tables!

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.2.23"
+    VERSION = "1.2.24"
   end
 end

data/lib/tasks/bullet_train/api_tasks.rake

@@ -1,6 +1,9 @@
 require "scaffolding"
 require "scaffolding/file_manipulator"
 
+require "faraday"
+require "tempfile"
+
 namespace :bullet_train do
   namespace :api do
     desc "Bump the current version of application's API"
@@ -88,5 +91,42 @@ namespace :bullet_train do
 
       puts "Finished bumping to #{new_version}"
     end
+
+    desc "Bump the current version of application's API"
+    task push_to_redocly: :environment do
+      include Rails.application.routes.url_helpers
+
+      raise "You need to set REDOCLY_ORGANIZATION_ID in your environment. You can fetch it from the URL when you're on your Redocly dashboard." unless ENV["REDOCLY_ORGANIZATION_ID"].present?
+      raise "You need to set REDOCLY_API_KEY in your environment. You can create one at https://app.redocly.com/org/#{ENV["REDOCLY_ORGANIZATION_ID"]}/settings/api-keys ." unless ENV["REDOCLY_API_KEY"].present?
+
+      # Create a new Faraday connection
+      conn = Faraday.new(api_url(version: BulletTrain::Api.current_version))
+
+      # Fetch the file
+      response = conn.get
+
+      # Check if the request was successful
+      if response.status == 200
+        # Create a temp file
+        temp_file = Tempfile.new(["openapi-", ".yaml"])
+
+        # Write the file content to the temp file
+        temp_file.binmode
+        temp_file.write(response.body)
+        temp_file.rewind
+
+        # Close and delete the temp file when the script exits
+        temp_file.close
+        puts "File downloaded and saved to: #{temp_file.path}"
+
+        puts `echo "#{ENV["REDOCLY_API_KEY"]}" | redocly login`
+
+        puts `redocly push #{temp_file.path} "@#{ENV["REDOCLY_ORGANIZATION_ID"]}/#{I18n.t("application.name")}@#{BulletTrain::Api.current_version}" --public --upsert`
+
+        temp_file.unlink
+      else
+        puts "Failed to download the OpenAPI Document. Status code: #{response.status}"
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.2.23
+  version: 1.2.24
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Bullet Train API