swagger-ui 0.0.1

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'actionpack'
+
+group :development do
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.6)
+    multi_json (1.5.0)
+    rack (1.4.4)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  jeweler

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Justin Dell
+
+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,54 @@
+# Swagger
+
+Rails wrapper for the [Swagger-UI](https://github.com/wordnik/swagger-ui, 'Swagger') API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swagger-ui', :require => 'swagger'
+
+And then execute:
+
+    $ bundle
+
+Then run the generator:
+
+    $ rails generate swagger:install
+
+## Usage
+
+Check out index.html.haml in the examples for basic setup. A docs controller and routes will also be required. Fill out the api in the docs controller. Example:
+
+    class Api::DocsController < Api::ApiController
+      include Swagger
+
+      def index
+        document = {
+          "swaggerVersion" => "1.1",
+          "basePath" => api_docs_url,
+          "apis" => [
+            {"path" => "/foo",
+             "description" => ""}]
+        }
+        render :json => document
+      end
+
+      def foo
+        document(api_url, :resourcePath => 'foos') do |doc|
+          doc.api('/foos') do |api|
+            api.operations(['GET','POST']) do |op|
+              op.param('param', :required => true)
+            end
+          end
+        end
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "swagger-ui"
+  gem.homepage = "http://github.com/justindell/swagger"
+  gem.license = "MIT"
+  gem.summary = %Q{Swagger UI}
+  gem.description = %Q{Swagger UI wrapper}
+  gem.email = "dell.justin@gmail.com"
+  gem.authors = ["Justin Dell", "Brian Tatnall"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/index.html.haml

@@ -0,0 +1,35 @@
+%html
+  %head
+    %link{ :href => '/stylesheets/swagger.css', :media => 'screen', :rel => 'stylesheet', :type => 'text/css' }
+    %script{ :src => '/javascripts/swagger.js', :type => 'text/javascript'}
+
+  %body 
+    %div#message-bar.swagger-ui-wrap
+    %div#swagger-ui-container.swagger-ui-wrap
+
+    %script
+      ! $(function () {
+      !     window.swaggerUi = new SwaggerUi({
+      !         discoveryUrl:"http://localhost:3000/api/docs",
+      !         apiKey:"",
+      !         dom_id:"swagger-ui-container",
+      !         supportHeaderParams: false,
+      !         supportedSubmitMethods: ['get', 'post'],
+      !         onComplete: function(swaggerApi, swaggerUi){
+      !         	if(console) {
+      !                 console.log("Loaded SwaggerUI")
+      !                 console.log(swaggerApi);
+      !                 console.log(swaggerUi);
+      !             }
+      !           $('pre code').each(function(i, e) {hljs.highlightBlock(e)});
+      !         },
+      !         onFailure: function(data) {
+      !         	if(console) {
+      !                 console.log("Unable to Load SwaggerUI");
+      !                 console.log(data);
+      !             }
+      !         },
+      !         docExpansion: "none"
+      !     });
+      !     window.swaggerUi.load();
+      ! });

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

@@ -0,0 +1,10 @@
+module Swagger
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../../', __FILE__)
+
+    def copy_files
+      template 'public/stylesheets/swagger.css', 'public/stylesheets/swagger.css'
+      template 'public/javascripts/swagger.js',  'public/javascripts/swagger.js'
+    end
+  end
+end

data/lib/swagger/api.rb

@@ -0,0 +1,24 @@
+module Swagger
+  class Api
+    def initialize path, opts
+      defaults = { 
+        :path => path,
+        :operations => []}
+      @values = defaults.merge opts
+    end
+
+    def path
+      @values[:path]
+    end
+
+    def operations http_methods, opts = {}
+      operations = http_methods.map { |m| Operation.new self, m, opts }
+      operations.each { |o| yield(o) }
+      @values[:operations].concat operations
+    end
+
+    def as_json options
+      @values.as_json options
+    end
+  end
+end

data/lib/swagger/document.rb

@@ -0,0 +1,23 @@
+module Swagger
+  class Document
+    def initialize base_path, opts = {}
+      defaults = {
+        :swaggerVersion => "1.1",
+        :basePath => base_path,
+        :apis => [],
+      }
+      @values = defaults.merge opts
+    end
+
+    def api path, opts = {}
+      a = Api.new(path, opts)
+      yield(a)
+      @values[:apis] << a
+      a
+    end
+
+    def as_json options
+      @values.as_json options
+    end
+  end
+end

data/lib/swagger/operation.rb

@@ -0,0 +1,61 @@
+module Swagger
+  class Operation
+    include ActionView::Helpers::TextHelper
+    HTTP_METHODS = ["GET","POST","PUT","DELETE"]
+    ALLOWABLE_VALUES_VALUE_TYPES = ["LIST", "RANGE"]
+    CONTAINERS = ['List', 'Set', 'Array']
+    PRIMITIVES = ['byte', 'boolean', 'int', 'long', 'float', 'double', 'string', 'Date']
+    PARAM_TYPES = {
+      'body' => {:types => ['complex', 'container'], 
+                 :allowMultipleAllowed => false},
+      'path' => {:types => PRIMITIVES, 
+                 :allowMultipleAllowed => false},
+      'query' => {:types => PRIMITIVES, 
+                  :allowMultipleAllowed => true},
+      'header' => {:types => PRIMITIVES, 
+                   :allowMultipleAllowed => false}
+    } 
+
+    def initialize api, http_method, opts = {}
+      bomb("#{http_method} not valid. httpMethod must be one of: #{HTTP_METHODS}") unless HTTP_METHODS.include?(http_method)
+      defaults = {
+        :nickname => api.path.split('/').last,
+        :httpMethod => http_method,
+        :parameters => [],
+        :summary => ""
+      }
+      values = defaults.merge opts
+      values[:notes] = simple_format(values[:notes]) if values[:notes]
+      @values = values
+    end
+
+    def param name, opts = {}
+      defaults = {
+        :name => name,
+        :description => name,
+        :required => false,
+        :allowMultiple => false,
+        :dataType => "string",
+        :paramType =>  "query"
+      }
+      if list = opts.delete(:list)
+        defaults.merge!(:allowableValues => {:values => list,
+                                             :valueType => "LIST"})
+      end
+      if range = opts.delete(:range)
+        defaults.merge!(:allowableValues => {:min => range.first,
+                                             :max => range.last,
+                                             :valueType => "RANGE"})
+      end
+      result = defaults.merge(opts)
+      bomb("#{result[:dataType]} not valid. dataType must be one of #{PRIMITIVES.inspect}") unless PRIMITIVES.include?(result[:dataType])
+      bomb("#{result[:paramType]} not valid. paramType must be one of #{PARAM_TYPES.keys.inspect}") unless PARAM_TYPES.keys.include?(result[:paramType])
+      bomb("allowMultiple not allowed for paramType #{result[:paramType]}") if result[:allowMultiple] && !PARAM_TYPES[result[:paramType]][:allowMultipleAllowed]
+      @values[:parameters] << result
+    end
+
+    def as_json options
+      @values.as_json options
+    end
+  end
+end

data/lib/swagger/version.rb

@@ -0,0 +1,3 @@
+module Swagger
+  VERSION = "0.0.1"
+end

data/lib/swagger.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'action_view'
+require "swagger/version"
+require 'swagger/document'
+require 'swagger/api'
+require 'swagger/operation'
+
+module Swagger
+  def document base_path, opts = {}
+    d = Document.new(base_path, opts).tap { |d| yield(d) }
+    render :json => d
+  end
+end