puppet-herald 0.1.1 → 0.2.0

data/lib/puppet-herald/models/report.rb

@@ -2,77 +2,84 @@ require 'puppet-herald/models/log-entry'
 require 'puppet-herald/models/node'
 require 'puppet-herald/stubs/puppet'
 
-class Report < ActiveRecord::Base
-  belongs_to :node
-  has_many   :log_entries, dependent: :delete_all
+# A module for Herald
+module PuppetHerald
+  # module for models
+  module Models
+    # A model for Report
+    class Report < ActiveRecord::Base
+      belongs_to :node
+      has_many :log_entries, dependent: :delete_all
 
-  def self.get_with_log_entries id
-    Report.where("id = ?", id).includes(:log_entries).first
-  end
+      class << self
+        # Gets a report with prefetched log entries
+        # @param id [Integer] a in of report to get
+        # @return [Report, nil] fetched report or nil
+        def get_with_log_entries(id)
+          Report.joins(:log_entries).includes(:log_entries).find_by_id(id)
+        end
 
-  def self.create_from_yaml yaml
-    parsed = parse_yaml yaml
-    report = Report.new
-    
-    parse_properties parsed, report
-    parse_logs parsed, report
-    node = parse_node parsed, report
+        # Creates a report from given YAML report file
+        # @param yaml [String] a puppet report YAML as string
+        # @return [Report] created report
+        def create_from_yaml(yaml)
+          parsed = parse_yaml yaml
+          report = Report.new
 
-    report.save
-    node.save
-    return report
-  end
+          parse_properties parsed, report
+          parse_logs parsed, report
+          node = parse_node parsed, report
 
-  private
+          report.save
+          node.save
+          report
+        end
 
-  def self.parse_node parsed, report
-    node = Node.find_by_name(parsed.host)
-    if node.nil?
-      node = Node.new
-      node.name = parsed.host
-      node.no_of_reports = 0
-    end 
-    report.node = node
-    node.reports << report
-    node.no_of_reports += 1
-    node.status = parsed.status
-    node.last_run = parsed.time
-    return node
-  end
+        private
 
-  def self.parse_properties parsed, report
-    attr_to_copy = [
-      'status', 'environment', 
-      'transaction_uuid', 'time', 
-      'puppet_version', 'kind', 
-      'host', 'configuration_version'
-    ]
-    copy_attrs parsed, report, attr_to_copy
-  end
+        def parse_node(parsed, report)
+          node = Node.find_by_name(parsed.host)
+          if node.nil?
+            node = Node.new
+            node.name = parsed.host
+            node.no_of_reports = 0
+          end
+          report.node = node
+          node.reports << report
+          node.no_of_reports += 1
+          node.status = parsed.status
+          node.last_run = parsed.time
+          node
+        end
 
-  def self.parse_logs parsed, report
-    parsed.logs.each do |in_log|
-      log = LogEntry.new
-      attr_to_copy = [
-        'level', 'message', 
-        'source', 'time'
-      ]
-      copy_attrs in_log, log, attr_to_copy
-      log.report = report
-      report.log_entries << log
-    end
-  end
+        def parse_properties(parsed, report)
+          attr_to_copy = %w(status environment transaction_uuid time puppet_version kind host configuration_version)
+          copy_attrs parsed, report, attr_to_copy
+        end
 
-  def self.parse_yaml yaml
-    require 'yaml'
-    raw = YAML.parse yaml
-    raw.to_ruby
-  end
+        def parse_logs(parsed, report)
+          parsed.logs.each do |in_log|
+            log = LogEntry.new
+            attr_to_copy = %w(level message source time)
+            copy_attrs in_log, log, attr_to_copy
+            log.report = report
+            report.log_entries << log
+          end
+        end
+
+        def parse_yaml(yaml)
+          require 'yaml'
+          raw = YAML.parse yaml
+          raw.to_ruby
+        end
 
-  def self.copy_attrs from, to, attrs
-    attrs.each do |at|
-      value = from.send at
-      to.send "#{at}=", value
+        def copy_attrs(from, to, attrs)
+          attrs.each do |at|
+            value = from.send at
+            to.send "#{at}=", value
+          end
+        end
+      end
     end
   end
-end
+end

data/lib/puppet-herald/public/app.js

@@ -3,6 +3,7 @@
 
   var app = angular.module('herald' , [
     'ngRoute',
+    'herald.page',
     'herald.nodes',
     'herald.node',
     'herald.report',
@@ -14,14 +15,14 @@
     $routeProvider.otherwise({redirectTo: '/nodes'});
   }]);
 
-  app.factory('appService', function() {  
-    return {
-        page: 'home'
-    };
-  });
-
-  app.controller('AppController', ['appService', function(appService) {
-    this.page = appService.page;
+  app.controller('AppController', ['Page', '$rootScope', function(Page, $rootScope) {
+    var ctrl = this;
+    this.page = null;
+    this.target = null;
+    $rootScope.$on('Page::titleChanged', function(event, title, target) {
+      ctrl.page = title;
+      ctrl.target = target;
+    });
   }]);
 
 })();

data/lib/puppet-herald/public/components/directives/status-button.html

@@ -3,5 +3,5 @@
     btn btn-xs btn-{{ status | colorizeStatus }}
     glyphicon glyphicon-{{ status | iconizeStatus }}
     "
-  ng-click="navigate()"
+  ng-click="navigate(route, id)"
   aria-hidden="true"> {{ status | uppercase }}</button>

data/lib/puppet-herald/public/components/directives/status-button.js

@@ -10,8 +10,8 @@
 
     $scope.$location = $location;
 
-    $scope.navigate = function() {
-      var target = this.route.replace(':id', this.id);
+    $scope.navigate = function(route, id) {
+      var target = route.replace(':id', id);
       this.$location.path(target);
     };
 
@@ -36,6 +36,7 @@
         case 'unchanged': return 'success';
         case 'changed':   return 'info';
         case 'failed':    return 'danger';
+        case 'pending':   return 'warning';
         default:          return 'default';
       }
     }
@@ -47,7 +48,8 @@
         case 'unchanged': return 'ok';
         case 'changed':   return 'pencil';
         case 'failed':    return 'remove';
-        default:          return 'asterisk';
+        case 'pending':   return 'asterisk';
+        default:          return 'sign';
       }
     }
   });

data/lib/puppet-herald/public/components/filters/filters.js

@@ -1,12 +1,17 @@
 'use strict';
 
-angular.module('herald.filters', [
-])
+angular.module('herald.filters', [])
 
 .filter('capitalize', function() {
   return function(input) {
-    var first = input.substring(0, 1);
-    var rest = input.substring(1);
+    var text;
+    if (input == null) {
+      text = '';
+    } else {
+      text = input.toString();
+    }
+    var first = text.substring(0, 1);
+    var rest = text.substring(1);
     return first.toUpperCase() + rest;
   };
 });

data/lib/puppet-herald/public/components/page.js

@@ -0,0 +1,34 @@
+(function(angular){
+  'use strict';
+
+  var module = angular.module('herald.page' , []);
+
+  module.factory('Page', ['$document', '$rootScope', function($document, $rootScope) {
+    var root = $document;
+    var base = root[0].title
+    var title = null;
+    var target = null;
+    var service = {
+      title: function(newTitle, newTarget, joiner) {
+        var merged = newTitle + '';
+        if(typeof(joiner) === 'undefined') joiner = ': ';
+        if (typeof(newTarget) !== 'undefined') {
+          merged = merged + joiner + newTarget;
+        }
+        var whole = merged + ' | ' + base;
+        root[0].title = whole;
+        title = newTitle;
+        target = newTarget;
+        $rootScope.$emit('Page::titleChanged', title, target, merged, whole);
+      },
+      actualTitle: function() {
+        return title;
+      },
+      actualTarget: function() {
+        return target;
+      }
+    };
+    return service;
+  }]);
+
+})(angular);

data/lib/puppet-herald/public/node/node.html

@@ -1,6 +1,8 @@
 <div class="panel panel-primary" ng-controller="NodeController as ctrl">
   <!-- Default panel contents -->
-  <div class="panel-heading">Reports for {{ ctrl.node.name }} <span class="badge">{{ ctrl.node.reports.length }}</span></div>
+  <div class="panel-heading">Reports for 
+    <samp>{{ ctrl.node.name }}</samp> <span class="badge">{{ ctrl.node.reports.length }}</span>
+  </div>
 
   <!-- Table -->
   <table class="table table-striped table-hover">

data/lib/puppet-herald/public/node/node.js

@@ -2,7 +2,9 @@
 
 angular.module('herald.node', [
   'ngRoute',
-  'herald.directives'
+  'herald.page',
+  'herald.directives',
+  'angularMoment'
 ])
 
 .config(['$routeProvider', function($routeProvider) {
@@ -12,13 +14,14 @@ angular.module('herald.node', [
   });
 }])
 
-.controller('NodeController', ['$http', '$routeParams', function($http, $routeParams) {
+.controller('NodeController', ['$http', '$routeParams', 'Page', function($http, $routeParams, Page) {
   var ctrl = this;
   ctrl.node = null;
-
+  Page.title('Node');
   this.nodeId = $routeParams.nodeId;
 
-  $http.get('/api/v1/node/' + this.nodeId).success(function(data) {
+  $http.get('/api/v1/nodes/' + this.nodeId).success(function(data) {
     ctrl.node = data;
+    Page.title('Node', data.name);
   });
 }]);

data/lib/puppet-herald/public/nodes/nodes.js

@@ -3,6 +3,7 @@
 angular.module('herald.nodes', [
   'ngRoute',
   'herald.directives',
+  'herald.page',
   'angularMoment'
 ])
 
@@ -13,8 +14,8 @@ angular.module('herald.nodes', [
   });
 }])
 
-.controller('NodesController', ['$http', 'appService', function($http, appService) {
-  appService.page = 'nodes';
+.controller('NodesController', ['$http', 'Page', function($http, Page) {
+  Page.title('All nodes');
   var ctrl = this;
   ctrl.all = [];
 

data/lib/puppet-herald/public/report/report.html

@@ -1,6 +1,9 @@
 <div class="panel panel-primary" ng-controller="ReportController as ctrl">
   <!-- Default panel contents -->
-  <div class="panel-heading">Report for {{ ctrl.report.host }} <span class="badge">{{ ctrl.report.log_entries.length }}</span></div>
+  <div class="panel-heading">Report: 
+    <samp>{{ ctrl.report.configuration_version }}</samp>
+    <span class="badge">{{ ctrl.report.log_entries.length }}</span>
+  </div>
 
   <!-- Table -->
   <table class="table table-condensed table-hover herald-table-report">

data/lib/puppet-herald/public/report/report.js

@@ -2,6 +2,7 @@
 
 angular.module('herald.report', [
   'ngRoute',
+  'herald.page',
   'herald.directives'
 ])
 
@@ -12,13 +13,14 @@ angular.module('herald.report', [
   });
 }])
 
-.controller('ReportController', ['$http', '$routeParams', function($http, $routeParams) {
+.controller('ReportController', ['$http', '$routeParams', 'Page', function($http, $routeParams, Page) {
+  Page.title('Report');
   var ctrl = this;
   ctrl.report = null;
-
   this.reportId = $routeParams.reportId;
 
-  $http.get('/api/v1/report/' + this.reportId).success(function(data) {
+  $http.get('/api/v1/reports/' + this.reportId).success(function(data) {
     ctrl.report = data;
+    Page.title('Report', data.configuration_version);
   });
 }]);

data/lib/puppet-herald/stubs/puppet.rb

@@ -1,29 +1,40 @@
+# A stub Puppet module
 module Puppet
+  # A stub Puppet module
   module Transaction
-
+    # A stub Puppet class
     class Report
-      attr_accessor :host, :time, :kind, :puppet_version, :configuration_version, :transaction_uuid, :environment, :status, :logs
+      # A puppet variable from report
+      # @return [String] a puppet set variable
+      attr_accessor :host, :time, :kind, :puppet_version, :configuration_version
+
+      # A puppet variable from report
+      # @return [String] a puppet set variable
+      attr_accessor :transaction_uuid, :environment, :status, :logs
     end
 
+    # A stub Puppet class
     class Event
-
     end
-
   end
+
+  # A stub Puppet class
   class Resource
+    # A stub Puppet class
     class Status
-
     end
   end
+  # A stub Puppet module
   module Util
-
+    # A stub Puppet class
     class Log
+      # A puppet variable from report
+      # @return [String] a puppet set variable
       attr_accessor :level, :message, :source, :time, :line, :tags
     end
 
+    # A stub Puppet class
     class Metric
-
     end
-
   end
-end
+end

data/lib/puppet-herald/version.rb

@@ -1,20 +1,30 @@
+# A module for Herald
 module PuppetHerald
-  
-  def self.version_prep desired
+  # Prepare version
+  #
+  # @param desired [String] a desired version
+  # @return [String] a prepared version
+  def self.version_prep(desired)
     version = desired
     if desired.match(/[^0-9\.]+/)
       git = `git describe --tags --dirty --always`
-      version += "." + git.gsub('-', '.')
+      version += '.' + git.gsub('-', '.')
     end
-    return version.strip
+    version.strip
   end
 
-  VERSION     = version_prep '0.1.1'
+  # Version for Herald
+  VERSION     = version_prep '0.2.0'
+  # Lincense for Herald
   LICENSE     = 'Apache 2.0'
+  # Project name
   NAME        = 'Puppet Herald'
+  # Package (gem) for Herald
   PACKAGE     = 'puppet-herald'
+  # A summary info
   SUMMARY     = 'a Puppet report processor'
-  DESCRIPTION = "Provides a gateway for consuming puppet reports, a REST API and a simple Web app to display reports."
+  # A description info
+  DESCRIPTION = 'Provides a gateway for consuming puppet reports, a REST API and a simple Web app to display reports.'
+  # A homepage for Herald
   HOMEPAGE    = 'https://github.com/wavesoftware/gem-puppet-herald'
-
 end