swagger-to-rbs 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddb76510d5a4e87aee8bb582481a21c80616fa83e58a6fc49e8c1b02e449a4a5
-  data.tar.gz: 3460975741e8aad8d93e42939ef77cd6b40ba63ac3febf946e8a3e0af388618d
+  metadata.gz: 4009216d856b770d4226cdc662c17250a113cf2a06366f7a5731d39a72d417ed
+  data.tar.gz: 456756e34e5ce92d602ac0c23aa0d6e243a78b95e4f20a39210976a477a41ad7
 SHA512:
-  metadata.gz: 1c788888a133f558bfae8348f7d22012e401ce42f6cdac5ed5248b7a669e5dbde5b797145316a626a39a2fff667f283ec6d0b5f75e2d663f6e004540f804c7b6
-  data.tar.gz: ba69ff9e2377795ed266c9319254d94695d758d5795ff64d26fe81996f01ef595567b75787d413dcb8bf6177bb699fc09c1f408c4dd8d5bc2cc85c9a6142af45
+  metadata.gz: ba0e9c1101cfa113600e891feef046f2aff46b4dfa56d8c9f16dc38f08327ecd5bc16f49633bbb5420a7835401ceb0c3cd036137eccd7e7636da3537fb9fd866
+  data.tar.gz: 1b374d837cf5050238dac0096866624da70c192e7d03dca63f425cca3f44619f2020cedd441584dd8cc56582829753358c00fc723ee6d8e9f826762611415843

data/lib/swagger2_rbs/hash_helper.rb

@@ -1,6 +1,24 @@
 module Swagger2Rbs
   class HashHelper
 
+    def self.resolve_special_key(data, special_key)
+      return data unless data
+
+      new_data = data.dup
+      walk(data) do |key, value|
+        if (key.split(".").last == special_key)
+          update_key = key.split(".").reject{|k| k == special_key}.join(".")
+          new_value = yield(key, value)
+          set_value(new_data, update_key, new_value)
+        end
+      end
+      new_data
+    end
+
+    def self.present?(hash)
+      hash && !hash.empty?
+    end
+
     # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb#L129
     def self.deep_transform_keys_in_object!(object, &block)
       case object

data/lib/swagger2_rbs/rbs_type.rb

@@ -0,0 +1,46 @@
+module Swagger2Rbs
+  class RbsType
+    attr_reader :data, :symbolize_keys
+    def initialize(data, symbolize_keys: true)
+      @data = data
+      @symbolize_keys = symbolize_keys
+    end
+
+    def write_types
+      return nil unless HashHelper.present? data
+      typed = (data.is_a?(Array) ? data[0] : data)&.map{ |k, v| to_typed(k, v) }.join(', ')
+      if data.is_a?(Array)
+        "Array[{ #{typed} }]"
+      else
+        "{ #{typed} }"
+      end
+    end
+
+    def type_case(str)
+      case str
+      when "boolean"
+        "bool"
+      when nil
+        "untyped"
+      else
+        str&.capitalize
+      end
+    end
+
+    def key_to_typed(k)
+      return "#{k}:" if @symbolize_keys
+      "\"#{k}\" =>"
+    end
+
+    def to_typed(k, v)
+      return "#{key_to_typed(k)} #{type_case(v)}" unless v.is_a?(Array) || v.is_a?(Hash)
+      return "#{key_to_typed(k)} {#{v.map{ |k2, v2| to_typed(k2, v2) }.join(", ")}}" if v.is_a?(Hash)
+
+      if v[0]&.is_a?(Hash)
+        "#{key_to_typed(k)} Array[{" + v[0].map{ |k, v| to_typed(k, v) }.join(", ") + "}]"
+      else
+        "#{key_to_typed(k)} Array[#{type_case(v[0])}]"
+      end
+    end
+  end
+end

data/lib/swagger2_rbs/rest_endpoint.rb

@@ -20,14 +20,15 @@ module Swagger2Rbs
         typed_parameters_for_method: typed_parameters_for_method,
         has_body: body?,
         method_name: method_name,
-        response_typed: response_typed,
+        all_responses_typed: all_responses_typed,
+        all_responses_for_return_method: all_responses_for_return_method,
       }
     rescue => e
       raise e, "Context: #{path} #{method} Message: #{e.message}"
     end
 
     def body?
-      body && !body.empty?
+      HashHelper.present? body
     end
 
     def to_yaml
@@ -37,7 +38,8 @@ module Swagger2Rbs
         path_parameters: parameters,
         method_name: method_name,
         body: body,
-        response: response_typed,
+        response: response("200"),
+        all_responses: all_responses
       }
     rescue => e
       raise e, "Context: #{path} #{method} Message: #{e.message}"
@@ -61,7 +63,25 @@ module Swagger2Rbs
       body_schema = resolve_of(props.dig("requestBody", "content", "application/json", "schema"))
       return {} unless body_schema
 
-      schema_to_typed(body_schema)
+      schema_to_hash(body_schema)
+    end
+
+    def response(http_code)
+      schema = resolve_all_of(@props.dig("responses", http_code, "content", "application/json", "schema"))
+      schema_to_hash(schema, {})
+    end
+
+    def all_responses
+      result = @props.dig("responses").keys.reduce({}) do |memo, key|
+        memo.merge({ key => response(key) })
+      end
+    end
+
+    def all_responses_for_return_method
+      return '{ "200" => response }' if all_responses.empty?
+
+      result = all_responses.keys.map{|key| "\"#{key}\" => response" }.join(", ")
+      "{ #{result} }"
     end
 
     def parameters_for_method
@@ -74,6 +94,29 @@ module Swagger2Rbs
       end
     end
 
+    def schema_to_hash(schema, memo = {})
+      return nil unless schema
+
+      properties = schema["type"] == "array" ? schema["items"]["properties"] : schema["properties"]
+
+      result = properties&.reduce(memo)do |memo, (k,v)|
+        if v["type"] == "object"
+          memo.merge({k => schema_to_hash(v, {})})
+        elsif v["type"] == "array"
+          if v.dig("items", "type") == "object"
+            memo.merge({k => [schema_to_hash(v["items"], {})] })
+          else
+            memo.merge({k => [v.dig("items", "type")] })
+          end
+        else
+          memo.merge({k => v["type"] })
+        end
+      end
+      return [result] if schema["type"] == "array"
+
+      result
+    end
+
     def resolve_of(data)
       resolve_all_of(resolve_one_of(data))
     end
@@ -86,10 +129,12 @@ module Swagger2Rbs
     end
 
     def resolve_all_of(data)
-      return data unless data
-      return data unless data["allOf"]
-
-      data["allOf"].reduce(&:merge)
+      HashHelper.resolve_special_key(data, "allOf") do |key, value|
+        value.reduce(value[0]) do |memo, it|
+          memo["properties"] = memo["properties"].merge(it["properties"])
+          memo
+        end
+      end
     end
   end
 end

data/lib/swagger2_rbs/rest_endpoint_typed.rb

@@ -1,11 +1,6 @@
+require_relative './rbs_type'
 module Swagger2Rbs
-
   module RestEndpointTyped
-    def response_typed
-      schema = resolve_all_of(@props.dig("responses", "200", "content", "application/json", "schema"))
-      schema_to_typed(schema, {})
-    end
-
     def typed_parameters_for_method
       options_typed = "?Hash[untyped, untyped] options"
       return "(#{options_typed})" unless body && parameters
@@ -19,56 +14,17 @@ module Swagger2Rbs
     end
 
     def body_typed
-      return nil unless body?
-      typed = (body.is_a?(Array) ? body[0] : body)&.map{ |k, v| to_typed(k, v) }.join(', ')
-      if body.is_a?(Array)
-        "Array[{ #{typed} }]"
-      else
-        "{ #{typed} }"
-      end
-    end
-
-    def type_case(str)
-      case str
-      when "boolean"
-        "bool"
-      else
-        str&.capitalize
-      end
+      RbsType.new(body).write_types
     end
 
-    def to_typed(k, v)
-      return "#{k}: #{type_case(v)}" unless v.is_a?(Array) || v.is_a?(Hash)
-      return "#{k}: {#{v.map{ |k2, v2| to_typed(k2, v2) }.join(", ")}}" if v.is_a?(Hash)
-
-      if v[0]&.is_a?(Hash)
-        "#{k}: Array[{" + v[0].map{ |k, v| to_typed(k, v) }.join(", ") + "}]"
-      else
-        "#{k}: Array[#{type_case(v[0])}]"
-      end
+    def response_typed(http_code)
+      RbsType.new(response(http_code), symbolize_keys: false).write_types
     end
 
-    def schema_to_typed(schema, memo = {})
-      return nil unless schema
-
-      properties = schema["type"]["array"] ? schema["items"]["properties"] : schema["properties"]
-
-      result = properties&.reduce(memo)do |memo, (k,v)|
-        if v["type"] == "object"
-          memo.merge({k => schema_to_typed(v, {})})
-        elsif v["type"] == "array"
-          if v.dig("items", "type") == "object"
-            memo.merge({k => [schema_to_typed(v["items"], {})] })
-          else
-            memo.merge({k => [v.dig("items", "type")] })
-          end
-        else
-          memo.merge({k => v["type"] })
-        end
-      end
-      return [result] if schema["type"]["array"]
+    def all_responses_typed
+      return '{ "200" => untyped }' unless @props.dig("responses")
 
-      result
+      RbsType.new(all_responses, symbolize_keys: false).write_types
     end
   end
 end

data/lib/swagger2_rbs.rb

@@ -5,23 +5,11 @@ require_relative 'swagger2_rbs/hash_helper'
 
 module Swagger2Rbs
 
-  def self.resolve_ref(hash, key, value)
-    ref_key = value.gsub("#/", "").split("/")
-    data = hash.dig(*ref_key)
-    update_key = key.split(".").reject{|k| k == "$ref"}.join(".")
-
-    [update_key, data]
-  end
-
   def self.resolve_all_ref(swagger_spec)
-    new_swagger_spec = swagger_spec.dup
-    HashHelper.walk(swagger_spec) do |key, value|
-      if key.split(".").last == "$ref"
-        update_key, data = resolve_ref(swagger_spec, key, value)
-        HashHelper.set_value(new_swagger_spec, update_key, data)
-      end
+    HashHelper.resolve_special_key(swagger_spec, "$ref") do |key, value|
+      ref_key = value.gsub("#/", "").split("/")
+      swagger_spec.dig(*ref_key)
     end
-    new_swagger_spec
   end
 
   def self.swagger_to_rest_api(swagger_spec, parse_method = :to_h)

data/lib/templates/http_client.rb.erb

@@ -13,11 +13,13 @@ class <%= @module_name %>
 
   <%- unless endpoint[:has_body] -%>
   def <%= endpoint[:method_name] %>(<%= endpoint[:parameters_for_method] %>)
-    self.class.<%= endpoint[:http_method] %>("<%= endpoint[:path] %>", options)
+    response = self.class.<%= endpoint[:http_method] %>("<%= endpoint[:path] %>", options)
+    [response, <%= endpoint[:all_responses_for_return_method] %>]
   end
   <%- else -%>
   def <%= endpoint[:method_name] %>(<%= endpoint[:parameters_for_method] %>)
-    self.class.<%= endpoint[:http_method] %>("<%= endpoint[:path] %>", { body: body.to_json }.merge(options))
+    response = self.class.<%= endpoint[:http_method] %>("<%= endpoint[:path] %>", { body: body.to_json }.merge(options))
+    [response, <%= endpoint[:all_responses_for_return_method] %>]
   end
   <%- end -%>
   <%- end -%>

data/lib/templates/http_client.rbs.erb

@@ -4,6 +4,7 @@ module HTTParty
   class Response
     def body: -> untyped
     def success?: -> bool
+    def code: -> Integer
   end
 end
 
@@ -12,14 +13,14 @@ class <%= @module_name %>
 
   def self.headers: (untyped headers) -> void
   def self.base_uri: (String uri) -> void
-  def self.get: (String path, untyped options) -> void
-  def self.post: (String path, untyped options) -> void
-  def self.put: (String path, untyped options) -> void
-  def self.delete: (String path, untyped options) -> void
+  def self.get: (String path, untyped options) -> HTTParty::Response
+  def self.post: (String path, untyped options) -> HTTParty::Response
+  def self.put: (String path, untyped options) -> HTTParty::Response
+  def self.delete: (String path, untyped options) -> HTTParty::Response
 
   def initialize: -> void
   <%- @data[:endpoints].each do |endpoint| -%>
 
-  def <%= endpoint[:method_name] %>: <%= endpoint[:typed_parameters_for_method] %> -> HTTParty::Response
+  def <%= endpoint[:method_name] %>: <%= endpoint[:typed_parameters_for_method] %> -> [HTTParty::Response, <%= endpoint[:all_responses_typed] %>]
   <%- end -%>
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-to-rbs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Miguel Savignano
@@ -51,6 +51,7 @@ files:
 - lib/swagger2_rbs.rb
 - lib/swagger2_rbs/cli.rb
 - lib/swagger2_rbs/hash_helper.rb
+- lib/swagger2_rbs/rbs_type.rb
 - lib/swagger2_rbs/rest_endpoint.rb
 - lib/swagger2_rbs/rest_endpoint_typed.rb
 - lib/templates/http_client.rb.erb