swagger_yard-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f557fd9df6b77513d27bd07bf19a7916347c4d1
-  data.tar.gz: c3b1447dc6cd7466acaaa223f087ad30e122521f
+  metadata.gz: c94696f2feaf6e856d6ea364376c58a27ee9a9ba
+  data.tar.gz: 08976e63e0846806c8c2c94303a1c7191fa882e0
 SHA512:
-  metadata.gz: d539556a94a932b14b3a3f6878480084ff141d21d11270c2026471fa03600d648ea2607d63f60fe8be8135c054c257ed4a4869c9ea0c4b5f69cfcdd3d96fa559
-  data.tar.gz: 025eba31f3fc8815fa3e4d3e8ae4983d94360ccb3e1ba37451d35deefb327c8e6988ca931841f73c57a8a5321dd0925ae85dcf9f7b893518d24c736c22e313f6
+  metadata.gz: 5c12fefc9e29ebc4e924f8734ae2559f98f013aea0b85743f1a7faa7c472417d1dfe141f6f684f253cd8a2250e6f2cf38d6dd1fe3a0e82545d31a3a435c18ba7
+  data.tar.gz: afc7e95748615318a546b666ffb913753d8bdc61792c6bb6122d5be293c81458f053e1ab3f81c6b43c41bfcb194fd734abc40f6a733c3628b1acbe1dfad6a631

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - 2.2.2
 before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## SwaggerYard 0.2.0 -- 20-10-2015 ##
+
+* Support for Swagger's Spec v2
+
+    *Nick Sieger <@nicksieger>*
+
+* Remove support for Spec v1
+
+    *Tony Pitale <@tpitale>*
+
 ## SwaggerYard 0.1.0 -- 15-10-2015 ##
 
 * Add Engine from SwaggerYard

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in swagger_yard-rails.gemspec
 gemspec
-
-# jquery-rails is used by the dummy application
-# gem "jquery-rails"

data/README.md

@@ -23,6 +23,30 @@ And then execute:
 mount SwaggerYard::Rails::Engine, at: "/swagger"
 ```
 
+### Add JS/CSS for UI ###
+
+In your Gemfile (until the release of 2.1.3):
+
+```ruby
+gem 'swagger-ui_rails2', github: '3scale/swagger-ui_rails', branch: 'dev-2.1.3'
+```
+
+[https://github.com/3scale/swagger-ui_rails/tree/dev-2.1.3#usage](https://github.com/3scale/swagger-ui_rails/tree/dev-2.1.3#usage)
+
+in application.css:
+
+```css
+*= require swagger-ui2/index
+```
+
+in application.js:
+
+```js
+//= require swagger-ui2/index
+```
+
+**Note:** swagger_yard-rails will handle the template
+
 ### Configure SwaggerYard ###
 
 ```ruby

data/app/controllers/swagger_yard/rails/swagger_controller.rb

@@ -0,0 +1,14 @@
+module SwaggerYard
+  module Rails
+    class SwaggerController < ApplicationController
+      layout 'application'
+
+      def doc
+      end
+
+      def index
+        render :json => Swagger.new.to_h, :layout => false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+<script type="text/javascript">
+  $(function () {
+    var url = window.location.search.match(/url=([^&]+)/);
+    if (url && url.length > 1) {
+      url = decodeURIComponent(url[1]);
+    } else {
+      url = "/swagger/api.json";
+    }
+
+    window.swaggerUi = new SwaggerUi({
+      url: url,
+      dom_id:"swagger-ui-container",
+      supportHeaderParams: false,
+      supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+      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>
+
+<div class="swagger-section">
+  <div id="message-bar" class="swagger-ui-wrap">
+      &nbsp;
+  </div>
+
+  <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
+</div>

data/config/routes.rb

@@ -1,4 +1,8 @@
 SwaggerYard::Rails::Engine.routes.draw do
-   get '/api', to: 'swagger#index'
-   get '/api/*resource', to: 'swagger#show'
+  get '/doc', to: 'swagger#doc'
+
+  scope default: {format: 'json'} do
+    get '/swagger', to: 'swagger#index'
+    get '/api', to: 'swagger#index'
+  end
 end

data/lib/swagger_yard/rails.rb

@@ -7,5 +7,3 @@ module SwaggerYard
 end
 
 require "swagger_yard/rails/engine"
-require "swagger_yard/rails/application_controller"
-require "swagger_yard/rails/swagger_controller"

data/lib/swagger_yard/rails/engine.rb

@@ -5,6 +5,17 @@ module SwaggerYard
       initializer "swagger_yard-rails.finisher_hook" do |app|
         SwaggerYard.register_custom_yard_tags!
       end
+
+      initializer "swagger_yard-rails.paths" do |app|
+        SwaggerYard.configure do |config|
+          config.controller_path = ::Rails.root + 'app/controllers/**/*'
+          config.model_path      = ::Rails.root + 'app/models/**/*'
+        end
+      end
+
+      rake_tasks do
+        load File.expand_path('../tasks.rake', __FILE__)
+      end
     end
   end
 end

data/lib/swagger_yard/rails/tasks.rake

@@ -0,0 +1,7 @@
+namespace :swagger do
+  task :json, [:filename] => :environment do |t, args|
+    File.open(args[:filename] || "swagger.json", "w") do |f|
+      f.puts JSON.pretty_generate(SwaggerYard::Swagger.new.swagger_v2)
+    end
+  end
+end

data/lib/swagger_yard/rails/version.rb

@@ -1,5 +1,5 @@
 module SwaggerYard
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/swagger_yard-rails.gemspec

@@ -28,11 +28,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 3.2.8"
-  spec.add_dependency "swagger_yard", "~> 0.1.0"
+  spec.add_dependency "swagger_yard", "~> 0.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "apivore"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "bourne"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: apivore
+  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
@@ -125,13 +153,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/swagger_yard/rails/application_controller.rb
+- app/controllers/swagger_yard/rails/swagger_controller.rb
+- app/views/swagger_yard/rails/swagger/doc.html.erb
 - bin/console
 - bin/setup
 - config/routes.rb
 - lib/swagger_yard/rails.rb
-- lib/swagger_yard/rails/application_controller.rb
 - lib/swagger_yard/rails/engine.rb
-- lib/swagger_yard/rails/swagger_controller.rb
+- lib/swagger_yard/rails/tasks.rake
 - lib/swagger_yard/rails/version.rb
 - swagger_yard-rails.gemspec
 homepage: https://github.com/tpitale/swagger_yard-rails

data/lib/swagger_yard/rails/swagger_controller.rb

@@ -1,25 +0,0 @@
-module SwaggerYard
-  module Rails
-    class SwaggerController < ApplicationController
-      layout false
-
-      def index
-        listing = resource_listing.to_h
-        listing.merge!("basePath" => request.url) if listing["basePath"].blank?
-        render :json => listing
-      end
-
-      def show
-        declaration = resource_listing.declaration_for("/#{params[:resource]}").to_h
-
-        declaration.merge!("basePath" => request.base_url + SwaggerYard.config.api_path) if declaration["basePath"].blank?
-        render :json => declaration
-      end
-
-      private
-      def resource_listing
-        SwaggerYard::ResourceListing.new(::Rails.root+'app/controllers/**/*.rb', ::Rails.root+'app/models/**/*.rb')
-      end
-    end
-  end
-end