doctor-swagger 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doctor-swagger.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+  
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Donald Plummer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Doctor::Swagger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doctor-swagger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doctor-swagger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/doctor-swagger.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+puts File.expand_path(File.join(File.basename(__FILE__), 'lib'))
+require 'doctor_swagger/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Donald Plummer", "Michael Xavier"]
+  gem.email         = ["developers@crystalcommerce.com"]
+  gem.description   = %q{DSL for generating swagger resource documentation}
+  gem.summary       = <<-EOS
+Provides a mixin which gives a high-level DSL for describing a swagger
+resource. Use this to generate a documentation endpoint to describe an API that
+you wish to document with swagger.
+  EOS
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "doctor-swagger"
+  gem.require_paths = ["lib"]
+  gem.version       = DoctorSwagger::VERSION
+
+  gem.add_dependency("rdiscount", "~>1.6.8")
+
+  gem.add_development_dependency("rake", "~>0.9.2")
+  gem.add_development_dependency("rspec", "~>2.10.0")
+  gem.add_development_dependency("guard", "~>1.2.1")
+  gem.add_development_dependency("guard-rspec", "~>1.1.0")
+end

data/lib/doctor-swagger.rb

@@ -0,0 +1 @@
+require "doctor_swagger"

data/lib/doctor_swagger.rb

@@ -0,0 +1,78 @@
+require 'doctor_swagger/endpoint'
+require 'doctor_swagger/swagger_doc'
+require 'doctor_swagger/error_response'
+require 'doctor_swagger/errors'
+require 'doctor_swagger/operation'
+require 'doctor_swagger/parameter'
+require 'doctor_swagger/query_parameter'
+require 'doctor_swagger/post_parameter'
+require 'doctor_swagger/path_parameter'
+require 'doctor_swagger/post_body'
+require 'doctor_swagger/root_swagger_doc'
+
+module DoctorSwagger
+  #global settings, override with DSL
+  def self.swagger_version
+    @swagger_version ||= '1.0'
+  end
+
+  def self.api_version
+    @api_version ||= lambda { raise 'Set your API version with DoctorSwagger.api_version= or at the resource level'}
+  end
+
+  def self.base_path
+    @base_path ||= lambda { raise 'Set your base URL with DoctorSwagger.base_path= or at the resource level'}
+  end
+
+  def self.swagger_version=(version)
+    @swagger_version = version
+  end
+
+  def self.api_version=(version)
+    @api_version = version
+  end
+
+  def self.base_path=(url)
+    @base_path = url
+  end
+
+  module ClassMethods
+    def swagger_version(version)
+      @swagger_version = version
+    end
+
+    def api_version(version)
+      @api_version = version
+    end
+
+    def base_path(url)
+      @base_path = url
+    end
+
+    def swagger_doc
+      @swagger_doc
+    end
+
+    def swagger_resource(resource_path, &block)
+      @swagger_doc = SwaggerDoc.new(resource_path,
+                                    :swagger_version => @swagger_version,
+                                    :api_version     => @api_version,
+                                    :base_path       => @base_path,
+                                    &block)
+    end
+
+    def swagger_root_resource(resource_path, &block)
+      @swagger_doc = RootSwaggerDoc.new(resource_path,
+                                        :swagger_version => @swagger_version,
+                                        :api_version     => @api_version,
+                                        :base_path       => @base_path,
+                                        &block)
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend(ClassMethods)
+  end
+end
+
+require "doctor_swagger/version"

data/lib/doctor_swagger/endpoint.rb

@@ -0,0 +1,32 @@
+module DoctorSwagger
+  class Endpoint
+    def initialize(path, &block)
+      @path = path
+      @operations = []
+      instance_eval(&block)
+    end
+
+    def operations_as_json
+      if @operations && !@operations.empty?
+        {'operations' => @operations.map(&:as_json)}
+      else
+        {}
+      end
+    end
+
+    def as_json(*)
+      {
+        'path' => @path,
+        'description' => @description,
+      }.merge(operations_as_json)
+    end
+
+    def description(desc)
+      @description = desc
+    end
+
+    def operation(nickname, &block)
+      @operations << Operation.new(nickname, &block)
+    end
+  end
+end

data/lib/doctor_swagger/error_response.rb

@@ -0,0 +1,15 @@
+module DoctorSwagger
+  class ErrorResponse
+    def initialize(http_status, error)
+      @error       = error
+      @http_status = http_status
+    end
+
+    def as_json(*)
+      {
+        'error'       => @error,
+        'http_status' => @http_status
+      }
+    end
+  end
+end

data/lib/doctor_swagger/errors.rb

@@ -0,0 +1,15 @@
+module DoctorSwagger
+  module Errors
+    def self.standard_errors
+      [resource_not_found, access_denied]
+    end
+
+    def self.resource_not_found
+      ErrorResponse.new(404, 'resource_not_found')
+    end
+
+    def self.access_denied
+      ErrorResponse.new(401, 'access_denied')
+    end
+  end
+end

data/lib/doctor_swagger/operation.rb

@@ -0,0 +1,100 @@
+require 'rdiscount'
+
+module DoctorSwagger
+  class Operation
+    def initialize(nickname, &block)
+      @nickname = nickname
+      @summary  = ''
+      @parameters = []
+      @error_responses = []
+      @embeds = []
+      @scopes = []
+      @type   = ""
+      @internal_type = ""
+      instance_eval(&block)
+      add_embedded_parameter unless @embeds.empty?
+    end
+
+    def query_parameter(param, &block)
+      @parameters << QueryParameter.new(param, &block)
+    end
+
+    def path_parameter(param, &block)
+      @parameters << PathParameter.new(param, &block)
+    end
+
+    def post_parameter(param, &block)
+      @parameters << PostParameter.new(param, &block)
+    end
+
+    def post_body(&block)
+      @parameters << PostBody.new(&block)
+    end
+
+    def method(meth)
+      @method = meth
+    end
+
+    def notes(notes)
+      @notes = process_markdown(notes)
+    end
+
+    def summary(summary)
+      @summary = summary
+    end
+
+    def standard_errors
+      @error_responses |= Errors.standard_errors
+    end
+
+    def error(http_status, error)
+      @error_responses << ErrorResponse.new(http_status, error)
+    end
+
+    def embeds(*embeds)
+      @embeds |= embeds
+    end
+
+    def scopes(*scopes)
+      @scopes |= scopes
+    end
+
+    def type(type)
+      @type = type
+    end
+
+    def internal_type(internal_type)
+      @internal_type = internal_type
+    end
+
+    def as_json(*)
+
+      {
+        'parameters'           => @parameters.map(&:as_json),
+        'httpMethod'           => @method.to_s.upcase,
+        'notes'                => @notes,
+        'embeds'               => @embeds.map(&:to_s),
+        'scopes'               => @scopes.map(&:to_s),
+        'errorResponses'       => @error_responses.map(&:as_json),
+        'summary'              => @summary,
+        'nickname'             => @nickname.to_s,
+        'responseClass'        => @type,
+        'responseTypeInternal' => @internal_type
+      }
+    end
+
+  private
+    def add_embedded_parameter
+      embeds = @embeds
+      query_parameter(:embedded) do
+        description "Optional records to embed, comma-separated"
+        allow_multiple! if embeds.length > 1
+        allowable_values(*embeds)
+      end
+    end
+
+    def process_markdown(text)
+      RDiscount.new(text).to_html
+    end
+  end
+end

data/lib/doctor_swagger/parameter.rb

@@ -0,0 +1,65 @@
+module DoctorSwagger
+  class Parameter
+    ALLOWED_TYPES = [:string, :integer, :long, :double, :boolean]
+    class InvalidType < StandardError
+      def initialize(bad_type)
+        @message = "The type of '#{bad_type}' is not valid. Choose from #{ALLOWED_TYPES.inspect}"
+      end
+    end
+
+    def initialize(name, &block)
+      @name = name
+      @description = ""
+      @required = false
+      @allow_multiple = false
+      @allowable_values = []
+      @data_type = :string
+      instance_eval(&block)
+    end
+
+    def description(description)
+      @description = description
+    end
+
+    def required!
+      @required = true
+    end
+
+    def allow_multiple!
+      @allow_multiple = true
+    end
+
+    def allowable_values(*values)
+      @allowable_values |= values
+    end
+
+    def type(type)
+      raise InvalidType.new(type) unless ALLOWED_TYPES.include?(type)
+      @data_type = type
+    end
+
+    def allowable_values_as_json
+      if @allowable_values && !@allowable_values.empty?
+        {
+          'allowableValues' => {
+            'valueType' => 'LIST',
+            'values' => @allowable_values.map(&:to_s)
+          }
+        }
+      else
+        {}
+      end
+    end
+
+    def as_json(*)
+      {
+        'name'            => @name.to_s,
+        'description'     => @description,
+        'dataType'        => @data_type.to_s,
+        'required'        => @required,
+        'allowMultiple'   => @allow_multiple,
+        'paramType'       => param_type
+      }.merge(allowable_values_as_json)
+    end
+  end
+end

data/lib/doctor_swagger/path_parameter.rb

@@ -0,0 +1,7 @@
+module DoctorSwagger
+  class PathParameter < Parameter
+    def param_type
+      'path'
+    end
+  end
+end

data/lib/doctor_swagger/post_body.rb

@@ -0,0 +1,19 @@
+module DoctorSwagger
+  class PostBody < PostParameter
+    def initialize(&block)
+      super(:body, &block)
+    end
+
+    def example(example)
+      @example = example
+    end
+
+    def as_json(*)
+      if @example && !@example.empty?
+        super.merge('example' => @example)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/doctor_swagger/post_parameter.rb

@@ -0,0 +1,7 @@
+module DoctorSwagger
+  class PostParameter < Parameter
+    def param_type
+      'post'
+    end
+  end
+end

data/lib/doctor_swagger/query_parameter.rb

@@ -0,0 +1,7 @@
+module DoctorSwagger
+  class QueryParameter < Parameter
+    def param_type
+      'query'
+    end
+  end
+end

data/lib/doctor_swagger/root_swagger_doc.rb

@@ -0,0 +1,16 @@
+#TODO: specme
+module DoctorSwagger
+  class RootSwaggerDoc < SwaggerDoc
+    def initialize(base_path_extension, options = {}, &block)
+      options[:swagger_version] ||= DoctorSwagger.swagger_version
+      options[:api_version]     ||= DoctorSwagger.api_version
+      options[:base_path]       ||= DoctorSwagger.base_path
+      @swagger_version = options[:swagger_version]
+      @api_version     = options[:api_version]
+      @base_path       = try_call(options[:base_path])
+      @base_path      += base_path_extension
+      @endpoints       = []
+      instance_eval(&block)
+    end
+  end
+end

data/lib/doctor_swagger/swagger_doc.rb

@@ -0,0 +1,37 @@
+module DoctorSwagger
+  class SwaggerDoc
+
+    def initialize(resource_path, options = {}, &block)
+      @resource_path   = resource_path
+      options[:swagger_version] ||= DoctorSwagger.swagger_version
+      options[:api_version]     ||= DoctorSwagger.api_version
+      options[:base_path]       ||= DoctorSwagger.base_path
+      @swagger_version = options[:swagger_version]
+      @api_version     = options[:api_version]
+      @base_path       = options[:base_path]
+      @endpoints       = []
+      instance_eval(&block)
+    end
+
+    def endpoint(path, &block)
+      @endpoints << Endpoint.new(path, &block)
+    end
+
+    #TODO: add DSL for 
+    def as_json(*)
+      {
+        'apiVersion'     => try_call(@api_version),
+        'swaggerVersion' => try_call(@swagger_version),
+        'basePath'       => try_call(@base_path),
+        'resourcePath'   => @resource_path,
+        'apis'           => @endpoints.map(&:as_json)
+      }
+    end
+
+  private
+
+    def try_call(value)
+      value.respond_to?(:call) ? value.call : value
+    end
+  end
+end

data/lib/doctor_swagger/version.rb

@@ -0,0 +1,3 @@
+module DoctorSwagger
+  VERSION = "0.1.0"
+end

data/spec/doctor_swagger_spec.rb

@@ -0,0 +1,297 @@
+require 'spec_helper'
+require 'doctor-swagger'
+
+describe DoctorSwagger do
+  module DoctorSwaggerTest
+    include DoctorSwagger
+
+    swagger_version 'some crazy version'
+    api_version '3.0'
+    base_path       'https://example.com/api'
+
+    swagger_resource '/products' do
+      endpoint '/products' do
+        description 'Products'
+
+        operation :index do
+          query_parameter :category_id do
+            description 'The category id of the products you want'
+            required!
+            type :integer
+          end
+
+          method :get
+          notes 'Returns lots of products'
+
+          type '[product]'
+          internal_type '[Product]'
+
+          standard_errors
+          error 418, "im_a_teapot"
+
+          embeds :category, :variants
+          scopes 'read-inventory', 'other-scope'
+          summary 'Find products by category id'
+        end
+      end
+
+      endpoint '/products/{product_id}' do
+        description 'Show product'
+
+        operation :show do
+          path_parameter :product_id do
+            description 'The product id of the product you want'
+            required!
+            type :integer
+          end
+
+          method :get
+          notes 'Returns a product'
+
+          type 'product'
+          internal_type 'Product'
+
+          standard_errors
+          embeds :category, :variants
+          scopes 'read-inventory', 'other-scope'
+          summary 'Find product by product id'
+        end
+
+        operation :update do
+          path_parameter :product_id do
+            description 'The product id of the product you want'
+            required!
+            type :integer
+          end
+
+          post_body do
+            description 'The JSON representation of the product'
+            required!
+
+            example 'product' => {
+              'foo' => 'bar',
+              'wat' => nil
+            }
+          end
+
+          method :put
+          notes <<-EOS
+# Updates a *product*
+EOS
+
+          type 'product'
+          internal_type 'Product'
+
+          standard_errors
+          scopes 'read-inventory', 'other-scope'
+          summary 'Update product by product id'
+        end
+      end
+    end
+  end
+
+  subject { DoctorSwaggerTest.swagger_doc }
+
+  before(:each) do
+    @actual = DoctorSwaggerTest.swagger_doc
+  end
+
+  its(:as_json) do
+    should == {
+      'apiVersion' => '3.0',
+      'swaggerVersion' => 'some crazy version',
+      'basePath' => "https://example.com/api",
+      'resourcePath' => '/products',
+      'apis' => [
+        {
+          'path' => '/products',
+          'description' => 'Products',
+          'operations' => [
+            {
+              'parameters' => [
+                {
+                  'name' => 'category_id',
+                  'description' => 'The category id of the products you want',
+                  'dataType' => 'integer',
+                  'required' => true,
+                  'allowMultiple' => false,
+                  'paramType' => 'query'
+                },
+                {
+                  'name' => 'embedded',
+                  'description' => 'Optional records to embed, comma-separated',
+                  'dataType' => 'string',
+                  'required' => false,
+                  'allowMultiple' => true,
+                  'paramType' => 'query',
+                  'allowableValues' => {
+                    'values' => %w[category variants],
+                    'valueType' => 'LIST'
+                  }
+                }
+              ],
+              'httpMethod' => 'GET',
+              'notes' => "<p>Returns lots of products</p>\n",
+              'embeds' => %w[category variants],
+              'scopes' => %w[read-inventory other-scope],
+              'responseTypeInternal' => '[Product]',
+              'responseClass' => '[product]',
+              'errorResponses' => [
+                {
+                  'error' => 'resource_not_found',
+                  'http_status' => 404
+                },
+                {
+                  'error' => 'access_denied',
+                  'http_status' => 401
+                },
+                {
+                  'error' => 'im_a_teapot',
+                  'http_status' => 418
+                }
+              ],
+              'summary' => 'Find products by category id',
+              'nickname' => 'index'
+
+            }
+          ]
+        },
+        {
+          'path' => '/products/{product_id}',
+          'description' => 'Show product',
+          'operations' => [
+            {
+              'parameters' => [
+                {
+                  'name' => 'product_id',
+                  'description' => 'The product id of the product you want',
+                  'dataType' => 'integer',
+                  'required' => true,
+                  'allowMultiple' => false,
+                  'paramType' => 'path'
+                },
+                {
+                  'name' => 'embedded',
+                  'description' => 'Optional records to embed, comma-separated',
+                  'dataType' => 'string',
+                  'required' => false,
+                  'allowMultiple' => true,
+                  'paramType' => 'query',
+                  'allowableValues' => {
+                    'values' => %w[category variants],
+                    'valueType' => 'LIST'
+                  }
+                }
+
+              ],
+              'httpMethod' => 'GET',
+              'notes' => "<p>Returns a product</p>\n",
+              'embeds' => %w[category variants],
+              'scopes' => %w[read-inventory other-scope],
+              'responseTypeInternal' => 'Product',
+              'responseClass' => 'product',
+              'errorResponses' => [
+                {
+                  'error' => 'resource_not_found',
+                  'http_status' => 404
+                },
+                {
+                  'error' => 'access_denied',
+                  'http_status' => 401
+                }
+              ],
+              'summary' => 'Find product by product id',
+              'nickname' => 'show',
+              'scopes' => %w[read-inventory other-scope]
+
+            },
+            {
+              'parameters' => [
+                {
+                  'name' => 'product_id',
+                  'description' => 'The product id of the product you want',
+                  'dataType' => 'integer',
+                  'required' => true,
+                  'allowMultiple' => false,
+                  'paramType' => 'path'
+                },
+                {
+                  'name' => 'body',
+                  'description' => 'The JSON representation of the product',
+                  'dataType' => 'string',
+                  'required' => true,
+                  'allowMultiple' => false,
+                  'paramType' => 'post',
+                  'example'   => {
+                    'product' => {
+                      'foo' => 'bar',
+                      'wat' => nil
+                    }
+                  }
+                },
+              ],
+              'httpMethod' => 'PUT',
+              'notes' => "<h1>Updates a <em>product</em></h1>\n",
+              'embeds' => %w[],
+              'scopes' => %w[read-inventory other-scope],
+              'responseTypeInternal' => 'Product',
+              'responseClass' => 'product',
+              'errorResponses' => [
+                {
+                  'error' => 'resource_not_found',
+                  'http_status' => 404
+                },
+                {
+                  'error' => 'access_denied',
+                  'http_status' => 401
+                }
+              ],
+              'summary' => 'Update product by product id',
+              'nickname' => 'update',
+              'scopes' => %w[read-inventory other-scope]
+
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  context "dynamic version/path config" do
+    class DynamicSwaggerResource
+      include DoctorSwagger
+
+
+      def self.prefix=(prefix)
+        @prefix = prefix
+      end
+
+      def self.format(str)
+        "#{@prefix}#{str}"
+      end
+
+      swagger_version lambda { DynamicSwaggerResource.format('some crazy version') }
+      api_version     lambda { DynamicSwaggerResource.format('3.0') }
+      base_path       lambda { DynamicSwaggerResource.format('https://example.com/api') }
+
+      swagger_resource '/products' do
+      end
+    end
+
+    subject { DynamicSwaggerResource.swagger_doc }
+
+    before(:each) do
+      DynamicSwaggerResource.prefix = '!!!'
+    end
+
+    its(:as_json) do
+      should == {
+        'apiVersion' => '!!!3.0',
+        'swaggerVersion' => '!!!some crazy version',
+        'basePath' => "!!!https://example.com/api",
+        'resourcePath' => '/products',
+        'apis' => []
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$: << File.join(File.basename(__FILE__), '..', 'lib')
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: doctor-swagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Donald Plummer
+- Michael Xavier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: DSL for generating swagger resource documentation
+email:
+- developers@crystalcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- doctor-swagger.gemspec
+- lib/doctor-swagger.rb
+- lib/doctor_swagger.rb
+- lib/doctor_swagger/endpoint.rb
+- lib/doctor_swagger/error_response.rb
+- lib/doctor_swagger/errors.rb
+- lib/doctor_swagger/operation.rb
+- lib/doctor_swagger/parameter.rb
+- lib/doctor_swagger/path_parameter.rb
+- lib/doctor_swagger/post_body.rb
+- lib/doctor_swagger/post_parameter.rb
+- lib/doctor_swagger/query_parameter.rb
+- lib/doctor_swagger/root_swagger_doc.rb
+- lib/doctor_swagger/swagger_doc.rb
+- lib/doctor_swagger/version.rb
+- spec/doctor_swagger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a mixin which gives a high-level DSL for describing a swagger resource.
+  Use this to generate a documentation endpoint to describe an API that you wish to
+  document with swagger.
+test_files:
+- spec/doctor_swagger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: