praxis 0.13.0 → 0.14.0

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

@@ -12,7 +12,7 @@
       <p ng-repeat="url in action.urls">
         {{ url.verb }} {{ url.path }}
       </p>
-      <p>{{ action.description }}</p>
+      <p ng-bind-html="action.description | markdown"></p>
     </div>
   </div>
 
@@ -65,7 +65,7 @@
                 {{response.name}}
               </td>
               <td>
-                {{response.media_type.name || response.media_type.identifier}}
+                {{response.media_type.id || response.media_type.identifier}}
               </td>
               <td>
                 <rs-attribute-description attribute="response"></rs-attribute-description>

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

@@ -7,9 +7,9 @@
   <div class="row">
     <div class="col-lg-12">
       <h1 class="page-header">
-        {{ controllerName | resourceName }}
+        {{ controller.name | resourceName }}
       </h1>
-      <p>{{ controller.description }}</p>
+       <p ng-bind-html="controller.description | markdown"></p>
     </div>
   </div>
   <div class="row" ng-if="controller.actions.length">

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

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

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

@@ -1,19 +1,10 @@
 <!-- layout -->
-
-<div class="header">
-  <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>
-      </div>
-    </div>
-  </div>
-</div>
+<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 affix">
+      <div class="sidebar">
         <div class="row">
           <div class="col-sm-12">
             <p>

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

@@ -0,0 +1,9 @@
+<div class="header">
+  <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>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/api_browser/app/views/resource/_actions.html

@@ -19,7 +19,7 @@
           </div>
         </td>
         <td style="font-size: 110%;">
-          {{ action.description }}
+          <p ng-bind-html="action.description | markdown"></p>
         </td>
       </tr>
     </tbody>

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

@@ -7,7 +7,7 @@
   <div class="row">
     <div class="col-lg-12">
       <h1>
-        {{ typeName | resourceName }}
+        {{ type.name | resourceName }}
       </h1>
     </div>
   </div>
@@ -16,7 +16,7 @@
       <h3>Served by</h3>
       <ul>
         <li ng-repeat="controller in controllers">
-          <a ui-sref="root.controller({version: apiVersion, controller: controller.controller})">{{ controller.controller | resourceName }}</a>
+          <a ui-sref="root.controller({version: apiVersion, controller: controller.controller})">{{ controller.name | resourceName }}</a>
         </li>
       </ul>
     </div>

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

@@ -2,7 +2,8 @@
   <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">{{type.description}}</p>
+    <p ng-if="type.description" ng-bind-html="type.description | markdown"></p>
+    
     <rs-attribute-table attributes="type.attributes"></rs-attribute-table>
   </div>
 </div>

data/lib/api_browser/bower.json

@@ -21,6 +21,11 @@
     "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"
+  },
+  "devDependencies": {
+    "angular-mocks": "~1.2.6"
   }
 }

data/lib/api_browser/package.json

@@ -1,15 +1,18 @@
 {
   "name": "api_doc_browser",
-  "version": "0.0.0",
-  "description": "",
+  "version": "0.13.0",
+  "description": "Praxis API Browser app",
+  "repository": "https://github.com/rightscale/praxis",
+  "private": true,
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node_modules/.bin/grunt ci"
   },
   "author": "",
   "license": "BSD",
-  "devDependencies": {
+  "dependencies": {
     "grunt": "~0.4.2",
     "grunt-angular-templates": "^0.5.5",
+    "grunt-cli": "^0.1.13",
     "grunt-contrib-clean": "^0.5.0",
     "grunt-contrib-concat": "^0.4.0",
     "grunt-contrib-connect": "^0.7.1",
@@ -20,11 +23,19 @@
     "grunt-file-blocks": "^0.3.0",
     "grunt-filerev": "^0.2.1",
     "grunt-ngmin": "0.0.3",
-    "grunt-sass": "^0.12.1",
+    "grunt-sass": "^0.17.0",
     "grunt-usemin": "^2.1.1",
     "grunt-wiredep": "^1.7.0",
-    "load-grunt-tasks": "^0.4.0",
-    "requirejs": "^2.1.13",
+    "load-grunt-tasks": "^0.4.0"
+  },
+  "devDependencies": {
+    "grunt-contrib-jshint": "^0.11.0",
+    "grunt-karma": "^0.10.1",
+    "jasmine-core": "^2.2.0",
+    "karma": "^0.12.31",
+    "karma-jasmine": "^0.3.5",
+    "karma-phantomjs-launcher": "^0.1.4",
+    "quick_check": "^0.4.2",
     "time-grunt": "^0.3.1"
   }
 }

data/lib/praxis.rb

@@ -28,6 +28,7 @@ end
 module Praxis
 
   autoload :ActionDefinition, 'praxis/action_definition'
+  autoload :ApiGeneralInfo, 'praxis/api_general_info'
   autoload :ApiDefinition, 'praxis/api_definition'
   autoload :Application, 'praxis/application'
   autoload :Bootloader, 'praxis/bootloader'
@@ -53,15 +54,19 @@ module Praxis
 
   autoload :Stats, 'praxis/stats'
   autoload :Notifications, 'praxis/notifications'
-  
+
   autoload :RestfulDocGenerator, 'praxis/restful_doc_generator'
-  
+
   # types
+  module Types
+    autoload :MediaTypeCommon, 'praxis/types/media_type_common'
+  end
+
   autoload :Links, 'praxis/links'
   autoload :MediaType, 'praxis/media_type'
   autoload :MediaTypeCollection, 'praxis/media_type_collection'
   autoload :Multipart, 'praxis/types/multipart'
-  autoload :Collection, 'praxis/types/collection'
+  autoload :Collection, 'praxis/collection'
 
   autoload :MultipartParser, 'praxis/multipart/parser'
   autoload :MultipartPart, 'praxis/multipart/part'

data/lib/praxis/action_definition.rb

@@ -21,7 +21,7 @@ module Praxis
     attr_reader :metadata
 
     class << self
-      attr_accessor :doc_decorations      
+      attr_accessor :doc_decorations
     end
 
     @doc_decorations = []
@@ -35,9 +35,10 @@ module Praxis
       @resource_definition = resource_definition
       @responses = Hash.new
       @metadata = Hash.new
+      @routes = []
 
       if (media_type = resource_definition.media_type)
-        if media_type.kind_of?(Class) && media_type < Praxis::MediaType
+        if media_type.kind_of?(Class) && media_type < Praxis::Types::MediaTypeCommon
           @reference_media_type = media_type
         end
       end
@@ -104,13 +105,14 @@ module Praxis
       end
     end
 
-    def headers(type=Attributor::Hash.of(key:String), **opts, &block)
+    def headers(type=nil, **opts, &block)
       return @headers unless block
       if @headers
         update_attribute(@headers, opts, block)
       else
+        type = Attributor::Hash.of(key:String) unless type
         @headers = create_attribute(type,
-          dsl_compiler: HeadersDSLCompiler, case_insensitive_load: true, 
+          dsl_compiler: HeadersDSLCompiler, case_insensitive_load: true,
           **opts, &block)
       end
       @precomputed_header_keys_for_rack = nil #clear memoized data
@@ -128,7 +130,7 @@ module Praxis
         end
       end
     end
-    
+
 
     def routing(&block)
       routing_config = Skeletor::RestfulRoutingConfig.new(name, resource_definition, &block)
@@ -156,7 +158,9 @@ module Praxis
         # FIXME: change to :routes along with api browser
         hash[:urls] = routes.collect(&:describe)
         hash[:headers] = headers.describe if headers
-        hash[:params] = params.describe if params
+        if params
+          hash[:params] = params_description
+        end
         hash[:payload] = payload.describe if payload
         hash[:responses] = responses.inject({}) do |memo, (response_name, response)|
           memo[response.name] = response.describe
@@ -168,6 +172,24 @@ module Praxis
       end
     end
 
+    def params_description
+      route_params = primary_route.path.
+        named_captures.
+        keys.
+        collect(&:to_sym)
+
+      desc = params.describe
+      desc[:type][:attributes].keys.each do |k|
+        source = if route_params.include? k
+          'url'
+        else
+          'query'
+        end
+        desc[:type][:attributes][k][:source] = source          
+      end
+      desc
+    end
+
     def nodoc!
       metadata[:doc_visibility] = :none
     end

data/lib/praxis/api_definition.rb

@@ -9,6 +9,7 @@ module Praxis
 
     attr_reader :traits
     attr_reader :responses
+    attr_reader :infos
 
     def self.define(&block)
       if block.arity == 0
@@ -18,10 +19,12 @@ module Praxis
       end
     end
 
-
     def initialize
       @responses = Hash.new
       @traits = Hash.new
+      @infos = Hash.new do |hash, version|
+          hash[version] = ApiGeneralInfo.new
+      end
     end
 
     def response_template(name, &block)
@@ -41,7 +44,32 @@ module Praxis
       self.traits[name] = block
     end
 
-
+    # Setting info to the nil version, means setting it for all versions (if they don't  override them)
+    def info( version=nil, &block)
+      i = @infos[version]
+      i.instance_eval(&block)
+      i
+    end
+    
+    def describe
+      global_info = @infos[nil].describe
+      data = Hash.new do |hash, version|
+        hash[version] = Hash.new
+      end
+      # Fill in the "info" portion
+      @infos.each do |version,info|
+        next unless version
+        info_hash = global_info.merge(info.describe)
+        [:name, :title].each do |attr|
+          raise "Error: API Global information for version '#{version}' does not have '#{attr}' defined. " unless info_hash.key? attr
+        end
+        data[version][:info] = info_hash
+      end
+      
+      # Maybe report the traits?...or somehow the registered response_templates ...
+      data
+    end
+    
     define do |api|
       api.response_template :ok do |media_type: |
         media_type media_type

data/lib/praxis/api_general_info.rb

@@ -0,0 +1,36 @@
+module Praxis
+  class ApiGeneralInfo
+        
+    def name(val=nil)
+      return @name unless val
+      @name = val
+    end
+
+    def title(val=nil)
+      return @title unless val
+      @title = val
+    end
+
+    def description(val=nil)
+      return @description unless val
+      @description = val
+    end
+
+    def base_path(val=nil)
+      return @base_path unless val
+      @base_path = val
+    end
+        
+    def describe
+      hash = { schema_version: "1.0".freeze }
+
+      [:name, :title, :description, :base_path].each do |attr|
+        val = self.__send__(attr) 
+        hash[attr] = val unless val.nil?
+      end
+      hash
+    end      
+        
+  end
+  
+end

data/lib/praxis/bootloader.rb

@@ -114,6 +114,7 @@ module Praxis
 
     def run
       stages.each do |stage|
+        stage.setup!
         stage.run
       end
     end

data/lib/praxis/collection.rb

@@ -0,0 +1,34 @@
+module Praxis
+ class Collection < Attributor::Collection
+    include Types::MediaTypeCommon
+
+    def self.of(type)
+      if defined?(type::Collection)
+        return type::Collection
+      end
+
+      klass = super
+
+      if type < Praxis::Types::MediaTypeCommon
+        unless type.identifier.nil?
+          klass.identifier(type.identifier + ';type=collection')
+        end
+
+        type.const_set :Collection, klass
+      else
+        warn "DEPRECATION: Praxis::Collection.of() for non-MediaTypes will be unsupported in 1.0. Use Attributor::Collection.of() instead."
+        Attributor::Collection.of(type)
+      end
+
+    end
+
+    def self.member_type(type=nil)
+      unless type.nil?
+        @member_type = type
+      end
+
+      @member_type
+    end
+
+  end
+end

data/lib/praxis/controller.rb

@@ -22,6 +22,10 @@ module Praxis
         definition.controller = self
         Application.instance.controllers << self
       end
+      
+      def id
+        self.name.gsub('::'.freeze,'-'.freeze)
+      end
     end
 
     def initialize(request, response=Responses::Ok.new)
@@ -29,5 +33,8 @@ module Praxis
       @response = response
     end
 
+    def definition
+      self.class.definition
+    end
   end
 end

data/lib/praxis/dispatcher.rb

@@ -43,6 +43,9 @@ module Praxis
       @stages << RequestStages::Validate.new(:validate, self)
       @stages << RequestStages::Action.new(:action, self)
       @stages << RequestStages::Response.new(:response, self)
+      @stages.each do |s|
+        s.setup!
+      end
       setup_deferred_callbacks!
     end