swaggard 0.0.4 → 0.1.0

data/app/assets/stylesheets/swaggard/screen.css.scss

@@ -274,6 +274,9 @@
   font-weight: bold;
   font-size: 25px;
 }
+.swagger-section .swagger-ui-wrap .footer {
+  margin-top: 20px;
+}
 .swagger-section .swagger-ui-wrap p.big,
 .swagger-section .swagger-ui-wrap div.big p {
   font-size: 1em;
@@ -423,6 +426,17 @@
 .swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper .optionName {
   font-weight: bold;
 }
+.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:first-child,
+.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:last-child {
+  display: inline;
+}
+.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:not(:first-child):before {
+  display: block;
+  content: '';
+}
+.swagger-section .swagger-ui-wrap .model-signature .description span:last-of-type.propDesc.markdown > p:only-child {
+  margin-right: -3px;
+}
 .swagger-section .swagger-ui-wrap .model-signature .propName {
   font-weight: bold;
 }
@@ -782,7 +796,7 @@
   padding: 6px 8px;
 }
 .swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header span.response_throbber {
-  background-image: image-url("swaggard/throbber.gif");
+  background-image: image-url('swaggard/throbber.gif');
   width: 128px;
   height: 16px;
   display: block;
@@ -793,6 +807,9 @@
   outline: 2px solid black;
   outline-color: #cc0000;
 }
+.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form select[name='parameterContentType'] {
+  max-width: 300px;
+}
 .swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.response div.block pre {
   font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace;
   padding: 10px;
@@ -1066,6 +1083,9 @@
 .swagger-section .swagger-ui-wrap form.form_box p strong {
   color: black;
 }
+.swagger-section .swagger-ui-wrap .operation-status td.markdown > p:last-child {
+  padding-bottom: 0;
+}
 .swagger-section .title {
   font-style: bold;
 }
@@ -1138,8 +1158,16 @@
 .swagger-section .auth {
   float: right;
 }
-.swagger-section #api_information_panel {
-  position: absolute;
+.swagger-section .api-ic {
+  height: 18px;
+  vertical-align: middle;
+  display: inline-block;
+  background: image-url('swaggard/explorer_icons.png') no-repeat;
+}
+.swagger-section .api-ic .api_information_panel {
+  position: relative;
+  margin-top: 20px;
+  margin-left: -5px;
   background: #FFF;
   border: 1px solid #ccc;
   border-radius: 5px;
@@ -1150,34 +1178,32 @@
   color: black;
   padding: 5px;
 }
-.swagger-section #api_information_panel p .api-msg-enabled {
+.swagger-section .api-ic .api_information_panel p .api-msg-enabled {
   color: green;
 }
-.swagger-section #api_information_panel p .api-msg-disabled {
+.swagger-section .api-ic .api_information_panel p .api-msg-disabled {
   color: red;
 }
-.swagger-section .api-ic {
-  height: 18px;
-  vertical-align: middle;
-  display: inline-block;
-  background: image-url("swaggard/explorer_icons.png") no-repeat;
+.swagger-section .api-ic:hover .api_information_panel {
+  position: absolute;
+  display: block;
 }
 .swagger-section .ic-info {
   background-position: 0 0;
   width: 18px;
-  margin-top: -7px;
+  margin-top: -6px;
   margin-left: 4px;
 }
 .swagger-section .ic-warning {
   background-position: -60px 0;
   width: 18px;
-  margin-top: -7px;
+  margin-top: -6px;
   margin-left: 4px;
 }
 .swagger-section .ic-error {
   background-position: -30px 0;
   width: 18px;
-  margin-top: -7px;
+  margin-top: -6px;
   margin-left: 4px;
 }
 .swagger-section .ic-off {
@@ -1200,7 +1226,7 @@
   font-size: 1.5em;
   font-weight: bold;
   text-decoration: none;
-  background: transparent image-url("swaggard/logo_small.png") no-repeat left center;
+  background: transparent image-url('swaggard/logo_small.png') no-repeat left center;
   padding: 20px 0 20px 40px;
   color: white;
 }
@@ -1253,4 +1279,4 @@
   min-height: 30px;
   text-align: center;
   padding-top: 10px;
-}
+}

data/app/assets/stylesheets/swaggard/typography.css.scss

@@ -3,7 +3,7 @@
   font-family: 'Droid Sans';
   font-style: normal;
   font-weight: 400;
-  src: url('../fonts/droid-sans-v6-latin-regular.eot'); /* IE9 Compat Modes */
+  src: font-url('swaggard/droid-sans-v6-latin-regular.eot'); /* IE9 Compat Modes */
   src: local('Droid Sans'), local('DroidSans'),
        font-url('swaggard/droid-sans-v6-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
        font-url('swaggard/droid-sans-v6-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */
@@ -11,6 +11,7 @@
        font-url('swaggard/droid-sans-v6-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */
        font-url('swaggard/droid-sans-v6-latin-regular.svg#DroidSans') format('svg'); /* Legacy iOS */
 }
+
 /* droid-sans-700 - latin */
 @font-face {
   font-family: 'Droid Sans';

data/app/controllers/swaggard/swagger_controller.rb

@@ -12,7 +12,9 @@ module Swaggard
         end
 
         format.json do
-          render :json => Swaggard.get_doc
+          doc = Swaggard.get_doc(request.host_with_port)
+
+          render json: doc
         end
       end
     end

data/app/views/swaggard/swagger/index.html.erb

@@ -1,74 +1,33 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Swagger UI</title>
-
-  <%= stylesheet_link_tag    'swaggard/application', media: 'all' %>
-  <%= javascript_include_tag 'swaggard/application' %>
-
-  <script type="text/javascript">
-    $(function () {
-      var url = window.location.search.match(/url=([^&]+)/);
-      if (url && url.length > 1) {
-        url = decodeURIComponent(url[1]);
-      } else {
-        url = location.protocol + "//" + location.host + "/swagger.json";
-      }
-      window.swaggerUi = new SwaggerUi({
-        url: url,
-        dom_id: "swagger-ui-container",
-        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
-        onComplete: function(swaggerApi, swaggerUi){
-          $('pre code').each(function(i, e) {
-            hljs.highlightBlock(e)
-          });
-        },
-        onFailure: function(data) {
-          log("Unable to Load SwaggerUI");
-        },
-        docExpansion: "none",
-        apisSorter : "alpha"
-      });
-
-      function addApiKeyAuthorization() {
-        var key = $('#input_apiKey')[0].value;
-        log("key: " + key);
-        if(key && key.trim() != "") {
-          log("added key " + key);
-          window.authorizations.add('key', new ApiKeyAuthorization("<%= @authentication_key %>",
-                                           key,
-                                           "<%= @authentication_type %>"));
-        }
-      }
-
-      var $apiKeyInput = $('#input_apiKey');
-
-      $apiKeyInput.change(function() {
-        addApiKeyAuthorization();
-      });
-
-      var apiKey = "<%= @authentication_value %>";
-      $apiKeyInput.val(apiKey);
-      addApiKeyAuthorization();
-
-      window.swaggerUi.load();
-    });
-  </script>
-</head>
-
-<body class="swagger-section">
-<div id='header'>
-  <div class="swagger-ui-wrap">
-    <a id="logo" href="http://swagger.io">swagger</a>
-    <form id='api_selector'>
-      <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
-      <div class='input'><input placeholder="<%= @authentication_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>
+  <head>
+    <title>Swagger UI</title>
+
+    <%= favicon_link_tag 'swaggard/favicon-32x32.png', sizes: '32x32' %>
+    <%= favicon_link_tag 'swaggard/favicon-16x16.png', sizes: '16x16' %>
+
+    <%= stylesheet_link_tag    'swaggard/application', media: :screen %>
+    <%= stylesheet_link_tag    'swaggard/application_print', media: :print %>
+    <%= javascript_include_tag 'swaggard/application' %>
+
+  </head>
+
+  <body class='swagger-section'>
+    <div id='header'>
+      <div class='swagger-ui-wrap'>
+        <a id='logo' href='http://swagger.io'>swagger</a>
+        <%= form_tag '', id: :api_selector, data: { authentication_key: @authentication_key,
+                                                    authentication_type: @authentication_type,
+                                                    authentication_value: @authentication_value} do %>
+          <div class='input'><input placeholder='http://example.com/api' id='input_baseUrl' name='baseUrl' type='text'/></div>
+          <div class='input'><input placeholder='<%= @authentication_key %>' id='input_apiKey' name='apiKey' type='text'/></div>
+          <div class='input'><a id='explore' href='#'>Explore</a></div>
+        <% end %>
+
+      </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/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w[swaggard/application_print.css]

data/lib/swaggard.rb

@@ -30,10 +30,14 @@ module Swaggard
       ::YARD::Tags::Library.define_tag('Response class',  :response_class)
     end
 
-    def get_doc
+    def get_doc(host)
       load!
 
-      @api.to_doc
+      doc = @api.to_doc
+
+      doc['host'] = host if doc['host'].blank?
+
+      doc
     end
 
     private
@@ -71,13 +75,15 @@ module Swaggard
       parser = Parsers::Models.new
 
       definitions =[]
-      Dir[configuration.models_path].each do |file|
-        yard_objects = get_yard_objects(file)
+      configuration.models_paths.each do |path|
+        Dir[path].each do |file|
+          yard_objects = get_yard_objects(file)
 
-        definitions.concat(parser.run(yard_objects))
-      end
+          definitions.concat(parser.run(yard_objects))
+        end
 
-      @api.definitions = definitions
+        @api.definitions = definitions
+      end
     end
 
     def get_yard_objects(file)

data/lib/swaggard/api_definition.rb

@@ -32,7 +32,9 @@ module Swaggard
           'title'           => Swaggard.configuration.title,
           'termsOfService'  => Swaggard.configuration.tos,
           'contact' => {
-            'email' => Swaggard.configuration.contact
+            'name'  => Swaggard.configuration.contact_name,
+            'email' => Swaggard.configuration.contact_email,
+            'url'   => Swaggard.configuration.contact_url
           },
           'license' => {
             'name'  => Swaggard.configuration.license_name,

data/lib/swaggard/configuration.rb

@@ -12,11 +12,11 @@ module Swaggard
   #   end
   class Configuration
 
-    attr_accessor :doc_base_path, :api_base_path, :controllers_path, :models_path, :routes
+    attr_accessor :doc_base_path, :controllers_path, :models_paths, :routes
 
-    attr_writer :swagger_version, :api_version, :api_path, :api_formats, :title, :description,
-                :tos, :contact, :host, :authentication_type, :authentication_key,
-                :authentication_value
+    attr_writer :swagger_version, :api_base_path, :api_version, :api_path, :api_formats, :title,
+                :description, :tos, :contact_email, :contact_name, :contact_url, :host,
+                :authentication_type, :authentication_key, :authentication_value
 
     def swagger_version
       @swagger_version ||= '2.0'
@@ -30,6 +30,10 @@ module Swaggard
       @api_path ||= ''
     end
 
+    def api_base_path
+      @api_base_path ||= '/'
+    end
+
     def api_formats
       @api_formats ||= [:xml, :json]
     end
@@ -54,8 +58,16 @@ module Swaggard
       @tos ||= ''
     end
 
-    def contact
-      @contact ||= ''
+    def contact_name
+      @contact_name ||= ''
+    end
+
+    def contact_email
+      @contact_email ||= ''
+    end
+
+    def contact_url
+      @contact_email ||= ''
     end
 
     def license_name

data/lib/swaggard/engine.rb

@@ -6,8 +6,14 @@ module Swaggard
       app.reload_routes!
 
       Swaggard.configure do |config|
-        config.controllers_path = "#{app.root}/app/controllers/**/*.rb"
-        config.models_path = "#{app.root}/app/serializers/**/*.rb"
+        unless config.controllers_path
+          config.controllers_path = "#{app.root}/app/controllers/**/*.rb"
+        end
+
+        unless config.models_paths
+          config.models_paths = ["#{app.root}/app/serializers/**/*.rb"]
+        end
+
         config.routes = app.routes.routes
       end
 

data/lib/swaggard/parsers/controllers.rb

@@ -15,8 +15,6 @@ module Swaggard
           elsif tag && yard_object.type == :method
             operation = Swagger::Operation.new(yard_object, tag, routes)
             operations << operation if operation.valid?
-          else
-            break
           end
         end
 

data/lib/swaggard/parsers/models.rb

@@ -11,7 +11,7 @@ module Swaggard
         yard_objects.each do |yard_object|
           next unless yard_object.type == :class
 
-          definition = Swagger::Definition.new(yard_object.name)
+          definition = Swagger::Definition.new(yard_object.path)
 
           yard_object.tags.each do |tag|
             property = Swagger::Property.new(tag)

data/lib/swaggard/swagger/default_response.rb

@@ -0,0 +1,17 @@
+module Swaggard
+  module Swagger
+    class DefaultResponse
+
+      def status_code
+        'default'
+      end
+
+      def to_doc
+        {
+          'description' => 'successful operation'
+        }
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/definition.rb

@@ -15,7 +15,9 @@ module Swaggard
 
       def to_doc
         {
-          'properties' => Hash[@properties.map { |property| [property.id, property.to_doc] }]
+          'type'        => 'object',
+          'required'    => [],
+          'properties'  => Hash[@properties.map { |property| [property.id, property.to_doc] }]
         }
       end
 

data/lib/swaggard/swagger/operation.rb

@@ -5,6 +5,7 @@ require_relative 'parameters/path'
 require_relative 'parameters/query'
 
 require_relative 'response'
+require_relative 'default_response'
 
 module Swaggard
   module Swagger
@@ -43,6 +44,8 @@ module Swaggard
         build_path_parameters(routes)
 
         @parameters.sort_by { |parameter| parameter.name }
+
+        @responses << DefaultResponse.new unless @responses.any?
       end
 
       def valid?