lib/puppet-herald/models/report.rb in puppet-herald-0.1.1 vs lib/puppet-herald/models/report.rb in puppet-herald-0.2.0

@@ -1,78 +1,85 @@
 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 self.copy_attrs from, to, attrs
-    attrs.each do |at|
-      value = from.send at
-      to.send "#{at}=", value
+        def parse_yaml(yaml)
+          require 'yaml'
+          raw = YAML.parse yaml
+          raw.to_ruby
+        end
+
+        def copy_attrs(from, to, attrs)
+          attrs.each do |at|
+            value = from.send at
+            to.send "#{at}=", value
+          end
+        end
+      end
     end
   end
-end
\ No newline at end of file
+end