rspec-rails-swagger 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca8afd22d7d94c39871ce1136dfcc65f726df7fa
-  data.tar.gz: 8f42d67783da7d18d2bb6bd93ed4e86d19a6d636
+  metadata.gz: 30e7c45fb94e4b7f988d7d989276764e32963b33
+  data.tar.gz: 4b4f4491f8de4ce2bf4a531f004fc37122c318a7
 SHA512:
-  metadata.gz: eddec5fcd5449d1cd397cf6684e89f47769fafde43d66d455ca7f46e03ac51306a2b648fe3465c97583957818244a55ee77802d3b2285fa3aeb4c6fa9b847f9e
-  data.tar.gz: 483a7470fa969fe6dfcfc48f08231309b63e46eb6b1da5e075b236d95e14841349527b94fe3df38ac8af14c1fa94c35984861f0a6681c0438dd24e7403441317
+  metadata.gz: 2c8267bd639942994777a10f7988f29fd2ffd291e52721998791f2c8567151addc095929907dae159abb57d30950304819036f674a4dc46a8d920e473bac8d78
+  data.tar.gz: 8f27c383b3d0b131986f3c5a2224b67cd479270433a52c3c96c56efc2ab77ebea9a67c8f14a73abdce3c768b6acd76cc38697e44fb28957b1c3e26b07d8bf9c8

data/README.md

@@ -4,9 +4,9 @@
 [![Code Climate](https://codeclimate.com/github/drewish/rspec-rails-swagger/badges/gpa.svg)](https://codeclimate.com/github/drewish/rspec-rails-swagger)
 
 This gem helps you generate Swagger docs by using RSpec to document the paths.
-You execute a command to run the tests and generate the `.json` output. Running
-the tests ensures that your API and docs are in agreement, and generates output
-that can be used as examples.
+You execute a command to run the tests and generate the `.yaml` or `.json` output.
+Running the tests ensures that your API and docs are in agreement, and generates
+output that can be saved as response examples.
 
 The design of this was heavily influenced by the awesome [swagger_rails gem](https://github.com/domaindrivendev/swagger_rails).
 
@@ -52,9 +52,9 @@ and some default requests filled in. With the structure in place you should only
 need to add `before` calls to create records and then update the `let`s to
 return the appropriate values.
 
-## Generate the JSON
+## Generate the JSON or YAML
 
-To create the Swagger JSON files use the rake task:
+To create the Swagger files use the rake task:
 
 ```
 bundle exec rake swagger

data/lib/rspec/rails/swagger.rb

@@ -3,6 +3,7 @@ require 'rspec/rails/swagger/configuration'
 require 'rspec/rails/swagger/document'
 require 'rspec/rails/swagger/formatter'
 require 'rspec/rails/swagger/helpers'
+require 'rspec/rails/swagger/response_formatters'
 require 'rspec/rails/swagger/request_builder'
 require 'rspec/rails/swagger/route_parser'
 require 'rspec/rails/swagger/version'

data/lib/rspec/rails/swagger/formatter.rb

@@ -17,19 +17,19 @@ module RSpec
         end
 
         def example_group_started(notification)
-          output.print *group_output(notification)
+          output.print(*group_output(notification))
         end
 
         def example_passed(notification)
-          output.print RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :success)
+          output.print(RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :success))
         end
 
         def example_pending(notification)
-          output.print RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :pending)
+          output.print(RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :pending))
         end
 
         def example_failed(notification)
-          output.print RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :failure)
+          output.print(RSpec::Core::Formatters::ConsoleCodes.wrap(example_output(notification), :failure))
         end
 
         def example_finished(notification)
@@ -44,7 +44,7 @@ module RSpec
         end
 
         def close(_notification)
-          documents.each{|k, v| write_json(k, v)}
+          documents.each{|k, v| write_file(k, v)}
 
           self
         end
@@ -70,13 +70,33 @@ module RSpec
           " #{notification.example.metadata[:swagger_response][:status_code]}"
         end
 
-        def write_json(name, document)
-          root = ::RSpec.configuration.swagger_root
+        def write_file(name, document)
+          output =
+            if %w(.yaml .yml).include? File.extname(name)
+              YAML.dump(deep_stringify_keys(document))
+            else
+              JSON.pretty_generate(document) + "\n"
+            end
+
           # It would be good to at least warn if the name includes some '../' that
           # takes it out of root directory.
-          target = Pathname(name).expand_path(root)
+          target = Pathname(name).expand_path(::RSpec.configuration.swagger_root)
           target.dirname.mkpath
-          target.write(JSON.pretty_generate(document))
+          target.write(output)
+        end
+
+        # Lifted from ActiveSupport's Hash _deep_transform_keys_in_object
+        def deep_stringify_keys(object)
+          case object
+          when Hash
+            object.each_with_object({}) do |(key, value), result|
+              result[key.to_s] = deep_stringify_keys(value)
+            end
+          when Array
+            object.map { |e| deep_stringify_keys(e) }
+          else
+            object
+          end
         end
 
         def document_for(doc_name = nil)
@@ -130,12 +150,10 @@ module RSpec
         end
 
         def prepare_examples(examples)
-          if examples['application/json'].kind_of? String
-            begin
-              examples['application/json'] = JSON.parse(examples['application/json'])
-            rescue JSON::ParserError
-            end
+          examples.each_pair do |format, resp|
+            examples[format] = ResponseFormatters[format].call(resp)
           end
+
           examples
         end
       end

data/lib/rspec/rails/swagger/request_builder.rb

@@ -99,7 +99,8 @@ module RSpec
         def body
           # And here all we need is the first half of the key to find the body
           # parameter and its name to fetch a value.
-          if key = parameters(:body).keys.first
+          key = parameters(:body).keys.first
+          if key
             instance.send(key.split('&').last).to_json
           end
         end

data/lib/rspec/rails/swagger/response_formatters.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Rails
+    module Swagger
+      class ResponseFormatters
+
+        class JSON
+          def call(resp)
+            if resp.kind_of? String
+              ::JSON.parse(resp)
+            else
+              resp
+            end
+          rescue ::JSON::ParserError
+            resp
+          end
+        end
+
+        @formatters = {
+          :default => ->(resp) { resp },
+          'application/json' => JSON.new
+        }
+
+        class << self
+
+          def register(format, callable)
+            @formatters[format] = callable
+          end
+
+          def [](key)
+            @formatters[key] || @formatters[:default]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/rspec/rails/swagger/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Swagger.
     module Swagger
       module Version
-        STRING = '0.1.4'
+        STRING = '0.1.5'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - andrew morton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,7 @@ files:
 - lib/rspec/rails/swagger/formatter.rb
 - lib/rspec/rails/swagger/helpers.rb
 - lib/rspec/rails/swagger/request_builder.rb
+- lib/rspec/rails/swagger/response_formatters.rb
 - lib/rspec/rails/swagger/route_parser.rb
 - lib/rspec/rails/swagger/tasks/swagger.rake
 - lib/rspec/rails/swagger/version.rb
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Generate Swagger docs from RSpec integration tests