apia-open_api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c08e44efe16ad5c8c47e58621d9d416433e8aa16d65c9d250a9b7154ce4d93
-  data.tar.gz: cf33503d1e4ee2c028c9b62902d718eee5fc7ca4c80e936a1bf8dbed032c1335
+  metadata.gz: 3a45fd172c715b417ff39eca615ecf87f12b49d68a3a0b005702be43e1cce2b7
+  data.tar.gz: 0bc1c81f27016b6df2085c3968ef1262a8d2630533a6e836bd786940b5c6bb7d
 SHA512:
-  metadata.gz: 207a6efc59f1c89c5505e21e75a2fd456e5b1603eb4eafafb4d93052fc61f28dca62e1c9daa6edabe36cc8db75f3728db61213a214dc4dd31d332048c34e3c33
-  data.tar.gz: 33455542c2d48abd6a0b7c1e3fd9881ba3fe03780f76d68cdc2ea248ef25040035023b43d50378e92ac543e491a6a2c481d3333b722367f0e164e4d4e4b6e658
+  metadata.gz: 0b0c1e241009a2cebd05ad12a654fab114634ebd3a9eb2aa29e7134cbf6c87e6b8ffae9bfa1b62e5339308475b9b610adfae3197bd56450d7bd5b1229ca119e7
+  data.tar.gz: 2650e1efa99461dd62ae0359baee53aa494d312655ead60df13ba4a4384b08461a99c0e8bef9a7ae6d60f6411a12229ff1c36fdb325a45ac168c269da430a397

data/lib/apia/open_api/objects/path.rb

@@ -99,15 +99,33 @@ module Apia
             end
           end
 
-          id = "#{@route.request_method}:#{result_parts.join('_')}"
-          if @path_ids.include?(id)
-            id = "#{@route.request_method}:#{@route.path}"
-          end
+          first_part = "#{@route.request_method}:"
+          id = "#{first_part}#{result_parts.join('_')}"
+
+          id = fallback_id(first_part) if @path_ids.include?(id)
           @path_ids << id
 
           id
         end
 
+        # IDs can clash if two paths are different, but generate the same ID.
+        # For example:
+        # - /dns_zones/:dns_zone
+        # - /dns/zones/:dns_zone
+        # When there is a duplicate we fallback to using the path, but as the path
+        # ID is used as the prefix for any $ref IDs, we need to make sure it's not
+        # too long. This is because there is a 100 character filename limit imposed
+        # by the rubygems gem builder.
+        def fallback_id(first_part)
+          last_part = @route.path
+          if last_part.length >= 50
+            last_part = last_part.split(/[_:\/]/).map do |word|
+              word[0]
+            end.join("_")
+          end
+          "#{first_part}#{last_part}"
+        end
+
       end
     end
   end

data/lib/apia/open_api/objects/response.rb

@@ -211,7 +211,7 @@ module Apia
         end
 
         def generate_ref(namespace, http_status_code, definitions)
-          id = generate_id_for_error_ref(http_status_code, definitions)
+          id = generate_id_for_error_ref(namespace, http_status_code, definitions)
           if namespace == "responses"
             add_to_responses_components(http_status_code, definitions, id)
           else
@@ -220,25 +220,39 @@ module Apia
           { "$ref": "#/components/#{namespace}/#{id}" }
         end
 
-        def generate_id_for_error_ref(http_status_code, definitions)
+        def generate_id_for_error_ref(namespace, http_status_code, definitions)
+          suffix = namespace == "responses" ? "Response" : "Schema"
           api_authenticator_error_defs = api_authenticator_potential_errors.map(&:definition).select do |d|
             d.http_status_code.to_s == http_status_code.to_s
           end
           if api_authenticator_error_defs.any? && api_authenticator_error_defs == definitions
-            "APIAuthenticator#{http_status_code}Response"
+            "APIAuthenticator#{http_status_code}#{suffix}"
           elsif definitions.length == 1
-            "#{generate_id_from_definition(definitions.first)}Response"
+            "#{generate_id_from_definition(definitions.first)}#{suffix}"
           else
-            [
-              (definitions - api_authenticator_error_defs).map do |d|
-                generate_id_from_definition(d)
-              end.join,
-              http_status_code,
-              "Response"
-            ].flatten.join("_").camelize
+            generate_short_error_ref(suffix, http_status_code, definitions, api_authenticator_error_defs)
           end
         end
 
+        # When we have multiple errors for the same http status code, we need to generate a unique ID.
+        # By default we join all the error names together, with the http status code and camelize them.
+        # If this is too long, we use only the first and last two error names. Error names are sorted
+        # alphabetically, which should ensure we do not generate the same ID to represent different sets of errors.
+        # The length is important because the rubygems gem builder imposes a 100 character limit on filenames.
+        def generate_short_error_ref(suffix, http_status_code, definitions, api_authenticator_error_defs)
+          generated_ids = (definitions - api_authenticator_error_defs).map do |d|
+            generate_id_from_definition(d)
+          end.sort
+          if generated_ids.join.length > 80
+            sliced_ids = [generated_ids.first] + generated_ids[-2..]
+          end
+          [
+            (sliced_ids || generated_ids).join,
+            http_status_code,
+            suffix.first(3)
+          ].flatten.join("_").camelize
+        end
+
         def add_to_responses_components(http_status_code, definitions, id)
           return unless @spec.dig(:components, :components, id).nil?
 

data/lib/apia/open_api/objects/schema.rb

@@ -144,9 +144,14 @@ module Apia
             schema[:properties][child.name.to_s] = generate_schema_ref(child)
           else
             child_path = @path.nil? ? nil : @path + [child]
+
+            # Nested partial fields in the response have the potential to generate
+            # very long IDs, so we truncate them to avoid hitting the 100 character
+            # filename limit imposed by the rubygems gem builder.
+            truncated_id = @id.match(/^(.*?)\d*?(Response|Part).*$/)[1]
             schema[:properties][child.name.to_s] = generate_schema_ref(
               child,
-              id: "#{@id}_#{child.name}".camelize,
+              id: "#{truncated_id}Part_#{child.name}".camelize,
               endpoint: @endpoint,
               path: child_path
             )

data/lib/apia/open_api/version.rb

@@ -3,7 +3,7 @@
 module Apia
   module OpenApi
 
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia-open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Paul Sturgess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport