rspec-openapi 0.3.18 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd7d2eb0e69e2e60405a7d71d10acd3b2edf2d4db0358297a900200a0a69012e
-  data.tar.gz: 577545384d404ba11382ab4425e0bd40abeeb3e58db922e82d923f0d6d6ae8e9
+  metadata.gz: 3032d3fed3b9bdc2b2a8512db3d1645679163539106650c1ad05069a15ab59cd
+  data.tar.gz: d1d3e85b467226a857b30bfe95b5643a1a37df2c0a925e509bdd893ae3017177
 SHA512:
-  metadata.gz: 5f60ee2cf93946405e3e151786965b3a0f68e53ad147a6d7613f59f46f834efd9a641d0f878943af934879d2f5e27e8c8d4cd55dac5288d62a85dc2b77009ddb
-  data.tar.gz: 7dc56150dfb4a8a5b526d7ec626b4ebc9c0680878cd1f976213490a489a598dfe2a285f01029e5a17cdbbe0d8b492fe79a2e51148ac24df94d532c404b0231fd
+  metadata.gz: 0c65c74db1ada24cf360545bda34830ca82d9cbd11b6e862a0563f9fc2bf244d65a96ec74e8223c182d1a2bff72b237e30c5884c2818576f9c142585d177351b
+  data.tar.gz: 397cfcddeaf3c1f683b9a1cd75960bf7d61e24adfcc9988bea2533c7a781acd42f43178b2ffb45deb5b3e821090f979d18af041a078f9ca3c2c7cd124cb4aff2

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v0.4.1
+
+* Add `RSpec::OpenAPI.example_types` to hook types other than `type: :request`.
+  [#32](https://github.com/k0kubun/rspec-openapi/pull/32)
+
+## v0.4.0
+
+* Drop `RSpec::OpenAPI.output` introduced in v0.3.20
+* Guess whether it's JSON or not by the extension of `RSpec::OpenAPI.path`
+
+## 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

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 to JSON
+RSpec::OpenAPI.path = 'doc/schema.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
@@ -124,6 +135,9 @@ EOS
 
 # Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
+
+# Change the example type(s) that will generate schema
+RSpec::OpenAPI.example_types = %i[request]
 ```
 
 ### How can I add information which can't be generated from RSpec?
@@ -155,10 +169,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

@@ -9,7 +9,7 @@ records = []
 records_errors = []
 
 RSpec.configuration.after(:each) do |example|
-  if example.metadata[:type] == :request && example.metadata[:openapi] != false
+  if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
     record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
     records << record if record
   end
@@ -31,7 +31,7 @@ RSpec.configuration.after(:suite) do
   if records_errors.any?
     error_message = <<~EOS
       RSpec::OpenAPI got errors building #{records_errors.size} requests
-      
+
       #{records_errors.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
     EOS
     colorizer = ::RSpec::Core::Formatters::ConsoleCodes

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

@@ -67,6 +67,16 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       }.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

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,19 @@ class RSpec::OpenAPI::SchemaFile
   # @return [Hash]
   def read
     return {} unless File.exist?(@path)
-    YAML.load(File.read(@path))
+    YAML.load(File.read(@path)) # this can also parse JSON
   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 +45,8 @@ class RSpec::OpenAPI::SchemaFile
     end
     "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
+
+  def json?
+    File.extname(@path) == '.json'
+  end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.18'
+    VERSION = '0.4.1'
   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'
+  @request_headers = []
+  @server_urls = []
+  @example_types = %i[request]
 
   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, :example_types
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.18
+  version: 0.4.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack