swagger-to-rbs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74b61b73586f11db01b0d710db9d9d37ba73ff814100cee23ed8be6be6f844bb
+  data.tar.gz: '0649e4db09841b3681a93cb749ed43f8562271e49ac8e1e9ab4af30018404edc'
+SHA512:
+  metadata.gz: dcb476b66268b52abbfb5b25746755618d4bae2af3a28a2a8ee5d2bf0c1a32c937eaf4418887bc9e77b981afe6a4a1231ba418ffd7c1bfe52e7a6b87e5083596
+  data.tar.gz: c52a43103f947a24a7e839b3f59638a81677e850b159bd85290196c59f232424b99833fb1f5c8450523f8b3a77865562b66a49c7efedadf5f42d6a605452505e

data/README.md

@@ -0,0 +1,53 @@
+### Usage
+
+Dowload swagger spec
+
+Example:
+
+```
+curl https://petstore3.swagger.io/api/v3/openapi.json > swagger.json
+```
+
+Generate http client based on [Httparty gem](https://github.com/jnunemaker/httparty)
+
+```
+ruby lib/index.rb MyApi
+```
+
+Result:
+
+```rb
+require 'httparty'
+
+class PetApi
+  include HTTParty
+  base_uri "/api/v3"
+  #...
+
+  def getPetById(petId, params, options = {})
+    self.class.get("/pet/#{petId}", params: params.to_json, headers: { 'Content-Type' => 'application/json' }.merge(options))
+  end
+
+  def updatePet(body, options = {})
+    self.class.put("/pet", body: body.to_json, headers: { 'Content-Type' => 'application/json' }.merge(options))
+  end
+
+  def addPet(body, options = {})
+    self.class.post("/pet", body: body.to_json, headers: { 'Content-Type' => 'application/json' }.merge(options))
+  end
+  #...
+end
+```
+
+### Send default header in all request
+
+Authorization example:
+
+```
+api = MyApi.new
+
+MyApi.headers(Authorization: "Bearer #{access_token}")
+MyApi.base_uri("http://otherurl.test/api/v1)
+
+api.getPetById(1)
+```

data/bin/swagger-to-rbs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/swagger2_rbs'
+require_relative '../lib/swagger2_rbs/cli'
+
+Swagger2Rbs::Cli.start(ARGV)

data/lib/index.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'pry'
+require 'dotenv/load'
+require_relative 'swagger2_rbs'
+require_relative './swagger2_rbs/cli'
+
+Swagger2Rbs::Cli.start(ARGV)

data/lib/swagger2_rbs/cli.rb

@@ -0,0 +1,42 @@
+require 'thor'
+require 'json'
+require 'yaml'
+
+module Swagger2Rbs
+  class Cli < Thor
+    attr_reader :name, :swagger_path, :rest_api_path, :debug
+
+    desc 'genearte', 'generate http client and rbs'
+    option :name, desc: 'Name'
+    option :spec, desc: 'Swagger file path'
+    option :debug, desc: 'Generate debug file'
+    def generate
+      @name = options[:name]
+      @swagger_path = options[:spec]
+      @debug = options[:debug]
+      data = fetch_data
+      File.write(".rest-api.json", JSON.pretty_generate(data)) if debug
+
+      file_name = to_underscore(name)
+      File.write("#{file_name}.rb", ::Swagger2Rbs.generate(name, data.dup))
+      File.write("#{file_name}.rbs", ::Swagger2Rbs.generate_rbs(name, data.dup))
+    end
+
+    private
+    def fetch_data
+      if swagger_path
+        swagger_spec = JSON.parse(File.read(swagger_path))
+        ::Swagger2Rbs.swagger_to_rest_api(swagger_spec)
+      elsif rest_api_path
+        data = YAML.load_file(rest_api_path, symbolize_names: true)
+        ::Swagger2Rbs.rest_api_all(data)
+      else
+        raise StandardError, "Missing swagger_path or rest_api_path"
+      end
+    end
+
+    def to_underscore(string)
+      string.gsub(/(.)([A-Z])/,'\1_\2').downcase
+    end
+  end
+end

data/lib/swagger2_rbs/rest_endpoint.rb

@@ -0,0 +1,122 @@
+require 'slugify'
+
+module Swagger2Rbs
+  class RestEndpoint
+    attr_reader :path, :method, :props
+
+    def initialize(path, method, props)
+      @path = path
+      @method = method
+      @props = props || {}
+    end
+
+    def to_h
+      {
+        path: path_with_parameters,
+        method: method,
+        parameters: parameters,
+        parameters_for_method: parameters_for_method,
+        parameters_typed: parameters_typed,
+        method_name: method_name,
+        body: body,
+        body_typed: body_typed,
+        response_typed: response_typed,
+      }
+    end
+
+    def method_name
+      props["operationId"] || path.slugify.gsub("-", "_")
+    end
+
+    def path_with_parameters
+      path.gsub("{", '#{')
+    end
+
+    def parameters
+      return [] unless props["parameters"]
+
+      props["parameters"].select{|it| it["in"] == "path"}.map{|it| it["name"]}
+    end
+
+    def response_typed
+      schema = resolve_all_of(@props.dig("responses", "200", "content", "application/json", "schema"))
+      schema_to_typed(schema, {})
+    end
+
+    def parameters_typed
+      return nil if method != "get"
+      parameters.map{|it| "String #{it}" }
+      .push("?Hash[untyped, untyped] options")
+      .join(", ")
+    end
+
+    def body_typed
+      return nil if method != "post"
+
+      return "Hash[String, untyped]" unless body
+      return "Hash[String, untyped]" if body.empty?
+
+    "{" + body.map{ |k, v| to_typed(k, v) }.join(", ") + "}" + " body, ?Hash[untyped, untyped] options"
+    end
+
+    def to_typed(k, v)
+      return "#{k}: #{v&.capitalize}" 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| "#{k}: #{v&.capitalize}" }.join(", ") + "}]"
+      else
+        "#{k}: Array[#{v[0]&.capitalize}]"
+      end
+    end
+
+    def body
+      body_schema = resolve_of(props.dig("requestBody", "content", "application/json", "schema"))
+      return {} unless body_schema
+
+      schema_to_typed(body_schema)
+    end
+
+    def parameters_for_method
+      return parameters.push("options = {}").join(", ") if (method == "get")
+
+      parameters.push("body").push("options = {}").join(", ")
+    end
+
+    def schema_to_typed(schema, memo = {})
+      return nil unless schema
+
+      schema["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
+    end
+
+    def resolve_of(data)
+      resolve_all_of(resolve_one_of(data))
+    end
+
+    def resolve_one_of(data)
+      return data unless data
+      return data unless data["oneOf"]
+
+      data["oneOf"].reduce(&:merge)
+    end
+
+    def resolve_all_of(data)
+      return data unless data
+      return data unless data["allOf"]
+
+      data["allOf"].reduce(&:merge)
+    end
+  end
+end

data/lib/swagger2_rbs.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'erb'
+require_relative 'swagger2_rbs/rest_endpoint'
+
+module Swagger2Rbs
+
+  def self.swagger_to_rest_api(swagger_spec)
+    result = []
+    swagger_spec["paths"].each do |path, data|
+      data.each do |method, props|
+        rest_data = RestEndpoint.new(path, method, props)
+        result << rest_data.to_h
+      end
+    end
+
+    { base_uri: swagger_spec["servers"].first["url"], endpoints: result }
+  end
+
+  def self.rest_api_all(spec)
+    result = []
+    spec[:endpoints].each do |endpoint|
+      rest_data = RestEndpoint.new(endpoint[:path], endpoint[:method], endpoint[:props])
+      result << rest_data.to_h
+    end
+
+    { base_uri: spec[:base_uri], endpoints: result }
+  end
+
+  def self.mock_rest_api_data
+    data = YAML.load_file('spec/fixtures/rest-api.yaml').transform_keys(&:to_sym)
+    data[:endpoints].map!{|it| it.transform_keys(&:to_sym) }
+    data
+  end
+
+  def self.generate(name, data)
+    @module_name = name
+    @data = data
+    template = File.read("#{File.dirname(__dir__ )}/lib/templates/http_client.rb.erb")
+
+    ERB.new(template, nil, '-').result(binding)
+  end
+
+  def self.generate_rbs(name, data)
+    @module_name = name
+    @data = data
+    template = File.read("#{File.dirname(__dir__ )}/lib/templates/http_client.rbs.erb")
+
+    ERB.new(template, nil, '-').result(binding)
+  end
+end

data/lib/templates/http_client.rb.erb

@@ -0,0 +1,24 @@
+
+require 'httparty'
+
+class <%= @module_name %>
+  include HTTParty
+
+  base_uri "<%= @data[:base_uri] %>"
+
+  def initialize
+    self.class.headers({ 'Content-Type' => 'application/json' })
+  end
+  <%- @data[:endpoints].each do |endpoint| -%>
+
+  <%- if endpoint[:method] == 'get' -%>
+  def <%= endpoint[:method_name] %>(<%= endpoint[:parameters_for_method] %>)
+    self.class.<%= endpoint[:method] %>("<%= endpoint[:path] %>", options)
+  end
+  <%- else -%>
+  def <%= endpoint[:method_name] %>(<%= endpoint[:parameters_for_method] %>)
+    self.class.<%= endpoint[:method] %>("<%= endpoint[:path] %>", { body: body.to_json }.merge(options))
+  end
+  <%- end -%>
+  <%- end -%>
+end

data/lib/templates/http_client.rbs.erb

@@ -0,0 +1,17 @@
+
+# Classes
+
+class <%= @module_name %>
+  include HTTParty
+  attr_accessor default_headers: bot
+
+  def initialize: -> void
+  <%- @data[:endpoints].each do |endpoint| -%>
+
+  <%- if endpoint[:method] == 'get' -%>
+  def <%= endpoint[:method_name] %>(<%= endpoint[:parameters_typed] %>) -> HTTParty::Response
+  <%- else -%>
+  def <%= endpoint[:method_name] %>(<%= endpoint[:body_typed] %>) -> HTTParty::Response
+  <%- end -%>
+  <%- end -%>
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: swagger-to-rbs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Savignano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slugify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate Http client and rbs files
+email: migue.masx@gmail.com
+executables:
+- swagger-to-rbs
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/swagger-to-rbs
+- lib/index.rb
+- lib/swagger2_rbs.rb
+- lib/swagger2_rbs/cli.rb
+- lib/swagger2_rbs/rest_endpoint.rb
+- lib/templates/http_client.rb.erb
+- lib/templates/http_client.rbs.erb
+homepage: https://github.com/MiguelSavignano/swagger-to-rbs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Swagger to rbs
+test_files: []