api_doc_viewer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25c2ca3661218734a8b9cbf73ea26f37439670eb
-  data.tar.gz: c74bb775676baaa917b630144748afd5bd971bc6
+  metadata.gz: bd19e929a151817bf18a84741bb67b7ecf35ca59
+  data.tar.gz: 6ecf6fa47cec026d70c86b70882209a9d7e86a80
 SHA512:
-  metadata.gz: 0b4521dc23aa928c4dc37f2c3a33f5b1c7783484203fa309cd960ae8ceb91de17dee528f07403b21260f7f2d84aaf4db9e8e6d05032ee44491e3cb33f9f209ea
-  data.tar.gz: 3b6888920a487570fee74909ec648360f8633996723a906e91d5ada8fca31c78ad1e2acf90b1edd97b0b350ea834302863f57d7141680e86ddd46093d58daeb1
+  metadata.gz: 89b93415c7d71a8361602a31aae026025b4843c7996b96338fd22ea3dbf70987730a71db05c568191bf604277581bd96ee32f093d18881a825167d6b35bd53c4
+  data.tar.gz: cea5cfe932b8d158b319b1fd8d4e08dd4e55253314f43e222ef33cf6974bdfa49d8ca7b9e440ad1be20f1b124c7af1e3ad353dc24c3a689d4666c320e6325a47

data/app/assets/javascripts/api_doc_viewer/angular/controllers/mainController.js.coffee

@@ -8,25 +8,17 @@ angular.module('controllers').controller 'mainController', ['$scope', 'mainServi
     $scope.activeLink = link
 
     mainService.resourceLink(link).get (data) ->
+      mainService.formatData(data)
+
       $scope.parameters = data.parameters
       $scope.request =
         httpMethod: data.http_method
         route: data.route
-        headers: filterHeaders data.requests[0].request_headers
-        body: formatJSONWithSpaces data.requests[0].request_body
+        headers: data.request_headers
+        body: data.request_body
       $scope.response =
         status: data.requests[0].response_status
         status_text: data.requests[0].response_status_text
-        headers: filterHeaders data.requests[0].response_headers
-        body: formatJSONWithSpaces data.requests[0].response_body
+        headers: data.response_headers
+        body: data.response_body
 ]
-
-formatJSONWithSpaces = (data) ->
-  if data && data.trim().match(/^[\[\{].*[\}\]]$/)
-    JSON.stringify(JSON.parse(data), undefined, 2);
-
-filterHeaders = (headers) ->
-  delete headers['Origin']
-  if Object.keys(headers).length > 0
-    headers
-

data/app/assets/javascripts/api_doc_viewer/angular/services/mainService.js.coffee

@@ -1,10 +1,28 @@
 angular.module('services').factory 'mainService', ['$resource', ($resource) ->
-	return {
-		resourceLink: (link = null) ->
-			urlSuffix = if link? then "?link=#{link}" else ''
-			$resource "#{location.pathname}/documentation#{urlSuffix}", {},
-				get:
-					method: 'GET'
-					cache: true
-	}
+  return {
+    hiddenHeaders: ['Origin', 'Host', 'Cookie', 'X-Frame-Options', 'X-XSS-Protection', 'X-Content-Type-Options', 'X-UA-Compatible', 'ETag', 'Cache-Control', 'X-Request-Id', 'X-Runtime', 'Content-Length']
+    resourceLink: (link = null) ->
+      urlSuffix = if link? then "?link=#{link}" else ''
+      $resource "#{location.pathname}/documentation#{urlSuffix}", {},
+        get:
+          method: 'GET'
+          cache: true
+    formatData: (data) ->
+      data.request_headers = filterHeaders(data.requests[0].request_headers, @hiddenHeaders)
+      data.response_headers = filterHeaders(data.requests[0].response_headers, @hiddenHeaders)
+      data.request_body = formatBody(data.requests[0].request_body, true)
+      data.response_body = formatBody(data.requests[0].response_body)
+  }
 ]
+
+filterHeaders = (headers, hiddenHeaders) ->
+  for headerKey in hiddenHeaders
+    delete headers[headerKey]
+  if Object.keys(headers).length > 0 then headers
+
+formatBody = (body, deparam = false) ->
+  return unless body
+  if deparam
+    body = JSON.stringify($.deparam(body))
+  if body.match(/^[\[\{].*[\}\]]$/)
+    JSON.stringify(JSON.parse(body), undefined, 2)

data/app/assets/javascripts/api_doc_viewer/app.js.coffee

@@ -1,7 +1,4 @@
-app = angular.module('asdf', [
-  'controllers'
-  'services'
-])
+app = angular.module('apiDocViewer', ['controllers', 'services', 'hljs'])
 
 angular.module('controllers', [])
 angular.module('services', ['ngResource'])

data/app/assets/javascripts/api_doc_viewer/vendor/angular-highlightjs.js

@@ -0,0 +1,287 @@
+// AngularJS directive for syntax highlighting with highlight.js
+// Source: https://github.com/pc035860/angular-highlightjs
+
+/*global angular*/
+angular.module('hljs', [])
+
+.provider('hljsService', function () {
+  var _hljsOptions = {};
+
+  return {
+    setOptions: function (options) {
+      angular.extend(_hljsOptions, options);
+    },
+    getOptions: function () {
+      return angular.copy(_hljsOptions);
+    },
+    $get: ['$window', function ($window) {
+      ($window.hljs.configure || angular.noop)(_hljsOptions);
+      return $window.hljs;
+    }]
+  };
+})
+
+.factory('hljsCache', [
+         '$cacheFactory',
+function ($cacheFactory) {
+  return $cacheFactory('hljsCache');
+}])
+
+.controller('HljsCtrl', [
+                  'hljsCache', 'hljsService',
+function HljsCtrl (hljsCache,   hljsService) {
+  var ctrl = this;
+
+  var _elm = null,
+      _lang = null,
+      _code = null,
+      _hlCb = null;
+
+  ctrl.init = function (codeElm) {
+    _elm = codeElm;
+  };
+
+  ctrl.setLanguage = function (lang) {
+    _lang = lang;
+
+    if (_code) {
+      ctrl.highlight(_code);
+    }
+  };
+
+  ctrl.highlightCallback = function (cb) {
+    _hlCb = cb;
+  };
+
+  ctrl.highlight = function (code) {
+    if (!_elm) {
+      return;
+    }
+
+    var res, cacheKey;
+
+    _code = code;
+
+    if (_lang) {
+      // language specified
+      cacheKey = ctrl._cacheKey(_lang, _code);
+      res = hljsCache.get(cacheKey);
+
+      if (!res) {
+        res = hljsService.highlight(_lang, hljsService.fixMarkup(_code), true);
+        hljsCache.put(cacheKey, res);
+      }
+    }
+    else {
+      // language auto-detect
+      cacheKey = ctrl._cacheKey(_code);
+      res = hljsCache.get(cacheKey);
+
+      if (!res) {
+        res = hljsService.highlightAuto(hljsService.fixMarkup(_code));
+        hljsCache.put(cacheKey, res);
+      }
+    }
+
+    _elm.html(res.value);
+    // language as class on the <code> tag
+    _elm.addClass(res.language);
+
+    if (_hlCb !== null && angular.isFunction(_hlCb)) {
+      _hlCb();
+    }
+  };
+
+  ctrl.clear = function () {
+    if (!_elm) {
+      return;
+    }
+    _code = null;
+    _elm.text('');
+  };
+
+  ctrl.release = function () {
+    _elm = null;
+  };
+
+  ctrl._cacheKey = function () {
+    var args = Array.prototype.slice.call(arguments),
+        glue = "!angular-highlightjs!";
+    return args.join(glue);
+  };
+}])
+
+.directive('hljs', ['$compile', '$parse', function ($compile, $parse) {
+  return {
+    restrict: 'EA',
+    controller: 'HljsCtrl',
+    compile: function(tElm, tAttrs, transclude) {
+      // get static code
+      // strip the starting "new line" character
+      var staticCode = tElm[0].innerHTML.replace(/^(\r\n|\r|\n)/m, '');
+
+      // put template
+      tElm.html('<pre><code class="hljs"></code></pre>');
+
+      return function postLink(scope, iElm, iAttrs, ctrl) {
+        var compileCheck;
+
+        if (angular.isDefined(iAttrs.compile)) {
+          compileCheck = $parse(iAttrs.compile);
+        }
+
+        ctrl.init(iElm.find('code'));
+
+        if (iAttrs.onhighlight) {
+          ctrl.highlightCallback(function () {
+            scope.$eval(iAttrs.onhighlight);
+          });
+        }
+
+        if (staticCode) {
+          ctrl.highlight(staticCode);
+
+          // Check if the highlight result needs to be compiled
+          if (compileCheck && compileCheck(scope)) {
+            // compile the new DOM and link it to the current scope.
+            // NOTE: we only compile .childNodes so that
+            // we don't get into infinite loop compiling ourselves
+            $compile(iElm.find('code').contents())(scope);
+          }
+        }
+
+        scope.$on('$destroy', function () {
+          ctrl.release();
+        });
+      };
+    }
+  };
+}])
+
+.directive('language', [function () {
+  return {
+    require: 'hljs',
+    restrict: 'A',
+    link: function (scope, iElm, iAttrs, ctrl) {
+      iAttrs.$observe('language', function (lang) {
+        if (angular.isDefined(lang)) {
+          ctrl.setLanguage(lang);
+        }
+      });
+    }
+  };
+}])
+
+.directive('source', ['$compile', '$parse', function ($compile, $parse) {
+  return {
+    require: 'hljs',
+    restrict: 'A',
+    link: function(scope, iElm, iAttrs, ctrl) {
+      var compileCheck;
+
+      if (angular.isDefined(iAttrs.compile)) {
+        compileCheck = $parse(iAttrs.compile);
+      }
+
+      scope.$watch(iAttrs.source, function (newCode, oldCode) {
+        if (newCode) {
+          ctrl.highlight(newCode);
+
+          // Check if the highlight result needs to be compiled
+          if (compileCheck && compileCheck(scope)) {
+            // compile the new DOM and link it to the current scope.
+            // NOTE: we only compile .childNodes so that
+            // we don't get into infinite loop compiling ourselves
+            $compile(iElm.find('code').contents())(scope);
+          }
+        }
+        else {
+          ctrl.clear();
+        }
+      });
+    }
+  };
+}])
+
+.directive('include', [
+         '$http', '$templateCache', '$q', '$compile', '$parse',
+function ($http,   $templateCache,   $q,   $compile,   $parse) {
+  return {
+    require: 'hljs',
+    restrict: 'A',
+    compile: function(tElm, tAttrs, transclude) {
+      var srcExpr = tAttrs.include;
+
+      return function postLink(scope, iElm, iAttrs, ctrl) {
+        var changeCounter = 0, compileCheck;
+
+        if (angular.isDefined(iAttrs.compile)) {
+          compileCheck = $parse(iAttrs.compile);
+        }
+
+        scope.$watch(srcExpr, function (src) {
+          var thisChangeId = ++changeCounter;
+
+          if (src && angular.isString(src)) {
+            var templateCachePromise, dfd;
+
+            templateCachePromise = $templateCache.get(src);
+            if (!templateCachePromise) {
+              dfd = $q.defer();
+              $http.get(src, {
+                cache: $templateCache,
+                transformResponse: function(data, headersGetter) {
+                  // Return the raw string, so $http doesn't parse it
+                  // if it's json.
+                  return data;
+                }
+              }).success(function (code) {
+                if (thisChangeId !== changeCounter) {
+                  return;
+                }
+                dfd.resolve(code);
+              }).error(function() {
+                if (thisChangeId === changeCounter) {
+                  ctrl.clear();
+                }
+                dfd.resolve();
+              });
+              templateCachePromise = dfd.promise;
+            }
+
+            $q.when(templateCachePromise)
+            .then(function (code) {
+              if (!code) {
+                return;
+              }
+
+              // $templateCache from $http
+              if (angular.isArray(code)) {
+                // 1.1.5
+                code = code[1];
+              }
+              else if (angular.isObject(code)) {
+                // 1.0.7
+                code = code.data;
+              }
+
+              code = code.replace(/^(\r\n|\r|\n)/m, '');
+              ctrl.highlight(code);
+
+              // Check if the highlight result needs to be compiled
+              if (compileCheck && compileCheck(scope)) {
+                // compile the new DOM and link it to the current scope.
+                // NOTE: we only compile .childNodes so that
+                // we don't get into infinite loop compiling ourselves
+                $compile(iElm.find('code').contents())(scope);
+              }
+            });
+          }
+          else {
+            ctrl.clear();
+          }
+        });
+      };
+    }
+  };
+}]);