swagger_rails 1.0.0.pre.beta → 1.0.0.pre.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbbe5654c93a933a0238d3727ea570c95578efc4
-  data.tar.gz: 400ddf26eb5d0eef9daed9341652c49307942f86
+  metadata.gz: 92af79c8cb42efd72ea5b79b5b8f0979d9bc0bfa
+  data.tar.gz: 04b02dc891f0bc7843d8b02c442fcff10e0bb8f9
 SHA512:
-  metadata.gz: 813fe6d095a303656cf97fe4804e5644482e8a106979dbf469c6fa7975e751e82568be60f0fa9a63279e5eaa000ca043b0e04708fe60450d70887c5eabd76931
-  data.tar.gz: 5d5d1f837cbabf9227a5926f76eba01e3976a243eb2dfcb23eec62b9ad249f7554ed993bdc78ab019a3bddd4b4f61043b0ec7c2aa8cfd166ae5179440568097b
+  metadata.gz: ab65f619c9007bcb3d6e6b45c1c205f3fa8f47f1a60a0a4d82fdb9059f720591bf54b830afab08c57ff1434bfeb2d9e11aab47d4c0f2a7eec9b3636d3f7b4093
+  data.tar.gz: ca6014484ff29a056c1c2f009580843e5a665872e33094c549bdfa02fd53d6701e4f7c2a124678210b552ab447964a9f58848a5409a57314e26bc7ca083e13eb

data/app/controllers/swagger_rails/swagger_ui_controller.rb

@@ -3,7 +3,7 @@ module SwaggerRails
 
     def index
       @discovery_paths = Hash[
-        SwaggerRails.swagger_docs.map do |path, doc|
+        SwaggerRails.config.swagger_docs.map do |path, doc|
           [ "#{root_path}#{path}", doc[:info][:title] ]
         end
       ]

data/lib/generators/swagger_rails/install/install_generator.rb

@@ -6,7 +6,7 @@ module SwaggerRails
     source_root File.expand_path('../templates', __FILE__)
 
     def add_swagger_dir
-      empty_directory('config/swagger/v1')
+      empty_directory('swagger/v1')
     end
 
     def add_initializer

data/lib/generators/swagger_rails/install/templates/swagger_rails.rb

@@ -1,13 +1,16 @@
 SwaggerRails.configure do |c|
 
-  # Define your swagger documents and provide global metadata
-  # Describe actual operations in your spec/test files
-  c.swagger_doc 'v1/swagger.json' do
+  # Define your swagger documents and provide any global metadata here
+  # (Individual operations are generated from your spec/test files)
+  c.swagger_doc 'v1/swagger.json',
     {
+      swagger: '2.0',
       info: {
         title: 'API V1',
         version: 'v1'
       }
     }
-  end
+
+  # Specify a location to output generated swagger files
+  c.swagger_dir File.expand_path('../../../swagger', __FILE__)
 end

data/lib/swagger_rails.rb

@@ -2,23 +2,32 @@ require "swagger_rails/engine"
 
 module SwaggerRails
 
-  def self.configure
-    yield self
+  class Configuration
+    attr_reader :swagger_docs, :swagger_dir_string
+
+    def initialize
+      @swagger_docs = {}
+      @swagger_dir_string = nil
+    end
+
+    def swagger_doc(path, doc)
+      @swagger_docs[path] = doc
+    end
+
+    def swagger_dir(dir_string)
+      @swagger_dir_string = dir_string
+    end
   end
 
   class << self
-    @@swagger_docs = {}
+    attr_reader :config
 
-    def swagger_doc(path, &block)
-      @@swagger_docs[path] = block
+    def configure
+      yield config
     end
 
-    def swagger_docs
-      Hash[
-        @@swagger_docs.map do |path, factory|
-          [ path, factory.call.merge(swagger: '2.0') ]
-        end
-      ]
+    def config
+      @config ||= Configuration.new
     end
   end
 end

data/lib/swagger_rails/engine.rb

@@ -6,7 +6,7 @@ module SwaggerRails
     isolate_namespace SwaggerRails
 
     initializer 'swagger_rails.initialize' do |app|
-      middleware.use SwaggerDocs, File.join(app.root, 'config', 'swagger')
+      middleware.use SwaggerDocs, SwaggerRails.config.swagger_dir_string
       middleware.use SwaggerUi, "#{root}/bower_components/swagger-ui/dist"
     end
   end

data/lib/swagger_rails/rspec/dsl.rb

@@ -49,12 +49,20 @@ module SwaggerRails
       end
 
       def run_test!
+        if metadata.has_key?(:swagger_doc)
+          swagger_doc = SwaggerRails.config.swagger_docs[metadata[:swagger_doc]]
+        else
+          swagger_doc = SwaggerRails.config.swagger_docs.values.first
+        end
+
+        test_visitor = SwaggerRails::TestVisitor.new(swagger_doc)
+
         before do |example|
-          SwaggerRails::TestVisitor.instance.submit_request!(self, example.metadata)
+          test_visitor.submit_request!(self, example.metadata)
         end
 
         it "returns a #{metadata[:response_code]} status" do |example|
-          SwaggerRails::TestVisitor.instance.assert_response!(self, example.metadata)
+          test_visitor.assert_response!(self, example.metadata)
         end
       end
     end

data/lib/swagger_rails/rspec/formatter.rb

@@ -9,9 +9,10 @@ module SwaggerRails
         :example_group_finished,
         :stop
 
-      def initialize(output)
+      def initialize(output, config=SwaggerRails.config)
         @output = output
-        @swagger_docs = SwaggerRails.swagger_docs
+        @swagger_docs = config.swagger_docs
+        @swagger_dir_string = config.swagger_dir_string
 
         @output.puts 'Generating Swagger Docs ...'
       end
@@ -20,14 +21,14 @@ module SwaggerRails
         metadata = notification.group.metadata
         return unless metadata.has_key?(:response_code)
 
+        swagger_doc = @swagger_docs[metadata[:swagger_doc]] || @swagger_docs.values.first
         swagger_data = swagger_data_from(metadata)
-        swagger_doc = @swagger_docs[metadata[:docs_path]] || @swagger_docs.values.first
         swagger_doc.deep_merge!(swagger_data)
       end
 
       def stop(notification)
         @swagger_docs.each do |path, doc|
-          file_path = File.join(Rails.root, 'config/swagger', path)
+          file_path = File.join(@swagger_dir_string, path)
 
           File.open(file_path, 'w') do |file|
             file.write(JSON.pretty_generate(doc))
@@ -50,11 +51,19 @@ module SwaggerRails
       end
 
       def operation_from(metadata)
-        metadata.slice(:summary, :consumes, :produces, :parameters).tap do |operation|
-          operation[:responses] = {
-            metadata[:response_code] => metadata[:response]
-          }
-        end
+        {
+          tags: [ find_root_of(metadata)[:description] ] ,
+          summary: metadata[:summary],
+          consumes: metadata[:consumes],
+          produces: metadata[:produces],
+          parameters: metadata[:parameters],
+          responses: { metadata[:response_code] => metadata[:response] }
+        }
+      end
+
+      def find_root_of(metadata)
+        parent = metadata[:parent_example_group]
+        parent.nil? ? metadata : find_root_of(parent)
       end
     end
   end

data/lib/swagger_rails/test_visitor.rb

@@ -1,8 +1,9 @@
-require 'singleton'
-
 module SwaggerRails
   class TestVisitor
-    include Singleton
+
+    def initialize(swagger_doc)
+      @swagger_doc = swagger_doc
+    end
 
     def submit_request!(test, metadata)
       params_data = params_data_for(test, metadata[:parameters])
@@ -35,6 +36,7 @@ module SwaggerRails
         path_params_data.each do |param_data|
           path.sub!("\{#{param_data[:name]}\}", param_data[:value].to_s)
         end
+        path.prepend(@swagger_doc[:basePath] || '')
       end
     end
 

data/lib/swagger_rails/version.rb

@@ -1,3 +1,3 @@
 module SwaggerRails
-  VERSION = "1.0.0-beta"
+  VERSION = "1.0.0-beta2"
 end

data/lib/tasks/swagger_rails_tasks.rake

@@ -4,9 +4,10 @@
 # end
 
 require 'rspec/core/rake_task'
+require 'swagger_rails'
 
 desc 'Generate Swagger JSON files from integration specs'
 RSpec::Core::RakeTask.new('swaggerize') do |t|
-  t.pattern = 'spec/integration/**/*_spec.rb'
+  t.pattern = 'spec/requests/**/*_spec.rb, spec/api/**/*_spec.rb, spec/integration/**/*_spec.rb'
   t.rspec_opts = [ '--format SwaggerRails::RSpec::Formatter', '--dry-run' ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta
+  version: 1.0.0.pre.beta2
 platform: ruby
 authors:
 - domaindrivendev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,12 +44,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Use the provided DSL to accurately test and describe API operations in
-  your spec files. Then, you can easily generate corresponding swagger.json files
-  and serve them up with an embedded version of swagger-ui. This means you can complement
-  your API with a slick discovery UI to assist consumers with their integration efforts.
-  Best of all, it requires minimal coding and maintenance, allowing you to focus on
-  building an awesome API!
+description: Use the provided DSL to describe and test API operations in your spec
+  files. Then, you can easily generate corresponding swagger.json files and serve
+  them up with an embedded version of swagger-ui. Best of all, it requires minimal
+  coding and maintenance, allowing you to focus on building an awesome API!
 email:
 - domaindrivendev@gmail.com
 executables: []
@@ -112,7 +110,6 @@ files:
 - lib/generators/swagger_rails/custom_ui/files/index.html.erb
 - lib/generators/swagger_rails/install/USAGE
 - lib/generators/swagger_rails/install/install_generator.rb
-- lib/generators/swagger_rails/install/templates/swagger.json
 - lib/generators/swagger_rails/install/templates/swagger_rails.rb
 - lib/swagger_rails.rb
 - lib/swagger_rails/engine.rb
@@ -146,7 +143,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Leverage your api/integration test specs to generate swagger descriptions
-  for Rails-based API's
+summary: Generate API documentation, including a slick discovery/playground UI, directly
+  from your rspec integration specs
 test_files: []
 has_rdoc: 

data/lib/generators/swagger_rails/install/templates/swagger.json

@@ -1,45 +0,0 @@
-{
-    "swagger": "2.0",
-    "info": {
-        "version": "0.0.0",
-        "title": "[Enter a description for your API here]",
-        "description": "The docs below are powered by the default swagger.json that gets installed with swagger_rails. You'll need to update it to describe your API. See here for the complete swagger spec - https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md"
-    },
-    "paths": {
-        "/a/sample/resource": {
-            "post": {
-                "tags": [
-                  "a/sample/resource"
-                ],
-                "description": "Create a new sample resource",
-                "parameters": [
-                    {
-                        "name": "body",
-                        "in": "body",
-                        "schema": {
-                            "$ref": "#/definitions/CreateSampleResource"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Ok"
-                    }
-                }
-            }
-        }
-    },
-    "definitions": {
-        "CreateSampleResource": {
-            "properties": {
-                "name": {
-                    "type": "string"
-                },
-                "date_time": {
-                    "type": "string",
-                    "format": "date-time"
-                }
-            }
-        }
-    }
-}