rspec-openapi 0.3.16 → 0.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799f75b4bb5607dff7ab4a556b5d27d72b587af88636e7b510533724a1ede97a
-  data.tar.gz: 71aedf1e1610f23106dd778a2b9d9f4677c73c280127ff61300afa024068bef8
+  metadata.gz: d0ff0f4854e68684d59b37788218a797c61cdff744808237ca08818493a393eb
+  data.tar.gz: 0730c2487ccb75a2fd3bec8052136cb75b9410d42daea1e3a6c9826d6854df8d
 SHA512:
-  metadata.gz: e65865ca2d26e66f6fa560fe3fc157a491786ba7243d267dcdd4f22e3e5c28c29895384a32b8b19c095317a0447453ad292bfe91ff4059395f8ee08f0763f738
-  data.tar.gz: fda7f3678e952359a356069353d0756890edd7da50e4cd422489db091f9223439e1385d7939f27bd55d4c4afc7e6760bd55805275f932345273e6d5528a2b036
+  metadata.gz: dadb96bc250a1c615176c5ada6e5dd6a41f1dec2a96099ef5181ac83e77d9c008168c0219c0a92d59bfc7a5ca0388138bcdd2641d8c5eb767d42a38a2cbd4096
+  data.tar.gz: 276bf5d35e634db31d6cdcaac519dac4972cbf0c93014c9c45d59a97bb0d2c20ee969c843f54e879eca8bab29cea0192cf36aab9c3ba5b0c2ee803692b0a5816

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v0.3.20
+
+* Add `RSpec::OpenAPI.output` config to output JSON
+  [#31](https://github.com/k0kubun/rspec-openapi/pull/31)
+
+## v0.3.19
+
+* Add `server_urls` and `request_headers` configs
+  [#30](https://github.com/k0kubun/rspec-openapi/pull/30)
+
+## v0.3.18
+
+* Support nested query parameters
+  [#29](https://github.com/k0kubun/rspec-openapi/pull/29)
+
+## v0.3.17
+
+* Rescue NotImplementedError in the after suite hook as well
+  [#28](https://github.com/k0kubun/rspec-openapi/pull/28)
+
 ## v0.3.16
 
 * Use `media_type` instead of `content_type` for Rails 6.1

data/README.md

@@ -108,12 +108,23 @@ The following configurations are optional.
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
+# Change the output type yaml or json
+RSpec::OpenAPI.output = :json
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
 # Change `info.version`
 RSpec::OpenAPI.application_version = '1.0.0'
 
+# Set `headers` - generate parameters with headers for a request
+RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
+
+# Set `server_urls` - generate servers of a schema file
+RSpec::OpenAPI.server_urls = %w[
+  http://localhost:3000
+]
+
 # Generate a comment on top of a schema file
 RSpec::OpenAPI.comment = <<~EOS
   This file is auto-generated by rspec-openapi https://github.com/k0kubun/rspec-openapi
@@ -155,10 +166,6 @@ Beta
 
 Basic features are there, and some people are already using this.
 
-### Current limitation
-
-* Generating a JSON file is not supported yet
-
 ### Other missing features with notes
 
 * Delete obsoleted endpoints

data/lib/rspec/openapi/default_schema.rb

@@ -6,6 +6,7 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
         title: title,
         version: RSpec::OpenAPI.application_version,
       },
+      servers: RSpec::OpenAPI.server_urls.map { |url| { url: url } } || [],
       paths: {},
     }.freeze
   end

data/lib/rspec/openapi/hooks.rb

@@ -22,7 +22,7 @@ RSpec.configuration.after(:suite) do
     records.each do |record|
       begin
         RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
-      rescue => e # e.g. SchemaBuilder raises a NotImplementedError
+      rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
         # NOTE: Don't fail the build
         records_errors << [e, record]
       end

data/lib/rspec/openapi/record.rb

@@ -5,6 +5,7 @@ RSpec::OpenAPI::Record = Struct.new(
   :query_params,          # @param [Hash]    - {:query=>"string"}
   :request_params,        # @param [Hash]    - {:request=>"body"}
   :request_content_type,  # @param [String]  - "application/json"
+  :request_headers,       # @param [Array]  - [["header_key1", "header_value1"], ["header_key2", "header_value2"]]
   :summary,               # @param [String]  - "v1/statuses #show"
   :tags,                  # @param [Array]   - ["Status"]
   :description,           # @param [String]  - "returns a status"

data/lib/rspec/openapi/record_builder.rb

@@ -34,6 +34,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
         nil
       end
 
+    request_headers = RSpec::OpenAPI.request_headers.each_with_object([]) do |header, headers_arr|
+      header_key = header.gsub(/-/, '_').upcase
+      header_value = request.get_header(['HTTP', header_key].join('_')) || request.get_header(header_key)
+      headers_arr << [header, header_value] if header_value
+    end
+
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       path: path,
@@ -41,6 +47,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
       request_content_type: request.media_type,
+      request_headers: request_headers,
       summary: summary,
       tags: tags,
       description: RSpec::OpenAPI.description_builder.call(example),

data/lib/rspec/openapi/schema_builder.rb

@@ -50,7 +50,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.path_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
@@ -60,17 +60,37 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     record.query_params.each do |key, value|
       parameters << {
-        name: key.to_s,
+        name: build_parameter_name(key, value),
         in: 'query',
         schema: build_property(try_cast(value)),
         example: (try_cast(value) if example_enabled?),
       }.compact
     end
 
+    record.request_headers.each do |key, value|
+      parameters << {
+        name: build_parameter_name(key, value),
+        in: 'header',
+        required: true,
+        schema: build_property(try_cast(value)),
+        example: (try_cast(value) if example_enabled?),
+      }.compact
+    end
+
     return nil if parameters.empty?
     parameters
   end
 
+  def build_parameter_name(key, value)
+    key = key.to_s
+    if value.is_a?(Hash) && (value_keys = value.keys).size == 1
+      value_key = value_keys.first
+      build_parameter_name("#{key}[#{value_key}]", value[value_key])
+    else
+      key
+    end
+  end
+
   def build_request_body(record)
     return nil if record.request_content_type.nil?
     return nil if record.request_params.empty?

data/lib/rspec/openapi/schema_file.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'yaml'
+require 'json'
 
 # TODO: Support JSON
 class RSpec::OpenAPI::SchemaFile
@@ -20,13 +21,25 @@ class RSpec::OpenAPI::SchemaFile
   # @return [Hash]
   def read
     return {} unless File.exist?(@path)
-    YAML.load(File.read(@path))
+
+    content = File.read(@path)
+
+    return JSON.load(content) if json?
+
+    YAML.load(content)
   end
 
   # @param [Hash] spec
   def write(spec)
     FileUtils.mkdir_p(File.dirname(@path))
-    File.write(@path, prepend_comment(YAML.dump(spec)))
+
+    output = if json?
+               JSON.pretty_generate(spec)
+             else
+               prepend_comment(YAML.dump(spec))
+             end
+
+    File.write(@path, output)
   end
 
   def prepend_comment(content)
@@ -38,4 +51,8 @@ class RSpec::OpenAPI::SchemaFile
     end
     "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
+
+  def json?
+    RSpec::OpenAPI.output.to_s == 'json'
+  end
 end

data/lib/rspec/openapi/schema_merger.rb

@@ -30,6 +30,13 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
         deep_reverse_merge!(base[key], value)
       elsif !base.key?(key)
         base[key] = value
+      elsif base[key].is_a?(Array) && value.is_a?(Array)
+        if key == "parameters"
+          # merge arrays
+          base[key] |= value
+        end
+      else
+        # no-op
       end
     end
     base

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.16'
+    VERSION = '0.3.20'
   end
 end

data/lib/rspec/openapi.rb

@@ -7,8 +7,11 @@ module RSpec::OpenAPI
   @enable_example = true
   @description_builder = -> (example) { example.description }
   @application_version = '1.0.0'
+  @output = :yaml
+  @request_headers = []
+  @server_urls = []
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :output
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.16
+  version: 0.3.20
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -75,7 +75,7 @@ metadata:
   homepage_uri: https://github.com/k0kubun/rspec-openapi
   source_code_uri: https://github.com/k0kubun/rspec-openapi
   changelog_uri: https://github.com/k0kubun/rspec-openapi/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []