doctor-swagger 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+  - ree

data/README.md

@@ -1,6 +1,7 @@
-# Doctor::Swagger
+# DoctorSwagger
+[![Build Status](https://secure.travis-ci.org/crystalcommerce/doctor-swagger.png)](http://travis-ci.org/crystalcommerce/doctor-swagger)
 
-TODO: Write a gem description
+A DSL for generating Swagger schemas.
 
 ## Installation
 
@@ -18,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See the spec file.
 
 ## Contributing
 
@@ -27,3 +28,8 @@ TODO: Write usage instructions here
 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
+
+## License
+
+DoctorSwagger is released under the [MIT
+License](http://opensource.org/licenses/MIT).

data/doctor-swagger.gemspec

@@ -1,6 +1,5 @@
 # -*- 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|
@@ -21,7 +20,7 @@ you wish to document with swagger.
   gem.require_paths = ["lib"]
   gem.version       = DoctorSwagger::VERSION
 
-  gem.add_dependency("rdiscount", "~>1.6.8")
+  gem.add_dependency("kramdown", "~>0.14.0")
 
   gem.add_development_dependency("rake", "~>0.9.2")
   gem.add_development_dependency("rspec", "~>2.10.0")

data/lib/doctor_swagger.rb

@@ -7,6 +7,7 @@ require 'doctor_swagger/parameter'
 require 'doctor_swagger/query_parameter'
 require 'doctor_swagger/post_parameter'
 require 'doctor_swagger/path_parameter'
+require 'doctor_swagger/header_parameter'
 require 'doctor_swagger/post_body'
 require 'doctor_swagger/root_swagger_doc'
 

data/lib/doctor_swagger/header_parameter.rb

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

data/lib/doctor_swagger/operation.rb

@@ -1,4 +1,4 @@
-require 'rdiscount'
+require 'kramdown'
 
 module DoctorSwagger
   class Operation
@@ -27,6 +27,10 @@ module DoctorSwagger
       @parameters << PostParameter.new(param, &block)
     end
 
+    def header_parameter(param, &block)
+      @parameters << HeaderParameter.new(param, &block)
+    end
+
     def post_body(&block)
       @parameters << PostBody.new(&block)
     end
@@ -94,7 +98,8 @@ module DoctorSwagger
     end
 
     def process_markdown(text)
-      RDiscount.new(text).to_html
+      Kramdown::Document.new(text, :input => :markdown,
+                                   :auto_ids => false).to_html
     end
   end
 end

data/lib/doctor_swagger/version.rb

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

data/spec/doctor_swagger_spec.rb

@@ -14,6 +14,12 @@ describe DoctorSwagger do
         description 'Products'
 
         operation :index do
+          header_parameter :api_key do
+            description 'The api key issued to your app'
+            required!
+            type :string
+          end
+
           query_parameter :category_id do
             description 'The category id of the products you want'
             required!
@@ -109,6 +115,14 @@ EOS
           'operations' => [
             {
               'parameters' => [
+                {
+                  'name' => 'api_key',
+                  'description' => 'The api key issued to your app',
+                  'dataType' => 'string',
+                  'required' => true,
+                  'allowMultiple' => false,
+                  'paramType' => 'header'
+                },
                 {
                   'name' => 'category_id',
                   'description' => 'The category id of the products you want',

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: doctor-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
   prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Donald Plummer
@@ -10,83 +10,83 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdiscount
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  type: :runtime
+  name: kramdown
+  version_requirements: !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
+        version: 0.14.0
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !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
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !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
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.10.0
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
   name: guard
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !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
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
   name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !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
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -102,6 +102,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -113,6 +114,7 @@ files:
 - lib/doctor_swagger/endpoint.rb
 - lib/doctor_swagger/error_response.rb
 - lib/doctor_swagger/errors.rb
+- lib/doctor_swagger/header_parameter.rb
 - lib/doctor_swagger/operation.rb
 - lib/doctor_swagger/parameter.rb
 - lib/doctor_swagger/path_parameter.rb
@@ -144,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Provides a mixin which gives a high-level DSL for describing a swagger resource.