praxis 0.21 → 2.0.pre.3

data/CONTRIBUTING.md

@@ -5,7 +5,7 @@ know if anything feels wrong or incomplete.
 
 ## Reporting Issues
 
-When reporting [issues](https://github.com/rightscale/praxis/issues) on GitHub,
+When reporting [issues](https://github.com/praxis/praxis/issues) on GitHub,
 remember to include your Ruby version.
 
 Please also include the steps required to reproduce the problem if possible and
@@ -45,8 +45,8 @@ everything for everybody. This means that we might decide against incorporating
 a new feature. However, there might be a way to implement that feature *on top
 of* Praxis.
 
-If you want to work on something that we have already reviewed and prepared, 
-checkout the *Ready* column on our [Waffle board](https://waffle.io/rightscale/praxis).
+If you want to work on something that we have already reviewed and prepared,
+checkout the *Ready* column on our [Waffle board](https://waffle.io/praxis/praxis).
 
 ### Discuss your design on the mailing list
 
@@ -60,7 +60,7 @@ is working on the same thing.
 ### Create issues...
 
 Any significant improvement should be documented as [a GitHub
-issue](https://github.com/rightscale/praxis/issues) before anybody starts
+issue](https://github.com/praxis/praxis/issues) before anybody starts
 working on it.
 
 ### ...but check for existing issues first!

data/README.md

@@ -1,11 +1,13 @@
-# Praxis [![TravisCI][travis-img-url]][travis-ci-url] [![Coverage Status][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url]
+# Praxis [![TravisCI][travis-img-url]][travis-ci-url] [![Coverage Status][coveralls-img-url]][coveralls-url] 
 
-[travis-img-url]: https://travis-ci.org/rightscale/praxis.svg?branch=master
-[travis-ci-url]:https://travis-ci.org/rightscale/praxis
-[coveralls-img-url]:https://coveralls.io/repos/rightscale/praxis/badge.svg?branch=master&service=github
-[coveralls-url]:https://coveralls.io/github/rightscale/praxis?branch=master
-[gemnasium-img-url]:https://gemnasium.com/rightscale/praxis.svg
-[gemnasium-url]:https://gemnasium.com/rightscale/praxis
+[//]: # ( COMMENTED OUT UNTIL GEMNASIUM CAN SEE THE REPOS: [![Dependency Status][gemnasium-img-url]][gemnasium-url])
+
+[travis-img-url]: https://travis-ci.org/praxis/praxis.svg?branch=master
+[travis-ci-url]:https://travis-ci.org/praxis/praxis
+[coveralls-img-url]:https://coveralls.io/repos/github/praxis/praxis/badge.svg?branch=master
+[coveralls-url]:https://coveralls.io/github/praxis/praxis?branch=master
+[gemnasium-img-url]:https://gemnasium.com/praxis/praxis.svg
+[gemnasium-url]:https://gemnasium.com/praxis/praxis
 
 Praxis is a framework for both _designing_ and _implementing_ APIs.
 
@@ -33,7 +35,7 @@ bundle
 rackup
 ```
 
-Or better yet, checkout a simple, but functional [blog example app](https://github.com/rightscale/praxis-example-app) which showcases a few of the main design and implementation aspects that Praxis has to offer.
+Or better yet, checkout a simple, but functional [blog example app](https://github.com/praxis/praxis-example-app) which showcases a few of the main design and implementation aspects that Praxis has to offer.
 
 
 ## Mailing List
@@ -52,7 +54,7 @@ And follow us on twitter: [@praxisapi](http://twitter.com/praxisapi)
 
 ## Contributions
 Contributions to make Praxis better are welcome. Please refer to
-[CONTRIBUTING](https://github.com/rightscale/praxis/blob/master/CONTRIBUTING.md)
+[CONTRIBUTING](https://github.com/praxis/praxis/blob/master/CONTRIBUTING.md)
 for further details on what contributions are accepted and how to go about
 contributing.
 

data/lib/api_browser/app/js/directives/attribute_table.js

@@ -8,7 +8,8 @@ app.directive('attributeTable', function() {
     templateUrl: 'views/directives/attribute_table.html',
     scope: {
       attributes: '=',
-      showGroups: '='
+      showGroups: '=',
+      parentRequirements: '='
     },
     link: function(scope) {
       scope.groups = [{attributes: []}];

data/lib/api_browser/app/js/directives/conditional_requirements.js

@@ -0,0 +1,13 @@
+app.directive('conditionalRequirements', function() {
+  return {
+    restrict: 'E',
+    scope: {
+      requirements: '=',
+    },
+    templateUrl: 'views/types/embedded/requirements.html',
+    link: function(scope, element, attrs) {
+      // Reject requirements of type "all"
+      scope.condRequirements = _.reject(scope.requirements, {type: 'all'});
+    }
+  };
+});

data/lib/api_browser/app/js/directives/type_placeholder.js

@@ -9,10 +9,19 @@ app.directive('typePlaceholder', function(templateFor, $stateParams) {
       type: '=',
       template: '@',
       details: '=?',
-      name: '=?'
+      name: '=?',
+      parentRequirements: '=?',
     },
     link: function(scope, element) {
+
       scope.apiVersion = $stateParams.version;
+
+      if( typeof scope.parentRequirements === 'undefined' ){
+        if( typeof scope.type.requirements !== 'undefined' && scope.type.requirements.length > 0 ){
+          scope.parentRequirements = scope.type.requirements;
+        }
+      }
+
       templateFor(scope.type, scope.template).then(function(templateFn) {
         element.replaceWith(templateFn(scope));
       });

data/lib/api_browser/app/js/factories/normalize_attributes.js

@@ -6,8 +6,10 @@ app.factory('normalizeAttributes', function() {
       if (attribute.values != null) attribute.options.values = attribute.values;
       if (attribute.default != null) attribute.options.default = attribute.default;
       if (attribute.example != null) attribute.options.example = attribute.example;
-      if (attribute.type && attribute.type.attributes) {
-        normalize(type, attribute.type.attributes, path);
+      if ( attribute.type.attributes ) {
+        normalize(attribute.type, attribute.type.attributes, path);
+      }else if( attribute.type.member_attribute ){
+        normalize(attribute.type.member_attribute.type, attribute.type.member_attribute.type.attributes, path);
       }
     });
   }

data/lib/api_browser/app/js/factories/template_for.js

@@ -56,6 +56,8 @@ app.provider('templateFor', function() {
       switch ($family) {
         case 'hash':
           return 'views/types/embedded/struct.html';
+        case 'array':
+          return 'views/types/embedded/array.html';
         default:
           return 'views/types/embedded/default.html';
       }
@@ -66,7 +68,7 @@ app.provider('templateFor', function() {
     'ngInject';
     if ($requestedTemplate === 'label') {
       if ( $typeDefinition.member_attribute !== undefined) {
-        if ($typeDefinition.member_attribute.anonymous || _.contains(primitives, $typeDefinition.name)) {
+        if ($typeDefinition.member_attribute.anonymous || _.contains(primitives, $typeDefinition.member_attribute.type.name)) {
           return 'views/types/label/primitive_collection.html';
         } else{
           return 'views/types/label/type_collection.html';
@@ -121,5 +123,6 @@ app.provider('templateFor', function() {
   'Integer',
   'Object',
   'String',
-  'Struct'
+  'Struct',
+  'URI'
 ]);

data/lib/api_browser/app/js/filters/has_requirement.js

@@ -0,0 +1,14 @@
+app.filter('hasRequirement', function() {
+  return function(parent_reqs, attr_name) {
+    var name = _.last(attr_name.split('.'));
+    var groups=[]
+    if( parent_reqs.length > 0 ){
+      _.each(parent_reqs, function(reqdef) {
+        if( reqdef.attributes.includes(name) ){
+          groups.push(reqdef.type);
+        }
+      });
+    }
+    return groups;
+  };
+});

data/lib/api_browser/app/js/filters/tag_requirement.js

@@ -0,0 +1,13 @@
+app.filter('tagRequirement', function() {
+  return function(groups) {
+    if ( typeof groups === 'undefined' || groups.length == 0 ) {
+      return "";
+    }else if (groups.includes('all') ) {
+      var title = "required attribute";
+      return "<span class='required-attribute-mark' title=\""+title+"\" >*</span>"
+    } else {
+      var title = "conditionally required";
+      return"<span class='conditional-attribute-mark' title=\""+title+"\" >*</span>"
+    }
+  };
+});

data/lib/api_browser/app/sass/praxis.scss

@@ -31,6 +31,17 @@
   color: #aaa;
 }
 
+.required-attribute-mark {
+  color: red;
+  font-weight: bold;
+}
+
+.conditional-attribute-mark {
+  color: orange;
+  font-weight: bold;
+}
+
+
 .attribute-table {
   div[class*='col-'] {
     padding: $table-cell-padding;

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

@@ -26,14 +26,14 @@
   <div class="row" ng-if="action.params.type.attributes">
     <div class="col-lg-12">
       <h2>Request Parameters</h2>
-      <type-placeholder details="action.params.type.attributes" type="action.params.type" template="standalone"></type-placeholder>
+      <type-placeholder details="action.params.type.attributes" type="action.params.type" template="standalone" parent-requirements="action.params.type.requirements"></type-placeholder>
     </div>
   </div>
 
   <div class="row" ng-if="action.payload.type">
     <div class="col-lg-12">
       <h2>Request Body</h2>
-      <type-placeholder type="action.payload.type" template="standalone" details="action.payload.type.attributes"></type-placeholder>
+      <type-placeholder type="action.payload.type" template="standalone" details="action.payload.type.attributes" parent-requirements="action.payload.type.requirements"></type-placeholder>
     </div>
   </div>
 

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

@@ -1,4 +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>
+  <attribute-description attribute="{options: row.value, description: '<em>These settings apply to each element of the collection:</em>'}"></attribute-description>
 </dd>

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

@@ -11,7 +11,7 @@
       <tr ng-if="g.name && g.attributes.length">
         <th colspan="3">{{g.name}}</th>
       </tr>
-      <tr type-placeholder ng-repeat="item in g.attributes" type="item.type" template="embedded" name="item.name" details="item"></tr>
+      <tr type-placeholder ng-repeat="item in g.attributes" type="item.type" template="embedded" name="item.name" details="item" parent-requirements="parentRequirements"></tr>
     </tbody>
   </table>
 </div>

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

@@ -2,5 +2,5 @@
   <div ng-if="error" class="alert alert-danger">
     <p>The requested type could not be found.</p>
   </div>
-  <type-placeholder type="type" template="main" details="type.attributes"></type-placeholder>
+  <type-placeholder type="type" template="main" details="type.attributes" parent-requirements="type.requirements"></type-placeholder>
 </div>

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

@@ -5,9 +5,9 @@
       <p ng-if="type.identifier"><b>Media-type identifier: {{ type.identifier }}</b></p>
       <div ng-if="type.description" ng-bind-html="type.description | markdown"></div>
 
-      <attribute-table attributes="type.attributes"></attribute-table>
+      <attribute-table attributes="type.attributes" parent-requirements="type.requirements"></attribute-table>
     </div>
-    <div ng-if="type.attributes === undefined" type-placeholder type="type" template="standalone" name="type.name" details="type"></div>
+    <div ng-if="type.attributes === undefined" type-placeholder type="type" template="standalone" name="type.name" details="type" parent-requirements="type.requirements"></div>
   </div>
 </div>
 <div class="row" ng-if="views.length">

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

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

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

@@ -1,8 +1,10 @@
 <tr>
-  <td ng-bind-html="name | attributeName">
+  <td>
+    <span ng-bind-html="name | attributeName"></span>
   </td>
   <td>
     <type-placeholder template="label" type="type"></type-placeholder>
+    <span ng-bind-html="parentRequirements| hasRequirement:name | tagRequirement"></span>
   </td>
   <td>
     <attribute-description attribute="details"></attribute-description>

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

@@ -0,0 +1,6 @@
+<div ng-if="condRequirements.length > 0">
+<p style='text-indent: 20px;margin-bottom: 0px'><em>its attributes must satisfy the following conditions:</em></p>
+  <ul>
+  <li ng-repeat="req in condRequirements" ng-include="'views/types/embedded/single_req.html'"></li>
+</ul>
+</div>

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

@@ -0,0 +1,9 @@
+<p style='margin-bottom: 0px' ng-if="req.type == 'most'">
+  <em>at most {{req.count}} of:</em> <span ng-bind-html="req.attributes.join(', ')"></span>
+</p>
+<p style='margin-bottom: 0px' ng-if="req.type == 'least'">
+  <em>at least {{req.count}} of:</em> <span ng-bind-html="req.attributes.join(', ')"></span>
+</p>
+<p style='margin-bottom: 0px' ng-if="req.type == 'exactly'">
+  <em>exactly {{req.count}} of:</em> <span ng-bind-html="req.attributes.join(', ')"></span>
+</p>

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

@@ -1,2 +1,14 @@
-<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>
+<tr>
+  <td>
+    <span ng-bind-html="name | attributeName"></span>
+    <conditional-requirements requirements='type.requirements'></conditional-requirements>
+  </td>
+  <td>
+    <type-placeholder template="label" type="type"></type-placeholder>
+    <span ng-bind-html="parentRequirements | hasRequirement:name | tagRequirement"></span>
+  </td>
+  <td>
+    <attribute-description attribute="details"></attribute-description>
+  </td>
+</tr>
+<tr type-placeholder ng-repeat="(k,v) in type.attributes" type="v.type" template="embedded" name="name + '.' + k" details="v" parent-requirements="type.requirements"></tr>

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

@@ -1,3 +1,3 @@
 <p>A Collection of:</p>
 
-<type-placeholder type="type.member_attribute.type" template="standalone" details="type.member_attribute.type.attributes"></type-placeholder>
+<type-placeholder type="type.member_attribute.type" template="standalone" details="type.member_attribute.type.attributes" parent-requirements="type.member_attribute.type.requirements"></type-placeholder>

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

@@ -1 +1,2 @@
-<attribute-table attributes="details" show-groups="true"></attribute-table>
+<attribute-table attributes="details" show-groups="false" parent-requirements="parentRequirements"></attribute-table>
+<conditional-requirements requirements="parentRequirements "></conditional-requirements>

data/lib/api_browser/package.json

@@ -2,7 +2,7 @@
   "name": "api_doc_browser",
   "version": "0.13.0",
   "description": "Praxis API Browser app",
-  "repository": "https://github.com/rightscale/praxis",
+  "repository": "https://github.com/praxis/praxis",
   "private": true,
   "scripts": {
     "test": "node_modules/.bin/grunt ci"

data/lib/praxis.rb

@@ -1,9 +1,10 @@
 require 'rack'
 require 'attributor'
-require 'praxis-mapper'
 require 'praxis-blueprints'
 
 require 'active_support/concern'
+require 'praxis/request_superclassing'
+require 'active_support/inflector'
 
 $:.unshift File.dirname(__FILE__)
 
@@ -43,7 +44,6 @@ module Praxis
   autoload :Stage, 'praxis/stage'
   autoload :Trait, 'praxis/trait'
 
-  autoload :Stats, 'praxis/stats'
   autoload :Notifications, 'praxis/notifications'
   autoload :MiddlewareApp, 'praxis/middleware_app'
 
@@ -62,7 +62,6 @@ module Praxis
 
   autoload :Links, 'praxis/links'
   autoload :MediaType, 'praxis/media_type'
-  autoload :MediaTypeCollection, 'praxis/media_type_collection'
   autoload :MediaTypeIdentifier, 'praxis/media_type_identifier'
   autoload :Multipart, 'praxis/types/multipart'
   autoload :Collection, 'praxis/collection'
@@ -89,6 +88,8 @@ module Praxis
     autoload :MapperSelectors, 'praxis/extensions/mapper_selectors'
     autoload :Rendering, 'praxis/extensions/rendering'
     autoload :FieldExpansion, 'praxis/extensions/field_expansion'
+    autoload :ActiveRecordFilterQueryBuilder, 'praxis/extensions/attribute_filtering/active_record_filter_query_builder'
+    autoload :SequelFilterQueryBuilder, 'praxis/extensions/attribute_filtering/sequel_filter_query_builder'
   end
 
   module Handlers
@@ -122,6 +123,11 @@ module Praxis
     autoload :Response, 'praxis/request_stages/response'
   end
 
+  module Mapper
+    autoload :Resource, 'praxis/mapper/resource'
+    autoload :SelectorGenerator, 'praxis/mapper/selector_generator'
+  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'

data/lib/praxis/action_definition.rb

@@ -76,7 +76,7 @@ module Praxis
 
     def update_attribute(attribute, options, block)
       attribute.options.merge!(options)
-      attribute.type.attributes(options, &block)
+      attribute.type.attributes(**options, &block)
     end
 
     def response(name, type=nil, **args, &block)

data/lib/praxis/action_definition/headers_dsl_compiler.rb

@@ -25,7 +25,7 @@ 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
-        key name , String, options
+        key name , String, **options
       end
 
       # Override the attribute to really call "key" in the hash (for temporary backwards compat)      

data/lib/praxis/application.rb

@@ -74,14 +74,6 @@ module Praxis
       @builder.run(@router)
       @app = @builder.to_app
 
-      Notifications.subscribe 'rack.request.all'.freeze do |name, start, finish, _id, payload|
-        duration = (finish - start) * 1000
-        Stats.timing(name, duration)
-
-        status, _, _ = payload[:response]
-        Stats.increment "rack.request.#{status}"
-      end
-
       self
     end
 
@@ -122,7 +114,7 @@ module Praxis
 
     def config(key=nil, type=Attributor::Struct, **opts, &block)
       if block_given? || (type==Attributor::Struct && !opts.empty? )
-        @config.define(key, type, opts, &block)
+        @config.define(key, type, **opts, &block)
       else
         @config.get
       end

data/lib/praxis/bootloader.rb

@@ -47,7 +47,6 @@ module Praxis
       stages << BootloaderStages::WarnUnloadedFiles.new(:warn_unloaded_files, application)
 
       after(:app) do
-        Praxis::Mapper.finalize!
         Praxis::Blueprint.finalize!
         Praxis::ResourceDefinition.finalize!
       end
@@ -112,10 +111,8 @@ module Praxis
     end
 
     def setup!
-      # use the Stats and Notifications plugins by default
-      use Praxis::Stats
+      # use the Notifications plugin by default
       use Praxis::Notifications
-
       run
     end
 

data/lib/praxis/config.rb

@@ -54,7 +54,7 @@ module Praxis
             )
           end
           top.options.merge!(opts)
-          top.type.attributes(opts, &block)
+          top.type.attributes(**opts, &block)
         else
           @attribute.attributes[key] = Attributor::Attribute.new(type, opts, &block)
         end