puppet-herald 0.2.0 → 0.8.0

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

@@ -2,6 +2,7 @@ require 'sinatra/base'
 require 'sinatra/namespace'
 require 'puppet-herald'
 require 'puppet-herald/app/configuration'
+require 'puppet-herald/models'
 require 'puppet-herald/models/node'
 require 'puppet-herald/models/report'
 
@@ -18,6 +19,7 @@ module PuppetHerald
         @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)
@@ -27,34 +29,46 @@ module PuppetHerald
         [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)
+        report = PuppetHerald::Models::Report.with_log_entries(id)
         status = 200
         status = 404 if report.nil?
         body = report.to_json(include: :log_entries)
         [status, body]
       end
-      # Gets all nodes
+      # Gets all nodes with pagination
+      #
+      # @param request [Sinatra::Request] an request object
       # @return [Array] an response array: [code, body] or [code, headers, body]
-      def nodes
-        nodes = PuppetHerald::Models::Node.all
-        [200, nodes.to_json]
+      def nodes(request)
+        pag = paginate request
+        nodes = PuppetHerald::Models::Node.paginate(pag)
+        [200, headers(pag), nodes.to_json(methods: :no_of_reports)]
+      rescue ArgumentError => ex
+        clienterror ex
       end
-      # Gets a node by its ID
+      # Gets a node by its ID, with pagination
+      #
       # @param params [Hash] an requests parsed params
+      # @param request [Sinatra::Request] an request object
       # @return [Array] an response array: [code, body] or [code, headers, body]
-      def get_node(params)
+      def get_node(params, request)
         id = params[:id]
-        node = PuppetHerald::Models::Node.get_with_reports(id)
+        pag = paginate request
+        node = PuppetHerald::Models::Node.with_reports(id, pag)
         status = 200
         status = 404 if node.nil?
-        body = node.to_json(include: :reports)
-        [status, body]
+        body = node.to_json(include: :reports, methods: :no_of_reports)
+        [status, headers(pag), body]
+      rescue ArgumentError => ex
+        clienterror ex
       end
       # Get a app's artifact information
+      #
       # @return [Array] an response array: [code, body] or [code, headers, body]
       def version_json
         ver = {}
@@ -63,6 +77,59 @@ module PuppetHerald
         end
         [200, ver.to_json]
       end
+
+      private
+
+      # Creates headers for given pagination
+      #
+      # @param pagination [PuppetHerald::Models::Pagination] a pagination
+      # @param httpize [Boolean] if true given, will change headers to Rack format +HTTP_*+
+      # @return [Hash] a HTTP request headers
+      def headers(pagination, httpize = false)
+        keys = httpize_keys(httpize)
+        head = {
+          keys[:page]  => pagination.page.to_s,
+          keys[:limit] => pagination.limit.to_s
+        }
+        head[keys[:total]] = pagination.total.to_s unless pagination.total.nil?
+        head[keys[:pages]] = pagination.pages.to_s unless pagination.pages.nil?
+        head
+      end
+
+      def httpize_keys(httpize = false)
+        map = PuppetHerald::Models::Pagination::KEYS.map do |k, str|
+          [k, httpize_key(str, httpize)]
+        end
+        Hash[map]
+      end
+
+      def httpize_key(key, httpize = false)
+        noop = ->(name) { name }
+        oper = httpize ? method(:httpize) : noop
+        oper.call key
+      end
+
+      # Creates a pagination from request
+      #
+      # @param request [Sinatra::Request] a HTTP request
+      # @return [PuppetHerald::Models::Pagination] a pagination
+      def paginate(request)
+        pkey = httpize(PuppetHerald::Models::Pagination::KEYS[:page])
+        lkey = httpize(PuppetHerald::Models::Pagination::KEYS[:limit])
+        page = request.env[pkey] ? request.env[pkey] : PuppetHerald::Models::Pagination::DEFAULT.page
+        limit = request.env[lkey] ? request.env[lkey] : PuppetHerald::Models::Pagination::DEFAULT.limit
+        PuppetHerald::Models::Pagination.new(page, limit)
+      end
+
+      def httpize(header_name)
+        upper = header_name.upcase.gsub('-', '_')
+        "HTTP_#{upper}"
+      end
+
+      def clienterror(ex)
+        err = { error: "#{ex.class}: #{ex.message}" }
+        [400, err.to_json]
+      end
     end
 
     # An API app module
@@ -92,12 +159,12 @@ module PuppetHerald
 
           get '/nodes' do
             content_type 'application/json'
-            api.nodes
+            api.nodes request
           end
 
           get '/nodes/:id' do
             content_type 'application/json'
-            api.get_node params
+            api.get_node params, request
           end
 
           get '/reports/:id' do

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

@@ -4,6 +4,7 @@ require 'sinatra/namespace'
 require 'sinatra/activerecord'
 require 'puppet-herald'
 require 'puppet-herald/javascript'
+require 'puppet-herald/purgecronjob'
 
 # A module for Herald
 module PuppetHerald
@@ -16,14 +17,26 @@ module PuppetHerald
       set :database, PuppetHerald.database.spec unless PuppetHerald.database.spec.nil?
 
       class << self
-        # Migrates a database to state desired for the application
+        # Configure the application
         #
+        # @param options [Hash] optional parameters
         # @return [nil]
-        def dbmigrate!
-          ActiveRecord::Base.establish_connection(PuppetHerald.database.spec)
+        def configure_app(options = {})
+          cron = options.fetch(:cron, true)
+          dbmigrate = options.fetch(:dbmigrate, true)
           setup_database_logger
-          ActiveRecord::Migrator.up 'db/migrate'
-          ActiveRecord::Base.clear_active_connections!
+          dbmigrate! if dbmigrate
+          enable_cron if cron
+          nil
+        end
+
+        # De-configure the application
+        #
+        # @param options [Hash] optional parameters
+        # @return [nil]
+        def deconfigure_app(options = {})
+          cron = options.fetch(:cron, true)
+          disable_cron if cron
           nil
         end
 
@@ -36,24 +49,43 @@ module PuppetHerald
 
         private
 
+        # Migrates a database to state desired for the application
+        #
+        # @return [nil]
+        def dbmigrate!
+          ActiveRecord::Base.establish_connection(PuppetHerald.database.spec)
+          ActiveRecord::Migrator.up 'db/migrate'
+          ActiveRecord::Base.clear_active_connections!
+          nil
+        end
+
+        # Enable cron in application
+        def enable_cron
+          require 'rufus/scheduler'
+          set :scheduler, Rufus::Scheduler.new
+          job = PuppetHerald::PurgeCronJob.new
+          # Run every 30 minutes, by default
+          cron = ENV['PUPPET_HERALD_PURGE_CRON'] || '*/30 * * * *'
+          PuppetHerald.logger.info "Stating scheduler with: `#{cron}`..."
+          scheduler.cron(cron) { job.run! }
+        end
+
+        # Disable cron in application
+        def disable_cron
+          scheduler.shutdown if scheduler.up?
+          PuppetHerald.logger.info 'Scheduler stopped.'
+        end
+
         # 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
+          ActiveRecord::Base.logger = PuppetHerald.logger
           nil
         end
       end
 
-      if PuppetHerald.in_dev?
-        set :environment, :development
-      else
-        set :environment, :production
-      end
+      set :environment, PuppetHerald.rackenv
       set :show_exceptions, false
 
       error do

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

@@ -37,20 +37,20 @@ module PuppetHerald
       set :logic, PuppetHerald::App::LogicImpl.new
 
       get '/' do
-        redirect '/app.html', 301
+        cache_control :public, :must_revalidate, max_age: 60 if PuppetHerald.in_prod?
+        @minified, @files = settings.logic.app_html
+        erb :app
       end
 
       get '/index.html' do
-        redirect '/app.html', 301
+        redirect '/', 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
+        redirect '/', 301
       end
 
-      get(/\/app\.min\.(js\.map|js)/) do |ext|
+      get %r{^/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?

data/lib/puppet-herald/app/views/app.erb

@@ -3,37 +3,31 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>Herald - a Puppet report processor</title>
+    <title>Herald</title>
 
     <meta name="description" content="Herald - a Puppet report processor">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- Latest compiled and minified CSS -->
-    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap<%= @minified %>.css">
+    <link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap<%= @minified %>.css">
     <!-- Optional theme -->
-    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme<%= @minified %>.css">
+    <link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap-theme<%= @minified %>.css">
     <link rel="stylesheet" href="css/herald.css">
+    <link rel="icon" type="image/png" href="img/shield97.png"/>
   </head>
   <body>
 
-    <section class="container-fluid">
-      
-      <h2><a href="#/"><img src="/img/shield97.svg" />Herald</a> <small>a Puppet report processor</small></h2>
+    <ui-view></ui-view>
 
-      <div ng-view></div>
-      
-      <address>
-        <hr />
-        <p class="text-muted"><small>Herald v<span app-version></span></small></p>
-      </address>
-    </section>
+    <script type="text/javascript" src="bower_components/angular/angular<%= @minified %>.js"></script>
+    <script type="text/javascript" src="bower_components/angular-ui-router/release/angular-ui-router<%= @minified %>.js"></script>
+    <script type="text/javascript" src="bower_components/angular-breadcrumb/release/angular-breadcrumb<%= @minified %>.js"></script>
+    <script type="text/javascript" src="bower_components/moment/min/moment.min.js"></script>
+    <script type="text/javascript" src="bower_components/angular-moment/angular-moment<%= @minified %>.js"></script>
+    <script type="text/javascript" src="bower_components/ngstorage/ngStorage<%= @minified %>.js"></script>
+    <script type="text/javascript" src="bower_components/angular-utils-pagination/dirPagination.js"></script>
 
-    <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.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 -->
+    <!-- Automatic includes of project files -->
     <% @files.each do |file| %>
-    <script src="<%= file %>"></script><% end %>
+    <script type="text/javascript" src="<%= file %>"></script><% end %>
   </body>
 </html>

data/lib/puppet-herald/app/views/err500.erb

@@ -3,13 +3,16 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>Error 500 | Herald - a Puppet report processor</title>
+    <title>Herald</title>
+    <title>Error 500 | Herald</title>
     <meta name="description" content="Herald - a Puppet report processor">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- Latest compiled and minified CSS -->
-    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
+    <link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap<%= @minified %>.css">
     <!-- Optional theme -->
-    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css">
+    <link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap-theme<%= @minified %>.css">
+    <link rel="stylesheet" href="css/herald.css">
+    <link rel="icon" type="image/png" href="img/shield97.png"/>
   </head>
   <body>
 
@@ -18,10 +21,10 @@
       
       <div class="jumbotron">
         <h2 class="text-danger glyphicon glyphicon-fire">Internal Server Error (500)</h2>
-        <p>Something realy unpredictable just happend...</p>
+        <p>Something really unpredictable just happend...</p>
         <div class="well well-lg"><samp><%= @bug[:message] %></samp></div>
         <p><small><strong>Pro Tip!</strong> Please report this bug by passing contents of bug file: <code><%= @bug[:bugfile] %></code></small></p>
-        <p><a class="btn btn-danger btn-lg" href="<%= @bug[:homepage] %>" role="button">Report a bug</a></p>
+        <p><a class="btn btn-danger btn-lg" href="<%= @bug[:homepage] %>/issues/new" role="button">Report a bug</a></p>
       </div>
     </section>
   </body>

data/lib/puppet-herald/application.rb

@@ -19,9 +19,17 @@ module PuppetHerald
       # @param block [block] an extra configuration block
       # @return [Sinatra::Application] an Herald application
       def run!(options = {}, &block)
-        PuppetHerald::App::Configuration.dbmigrate!
+        PuppetHerald::App::Configuration.configure_app
         super options, *block
       end
+
+      # Deconfigure application
+      #
+      # @return [nil]
+      def quit!
+        PuppetHerald::App::Configuration.deconfigure_app
+        super
+      end
     end
   end
 end

data/lib/puppet-herald/cli.rb

@@ -1,5 +1,4 @@
 require 'micro-optparse'
-require 'logger'
 require 'puppet-herald'
 require 'puppet-herald/version'
 require 'puppet-herald/database'
@@ -11,21 +10,15 @@ module PuppetHerald
     # Initialize CLI
     # @return [CLI] an CLI object
     def initialize
-      @logger = Logger.new STDOUT
-      @errlogger = Logger.new STDERR
       self
     end
 
-    # Logger for CLI interface (error and std)
-    # @return [Logger] logger for CLI
-    attr_reader :logger, :errlogger
-
     # Executes an Herald app from CLI
     #
     # @param argv [Array] an argv from CLI
     # @return [Integer] a status code for program
     def run!(argv = ARGV)
-      PuppetHerald.environment
+      PuppetHerald.rackenv
 
       options = parse_or_kill argv, 2
       run_or_kill options, 1
@@ -40,7 +33,8 @@ module PuppetHerald
     def parse(argv)
       options = parser.process!(argv)
 
-      logger.info "Starting #{PuppetHerald::NAME} v#{PuppetHerald::VERSION} in #{PuppetHerald.environment}..."
+      msg = "Starting #{PuppetHerald::NAME} v#{PuppetHerald::VERSION} in #{PuppetHerald.rackenv}..."
+      PuppetHerald.logger.info msg
       PuppetHerald.database.dbconn   = options[:dbconn]
       PuppetHerald.database.passfile = options[:passfile]
       PuppetHerald.database.spec(true)
@@ -54,14 +48,14 @@ module PuppetHerald
       PuppetHerald::Application.run! options
     rescue StandardError => ex
       bug = PuppetHerald.bug(ex)
-      errlogger.fatal "Unexpected error occured, mayby a bug?\n\n#{bug[:message]}\n\n#{bug[:help]}"
+      PuppetHerald.errlogger.fatal "Unexpected error occured, mayby a bug?\n\n#{bug[:message]}\n\n#{bug[:help]}"
       Kernel.exit retcode
     end
 
     def parse_or_kill(argv, retcode)
       return parse argv
     rescue StandardError => ex
-      errlogger.fatal "Database configuration is invalid!\n\n#{ex.message}"
+      PuppetHerald.errlogger.fatal "Database configuration is invalid!\n\n#{ex.message}"
       Kernel.exit retcode
     end
 

data/lib/puppet-herald/database.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'logger'
 
 # A module for Herald
 module PuppetHerald
@@ -8,13 +7,8 @@ module PuppetHerald
     def initialize
       @dbconn   = nil
       @passfile = nil
-      @logger = Logger.new STDOUT
     end
 
-    # Gets a logger for database
-    # @return [Logger] a logger
-    attr_reader :logger
-
     # Sets a database connection
     # @return [String] a dbconnection string
     attr_writer :dbconn
@@ -57,7 +51,7 @@ module PuppetHerald
       return unless log
       copy = connection.dup
       copy[:password] = '***' unless copy[:password].nil?
-      logger.info "Using #{copy.inspect} for database."
+      PuppetHerald.logger.info "Using #{copy.inspect} for database."
     end
 
     def sqlite(match)