praxis 0.16.1 → 0.17.0

data/lib/api_browser/app/views/directives/attribute_description.html

@@ -1,2 +1,2 @@
-<p ng-bind-html="attribute.description | markdown"></p>
+<div ng-bind-html="attribute.description | markdown"></div>
 <dl></dl>

data/lib/api_browser/app/views/directives/attribute_description/example.html

@@ -0,0 +1,13 @@
+<dt ng-if="row.value.length < 50">Example</dt>
+<dt ng-if="row.value.length >= 50">
+    Example (<a ng-init="row.isCollapsed = true" ng-click="row.isCollapsed = !row.isCollapsed">{{row.isCollapsed? 'show' : 'hide'}}</a>)
+  </dt>
+</dt>
+
+
+<dd ng-if="row.value.length <= 50">
+  <code ng-class="{hide: false}">{{row.value}}</code>
+</dd>
+<dd ng-if="row.value.length > 50">
+  <pre ng-class="{hide: row.isCollapsed}">{{row.value}}</pre>
+</dd>

data/lib/api_browser/app/views/directives/attribute_description/headers.html

@@ -0,0 +1,8 @@
+<dt ng-hide="row.value | isEmpty">{{row.name}}</dt>
+<dd ng-hide="row.value | isEmpty">
+  <div ng-repeat="(k,v) in row.value">
+    <span>{{k}}:</span>
+    <span ng-if="v.value === true"><em>Any value</em></span>
+    <span ng-if="v.value !== true">{{v.value}}</span>
+  </div>
+</dd>

data/lib/api_browser/app/views/directives/attribute_description/member_options.html

@@ -0,0 +1,4 @@
+<dt>Member type values</dt>
+<dd class="well">
+  <attribute-description attribute="{options: row.value, description: 'These settings apply to the contained type:'}"></attribute-description>
+</dd>

data/lib/api_browser/app/views/directives/attribute_description/values.html

@@ -0,0 +1,14 @@
+<dt ng-if="row.value.length == 1">Value</dt>
+<dt ng-if="row.value.length < 5 && row.value.length > 1">Possible values</dt>
+<dt ng-if="row.value.length >= 5">
+  Possible values (<a ng-init="row.isCollapsed = true" ng-click="row.isCollapsed = !row.isCollapsed">{{row.isCollapsed? 'show' : 'hide'}}</a>)
+  </dt>
+</dt>
+
+<dd ng-if="row.value.length == 1"><code>{{row.value[0]}}</code> (this field will always hold this value)</dd>
+<dd ng-if="row.value.length > 1">
+  <div ng-class="{hide: !row.isCollapsed || row.value.length < 5}">{{row.value.slice(0, 4).join(', ')}}, <a ng-init="row.isCollapsed = true" ng-click="row.isCollapsed = !row.isCollapsed">and {{row.value.length - 4}} more</a>.</div>
+  <ul ng-class="{hide: row.isCollapsed && row.value.length >= 5}">
+    <li ng-repeat="v in row.value"><code>{{v}}</code></li>
+  </ul>
+</dd>

data/lib/api_browser/app/views/directives/attribute_table.html

@@ -1,5 +1,5 @@
 <div class="table-responsive">
-  <table class="table table-striped">
+  <table class="table table-striped table-bordered">
     <thead>
       <tr>
         <th>Attribute</th>
@@ -11,7 +11,7 @@
       <tr ng-if="g.name && g.attributes.length">
         <th colspan="3">{{g.name}}</th>
       </tr>
-      <tr rs-attribute-table-row ng-repeat="item in g.attributes" name="item.name" attribute="item" ></tr>
+      <tr type-placeholder ng-repeat="item in g.attributes" type="item.type" template="embedded" name="item.name" details="item"></tr>
     </tbody>
   </table>
 </div>

data/lib/api_browser/app/views/home.html

@@ -1,7 +1,5 @@
-<!-- Home -->
-
 <div class="jumbotron">
   <h2>
-    API Doc Browser
+    {{:: title}}
   </h2>
 </div>

data/lib/api_browser/app/views/layout.html

@@ -1,41 +1,8 @@
-<!-- layout -->
-<ng-include src="'views/navbar.html'"></ng-include>
+<ng-include src="'views/navbar.html'"></ng-include>
 
 <div class="container" ng-cloak>
   <div class="row">
-    <div class="col-sm-3" ng-controller="MenuCtrl">
-      <div class="sidebar">
-        <div class="row">
-          <div class="col-sm-12">
-            <p>
-              <div class="btn-group" dropdown is-open="status.isopen">
-                <button type="button" class="btn btn-success dropdown-toggle" ng-disabled="disabled">
-                  API Version: {{selectedVersion}} <span class="caret"></span>
-                </button>
-                <ul class="dropdown-menu col-sm-12" role="menu">
-                  <li ng-repeat="version in versions">
-                    <a ng-click="select(version)" dropdown-toggle>{{version}}</a>
-                  </li>
-                </ul>
-              </div>
-            </p>
-          </div>
-        </div>
-        <div class="row">
-          <div class="col-sm-12">
-            <div class="list-group">
-              <a ng-repeat="link in availableLinks()"
-                 href="{{link.stateRef}}"
-                 class="list-group-item"
-                 ng-class="{active: link.typeName == currentType}">
-                {{ link.name }}
-              </a>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-    <div class="col-sm-9" ui-view="">
-    </div>
+    <div class="col-sm-3" ng-controller="MenuCtrl" ng-include="'views/menu.html'"></div>
+    <div class="col-sm-9" ui-view=""></div>
   </div>
 </div>

data/lib/api_browser/app/views/menu.html

@@ -0,0 +1,45 @@
+<div class="sidebar fixed-if-fits hidden-print">
+  <div class="row">
+    <div class="col-sm-12">
+      <p>
+        <div class="btn-group" dropdown is-open="status.isopen">
+          <button type="button" class="btn btn-success dropdown-toggle" ng-disabled="disabled">
+            {{:: versionLabel}}: {{selectedVersion}} <span class="caret"></span>
+          </button>
+          <ul class="dropdown-menu col-sm-12" role="menu">
+            <li ng-repeat="version in versions">
+              <a ng-click="select(version)" dropdown-toggle>{{version}}</a>
+            </li>
+          </ul>
+        </div>
+      </p>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-sm-12">
+      <tabset justified="true" class="tab-list-group">
+        <tab heading="Resources" active="active.resources">
+          <div class="list-group">
+            <a ng-repeat="link in availableResources()"
+               href="{{link.stateRef}}"
+               class="list-group-item"
+               ng-hide="expandChildren && link.parent && selectedGrandfatherType != link.grandfather"
+               ng-class="{active: link.typeName == currentType, 'child-resource': link.parent, 'group-selected': selectedGrandfatherType ==  link.grandfather}">
+              {{ link.name }}
+            </a>
+          </div>
+        </tab>
+        <tab heading="Schemas" active="active.schemas">
+          <div class="list-group">
+            <a ng-repeat="link in availableOthers()"
+               href="{{link.stateRef}}"
+               class="list-group-item"
+               ng-class="{active: link.typeName == currentType}">
+              {{ link.name }}
+            </a>
+          </div>
+        </tab>
+      </tabset>
+    </div>
+  </div>
+</div>

data/lib/api_browser/app/views/navbar.html

@@ -2,7 +2,7 @@
   <div class="navbar navbar-default navbar-fixed-top" role="navigation">
     <div class="container">
       <div class="navbar-header">
-        <a class="navbar-brand" href="#">API Browser</a>
+        <a class="navbar-brand" href="#">{{:: title}}</a>
       </div>
     </div>
   </div>

data/lib/api_browser/app/views/type.html

@@ -11,7 +11,7 @@
       </h1>
     </div>
   </div>
-  <div class="row" ng-if="controllers">
+  <div class="row" ng-if="controllers.length">
     <div class="col-lg-12">
       <h3>Served by</h3>
       <ul>
@@ -21,5 +21,5 @@
       </ul>
     </div>
   </div>
-  <ng-include src="'views/type/_details.html'" />
+  <ng-include src="'views/type/details.html'" />
 </div>

data/lib/api_browser/app/views/type/{_details.html → details.html}

@@ -1,10 +1,10 @@
 <div class="row" ng-if="type">
   <div class="col-lg-12">
-    <h2>Media Type</h2>
-    <p ng-if="type.identifier"><b>Identifier: {{ type.identifier }}</b></p>
-    <p ng-if="type.description" ng-bind-html="type.description | markdown"></p>
-    
-    <rs-attribute-table attributes="type.attributes"></rs-attribute-table>
+    <h2>Schema</h2>
+    <p ng-if="type.identifier"><b>Media-type: {{ type.identifier }}</b></p>
+    <div ng-if="type.description" ng-bind-html="type.description | markdown"></div>
+
+    <attribute-table attributes="type.attributes"></attribute-table>
   </div>
 </div>
 <div class="row" ng-if="views.length">
@@ -16,7 +16,7 @@
           <div class="col-md-4">
             <h4>Attributes</h4>
             <ul>
-              <li ng-repeat="(name,value) in view.attributes">{{name}}</li>
+              <li ng-repeat="(name,value) in view.attributes">{{name}} <span class="label label-default" ng-if="value.view">rendered with {{value.view}} view</span></li>
             </ul>
           </div>
           <div class="col-md-8">

data/lib/api_browser/app/views/types/embedded/default.html

@@ -0,0 +1,10 @@
+<tr>
+  <td ng-bind-html="name | attributeName">
+  </td>
+  <td>
+    <type-placeholder template="label" type="type"></type-placeholder>
+  </td>
+  <td>
+    <attribute-description attribute="details"></attribute-description>
+  </td>
+</tr>

data/lib/api_browser/app/views/types/embedded/links.html

@@ -0,0 +1,11 @@
+<tr ng-include="'views/types/embedded/default.html'" no-container></tr>
+<tr ng-repeat="(attribute_name,attribute) in attribute.type.attributes">
+  <td ng-bind-html="name + '.' + attribute_name | attributeName">
+  </td>
+  <td>
+     <type-placeholder template="label" type="attribute.type"></type-placeholder>
+  </td>
+  <td>
+    <attribute-description attribute="attribute"></attribute-description>
+  </td>
+</tr>

data/lib/api_browser/app/views/types/embedded/struct.html

@@ -0,0 +1,2 @@
+<tr ng-include="'views/types/embedded/default.html'" no-container></tr>
+<tr type-placeholder ng-repeat="(k,v) in type.attributes" type="v.type" template="embedded" name="name + '.' + k" details="v"></tr>

data/lib/api_browser/app/views/types/label/link.html

@@ -0,0 +1 @@
+<span>Link&nbsp;[&nbsp;<a ui-sref="root.type({version: apiVersion, type: type.link_to})">{{type.link_to | resourceName}}</a>&nbsp;]</span>

data/lib/api_browser/app/views/types/label/primitive.html

@@ -0,0 +1 @@
+<span>{{type.name}}</span>

data/lib/api_browser/app/views/types/label/primitive_collection.html

@@ -0,0 +1 @@
+<span>Collection&nbsp;[&nbsp;{{type.member_attribute.type.name}}&nbsp;]</a>

data/lib/api_browser/app/views/types/label/type.html

@@ -0,0 +1 @@
+<a ui-sref="root.type({version: apiVersion, type: type.id})">{{type.name | resourceName}}</a>

data/lib/api_browser/app/views/types/label/type_collection.html

@@ -0,0 +1 @@
+<span>Collection&nbsp;[&nbsp;<a ui-sref="root.type({version: apiVersion, type: type.member_attribute.type.id})">{{type.member_attribute.type.name | resourceName}}</a>&nbsp;]</span>

data/lib/api_browser/app/views/{directives/request_body/_default.html → types/standalone/default.html}

@@ -10,7 +10,7 @@
       <tr>
         <td>{{payload.type.name}}</td>
         <td>
-          <rs-attribute-description attribute="{options:{example:payload.example,typeData:payload.type}}"></rs-attribute-description>
+          <attribute-description attribute="{options:{example:payload.example,typeData:payload.type}}"></attribute-description>
         </td>
       </tr>
     </tbody>

data/lib/api_browser/app/views/types/standalone/struct.html

@@ -0,0 +1 @@
+<attribute-table attributes="details" show-groups="true"></attribute-table>

data/lib/api_browser/bower.json

@@ -1,8 +1,9 @@
 {
   "name": "api_doc_browser",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "authors": [
-    "Euge Gimelberg <eugene@rightscale.com>"
+    "Euge Gimelberg <eugene@rightscale.com>",
+    "Jakub Hampl <jakub.hampl@rightscale.com>"
   ],
   "license": "MIT",
   "private": true,
@@ -15,17 +16,16 @@
     "tests"
   ],
   "dependencies": {
-    "angular": "~1.2.6",
+    "angular": "~1.4.0",
     "jquery": "2.1.1",
-    "lodash": "~2.4.1",
+    "lodash": "^3.7.0",
     "bootstrap-sass": "~3.0.2",
     "angular-ui-router": "~0.2.10",
-    "angular-ui-bootstrap-bower": "~0.11.0",
-    "angular-sanitize": "~1.2.16",
-    "showdown": "~0.4.0",
-    "angular-sanitize": "~1.2.16"
+    "angular-ui-bootstrap-bower": "~0.13.0",
+    "angular-sanitize": "~1.4",
+    "showdown": "~0.4.0"
   },
   "devDependencies": {
-    "angular-mocks": "~1.2.6"
+    "angular-mocks": "~1.4.0"
   }
 }

data/lib/api_browser/package.json

@@ -22,7 +22,7 @@
     "grunt-contrib-watch": "~0.5.3",
     "grunt-file-blocks": "^0.3.0",
     "grunt-filerev": "^0.2.1",
-    "grunt-ngmin": "0.0.3",
+    "grunt-ng-annotate": "^0.10.0",
     "grunt-sass": "^0.18.0",
     "grunt-usemin": "^2.1.1",
     "grunt-wiredep": "^1.7.0",

data/lib/praxis.rb

@@ -26,6 +26,7 @@ module Praxis
   autoload :Callbacks, 'praxis/callbacks'
   autoload :Dispatcher, 'praxis/dispatcher'
   autoload :ErrorHandler, 'praxis/error_handler'
+  autoload :ValidationHandler, 'praxis/validation_handler'
   autoload :Exception, 'praxis/exception'
   autoload :FileGroup,'praxis/file_group'
   autoload :Plugin, 'praxis/plugin'
@@ -49,7 +50,9 @@ module Praxis
 
   # types
   module Types
+    autoload :FuzzyHash, 'praxis/types/fuzzy_hash'
     autoload :MediaTypeCommon, 'praxis/types/media_type_common'
+    autoload :MultipartArray, 'praxis/types/multipart_array'
   end
 
   autoload :Links, 'praxis/links'
@@ -77,12 +80,9 @@ module Praxis
     autoload :Validation, 'praxis/exceptions/validation'
   end
 
-  # Avoid loading responses (and templates) lazily as they need to be registered in time
-  require 'praxis/responses/http'
-  require 'praxis/responses/internal_server_error'
-  require 'praxis/responses/validation_error'
 
   module Handlers
+    autoload :Plain, 'praxis/handlers/plain'
     autoload :JSON, 'praxis/handlers/json'
     autoload :WWWForm, 'praxis/handlers/www_form'
     autoload :XML, 'praxis/handlers/xml'
@@ -112,4 +112,10 @@ module Praxis
     autoload :Response, 'praxis/request_stages/response'
   end
 
+  # Avoid loading responses (and templates) lazily as they need to be registered in time
+  require 'praxis/responses/http'
+  require 'praxis/responses/internal_server_error'
+  require 'praxis/responses/validation_error'
+  require 'praxis/responses/multipart_ok'
+
 end

data/lib/praxis/action_definition.rb

@@ -49,10 +49,10 @@ module Praxis
       version = resource_definition.version
       api_info = ApiDefinition.instance.info(resource_definition.version)
 
-      version_prefix = "#{api_info.base_path}#{resource_definition.version_prefix}"
-      prefix = Array(resource_definition.prefix)
+      route_base = "#{api_info.base_path}#{resource_definition.version_prefix}"
+      prefix = Array(resource_definition.routing_prefix)
 
-      @routing_config = RoutingConfig.new(version: version, base: version_prefix, prefix: prefix)
+      @routing_config = RoutingConfig.new(version: version, base: route_base, prefix: prefix)
 
       resource_definition.traits.each do |trait|
         self.trait(trait)
@@ -79,7 +79,17 @@ module Praxis
       attribute.type.attributes(options, &block)
     end
 
-    def response(name, **args)
+    def response(name, type=nil, **args, &block)
+      if type
+        # should verify type is a media type
+        
+        if block_given?
+          type = type.construct(block)
+        end
+
+        args[:media_type] = type
+      end
+
       template = ApiDefinition.instance.response(name)
       @responses[name] = template.compile(self, **args)
     end
@@ -141,6 +151,8 @@ module Praxis
         @headers = create_attribute(type,
                                     dsl_compiler: HeadersDSLCompiler, case_insensitive_load: true,
                                     **opts, &block)
+
+        @headers
       end
       @precomputed_header_keys_for_rack = nil #clear memoized data
     end

data/lib/praxis/action_definition/headers_dsl_compiler.rb

@@ -11,7 +11,11 @@ module Praxis
       #                     required: true             => to make it required
       #                     description: "lorem ipsum" => to describe it (like any other attribute)
 
-      def header(name, val=nil, **options )
+      def header(name, val=nil, **options)
+        if val.kind_of?(Class)
+          return key name, val, **options  
+        end
+
         case val
         when Regexp
           options[:regexp] = val
@@ -21,7 +25,6 @@ module Praxis
           # Defining the existence without any other options can only mean that it is required (otherwise it is a useless definition)
           options[:required] = true if options.empty?
         end
-        #orig_attribute name.upcase , String, options
         key name , String, options
       end
 

data/lib/praxis/api_definition.rb

@@ -12,6 +12,8 @@ module Praxis
     attr_reader :infos
     attr_reader :global_info
 
+    attr_accessor :versioning_scheme
+
     def self.define(&block)
       if block.arity == 0
         self.instance.instance_eval(&block)
@@ -28,7 +30,7 @@ module Praxis
       @global_info = ApiGeneralInfo.new
 
       @infos = Hash.new do |hash, version|
-        hash[version] = ApiGeneralInfo.new(@global_info)
+        hash[version] = ApiGeneralInfo.new(@global_info, version: version)
       end
     end