rswag-specs 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70532fd02f91610d9cb9dac9c2bc423c033dc3da
-  data.tar.gz: 9d942cd137b327ad9f8f9bc39ea621b81cd216fd
+  metadata.gz: 6ad505db2b445cd38fdcdd4c78aadefe9b996b63
+  data.tar.gz: 822fc014d46cb7c1b70e98caa330d41020b2a909
 SHA512:
-  metadata.gz: 3b415fc36ed7894301fd2e037b419dd9df53108fe24bfc64af9bb4d65be9a2221f9f30029d6936bf79868a0151f58b26e4a21536a919450c74a9af14c9c8831f
-  data.tar.gz: 4bd4fefe965d56f2afab78b35278b84c492f53a9b44423e93cf97a2a287166ec87a8776913e899d159f77fc8b5740e55b0588400fc1f1467352758b3b9f983c6
+  metadata.gz: 5001a2a51c3bbd6693466d5f6674ffa7a2662c5e9017814df96e2461a20aa854df6e8ffd63ff483f4e17f9ca62da6ee3ff35f37f23eff35b6d632530d7de095d
+  data.tar.gz: 6d939b5b8bdb64cb2542e4012bad4c4bc14166bc2a92f3ed6da1a0eb4d8af0632c3257ee94fddd4bdc9c9938db5b01fbba2967c8c50222346b5af50d85e6e2c0

data/lib/rswag/specs.rb

@@ -2,6 +2,7 @@ require 'rspec/core'
 require 'rswag/specs/version'
 require 'rswag/specs/example_group_helpers'
 require 'rswag/specs/example_helpers'
+require 'rswag/specs/configuration'
 require 'rswag/specs/railtie' if defined?(Rails::Railtie)
 
 module Rswag
@@ -15,6 +16,10 @@ module Rswag
       c.include ExampleHelpers, type: :request
     end
 
+    def self.config
+      @config ||= Configuration.new(RSpec.configuration)
+    end
+
     # Support Rails 3+ and RSpec 2+ (sigh!)
     RAILS_VERSION = Rails::VERSION::MAJOR
     RSPEC_VERSION = RSpec::Core::Version::STRING.split('.').first.to_i

data/lib/rswag/specs/configuration.rb

@@ -0,0 +1,37 @@
+module Rswag
+  module Specs
+
+    class Configuration
+
+      def initialize(rspec_config)
+        @rspec_config = rspec_config
+      end
+
+      def swagger_root
+        @swagger_root ||= begin
+          if @rspec_config.swagger_root.nil?
+            raise ConfigurationError, 'No swagger_root provided. See swagger_helper.rb'
+          end
+          @rspec_config.swagger_root
+        end
+      end
+
+      def swagger_docs
+        @swagger_docs ||= begin
+          if @rspec_config.swagger_docs.nil? || @rspec_config.swagger_docs.empty?
+            raise ConfigurationError, 'No swagger_docs defined. See swagger_helper.rb'
+          end
+          @rspec_config.swagger_docs
+        end
+      end
+
+      def get_swagger_doc(name)
+        return swagger_docs.values.first if name.nil?
+        raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]
+        swagger_docs[name]
+      end
+    end
+
+    class ConfigurationError < StandardError; end
+  end
+end

data/lib/rswag/specs/example_group_helpers.rb

@@ -2,9 +2,9 @@ module Rswag
   module Specs
     module ExampleGroupHelpers
 
-      def path(path, &block)
-        api_metadata = { path: path}
-        describe(path, api_metadata, &block)
+      def path(template, &block)
+        api_metadata = { path_item: { template: template } }
+        describe(template, api_metadata, &block)
       end
 
       [ :get, :post, :patch, :put, :delete, :head ].each do |verb|
@@ -37,8 +37,14 @@ module Rswag
 
       def parameter(attributes)
         attributes[:required] = true if attributes[:in].to_sym == :path
-        metadata[:operation][:parameters] ||= []
-        metadata[:operation][:parameters] << attributes
+
+        if metadata.has_key?(:operation)
+          metadata[:operation][:parameters] ||= []
+          metadata[:operation][:parameters] << attributes
+        else
+          metadata[:path_item][:parameters] ||= []
+          metadata[:path_item][:parameters] << attributes
+        end
       end
 
       def response(code, description, &block)

data/lib/rswag/specs/example_helpers.rb

@@ -6,7 +6,8 @@ module Rswag
     module ExampleHelpers
 
       def submit_request(api_metadata)
-        factory = RequestFactory.new(api_metadata, global_metadata(api_metadata[:swagger_doc]))
+        global_metadata = rswag_config.get_swagger_doc(api_metadata[:swagger_doc])
+        factory = RequestFactory.new(api_metadata, global_metadata)
 
         if RAILS_VERSION < 5
           send(
@@ -28,15 +29,15 @@ module Rswag
       end
 
       def assert_response_matches_metadata(api_metadata)
-        validator = ResponseValidator.new(api_metadata, global_metadata(api_metadata[:swagger_doc]))
+        global_metadata = rswag_config.get_swagger_doc(api_metadata[:swagger_doc])
+        validator = ResponseValidator.new(api_metadata, global_metadata)
         validator.validate!(response)
       end
 
       private
 
-      def global_metadata(swagger_doc)
-        swagger_docs = ::RSpec.configuration.swagger_docs
-        swagger_doc.nil? ? swagger_docs.values.first : swagger_docs[swagger_doc]
+      def rswag_config
+        ::Rswag::Specs.config
       end
     end
   end

data/lib/rswag/specs/request_factory.rb

@@ -11,7 +11,7 @@ module Rswag
       end
 
       def build_fullpath(example)
-        @api_metadata[:path].dup.tap do |t|
+        @api_metadata[:path_item][:template].dup.tap do |t|
           t.prepend(@global_metadata[:basePath] || '')
           parameters_in(:path).each { |p| t.gsub!("{#{p[:name]}}", example.send(p[:name]).to_s) }
           t.concat(build_query_string(example))
@@ -44,7 +44,13 @@ module Rswag
       private
 
       def parameters_in(location)
-        (@api_metadata[:operation][:parameters] || [])
+        path_item_params = @api_metadata[:path_item][:parameters] || []
+        operation_params = @api_metadata[:operation][:parameters] || []
+        applicable_params = operation_params
+          .concat(path_item_params)
+          .uniq { |p| p[:name] } # operation params should override path_item params
+
+        applicable_params
           .map { |p| p['$ref'] ? resolve_parameter(p['$ref']) : p } # resolve any references
           .concat(resolve_api_key_parameters)
           .select { |p| p[:in] == location }
@@ -59,9 +65,13 @@ module Rswag
 
       def resolve_api_key_parameters
         @api_key_params ||= begin
-          global_requirements = (@global_metadata[:security] || {})
-          requirements = global_requirements.merge(@api_metadata[:operation][:security] || {})
-          definitions = (@global_metadata[:securityDefinitions] || {}).slice(*requirements.keys)
+          # First figure out the security requirement applicable to the operation
+          global_requirements = (@global_metadata[:security] || [] ).map { |r| r.keys.first }
+          operation_requirements = (@api_metadata[:operation][:security] || [] ).map { |r| r.keys.first }
+          requirements = global_requirements | operation_requirements
+
+          # Then obtain the scheme definitions for those requirements
+          definitions = (@global_metadata[:securityDefinitions] || {}).slice(*requirements)
           definitions.values.select { |d| d[:type] == :apiKey }
         end
       end

data/lib/rswag/specs/swagger_formatter.rb

@@ -1,5 +1,4 @@
 require 'active_support/core_ext/hash/deep_merge'
-require 'rspec/core/formatters/base_text_formatter'
 require 'swagger_helper'
 
 module Rswag
@@ -11,12 +10,9 @@ module Rswag
         ::RSpec::Core::Formatters.register self, :example_group_finished, :stop
       end
 
-      def initialize(output)
+      def initialize(output, config = Rswag::Specs.config)
         @output = output
-        @swagger_root = ::RSpec.configuration.swagger_root
-        raise ConfigurationError, 'Missing swagger_root. See swagger_helper.rb' if @swagger_root.nil?
-        @swagger_docs = ::RSpec.configuration.swagger_docs || []
-        raise ConfigurationError, 'Missing swagger_docs. See swagger_helper.rb' if @swagger_docs.empty?
+        @config = config
 
         @output.puts 'Generating Swagger docs ...'
       end
@@ -30,13 +26,13 @@ module Rswag
         end
 
         return unless metadata.has_key?(:response)
-        swagger_doc = get_swagger_doc(metadata[:swagger_doc])
+        swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
         swagger_doc.deep_merge!(metadata_to_swagger(metadata))
       end
 
       def stop(notification=nil)
-        @swagger_docs.each do |url_path, doc|
-          file_path = File.join(@swagger_root, url_path)
+        @config.swagger_docs.each do |url_path, doc|
+          file_path = File.join(@config.swagger_root, url_path)
           dirname = File.dirname(file_path)
           FileUtils.mkdir_p dirname unless File.exists?(dirname)
 
@@ -50,30 +46,22 @@ module Rswag
 
       private
 
-      def get_swagger_doc(tag)
-        return @swagger_docs.values.first if tag.nil?
-        raise ConfigurationError, "Unknown swagger_doc '#{tag}'" unless @swagger_docs.has_key?(tag)
-        @swagger_docs[tag]
-      end
-
       def metadata_to_swagger(metadata)
         response_code = metadata[:response][:code]
         response = metadata[:response].reject { |k,v| k == :code }
+
         verb = metadata[:operation][:verb]
         operation = metadata[:operation]
           .reject { |k,v| k == :verb }
           .merge(responses: { response_code => response })
 
-        {
-          paths: {
-            metadata[:path] => {
-              verb => operation
-            }
-          }
-        }
+        path_template = metadata[:path_item][:template]
+        path_item = metadata[:path_item]
+          .reject { |k,v| k == :template }
+          .merge(verb => operation)
+
+        { paths: { path_template => path_item } }
       end
     end
-
-    class ConfigurationError < StandardError; end
   end
 end

data/lib/rswag/specs/version.rb

@@ -1,5 +1,5 @@
 module Rswag
   module Specs
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Richie Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,6 +78,7 @@ files:
 - lib/generators/rswag/specs/install/install_generator.rb
 - lib/generators/rswag/specs/install/templates/swagger_helper.rb
 - lib/rswag/specs.rb
+- lib/rswag/specs/configuration.rb
 - lib/rswag/specs/example_group_helpers.rb
 - lib/rswag/specs/example_helpers.rb
 - lib/rswag/specs/railtie.rb