praxis 0.21 → 0.22.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0a0928d3b9a59294d32767a333b73c03a0a7955
-  data.tar.gz: 840261c0c55f18280f3c32d53a62053ed8582834
+SHA256:
+  metadata.gz: c479acc3992139388b14120b7a76dde37e828ea034484786507f5a9b3fbb773f
+  data.tar.gz: 87a961f20eb8b758584306fa1082a72c79432ca897fa6c5d4b3716f251defa02
 SHA512:
-  metadata.gz: 2c7d30737b31ec8204e030ca43577d8a4620b4a16ee3f9ec00c40ef740f08db8c7c21d9bc1d06dc7ddc56e2223dc0f9aaa990526a6f92f7297493dcf02158c11
-  data.tar.gz: b1e794d55ef40a616c21adeb8a72cea53b796e4a943636c5a16a576f282298c6f573b730f708ab2a0bbb050784c56c3b1fe53f760488c3100d98958a2b50f6eb
+  metadata.gz: bcebeae7aa1dba132dbf3a28a9d14b359189f37a604817a7bba0ef1e4c1c9bffd9a89ab1bad553b6c4dbcccb53a362cc89ba1c3bdaf90f71adbf34f91e6d95ec
+  data.tar.gz: 4d5c5600fb77f9e26384640a2b562fba88a63151e34f6d277a521e51661b3212a62c7d5f92a372f4bef95cbae4f39372970e0b9ffc2c94d819f9441c54d7ea2a

data/.travis.yml

@@ -2,19 +2,27 @@ language: ruby
 cache: bundler
 sudo: false
 rvm:
-  - 2.2.5
-  - 2.3.1
-node_js:
-  - "0.10"
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 branches:
   only:
     - master
 before_install:
-  - cd lib/api_browser
-  - npm install
-  - cd ../..
-script:
-  - bundle exec rspec spec
-  - cd lib/api_browser
-  - npm test
-  - cd ../..
+  - gem update --system # Due to: https://github.com/travis-ci/travis-ci/issues/8978
+# Leaving all API browser testing commented out as there are some very node dependencies that
+# need to be worked out and updated
+# node_js:
+#   - "0.10"
+# before_install:
+#   - nvm install 0.10
+#   - node --version
+#   - cd lib/api_browser
+#   - npm install
+#   - cd ../..
+# script:
+#   - bundle exec rspec spec
+#   - cd lib/api_browser
+#   - npm test
+#   - cd ../..

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## next
 
+* Builds an initial Rails embeddability/compatibility set of functions and helpers:
+  * Refactored dispatcher methods so that instrumentation can be easily added on (but without building a flexible hook system that might decrease the performance)
+  * Change `Praxis:Request` super classing to be definable by a module setter
+      * Make `rails_compat/request_methods` to use it.
+  * Built `rails_compat` extension. Which for now only:
+    * changes `Praxis:Request` to derive from `ActionDispatch::Request`
+    * Will load the RailsPlugin code
+  * Built a `RailsPlugin` plugin which, for now, will:
+    * emulate firing off the `action_controller` basic hooks (`start_processing` and `process_action`).
+    * Add a few basic controller methods (which make some of the other mixing you might want to throw in your controllers happier). For example: the `head` method for controllers, as it is one of the most used for simple extensions. NOTE: The `render` method is not currently added.
+    * NOTE: db and view runtime values on request processing not done (i.e., not integrated with Praxis’ DB or rendering frameworks)
+* Include URI in the primitive types when generating docs and displaying them (as to not have a generic URI schema polluting the lists)
+* Loosen up the version of Rack that Praxis requires. Adapted the old MultipartParser to be compabible with Rack 2x (but in reality we should see about reusing the brand new parser that 2x comes with in the future)
+* Loosen up the version of Mustermann to allow for their latest 1.x series (which will be used by some of the latest gems with Rails 5 and friends)
+* Fix and improve Doc Browser presentation
+  * proper showing of substructures of payloads
+  * mark required attrs with red star (and semi-required as orange)
+  * display the existing special requirements as well
+  * Added requirements for parameters as well (in addition to payload)
+  * format member_options display better
+* Make `MiddleWareApp` initialize lazily. This allows the main rack app (i.e., Rails) to be fully initialized by the time any code in the Praxis middleware gets touched (i.e., full ActiveRecord connection initialization...etc.)
+* Removed 'Stats' plugin
+* CGI.decode filter values in the `FilteringParams` extension
+
 ## 0.21
 
 * Protect against `MediaType`s that do not have any links defined.

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

@@ -4,6 +4,7 @@ require 'praxis-mapper'
 require 'praxis-blueprints'
 
 require 'active_support/concern'
+require 'praxis/request_superclassing'
 
 $:.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'
 
@@ -89,6 +89,7 @@ module Praxis
     autoload :MapperSelectors, 'praxis/extensions/mapper_selectors'
     autoload :Rendering, 'praxis/extensions/rendering'
     autoload :FieldExpansion, 'praxis/extensions/field_expansion'
+    autoload :AttributeFiltering, 'praxis/extensions/attribute_filtering'
   end
 
   module Handlers
@@ -122,10 +123,11 @@ 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'
+  # # Avoid loading responses (and templates) lazily as they need to be registered in time
+  # ... now done in Praxis initialize
+  # require 'praxis/responses/http'
+  # require 'praxis/responses/internal_server_error'
+  # require 'praxis/responses/validation_error'
+  # require 'praxis/responses/multipart_ok'
 
 end