bullet_train-api 1.6.26 → 1.6.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f53bd14ce32fe54b5dde95fa14aa33fadbc9849f786a72b4ab714ad06a4c59
-  data.tar.gz: 40c98339cd1c7823b81d730101cc136e4cc2886857671ce3754732bb376bc566
+  metadata.gz: 3da820ecd4427cce764eab98c2b258a9677022ea138e990020176c1c16a5879f
+  data.tar.gz: 52fd62ced5483d47f5d4e31978a2788cfea8a46917e5d945eeffb0ebe203c18c
 SHA512:
-  metadata.gz: 4d7aa0e7721fabfcd492edcbaf4ea00455038ddd55d2bb4117404e90129a447c2f14cc137760d11d7bfb78103bc242bed5d2ac161babc8a94772a9e3045e7c62
-  data.tar.gz: a3c4a43aff5bdaf0b6d07f7c7575394b47113dbe14dac87564d47da0f2cda2d16a07b0a13369820d618005f649d048c76420f988734351d14523ea81c1104327
+  metadata.gz: cb260cba10aaf616fa8b4ba8b7d3ab4f358dc384af7c860ff2d53389de318bfc46f9acdedde06d4cb8d4759b92b9dcff815d2c0f63bc8619e8020a062fa22c2f
+  data.tar.gz: c69f7552837e1706946a698ab6aa8ca470aa0b7f2a549d4ff2fe44e740ec58fa851e622979e684b080bb4f42517d75dc4972d9944e20354824e1737a10d337bc

data/app/helpers/api/open_api_helper.rb

@@ -38,8 +38,8 @@ module Api
       end
 
       if custom_output
-        merge = deep_merge(YAML.load(output), YAML.load(custom_output)).to_yaml.html_safe
-        # YAML.load escapes emojis https://github.com/ruby/psych/issues/371
+        merge = deep_merge(YAML.safe_load(output), YAML.safe_load(custom_output)).to_yaml.html_safe
+        # YAML.safe_load escapes emojis https://github.com/ruby/psych/issues/371
         # Next line returns emojis back and removes yaml garbage
         output = merge.gsub("---", "").gsub(/\\u[\da-f]{8}/i) { |m| [m[-8..].to_i(16)].pack("U") }
       end
@@ -47,7 +47,9 @@ module Api
       indent(output, 1)
     end
 
-    def automatic_components_for(model, locals: {})
+    def automatic_components_for(model, **options)
+      locals = options.delete(:locals) || {}
+
       path = "app/views/api/#{@version}"
       paths = [path, "app/views"] + gem_paths.product(%W[/#{path} /app/views]).map(&:join)
 
@@ -76,6 +78,9 @@ module Api
 
       attributes_output = JSON.parse(schema_json)
 
+      # Allow customization of Attributes
+      customize_component!(attributes_output, options[:attributes]) if options[:attributes]
+
       # Add "Attributes" part to $ref's
       update_ref_values!(attributes_output)
 
@@ -106,6 +111,9 @@ module Api
         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? }
 
+        # Allow customization of Parameters
+        customize_component!(parameters_output, options[:parameters]) if options[:parameters]
+
         (
           indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3) +
             indent("    " + parameters_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Parameters:"), 3)
@@ -164,5 +172,41 @@ module Api
         end
       end
     end
+
+    def customize_component!(original, custom)
+      custom = custom.deep_stringify_keys.deep_transform_values { |v| v.is_a?(Symbol) ? v.to_s : v }
+
+      if custom.key?("add")
+        custom["add"].each do |property, details|
+          if details["required"]
+            original["required"] << property
+            details.delete("required")
+          end
+          original["properties"][property] = details
+          if details["example"]
+            original["example"][property] = details["example"]
+            details.delete("example")
+          end
+        end
+      end
+
+      if custom.key?("remove")
+        Array(custom["remove"]).each do |property|
+          original["required"].delete(property)
+          original["properties"].delete(property)
+          original["example"].delete(property)
+        end
+      end
+
+      if custom.key?("only")
+        original["properties"].keys.each do |property|
+          unless Array(custom["only"]).include?(property)
+            original["properties"].delete(property)
+            original["required"].delete(property)
+            original["example"].delete(property)
+          end
+        end
+      end
+    end
   end
 end

data/config/locales/en/platform/access_tokens.en.yml

@@ -20,38 +20,56 @@ en:
         destroy: Are you sure you want to remove %{access_token_name}? This will break any active integrations using this token and can't be undone.
     fields: &fields
       id:
-        heading: Access Token ID
+        heading: &id Access Token ID
+        api_title: *id
+        api_description: *id
       application_id:
-        heading: Application ID
+        heading: &application_id Application ID
+        api_title: *application_id
+        api_description: *application_id
       token:
         _: &token Token
         label: *token
         heading: *token
+        api_title: *token
+        api_description: *token
       expires_in:
         _: &expires_in Expires In
         label: *expires_in
         heading: *expires_in
+        api_title: *expires_in
+        api_description: *expires_in
       scopes:
         _: &scopes Scopes
         label: *scopes
         heading: *scopes
+        api_title: *scopes
+        api_description: *scopes
       last_used_at:
         _: &last_used_at Last Used At
         label: *last_used_at
         heading: *last_used_at
+        api_title: *last_used_at
+        api_description: *last_used_at
       description:
         _: &description Description
         label: *description
         heading: *description
+        api_title: *description
+        api_description: *description
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         _: &created_at Created
         label: *created_at
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         _: &updated_at Updated
         label: *updated_at
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     api:
       collection_actions: "Collection Actions for Access Tokens"
       index: "List Access Tokens"

data/config/locales/en/platform/applications.en.yml

@@ -24,32 +24,46 @@ en:
       name:
         _: &name Name
         label: *name
-        heading: Application Name
+        heading: &application_name Application Name
+        api_title: *application_name
+        api_description: *application_name
 
       redirect_uri:
         _: &redirect_uri Redirect URI
         label: *redirect_uri
         heading: *redirect_uri
+        api_title: *redirect_uri
+        api_description: *redirect_uri
         help: This is only required if you're building an OAuth2-powered integration for other users.
 
       uid:
-        heading: Client UID
+        heading: &uid Client UID
+        api_title: *uid
+        api_description: *uid
 
       secret:
-        heading: Client Secret
+        heading: &secret Client Secret
+        api_title: *secret
+        api_description: *secret
 
       label_string:
-        heading: Application Name
+        heading: *application_name
+        api_title: *application_name
+        api_description: *application_name
 
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         _: &created_at Added
         label: *created_at
         heading: *created_at
+        api_title: *created_at
+        api_description: *created_at
       updated_at:
         _: &updated_at Updated
         label: *updated_at
         heading: *updated_at
+        api_title: *updated_at
+        api_description: *updated_at
     index:
       section: "%{teams_possessive} Platform Applications"
       contexts:

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.6.26"
+    VERSION = "1.6.28"
   end
 end

data/lib/tasks/bullet_train/api_tasks.rake

@@ -146,5 +146,103 @@ namespace :bullet_train do
         )
       end
     end
+
+    desc "Create `api_title` and `api_description` translations"
+    task create_translations: :environment do
+      # Define the root of the locales directory
+      locales_root = Rails.root.join("config", "locales").to_s
+
+      # Define the backup directory
+      backup_dir = Rails.root.join("tmp", "locales_backup")
+      FileUtils.mkdir_p(backup_dir) unless Dir.exist?(backup_dir)
+
+      original_files = Dir.glob("#{locales_root}/**/*.yml")
+      differing_files_count = 0
+
+      original_files.each do |file|
+        puts "Processing #{file}..."
+
+        lines = File.readlines(file)
+        new_content = []
+        inside_fields = false
+        current_field = nil
+        fields_indentation = 4
+        api_title_exists = false
+        api_description_exists = false
+
+        # Read the entire file as a string
+        lines.each_with_index do |line, index|
+          # fields are always under locale:model:
+          if line.start_with?("#{" " * fields_indentation}fields:")
+            inside_fields = true
+            new_content << line
+            next
+          end
+
+          if inside_fields
+            current_indentation = line.index(/\S/) || 0
+            if current_indentation <= fields_indentation
+              # We've exited the fields block
+              inside_fields = false
+              current_field = nil
+            elsif current_indentation == fields_indentation + 2
+              # We're on a line with a field name
+              current_field = line.strip.split(":").first
+
+              api_title_exists = false
+              api_description_exists = false
+
+              n = 1
+              until index + n >= lines.length || (lines[index + n].index(/\S/) || 0) <= fields_indentation
+                if lines[index + n].strip.start_with?("api_title:")
+                  api_title_exists = true
+                elsif lines[index + n].strip.start_with?("api_description:")
+                  api_description_exists = true
+                end
+                n += 1
+              end
+
+            elsif current_field && line.strip.start_with?("heading:")
+              heading_value = line.split(":").last&.strip
+              indent = " " * current_indentation
+
+              if heading_value&.start_with?("&", "*")
+                new_content << line
+              else
+                heading_value = "&#{current_field} #{heading_value}"
+                new_content << "#{indent}heading: #{heading_value}\n"
+              end
+
+              field_key = heading_value[1..]&.split(" ")&.first
+              new_content << "#{indent}api_title: *#{field_key}\n" unless api_title_exists
+              new_content << "#{indent}api_description: *#{field_key}\n" unless api_description_exists
+
+              next
+            end
+          end
+
+          new_content << line
+        end
+
+        # Only write to file if there are changes
+        unless lines.join == new_content.join
+          differing_files_count += 1
+
+          # Compute the relative path manually
+          relative_path = file.sub(/^#{Regexp.escape(locales_root)}\/?/, "")
+
+          backup_path = File.join(backup_dir, relative_path)
+          FileUtils.mkdir_p(File.dirname(backup_path))
+          FileUtils.cp(file, backup_path)
+          puts "↳ Updating, backup created: #{backup_path}"
+
+          # Write the updated data back to the file
+          File.write(file, new_content.join)
+        end
+      end
+
+      puts "---"
+      puts "Total files updated: #{differing_files_count}/#{original_files.size}"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.6.26
+  version: 1.6.28
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -246,7 +246,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/bullet-train-co/bullet_train-core/tree/main/bullet_train-api
   source_code_uri: https://github.com/bullet-train-co/bullet_train-core/tree/main/bullet_train-api
-post_install_message: 
+post_install_message: "\n    Bullet Train is switching to separate translations for
+  API documentation.\n    To automatically update existing translations, run once:\n\n
+  \   bundle exec rake bullet_train:api:create_translations\n\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -261,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Bullet Train API