rswag-api 2.1.1 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb4e3352a6d79128a80330791bfe3a82561c4e658c2e531316368098ddc2d26
-  data.tar.gz: b21ab1fd96389fb193f9fd487c214b2ef6f0a30f010e9a07c9a2ab4ebb6f2ae9
+  metadata.gz: 9b73417261746971615d57f1e030552148fa2ff53f1071ed350ed8ddf092720a
+  data.tar.gz: 5365ebf8d3c67f6da3eef8ed1ff2c6819f312d64b6adad9fb39a2b1c3413cc82
 SHA512:
-  metadata.gz: 3dd345e95c82de2c375b71bbe4b443ee78f3648924ef12d84d44a9a1a144df3abbc40d35e57497eb58b94927890d997df2981aa4ced47ad75055b4e824196124
-  data.tar.gz: 3091da2ac5c5c54acdb23c4b643a27b6917a2685835a0599603078069e6eacf214705e992e535e005104b00bfd3fc14465670362c3a579ef33a7e7d6749f5723
+  metadata.gz: 2f1ca03959d88e66ab71a10290f2e8eba689926a04b2a6a559f4c9eef77bab95f5c7e0c63572a7868a03b7607048fc704f6923c62089176df7a2bb0a89c9837f
+  data.tar.gz: 662b0d2d6aa382372486ca40532d364413a18434a171d971e8f4f3a3fde672ad82d909baabbf11617a96a6d12b1f452945d4b16be529d9154041ea0c6e8c56d3

data/lib/generators/rswag/api/install/USAGE

@@ -5,4 +5,4 @@ Example:
     rails generate rswag:api:install
 
     This will create:
-        config/initializers/rswag-api.rb
+        config/initializers/rswag_api.rb

data/lib/generators/rswag/api/install/install_generator.rb

@@ -7,7 +7,7 @@ module Rswag
       source_root File.expand_path('../templates', __FILE__)
 
       def add_initializer
-        template('rswag-api.rb', 'config/initializers/rswag-api.rb')
+        template('rswag_api.rb', 'config/initializers/rswag_api.rb')
       end
 
       def add_routes

data/lib/rswag/api/configuration.rb

@@ -1,7 +1,7 @@
 module Rswag
   module Api
     class Configuration
-      attr_accessor :swagger_root, :swagger_filter
+      attr_accessor :swagger_root, :swagger_filter, :swagger_headers
 
       def resolve_swagger_root(env)
         path_params = env['action_dispatch.request.path_parameters'] || {}

data/lib/rswag/api/middleware.rb

@@ -1,8 +1,10 @@
 require 'json'
+require 'yaml'
+require 'rack/mime'
 
 module Rswag
   module Api
-    class Middleware 
+    class Middleware
 
       def initialize(app, config)
         @app = app
@@ -14,24 +16,47 @@ module Rswag
         filename = "#{@config.resolve_swagger_root(env)}/#{path}"
 
         if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
-          swagger = load_json(filename)
+          swagger = parse_file(filename)
           @config.swagger_filter.call(swagger, env) unless @config.swagger_filter.nil?
+          mime = Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+          headers = { 'Content-Type' => mime }.merge(@config.swagger_headers || {})
+          body = unload_swagger(filename, swagger)
 
           return [
             '200',
-            { 'Content-Type' => 'application/json' },
-            [ JSON.dump(swagger) ]
+            headers,
+            [ body ]
           ]
         end
-          
+
         return @app.call(env)
       end
 
       private
 
+      def parse_file(filename)
+        if /\.ya?ml$/ === filename
+          load_yaml(filename)
+        else
+          load_json(filename)
+        end
+      end
+
+      def load_yaml(filename)
+        YAML.safe_load(File.read(filename))
+      end
+
       def load_json(filename)
         JSON.parse(File.read(filename))
       end
+
+      def unload_swagger(filename, swagger)
+        if /\.ya?ml$/ === filename
+          YAML.dump(swagger)
+        else
+          JSON.dump(swagger)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rswag-api
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.3
 platform: ruby
 authors:
 - Richie Morris
+- Greg Myers
+- Jay Danielian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +21,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,9 +31,10 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
-description: Open up your API to the phenomenal Swagger ecosystem by exposing Swagger
-  files, that describe your service, as JSON endpoints
+        version: '7.0'
+description: 'Open up your API to the phenomenal OpenAPI ecosystem by exposing OpenAPI
+  files, that describe your service, as JSON endpoints. More about the OpenAPI initiative
+  here: http://spec.openapis.org/'
 email:
 - domaindrivendev@gmail.com
 executables: []
@@ -42,12 +45,12 @@ files:
 - Rakefile
 - lib/generators/rswag/api/install/USAGE
 - lib/generators/rswag/api/install/install_generator.rb
-- lib/generators/rswag/api/install/templates/rswag-api.rb
+- lib/generators/rswag/api/install/templates/rswag_api.rb
 - lib/rswag/api.rb
 - lib/rswag/api/configuration.rb
 - lib/rswag/api/engine.rb
 - lib/rswag/api/middleware.rb
-homepage: https://github.com/domaindrivendev/rswag
+homepage: https://github.com/rswag/rswag
 licenses:
 - MIT
 metadata: {}
@@ -66,9 +69,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: A Rails Engine that exposes Swagger files as JSON endpoints
+summary: A Rails Engine that exposes OpenAPI (formerly called Swagger) files as JSON
+  endpoints
 test_files: []