puppet-herald 0.1.1 → 0.2.0

data/db/migrate/20141211171326_create_log_entries.rb

@@ -1,13 +1,15 @@
+# Migration
 class CreateLogEntries < ActiveRecord::Migration
+  # Migration
   def change
     create_table :log_entries do |t|
-      t.datetime    :time
-      t.string      :level
-      t.string      :source
-      t.integer     :line
-      t.text        :message
-      
-      t.references  :report
+      t.datetime :time
+      t.string :level
+      t.string :source
+      t.integer :line
+      t.text :message
+
+      t.references :report
     end
   end
 end

data/db/schema.rb

@@ -11,37 +11,35 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20141211171326) do
-
+ActiveRecord::Schema.define(version: 20_141_211_171_326) do
   # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
+  enable_extension 'plpgsql'
 
-  create_table "log_entries", force: true do |t|
-    t.datetime "time"
-    t.string   "level"
-    t.string   "source"
-    t.integer  "line"
-    t.text     "message"
-    t.integer  "report_id"
+  create_table 'log_entries', force: true do |t|
+    t.datetime 'time'
+    t.string 'level'
+    t.string 'source'
+    t.integer 'line'
+    t.text 'message'
+    t.integer 'report_id'
   end
 
-  create_table "nodes", force: true do |t|
-    t.string   "name"
-    t.string   "status"
-    t.integer  "no_of_reports"
-    t.datetime "last_run"
+  create_table 'nodes', force: true do |t|
+    t.string 'name'
+    t.string 'status'
+    t.integer 'no_of_reports'
+    t.datetime 'last_run'
   end
 
-  create_table "reports", force: true do |t|
-    t.string   "status"
-    t.string   "environment"
-    t.string   "transaction_uuid"
-    t.string   "configuration_version"
-    t.string   "puppet_version"
-    t.string   "kind"
-    t.string   "host"
-    t.datetime "time"
-    t.integer  "node_id"
+  create_table 'reports', force: true do |t|
+    t.string 'status'
+    t.string 'environment'
+    t.string 'transaction_uuid'
+    t.string 'configuration_version'
+    t.string 'puppet_version'
+    t.string 'kind'
+    t.string 'host'
+    t.datetime 'time'
+    t.integer 'node_id'
   end
-
 end

data/lib/puppet-herald.rb

@@ -1,49 +1,87 @@
 begin
   require 'pry'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
   # Do nothing here
 end
 
+require 'puppet-herald/database'
+
+# A module for Herald
 module PuppetHerald
+  @root = File.dirname(File.dirname(File.realpath(__FILE__)))
+  @database = PuppetHerald::Database.new
 
-  @@root = File.dirname(File.dirname(File.realpath(__FILE__)))
+  # A database object
+  # @return [PuppetHerald::Database] a database object
+  def self.database  # rubocop:disable Style/TrivialAccessors
+    @database
+  end
 
-  def self.relative_dir dir
-    File.realpath(File.join @@root, dir)
+  # Calculates a replative directory inside the project
+  #
+  # @param dir [String] a sub directory
+  # @return [String] a full path to replative dir
+  def self.relative_dir(dir)
+    File.realpath(File.join @root, dir)
   end
 
+  def self.environment=(environment)
+    rackenv = :production
+    envsymbol = environment.to_s.to_sym
+    case envsymbol
+    when :dev, :development
+      rackenv = :development
+    when :test, :ci
+      rackenv = :test
+    else
+      rackenv = :production
+      envsymbol = :production
+    end
+    ENV['PUPPET_HERALD_ENV'] = envsymbol.to_s
+    ENV['RACK_ENV'] = rackenv.to_s
+  end
+
+  # Gets the environment set for Herald
+  # @return [Symbol] an environment
   def self.environment
     env = :production
-    unless ENV['PUPPET_HERALD_ENV'].nil?
-      env = ENV['PUPPET_HERALD_ENV'].to_sym
-    end
-    return env
+    env = ENV['PUPPET_HERALD_ENV'].to_sym unless ENV['PUPPET_HERALD_ENV'].nil?
+    ENV['RACK_ENV'] = env.to_s
+    env
   end
 
-  def self.is_in_dev?
-    return [:development, :dev, :test, :ci].include? environment
+  # Checks is running in DEVELOPMENT kind of environment (dev, ci, test)
+  #
+  # @return [Boolean] true if runs in development
+  def self.in_dev?
+    [:development, :dev, :test, :ci].include? environment
   end
 
-  def self.is_in_prod?
-    return !is_in_dev?
+  # Checks is running in production environment
+  #
+  # @return [Boolean] true if runs in production
+  def self.in_prod?
+    !in_dev?
   end
 
-  def self.bug ex
+  # Reports a bug in desired format
+  #
+  # @param ex [Exception] an exception that was thrown
+  # @return [Hash] a hash with info about bug to be displayed to user
+  def self.bug(ex)
     file = Tempfile.new(['puppet-herald-bug', '.log'])
     filepath = file.path
     file.close
     file.unlink
-    message = "v#{PuppetHerald::VERSION}-#{ex.class.to_s}: #{ex.message}"
+    message = "v#{PuppetHerald::VERSION}-#{ex.class}: #{ex.message}"
     contents = message + "\n\n" + ex.backtrace.join("\n") + "\n"
     File.write(filepath, contents)
     bugo = {
-      :message  => message,
-      :homepage => PuppetHerald::HOMEPAGE,
-      :bugfile  => filepath,
-      :help     => "Please report this bug to #{PuppetHerald::HOMEPAGE} by passing contents of bug file: #{filepath}"
+      message: message,
+      homepage: PuppetHerald::HOMEPAGE,
+      bugfile: filepath,
+      help: "Please report this bug to #{PuppetHerald::HOMEPAGE} by passing contents of bug file: #{filepath}"
     }
-    return bugo
+    bugo
   end
 end
-
-require 'puppet-herald/database'

data/lib/puppet-herald/app/api.rb

@@ -0,0 +1,111 @@
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'puppet-herald'
+require 'puppet-herald/app/configuration'
+require 'puppet-herald/models/node'
+require 'puppet-herald/models/report'
+
+# A module for Herald
+module PuppetHerald
+  # Module that holds modules of Sinatra app
+  module App
+    # An implementation of API v1
+    class ApiImplV1
+      # Constructor
+      # @param app [Sinatra::Base] an app module
+      # @return [ApiImplV1] an API impl
+      def initialize(app)
+        @app = app
+      end
+      # Creates a new report
+      # @param request [Sinatra::Request] an request object
+      # @return [Array] an response array: [code, body] or [code, headers, body]
+      def post_reports(request)
+        yaml = request.body.read
+        report = PuppetHerald::Models::Report.create_from_yaml yaml
+        body = { id: report.id }.to_json
+        [201, body]
+      end
+      # Get a report by its ID
+      # @param params [Hash] an requests parsed params
+      # @return [Array] an response array: [code, body] or [code, headers, body]
+      def get_report(params)
+        id = params[:id]
+        report = PuppetHerald::Models::Report.get_with_log_entries(id)
+        status = 200
+        status = 404 if report.nil?
+        body = report.to_json(include: :log_entries)
+        [status, body]
+      end
+      # Gets all nodes
+      # @return [Array] an response array: [code, body] or [code, headers, body]
+      def nodes
+        nodes = PuppetHerald::Models::Node.all
+        [200, nodes.to_json]
+      end
+      # Gets a node by its ID
+      # @param params [Hash] an requests parsed params
+      # @return [Array] an response array: [code, body] or [code, headers, body]
+      def get_node(params)
+        id = params[:id]
+        node = PuppetHerald::Models::Node.get_with_reports(id)
+        status = 200
+        status = 404 if node.nil?
+        body = node.to_json(include: :reports)
+        [status, body]
+      end
+      # Get a app's artifact information
+      # @return [Array] an response array: [code, body] or [code, headers, body]
+      def version_json
+        ver = {}
+        [:VERSION, :LICENSE, :NAME, :PACKAGE, :SUMMARY, :DESCRIPTION, :HOMEPAGE].each do |const|
+          ver[const.downcase] = PuppetHerald.const_get const
+        end
+        [200, ver.to_json]
+      end
+    end
+
+    # An API app module
+    class Api < Sinatra::Base
+      register Sinatra::Namespace
+      use PuppetHerald::App::Configuration
+      set :api, ApiImplV1.new(self)
+      helpers do
+        # API getter
+        # @return [ApiImplV1] an api object
+        def api
+          settings.api
+        end
+      end
+
+      get '/version.json' do
+        content_type 'application/json'
+        api.version_json
+      end
+
+      namespace '/api' do
+        namespace '/v1' do
+          post '/reports' do
+            content_type 'application/json'
+            api.post_reports request
+          end
+
+          get '/nodes' do
+            content_type 'application/json'
+            api.nodes
+          end
+
+          get '/nodes/:id' do
+            content_type 'application/json'
+            api.get_node params
+          end
+
+          get '/reports/:id' do
+            content_type 'application/json'
+            api.get_report params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/puppet-herald/app/configuration.rb

@@ -0,0 +1,70 @@
+require 'logger'
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'sinatra/activerecord'
+require 'puppet-herald'
+require 'puppet-herald/javascript'
+
+# A module for Herald
+module PuppetHerald
+  # A module that holds module of app
+  module App
+    # A configuration for application
+    class Configuration < Sinatra::Base
+      register Sinatra::ActiveRecordExtension
+
+      set :database, PuppetHerald.database.spec unless PuppetHerald.database.spec.nil?
+
+      class << self
+        # Migrates a database to state desired for the application
+        #
+        # @return [nil]
+        def dbmigrate!
+          ActiveRecord::Base.establish_connection(PuppetHerald.database.spec)
+          setup_database_logger
+          ActiveRecord::Migrator.up 'db/migrate'
+          ActiveRecord::Base.clear_active_connections!
+          nil
+        end
+
+        # Is request part of the API
+        # @param req [Sinatra::Request] a request to check
+        # @return [Boolean] true, if given request point to part of the API
+        def api?(req)
+          (req.path.start_with?('/api') || req.path.start_with?('/version.json'))
+        end
+
+        private
+
+        # Sets logger level for database handlers
+        #
+        # @return [nil]
+        def setup_database_logger
+          if PuppetHerald.in_dev?
+            ActiveRecord::Base.logger.level = Logger::DEBUG
+          else
+            ActiveRecord::Base.logger.level = Logger::WARN
+          end
+          nil
+        end
+      end
+
+      if PuppetHerald.in_dev?
+        set :environment, :development
+      else
+        set :environment, :production
+      end
+      set :show_exceptions, false
+
+      error do
+        @bug = PuppetHerald.bug env['sinatra.error']
+        if PuppetHerald::App::Configuration.api? request
+          content_type 'application/json'
+          @bug.to_json
+        else
+          erb :err500
+        end
+      end
+    end
+  end
+end

data/lib/puppet-herald/app/frontend.rb

@@ -0,0 +1,61 @@
+require 'puppet-herald'
+require 'puppet-herald/javascript'
+require 'sinatra/base'
+require 'sinatra/namespace'
+
+# A module for Herald
+module PuppetHerald
+  # A module that holds module of app
+  module App
+    # Frontend logic impl internal class
+    class LogicImpl
+      def initialize
+        @js = PuppetHerald::Javascript.new
+      end
+      # Gets an app.html
+      # @dodgy executed also to raise an exception for testing (application_spec)
+      def app_html
+        if PuppetHerald.in_prod?
+          minified = '.min'
+          files = ['/app.min.js']
+        else
+          minified = ''
+          files = @js.files
+        end
+        [minified, files]
+      end
+      # Uglify an application JS's into one minified JS file
+      # @param mapname [String] name of source map to be put into uglified JS
+      # @return [Hash] a hash with uglified JS and source map
+      def uglify(mapname)
+        @js.uglify mapname
+      end
+    end
+    # Class that holds implementation of frontent interface
+    class Frontend < Sinatra::Base
+      use PuppetHerald::App::Configuration
+      set :logic, PuppetHerald::App::LogicImpl.new
+
+      get '/' do
+        redirect '/app.html', 301
+      end
+
+      get '/index.html' do
+        redirect '/app.html', 301
+      end
+
+      get '/app.html' do
+        cache_control :public, :must_revalidate, max_age: 60 if PuppetHerald.in_prod?
+        @minified, @files = settings.logic.app_html
+        erb :app
+      end
+
+      get(/\/app\.min\.(js\.map|js)/) do |ext|
+        content_type 'application/javascript'
+        contents = settings.logic.uglify('/app.min.js.map')[ext]
+        cache_control :public, :must_revalidate, max_age: 60 if PuppetHerald.in_prod?
+        contents
+      end
+    end
+  end
+end

data/lib/puppet-herald/{views → app/views}/app.erb

@@ -1,9 +1,6 @@
 <!DOCTYPE html>
-<!--[if lt IE 7]>      <html lang="en" ng-app="herald" class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
-<!--[if IE 7]>         <html lang="en" ng-app="herald" class="no-js lt-ie9 lt-ie8"> <![endif]-->
-<!--[if IE 8]>         <html lang="en" ng-app="herald" class="no-js lt-ie9"> <![endif]-->
-<!--[if gt IE 8]><!--> <html lang="en" ng-app="herald" class="no-js"> <!--<![endif]-->
-  <head ng-controller="AppController as app">
+<html lang="en" ng-app="herald" ng-controller="AppController">
+  <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <title>Herald - a Puppet report processor</title>
@@ -20,7 +17,7 @@
 
     <section class="container-fluid">
       
-      <h2><img src="/img/shield97.svg" />Herald <small>a Puppet report processor</small></h2>
+      <h2><a href="#/"><img src="/img/shield97.svg" />Herald</a> <small>a Puppet report processor</small></h2>
 
       <div ng-view></div>
       
@@ -32,8 +29,8 @@
 
     <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/angularjs/1.3.6/angular<%= @minified %>.js"></script>
     <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/angularjs/1.3.6/angular-route<%= @minified %>.js"></script>
-    <script src="//cdn.jsdelivr.net/momentjs/2.5.1/moment.min.js"></script>
-    <script src="//cdn.jsdelivr.net/angular.moment/0.6.2/angular-moment.js"></script>
+    <script src="//cdn.jsdelivr.net/momentjs/2.8.4/moment.min.js"></script>
+    <script src="//cdn.jsdelivr.net/angular.moment/0.8.3/angular-moment<%= @minified %>.js"></script>
 
     <!-- Automatic incudes of project files -->
     <% @files.each do |file| %>