rswag-api 2.1.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a619111fdd8a670fc3c02438872a2bc3ac74a51b1493afacb7fa0d69fb8f264
-  data.tar.gz: c1c9e70d901f6d93eb7a45269330085f3fdbf9d2343a253609308c6872c87e62
+  metadata.gz: 4d6e406c1fae102d2fd4c15b6b643fb8e1976edab4f07c8b6a85b87e6b9220ff
+  data.tar.gz: 23f6675fe724e257b16fbf6ec1d2cda567faf8c06ba860bff26dfdc848921a07
 SHA512:
-  metadata.gz: b174fe9ebd7719e3b83ed10fd4c9a72cb076f39b64f9a8b3a23ebb11d5d4d19e7c0bd9e2812beaf021a660115a868b21c3287cefcdbe349b0273d3ece30e9e5b
-  data.tar.gz: e59cd9b3d248efdfb515cc724e9d4973e360dd184797c91d9105dd8cafa1c04729c2790b1b5d6fc15572fa34c30af8d611e7df1a97344aa1554756b2082d5fbc
+  metadata.gz: e3a334ea2eea804b7f2454f769df98fb36d572a169e0400d413ad709eca1d2bad2ff4a7adf81836af31aceda70a4a4d8d68805d54cb163cfa605711e8ac45541
+  data.tar.gz: b3714e5bcd0202b840a140a09318c16286c3619a6af3aa5aa844dcafb91ff2f9528e5e09b23ca40a5ee012bf78007c4bdb79a9ab347afedefbf8f873340c5e03

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.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Richie Morris
+- Greg Myers
+- Jay Danielian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2021-01-28 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: []