swagger_yard 0.0.5 → 0.1.0

metadata

@@ -1,55 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: SwaggerYard API doc gem that uses YARD to parse the docs for a REST rails
@@ -60,43 +102,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/controllers/swagger_yard/application_controller.rb
-- app/controllers/swagger_yard/swagger_controller.rb
-- app/views/swagger_yard/swagger/doc.html.erb
+- MIT-LICENSE
+- README.md
+- Rakefile
 - config/routes.rb
-- public/swagger-ui/css/hightlight.default.css
-- public/swagger-ui/css/screen.css
-- public/swagger-ui/images/logo_small.png
-- public/swagger-ui/images/pet_store_api.png
-- public/swagger-ui/images/throbber.gif
-- public/swagger-ui/images/wordnik_api.png
-- public/swagger-ui/lib/backbone-min.js
-- public/swagger-ui/lib/handlebars-1.0.rc.1.js
-- public/swagger-ui/lib/highlight.7.3.pack.js
-- public/swagger-ui/lib/jquery-1.8.0.min.js
-- public/swagger-ui/lib/jquery.ba-bbq.min.js
-- public/swagger-ui/lib/jquery.slideto.min.js
-- public/swagger-ui/lib/jquery.wiggle.min.js
-- public/swagger-ui/lib/MD5.js
-- public/swagger-ui/lib/swagger.js
-- public/swagger-ui/lib/underscore-min.js
-- public/swagger-ui/swagger-ui.js
-- public/swagger-ui/swagger-ui_org.js
-- lib/generators/swagger_yard/doc_generator.rb
-- lib/generators/swagger_yard/js_generator.rb
+- lib/swagger_yard.rb
 - lib/swagger_yard/api.rb
 - lib/swagger_yard/api_declaration.rb
-- lib/swagger_yard/cache.rb
-- lib/swagger_yard/engine.rb
-- lib/swagger_yard/local_dispatcher.rb
+- lib/swagger_yard/authorization.rb
+- lib/swagger_yard/configuration.rb
+- lib/swagger_yard/listing_info.rb
+- lib/swagger_yard/model.rb
+- lib/swagger_yard/operation.rb
 - lib/swagger_yard/parameter.rb
-- lib/swagger_yard/parser.rb
+- lib/swagger_yard/property.rb
 - lib/swagger_yard/resource_listing.rb
+- lib/swagger_yard/type.rb
 - lib/swagger_yard/version.rb
-- lib/swagger_yard.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
 homepage: http://www.synctv.com
 licenses:
 - MIT
@@ -107,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: SwaggerYard API doc through YARD

data/app/controllers/swagger_yard/application_controller.rb

@@ -1,4 +0,0 @@
-module SwaggerYard
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/controllers/swagger_yard/swagger_controller.rb

@@ -1,21 +0,0 @@
-module SwaggerYard
-  class SwaggerController < ApplicationController
-    layout false
-
-    def index
-      swagger_listing = SwaggerYard.get_listing
-      swagger_listing.merge!("basePath" => request.url) if swagger_listing["basePath"].blank?
-      render :json => swagger_listing
-    end
-
-    def show
-      swagger_api = SwaggerYard.get_api("/#{params[:resource]}")
-      swagger_api.merge!("basePath" => request.base_url + SwaggerYard.api_path) if swagger_api["basePath"].blank? 
-      render :json => swagger_api
-    end
-
-    def doc
-      render :doc
-    end
-  end
-end

data/app/views/swagger_yard/swagger/doc.html.erb

@@ -1,80 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>Swagger UI</title>
-    <link href='//fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'/>
-    <link href='../swagger-ui/css/hightlight.default.css' media='screen' rel='stylesheet' type='text/css'/>
-    <link href='../swagger-ui/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
-    <script src='../swagger-ui/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/jquery.slideto.min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/jquery.wiggle.min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/handlebars-1.0.rc.1.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/underscore-min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/backbone-min.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/swagger.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/MD5.js' type='text/javascript'></script>
-    <script src='../swagger-ui/lib/highlight.7.3.pack.js' type='text/javascript'></script>
-    <script src='../swagger-ui/swagger-ui.js' type='text/javascript'></script>
-
-    <script type="text/javascript">
-	$(function () {
-	    window.swaggerUi = new SwaggerUi({
-                discoveryUrl: location.protocol + "//" + location.host + "/swagger/api",
-                dom_id:"swagger-ui-container",
-                supportHeaderParams: true,
-                supportedSubmitMethods: ['get', 'post', 'put'],
-                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();
-        });
-
-    </script>
-</head>
-
-<body>
-<div id='header'>
-    <div class="swagger-ui-wrap">
-        <a id="logo" href="http://swagger.wordnik.com">swagger</a>
-
-        <form id='api_selector'>
-            <div class='input icon-btn'>
-                <img id="show-pet-store-icon" src="../swagger-ui/images/pet_store_api.png" title="Show Swagger Petstore Example Apis">
-            </div>
-            <div class='input icon-btn'>
-                <img id="show-wordnik-dev-icon" src="../swagger-ui/images/wordnik_api.png" title="Show Wordnik Developer Apis">
-            </div>
-            <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl"
-                                      type="text"/></div>
-            <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
-            <div class='input'><a id="explore" href="#">Explore</a></div>
-        </form>
-    </div>
-</div>
-
-<div id="message-bar" class="swagger-ui-wrap">
-    &nbsp;
-</div>
-
-<div id="swagger-ui-container" class="swagger-ui-wrap">
-
-</div>
-
-</body>
-
-</html>

data/lib/generators/swagger_yard/doc_generator.rb

@@ -1,11 +0,0 @@
-require 'rails/generators'
-module SwaggerYard
-  class DocGenerator < Rails::Generators::Base
-    source_root File.expand_path("../../../../app/views/swagger_yard/swagger", __FILE__)
-    desc "Add swagger-ui doc ERB file to app/views for customization"
-    
-    def generate_layout  
-      copy_file "doc.html.erb", "app/views/swagger_yard/swagger/doc.html.erb"
-    end
-  end
-end

data/lib/generators/swagger_yard/js_generator.rb

@@ -1,13 +0,0 @@
-require 'rails/generators'
-
-module SwaggerYard
-  class JsGenerator < Rails::Generators::Base
-    source_root File.expand_path("../../../../public/swagger-ui", __FILE__)
-    desc "Add swagger-ui js to /public for customization"
-    
-    def generate_layout  
-      copy_file "swagger-ui_org.js", "public/swagger-ui/swagger-ui.js"
-      directory "lib", "public/swagger-ui/lib"
-    end
-  end
-end

data/lib/swagger_yard/cache.rb

@@ -1,50 +0,0 @@
-module SwaggerYard
-  # For now just a simple wrapper class for a Memcache client.
-  class Cache
-
-    attr_reader :prefix, :store
-
-    def initialize(store, prefix)
-      @store = store
-      @prefix = prefix
-    end
-
-    # Read from the Cache.
-    def [](resource_name)
-      case
-        when store.respond_to?(:read)
-          store.read key_for(resource_name)
-        when store.respond_to?(:[])
-          store[key_for(resource_name)]
-        when store.respond_to?(:get)
-          store.get key_for(resource_name)
-      end
-    end
-
-    # Write to the Cache.
-    def []=(resource_name, value)
-      case
-        when store.respond_to?(:write)
-          store.write key_for(resource_name), value
-        when store.respond_to?(:[]=)
-          store[key_for(resource_name)] = value
-        when store.respond_to?(:set)
-          store.set key_for(resource_name), value
-      end
-    end
-
-    def fetch(resource_name)
-      value = self[resource_name]
-      if value.nil? && block_given?
-        value = yield
-        self[resource_name] = yield
-      end
-      value
-    end
-
-    # Cache key for a given entry.
-    def key_for(resource_name)
-      [prefix, resource_name].join
-    end
-  end
-end

data/lib/swagger_yard/engine.rb

@@ -1,18 +0,0 @@
-require "swagger_yard/local_dispatcher"
-
-module SwaggerYard
-  class Engine < ::Rails::Engine
-    if SwaggerYard::LocalDispatcher.new.server?
-      isolate_namespace SwaggerYard
-
-      # NOTE: We should opt for asset pipeline instead of this.
-      initializer 'swagger_yard.load_static_assets' do |app|
-        app.middleware.use(::ActionDispatch::Static, "#{root}/public")
-      end
-
-      initializer "swagger_yard.finisher_hook" do |app|
-        SwaggerYard.generate!("#{app.root}/app/controllers/**/*.rb")
-      end
-    end
-  end
-end

data/lib/swagger_yard/local_dispatcher.rb

@@ -1,51 +0,0 @@
-module SwaggerYard
-  # An instance of LocalEnvironment is responsible for determining the dispatcher. 
-  # This is useful to determine whether or not to run SwaggerYard#generate!.
-  # 
-  # Implementation heavily borrowed from NewRelic.
-  class LocalDispatcher
-    def discovered_dispatcher
-      discover_dispatcher unless @discovered_dispatcher
-      @discovered_dispatcher
-    end
-
-    def server?
-      [:thin, :unicorn].include?(discovered_dispatcher)
-    end
-
-  private
-
-    def discover_dispatcher
-      dispatchers = %w[sidekiq thin unicorn]
-      while dispatchers.any? && @discovered_dispatcher.nil?
-        send 'check_for_' + (dispatchers.shift)
-      end
-    end
-
-    def find_class_in_object_space(klass)
-      ObjectSpace.each_object(klass) do |x|
-        return x
-      end
-      return nil
-    end
-
-    def check_for_unicorn
-      if defined?(::Unicorn) && defined?(::Unicorn::HttpServer)
-        v = find_class_in_object_space(::Unicorn::HttpServer)
-        @discovered_dispatcher = :unicorn if v
-      end
-    end
-
-    def check_for_sidekiq
-      if defined?(::Sidekiq) && File.basename($0) == 'sidekiq'
-        @discovered_dispatcher = :sidekiq
-      end
-    end
-
-    def check_for_thin
-      if defined?(::Thin) && defined?(::Thin::VERSION)
-        @discovered_dispatcher = :thin
-      end
-    end
-  end
-end

data/lib/swagger_yard/parser.rb

@@ -1,35 +0,0 @@
-require_relative 'api'
-require_relative 'api_declaration'
-require_relative 'resource_listing'
-
-module SwaggerYard
-  class Parser
-    attr_reader :listing
-
-    def initialize
-      @listing = ResourceListing.new
-    end
-
-    def run(yard_objects)
-      api_declaration = ApiDeclaration.new
-      retain_api = true
-      
-      yard_objects.each do |yard_object|
-        case yard_object.type
-        when :class
-          break unless retain_api = api_declaration.add_listing_info(yard_object)
-        when :method
-          api = Api.new(yard_object)
-          api_declaration.add_api(api) if api.valid?
-        end
-      end
-
-      if retain_api
-        @listing.add(api_declaration)
-        api_declaration
-      else
-        nil
-      end
-    end
-  end
-end

data/public/swagger-ui/css/hightlight.default.css

@@ -1,135 +0,0 @@
-/*
-
-Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
-
-*/
-
-pre code {
-  display: block; padding: 0.5em;
-  background: #F0F0F0;
-}
-
-pre code,
-pre .subst,
-pre .tag .title,
-pre .lisp .title,
-pre .clojure .built_in,
-pre .nginx .title {
-  color: black;
-}
-
-pre .string,
-pre .title,
-pre .constant,
-pre .parent,
-pre .tag .value,
-pre .rules .value,
-pre .rules .value .number,
-pre .preprocessor,
-pre .ruby .symbol,
-pre .ruby .symbol .string,
-pre .aggregate,
-pre .template_tag,
-pre .django .variable,
-pre .smalltalk .class,
-pre .addition,
-pre .flow,
-pre .stream,
-pre .bash .variable,
-pre .apache .tag,
-pre .apache .cbracket,
-pre .tex .command,
-pre .tex .special,
-pre .erlang_repl .function_or_atom,
-pre .markdown .header {
-  color: #800;
-}
-
-pre .comment,
-pre .annotation,
-pre .template_comment,
-pre .diff .header,
-pre .chunk,
-pre .markdown .blockquote {
-  color: #888;
-}
-
-pre .number,
-pre .date,
-pre .regexp,
-pre .literal,
-pre .smalltalk .symbol,
-pre .smalltalk .char,
-pre .go .constant,
-pre .change,
-pre .markdown .bullet,
-pre .markdown .link_url {
-  color: #080;
-}
-
-pre .label,
-pre .javadoc,
-pre .ruby .string,
-pre .decorator,
-pre .filter .argument,
-pre .localvars,
-pre .array,
-pre .attr_selector,
-pre .important,
-pre .pseudo,
-pre .pi,
-pre .doctype,
-pre .deletion,
-pre .envvar,
-pre .shebang,
-pre .apache .sqbracket,
-pre .nginx .built_in,
-pre .tex .formula,
-pre .erlang_repl .reserved,
-pre .prompt,
-pre .markdown .link_label,
-pre .vhdl .attribute,
-pre .clojure .attribute,
-pre .coffeescript .property {
-  color: #88F
-}
-
-pre .keyword,
-pre .id,
-pre .phpdoc,
-pre .title,
-pre .built_in,
-pre .aggregate,
-pre .css .tag,
-pre .javadoctag,
-pre .phpdoc,
-pre .yardoctag,
-pre .smalltalk .class,
-pre .winutils,
-pre .bash .variable,
-pre .apache .tag,
-pre .go .typename,
-pre .tex .command,
-pre .markdown .strong,
-pre .request,
-pre .status {
-  font-weight: bold;
-}
-
-pre .markdown .emphasis {
-  font-style: italic;
-}
-
-pre .nginx .built_in {
-  font-weight: normal;
-}
-
-pre .coffeescript .javascript,
-pre .javascript .xml,
-pre .tex .formula,
-pre .xml .javascript,
-pre .xml .vbscript,
-pre .xml .css,
-pre .xml .cdata {
-  opacity: 0.5;
-}