RubyGems - praxis - Versions diffs - 0.0.1 → 0.9 - Mend

praxis 0.0.1 → 0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (484) hide show

data/lib/api_browser/app/index.html ADDED Viewed

@@ -0,0 +1,51 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title>API Browser</title>
+  <meta name="description" content="">
+  <meta name="viewport" content="width=device-width">
+  <!-- bower:css -->
+  <!-- endbower -->
+  <link rel="stylesheet" href="css/main.css">
+</head>
+<body ng-app="docBrowser">
+  <div ui-view=""></div>
+  <!-- build:js scripts/vendor.js -->
+  <!-- bower:js -->
+  <script src="bower_components/jquery/dist/jquery.js"></script>
+  <script src="bower_components/angular/angular.js"></script>
+  <script src="bower_components/lodash/dist/lodash.compat.js"></script>
+  <script src="bower_components/angular-ui-router/release/angular-ui-router.js"></script>
+  <script src="bower_components/angular-ui-bootstrap-bower/ui-bootstrap-tpls.js"></script>
+  <script src="bower_components/angular-sanitize/angular-sanitize.js"></script>
+  <!-- endbower -->
+  <!-- endbuild -->
+  <!-- build:js({.tmp,app}) scripts/scripts.js -->
+  <!-- fileblock:js scripts -->
+  <script src="js/app.js"></script>
+  <script src="js/filters/resource_name.js"></script>
+  <script src="js/controllers/menu.js"></script>
+  <script src="js/controllers/action.js"></script>
+  <script src="js/directives/attribute_table.js"></script>
+  <script src="js/controllers/type.js"></script>
+  <script src="js/controllers/controller.js"></script>
+  <script src="js/factories/Documentation.js"></script>
+  <script src="js/directives/type_label.js"></script>
+  <script src="js/filters/attribute_name.js"></script>
+  <script src="js/filters/friendly_json.js"></script>
+  <script src="js/directives/attribute_description.js"></script>
+  <script src="js/directives/attribute_table_row.js"></script>
+  <script src="js/factories/TypeTemplates.js"></script>
+  <script src="js/directives/no_container.js"></script>
+  <script src="js/filters/is_empty.js"></script>
+  <script src="js/directives/request_body.js"></script>
+  <script src="js/factories/PayloadTemplates.js"></script>
+  <script src="js/factories/TemplateProvider.js"></script>
+  <script src="js/directives/request_headers.js"></script>
+  <script src="js/directives/request_parameters.js"></script>
+  <!-- endfileblock -->
+  <!-- endbuild -->
+</body>
+</html>

data/lib/api_browser/app/js/app.js ADDED Viewed

@@ -0,0 +1,32 @@
+var app = angular.module('docBrowser', ['ui.router', 'ui.bootstrap', 'ngSanitize']);
+app.config(function ($stateProvider, $urlRouterProvider) {
+  $urlRouterProvider
+    .otherwise('/');
+  $stateProvider
+    .state('root', {
+      abstract: true,
+      templateUrl: 'views/layout.html'
+    })
+    .state('root.home', {
+      url: '/',
+      templateUrl: 'views/home.html'
+    })
+    .state('root.controller', {
+      url: '/:version/controller/:controller',
+      templateUrl: 'views/controller.html',
+      controller: 'ControllerCtrl'
+    })
+    .state('root.type', {
+      url: '/:version/type/:type',
+      templateUrl: 'views/type.html',
+      controller: 'TypeCtrl'
+    })
+    .state('root.action', {
+      url: '/:version/controller/:controller/:action',
+      templateUrl: 'views/action.html',
+      controller: 'ActionCtrl'
+    });
+});

data/lib/api_browser/app/js/controllers/action.js ADDED Viewed

@@ -0,0 +1,51 @@
+app.controller("ActionCtrl", function($scope, $stateParams, Documentation) {
+  $scope.controllerName = $stateParams.controller;
+  $scope.actionName = $stateParams.action;
+  $scope.apiVersion = $stateParams.version;
+  Documentation.getController($stateParams.version, $stateParams.controller).then(function(response) {
+    $scope.action = _.find(response.data.actions, function(action) { return action.name === $scope.actionName; });
+    if (!$scope.action) {
+      $scope.error = true;
+      return;
+    }
+    // Extract the example and attach it to each attribute
+    _.forEach(['headers', 'params', 'payload'], function(n) {
+      var set = $scope.action[n];
+      if (set) {
+        _.forEach(set.type.attributes, function(attribute, name) {
+          var example = set.example ? JSON.stringify(set.example[name], null, 2) : '';
+          if (!attribute.options) attribute.options = {};
+          if (example) attribute.options.example = example;
+          if (attribute.values) attribute.options.values = attribute.values;
+          if (attribute.default) attribute.options.default = attribute.default;
+        });
+      }
+    });
+    $scope.responses = [];
+    _.forEach($scope.action.responses, function(response, name) {
+      response.name = name;
+      response.options = {
+        headers: response.headers
+      }
+      $scope.responses.push(response);
+      if(response.parts_like) {
+        response.parts_like.isMultipart = true;
+        response.parts_like.options = {
+          headers: response.parts_like.headers
+        }
+        $scope.responses.push(response.parts_like);
+      }
+    });
+  }, function() {
+    $scope.error = true;
+  })
+  $scope.hasResponses = function() {
+    return $scope.action ? _.any($scope.action.responses) : false;
+  };
+});

data/lib/api_browser/app/js/controllers/controller.js ADDED Viewed

@@ -0,0 +1,10 @@
+app.controller("ControllerCtrl", function($scope, $stateParams, Documentation) {
+  $scope.controllerName = $stateParams.controller;
+  $scope.apiVersion = $stateParams.version;
+  Documentation.getController($stateParams.version, $stateParams.controller).then(function(response) {
+    $scope.controller = response.data;
+  }, function() {
+    $scope.error = true;
+  })
+});

data/lib/api_browser/app/js/controllers/menu.js ADDED Viewed

@@ -0,0 +1,49 @@
+app.controller("MenuCtrl", function($scope, $state, Documentation) {
+  $scope.versions = [];
+  $scope.links = {};
+  $scope.selectedVersion = '';
+  $scope.currentType = '';
+  Documentation.getIndex().success(function(index) {
+    _.forEach(index, function(items, version) {
+      $scope.versions.push(version);
+      var links = $scope.links[version] = [];
+      _.forEach(items, function(item, name) {
+        var link = { name: name, stateRef: '' };
+        if (item.controller) {
+          link.stateRef = $state.href('root.controller', { version: version, controller: item.controller });
+          link.typeName = item.controller;
+        }
+        else if (item.media_type) {
+          link.stateRef = $state.href('root.type', { version: version, type: item.media_type });
+          link.typeName = item.media_type;
+        }
+        else if (item.kind) {
+          link.stateRef = $state.href('root.type', { version: version, type: item.kind });
+          link.typeName = item.kind;
+        }
+        links.push(link);
+      });
+    });
+    $scope.selectedVersion = $scope.versions[0];
+  });
+  $scope.select = function(version) {
+    $scope.selectedVersion = version;
+  };
+  $scope.availableLinks = function() {
+    return $scope.links[$scope.selectedVersion];
+  }
+  $scope.$on('$stateChangeSuccess', function(e, state, params) {
+    if (params.version) $scope.selectedVersion = params.version;
+    $scope.currentType = params.controller || params.type;
+  });
+});

data/lib/api_browser/app/js/controllers/type.js ADDED Viewed

@@ -0,0 +1,28 @@
+app.controller("TypeCtrl", function ($scope, $stateParams, Documentation) {
+  $scope.typeName = $stateParams.type || $scope.controller.media_type;
+  $scope.apiVersion = $stateParams.version;
+  $scope.controllers = [];
+  $scope.views = [];
+  Documentation.getType($stateParams.version, $scope.typeName).then(function(response) {
+    $scope.type = response.data;
+    $scope.views = _(response.data.views)
+      .map(function(view, name) { return _.extend(view, { name: name }); })
+      .select(function(view) { return view.name != 'master'; })
+      .value();
+    _.forEach($scope.type.attributes, function(attribute, name) {
+      var example = JSON.stringify($scope.type.example[name], null, 2);
+      if (!attribute.options) attribute.options = {};
+      if (example) attribute.options.example = example;
+      if (attribute.values) attribute.options.values = attribute.values;
+      if (attribute.default) attribute.options.default = attribute.default;
+    });
+    Documentation.getIndex().success(function(response) {
+      $scope.controllers = _.select(response[$scope.apiVersion], function(item) { return item.controller && item.media_type == $scope.typeName; });
+    });
+  }, function() {
+    $scope.error = true;
+  });
+});

data/lib/api_browser/app/js/directives/attribute_description.js ADDED Viewed

@@ -0,0 +1,43 @@
+app.directive('rsAttributeDescription', function($compile, $templateCache, $http) {
+  return {
+    restrict: 'E',
+    templateUrl: 'views/directives/attribute_description.html',
+    scope: {
+      attribute: '='
+    },
+    link: function(scope, element) {
+      var list = element.find('dl');
+      _.forEach(scope.attribute.options, function(option, name) {
+        var templatePath = 'views/directives/attribute_description/_default.html';
+        switch (name) {
+          case 'example':
+            // expects string
+            if(typeof option !== 'string') {
+              option = JSON.stringify(option, null, 2);
+            }
+            templatePath = 'views/directives/attribute_description/_example.html';
+            break;
+          case 'headers':
+            templatePath = 'views/directives/attribute_description/_headers.html';
+            break;
+        }
+        $http.get(templatePath, { cache: $templateCache }).success(function(template) {
+          var row = $(template);
+          var rowScope = scope.$new(true);
+          rowScope.row = {
+            name: name,
+            value: option
+          };
+          $compile(row)(rowScope);
+          list.append(row);
+        });
+      })
+    }
+  };
+});

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

@@ -0,0 +1,27 @@
+app.directive('rsAttributeTable', function() {
+  return {
+    restrict: 'E',
+    templateUrl: 'views/directives/attribute_table.html',
+    controller: function(){},
+    scope: {
+      attributes: '=',
+      showGroups: '='
+    },
+    link: function(scope, element) {
+      // create attribute groups
+      scope.groups = [{attributes: []}];
+      // handle required, optional
+      if(scope.showGroups) {
+        scope.groups[0].name = 'Required';
+        scope.groups.push({name: 'Optional', attributes: []});
+      }
+      // map hash to array
+      _(scope.attributes).forEach(function(attr, key) {
+        attr.name = attr.name || key;
+        scope.groups[(scope.showGroups && !attr.required ? 1 : 0)].attributes.push(attr);
+      });
+    }
+  };
+});

data/lib/api_browser/app/js/directives/attribute_table_row.js ADDED Viewed

@@ -0,0 +1,17 @@
+app.directive('rsAttributeTableRow', function($compile, TypeTemplates) {
+  return {
+    restrict: 'E',
+    scope: {
+      name: '=',
+      attribute: '='
+    },
+    link: function(scope, element, attrs) {
+      // use the attribute type name to find the template
+      var name = (scope.attribute.type ? scope.attribute.type.name : null) || 'default';
+      TypeTemplates.resolve(name).then(function(template) {
+        element.replaceWith($compile(template)(scope));
+      });
+    }
+  }
+});

data/lib/api_browser/app/js/directives/no_container.js ADDED Viewed

@@ -0,0 +1,8 @@
+app.directive('noContainer', function() {
+	return {
+		restrict: 'A',
+		link: function(scope, element, attrs){
+			element.replaceWith(element.children());
+		}
+	};
+});

data/lib/api_browser/app/js/directives/request_body.js ADDED Viewed

@@ -0,0 +1,25 @@
+app.directive('rsRequestBody', function($compile, PayloadTemplates) {
+  return {
+    restrict: 'E',
+    scope: {
+      payload: '='
+    },
+    link: function(scope, element, attrs) {
+      // use the attribute type name to find the template
+      var alt, name = (scope.payload.type ? scope.payload.type.name : null) || 'default';
+      if(scope.payload.type) {
+        scope.attributes = scope.payload.type.attributes;
+      }
+      if(name === 'Struct') {
+        name = 'PraxisBody',
+        alt = 'Struct'
+      }
+      PayloadTemplates.resolve(name, alt).then(function(template) {
+        element.replaceWith($compile(template)(scope));
+      });
+    }
+  }
+});

data/lib/api_browser/app/js/directives/request_headers.js ADDED Viewed

@@ -0,0 +1,20 @@
+app.directive('rsRequestHeaders', function($compile, PayloadTemplates) {
+  return {
+    restrict: 'E',
+    scope: {
+      headers: '='
+    },
+    link: function(scope, element, attrs) {
+      // use the attribute type name to find the template
+      var name = (scope.headers.type ? scope.headers.type.name : null) || 'default';
+      if(scope.headers.type) {
+        scope.attributes = scope.headers.type.attributes;
+      }
+      PayloadTemplates.resolve('PraxisHeaders', 'Struct').then(function(template) {
+        element.replaceWith($compile(template)(scope));
+      });
+    }
+  }
+});

data/lib/api_browser/app/js/directives/request_parameters.js ADDED Viewed

@@ -0,0 +1,20 @@
+app.directive('rsRequestParameters', function($compile, PayloadTemplates) {
+  return {
+    restrict: 'E',
+    scope: {
+      parameters: '='
+    },
+    link: function(scope, element, attrs) {
+      // use the attribute type name to find the template
+      var name = (scope.parameters.type ? scope.parameters.type.name : null) || 'default';
+      if(scope.parameters.type) {
+        scope.attributes = scope.parameters.type.attributes;
+      }
+      PayloadTemplates.resolve('PraxisParameters', 'Struct').then(function(template) {
+        element.replaceWith($compile(template)(scope));
+      });
+    }
+  }
+});

data/lib/api_browser/app/js/directives/type_label.js ADDED Viewed

@@ -0,0 +1,53 @@
+app.directive('rsTypeLabel', function($compile, $templateCache, $http) {
+  var primitives = [
+    'Boolean',
+    'CSV',
+    'DateTime',
+    'Float',
+    'Hash',
+    'Ids',
+    'Integer',
+    'Object',
+    'String',
+    'Struct'
+  ];
+  var templates = {
+    primitive: '<span>{{type.name}}</span>',
+    type: '<a ui-sref="root.type({version: apiVersion, type: type.name})">{{type.name | resourceName}}</a>',
+    typeCollection: '<span>Collection&nbsp;[&nbsp;{{type.options.member_attribute.type.name}}&nbsp;]</a>',
+    primitiveCollection: '<span>Collection&nbsp;[&nbsp;<a ui-sref="root.type({version: apiVersion, type: type.options.member_attribute.type.name})">{{type.options.member_attribute.type.name | resourceName}}</a>&nbsp;]</span>',
+    link: '<span>Link&nbsp;[&nbsp;<a ui-sref="root.type({version: apiVersion, type: type.link_to})">{{type.link_to | resourceName}}</a>&nbsp;]</span>'
+  };
+  return {
+    restrict: 'E',
+    scope: {
+      type: '='
+    },
+    link: function(scope, element) {
+      var template = templates.type;
+      if (_.contains(primitives, scope.type.name)) {
+        template = templates.primitive;
+      }
+      else if (scope.type.name === 'Collection') {
+        if (_.contains(primitives, scope.type.options.member_attribute.type.name))
+          template = templates.typeCollection;
+        else
+          template = templates.primitiveCollection;
+      }
+      else if (scope.type.link_to) {
+        template = templates.link;
+      }
+      element.html(template);
+      $compile(element.contents())(scope);
+    },
+    controller: function($scope, $stateParams) {
+      $scope.apiVersion = $stateParams.version;
+    }
+  };
+});

data/lib/api_browser/app/js/factories/Documentation.js ADDED Viewed

@@ -0,0 +1,16 @@
+app.factory('Documentation', function($http) {
+  return {
+    getIndex: function() {
+      return $http.get('docs/index.json', { cache: true });
+    },
+    getController: function(version, name) {
+      return $http.get('docs/' + version + '/resources/' + name + '.json', { cache: true });
+    },
+    getType: function(version, name) {
+      return $http.get('docs/' + version + '/types/' + name + '.json', { cache: true });
+    },
+    getTemplates: function(version) {
+      return $http.get('docs/' + version + '/templates.json', { cache: true });
+    }
+  };
+});

data/lib/api_browser/app/js/factories/PayloadTemplates.js ADDED Viewed

@@ -0,0 +1,10 @@
+app.factory('PayloadTemplates', function($http, $templateCache, TemplateProvider) {
+  var defaultTemplate = $http.get('views/directives/request_body/_default.html', { cache: $templateCache });
+  var localTemplates = {
+    "Struct": $http.get('views/directives/request_body/_struct.html', { cache: $templateCache })
+  };
+  return TemplateProvider(defaultTemplate, localTemplates, "standalone");
+});

data/lib/api_browser/app/js/factories/TemplateProvider.js ADDED Viewed

@@ -0,0 +1,45 @@
+app.factory('TemplateProvider', function($q, $http, $templateCache, $stateParams, Documentation) {
+  // creates a template resolver
+  return function(defaultTemplate, localTemplates, prefix){
+    return {
+      resolve: function(name, alt) {
+        var deferred = $q.defer();
+        var getTemplate = function(customTemplates) {
+          var nsIdx;
+          while(true) {
+            if(customTemplates[prefix] && customTemplates[prefix][name]) {
+              deferred.resolve(customTemplates[prefix][name]);
+              break;
+            } else if (localTemplates[name]) {
+              localTemplates[name].then(function(response) {
+                deferred.resolve(response.data);
+              });
+              break;
+            } else {
+              nsIdx = name.indexOf('::');
+              if(nsIdx > 0) {
+                name = name.substr(nsIdx + 2);
+              } else if(alt) {
+                name = alt;
+                alt = null;
+              } else {
+                defaultTemplate.then(function(response) {
+                  deferred.resolve(response.data);
+                });
+                break;
+              }
+            }
+          }
+        };
+        Documentation.getTemplates($stateParams.version).then(function(response) {
+          getTemplate(response.data);
+        }, function() {
+          getTemplate({});
+        });
+        return deferred.promise;
+      }
+    };
+  };
+});

data/lib/api_browser/app/js/factories/TypeTemplates.js ADDED Viewed

@@ -0,0 +1,11 @@
+app.factory('TypeTemplates', function($http, $templateCache, TemplateProvider) {
+  var defaultTemplate = $http.get('views/directives/attribute_table_row/_default.html', { cache: $templateCache });
+  var localTemplates = {
+    "Struct": $http.get('views/directives/attribute_table_row/_struct.html', { cache: $templateCache }),
+    "Links": $http.get('views/directives/attribute_table_row/_links.html', { cache: $templateCache })
+  };
+  return TemplateProvider(defaultTemplate, localTemplates, "embedded");
+});

data/lib/api_browser/app/js/filters/attribute_name.js ADDED Viewed

@@ -0,0 +1,9 @@
+app.filter('attributeName', function($sce) {
+  return function(input) {
+    var parts = input.split('.');
+    if (parts.length == 2) {
+      return $sce.trustAsHtml('<span class="attribute-prefix">' + parts[0] + '.</span>' + parts[1]);
+    }
+    return $sce.trustAsHtml(input);
+  };
+});

data/lib/api_browser/app/js/filters/friendly_json.js ADDED Viewed

@@ -0,0 +1,5 @@
+app.filter('friendlyJson', function() {
+  return function(input) {
+    return JSON.stringify(input, null, 2);
+  };
+});

data/lib/api_browser/app/js/filters/is_empty.js ADDED Viewed

@@ -0,0 +1,8 @@
+app.filter('isEmpty', function() {
+  return function(input) {
+    return (input === undefined) ||
+        (input === null) ||
+        jQuery.isEmptyObject(input) ||
+        (input instanceof Array && !input.length);
+  };
+});

data/lib/api_browser/app/js/filters/resource_name.js ADDED Viewed

@@ -0,0 +1,5 @@
+app.filter('resourceName', function() {
+  return function(input) {
+    return _.last(input.split("::"));
+  };
+});

data/lib/api_browser/app/sass/main.scss ADDED Viewed

@@ -0,0 +1,59 @@
+//
+// API Doc Browser
+// ------------------------------
+// Bootstrap and Bootstrap variables
+@import "variables/bootstrap-variables";
+@import "../bower_components/bootstrap-sass/lib/bootstrap";
+// Modules
+@import "modules/body";
+@import "modules/header";
+@import "modules/sidebar";
+@import "modules/nav";
+@import "modules/table";
+@import "modules/switch";
+@import "modules/cloke";
+// Miscellaneous
+.required-type {
+  background-color: #f9f9f9;
+}
+.struct-main-attr-name {
+  color: #b0b0b0;
+}
+.attribute-prefix {
+  color: #aaa;
+}
+rs-attribute-description dt {
+  text-transform: capitalize;
+}
+.attribute-table {
+  div[class*='col-'] {
+    padding: $table-cell-padding;
+    line-height: $line-height-base;
+  }
+  .head {
+    border-bottom: 2px solid $table-border-color;
+    font-weight: bold;
+  }
+  .content {
+    .row {
+      border-top: 1px solid $table-border-color;
+    }
+    .row:nth-child(odd) {
+      background-color: $table-bg-accent;
+    }
+  }
+}

data/lib/api_browser/app/sass/modules/_body.scss ADDED Viewed

@@ -0,0 +1,11 @@
+//
+// Body
+// ------------------------------
+body {
+  padding-top: 65px;
+  padding-bottom: 50px;
+  a {
+    cursor: pointer;
+  }
+}

data/lib/api_browser/app/sass/modules/_cloke.scss ADDED Viewed

@@ -0,0 +1,8 @@
+_cloke.scss
+/*
+ since the cloak css code is added by angular.js, which is at the bottom of the page, we lose all benefit of it.
+ we add it here so that it is loaded at the beginning of the page
+*/
+[ng\:cloak], [ng-cloak], [data-ng-cloak], [x-ng-cloak], .ng-cloak, .x-ng-cloak {
+  display: none !important;
+}

data/lib/api_browser/app/sass/modules/_header.scss ADDED Viewed

@@ -0,0 +1,15 @@
+//
+// Header
+// ------------------------------
+.header {
+  .navbar-default {
+    background-image: -ms-linear-gradient(top, #fff 0%, $navbar-default-bg 100%);
+    background-image: -moz-linear-gradient(top, #fff 0%, $navbar-default-bg 100%);
+    background-image: -o-linear-gradient(top, #fff 0%, $navbar-default-bg 100%);
+    background-image: -webkit-gradient(linear, left top, left bottom, color-stop(0, #FFFFFF), color-stop(1, $navbar-default-bg));
+    background-image: -webkit-linear-gradient(top, #fff 0%, $navbar-default-bg 100%);
+    background-image: linear-gradient(to bottom, #fff 0%, $navbar-default-bg 100%);
+    box-shadow: 0 0 5px rgba(#000, 0.085);
+  }
+}