prrd 0.2.0

data/lib/prrd/database.rb

@@ -0,0 +1,107 @@
+# File: database.rb
+# Time-stamp: <2014-10-01 21:26:05 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Database class for PRRD
+
+module PRRD
+  # PRRD Database class
+  class Database
+    # Accessors
+    attr_accessor :path
+    attr_accessor :start, :step
+    attr_accessor :datasources, :archives
+
+    # Constructor
+    def initialize(values = nil)
+      @datasources = []
+      @archives = []
+      @start = Time.now.to_i - 86_400
+      @step = 300
+
+      unless values.nil?
+        values.each do |k, v|
+          m = "#{k}=".to_sym
+          next unless respond_to? m
+          send m, v
+        end
+      end
+    end
+
+    # Does database file exist?
+    def exists?
+      File.exist? @path
+    end
+
+    # Check database existence
+    def check_file
+      fail 'Database path is missing' if  @path.nil? || !exists?
+    end
+
+    # Add a datasource object
+    # @param datasource [PRRD::Database::Datasource]
+    def add_datasource(datasource)
+      @datasources << datasource
+    end
+
+    # Add datasource objects
+    # @param datasource [Array]
+    def add_datasources(datasources)
+      @datasources = datasources
+    end
+
+    # Add an archive object
+    # @param archive [PRRD::Database::Archive]
+    def add_archive(archive)
+      @archives << archive
+    end
+
+    # Add archive objects
+    # @param archives [Array]
+    def add_archives(archives)
+      @archives = archives
+    end
+
+    # Add an object
+    # @param object [Object]
+    def <<(object)
+      if object.is_a? PRRD::Database::Datasource
+        add_datasource object
+      elsif object.is_a? PRRD::Database::Archive
+        add_archive object
+      else
+        fail 'Can not add this kind of object in PRRD::Database'
+      end
+    end
+
+    # Create a database
+    # @return [String]
+    def create
+      File.write @path, ''
+
+      cmd = []
+      cmd << "#{PRRD.bin} create #{@path}"
+      cmd << "--start #{@start} --step #{@step}"
+
+      fail 'Datasources are missing' if @datasources.empty?
+      @datasources.map { |e| cmd << e.to_s }
+
+      fail 'Archives are missing' if @archives.empty?
+      @archives.map { |e| cmd << e.to_s }
+
+      # Execute
+      PRRD.execute cmd.join ' '
+    end
+
+    # Update a database
+    # @param timestamp [Integer]
+    # @param values [Array]
+    # @return [String]
+    def update(timestamp = nil, *values)
+      check_file
+      timestamp ||= Time.now.to_i
+
+      # Execute
+      PRRD.execute "#{PRRD.bin} update #{@path} #{timestamp}:#{values.join ':'}"
+    end
+  end
+end

data/lib/prrd/database/archive.rb

@@ -0,0 +1,39 @@
+# File: archive.rb
+# Time-stamp: <2014-09-30 00:04:06 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Archive class for PRRD
+
+module PRRD
+  class Database
+    # PRRD Database Archive class
+    class Archive < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :cf,
+          :xff,
+          :steps,
+          :rows
+        ]
+
+        super values
+      end
+
+      # Transform to a RRA formatted string
+      def to_s
+        fail 'Empty archive object' if @data.empty?
+
+        validate_presence :cf, :xff, :steps, :rows
+
+        chunks = ['RRA']
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          chunks << @data[k]
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/database/datasource.rb

@@ -0,0 +1,40 @@
+# File: datasource.rb
+# Time-stamp: <2014-09-30 00:04:37 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Datasource class for PRRD
+
+module PRRD
+  class Database
+    # PRRD Database Datasource class
+    class Datasource < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :name,
+          :type,
+          :heartbeat,
+          :min,
+          :max
+        ]
+
+        super values
+      end
+
+      # Transform to a DS formatted string
+      def to_s
+        fail 'Empty datasource object' if @data.empty?
+
+        validate_presence :name, :type, :heartbeat, :min, :max
+
+        chunks = ['DS']
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          chunks << @data[k]
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/graph.rb

@@ -0,0 +1,143 @@
+# File: graph.rb
+# Time-stamp: <2014-10-01 21:26:29 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Graph class for PRRD
+
+module PRRD
+  # PRRD Graph class
+  class Graph
+    # Accessors
+    attr_accessor :path, :database
+
+    attr_accessor :start, :end, :step
+    attr_accessor :title, :vertical_label
+    attr_accessor :width, :height, :only_graph, :full_size_mode
+    attr_accessor :lower_limit, :upper_limit, :rigid
+    attr_accessor :no_legend, :legend_position, :legend_direction
+    attr_accessor :base, :border, :zoom, :imgformat, :watermark
+    attr_accessor :entities
+
+    # Constructor
+    def initialize(values = nil)
+      @entities = {
+        colors: [],
+        definitions: [],
+        areas: [],
+        lines: [],
+        prints: [],
+        comments: [],
+        hrules: [],
+        vrules: [],
+        shift: [],
+        textalign: []
+      }
+
+      unless values.nil?
+        values.each do |k, v|
+          m = "#{k}=".to_sym
+          next unless respond_to? m
+          send m, v
+        end
+      end
+    end
+
+    # Check image existence
+    def check_file
+      fail 'Image path is missing' if  @path.nil?
+    end
+
+    # Check database existence
+    def check_database
+      fail 'No database provided' if @database.nil?
+    end
+
+    def method_missing(m, *args, &block)
+      entities = @entities.keys.map(&:to_s) + @entities.keys.map! { |e| e.to_s[0..-2] }
+      ms = m.to_s.gsub 'add_', ''
+      if entities.include? ms
+        if ms[-1] == 's'
+          @entities[ms.to_sym] = args[0]
+        else
+          @entities["#{ms}s".to_sym] << args[0]
+        end
+
+        return true
+      end
+
+      super
+    end
+
+    # Add an object
+    # @param object [Object]
+    def <<(object)
+      if object.is_a? PRRD::Graph::Definition
+        @entities[:definitions] << object
+      elsif object.is_a? PRRD::Graph::Color
+        @entities[:colors] << object
+      elsif object.is_a? PRRD::Graph::Area
+        @entities[:areas] << object
+      elsif object.is_a? PRRD::Graph::Line
+        @entities[:lines] << object
+      elsif object.is_a? PRRD::Graph::Print
+        @entities[:prints] << object
+      elsif object.is_a? PRRD::Graph::Comment
+        @entities[:comments] << object
+      elsif object.is_a? PRRD::Graph::Hrule
+        @entities[:hrules] << object
+      elsif object.is_a? PRRD::Graph::Vrule
+        @entities[:vrules] << object
+      elsif object.is_a? PRRD::Graph::Shift
+        @entities[:shift] << object
+      elsif object.is_a? PRRD::Graph::Textalign
+        @entities[:textalign] << object
+      else
+        fail 'Can not add this kind of object in PRRD::Graph'
+      end
+    end
+
+    # Generate a graph
+    # @return [String]
+    def generate
+      check_file
+      check_database
+
+      fail 'Definitions are missing' if @entities[:definitions].empty?
+
+      cmd = []
+
+      cmd << "#{PRRD.bin} graph #{@path}"
+
+      cmd << "--start=#{@start}" unless @start.nil?
+      cmd << "--end=#{@end}" unless @end.nil?
+      cmd << "--step=#{@step}" unless @step.nil?
+
+      cmd << "--title=\"#{@title}\"" unless @title.nil?
+      cmd << "--vertical-label=\"#{@vertical_label}\"" unless @vertical_label.nil?
+      cmd << "--width=#{@width}" unless @width.nil?
+      cmd << "--height=#{@height}" unless @height.nil?
+      cmd << '--only-graph' unless @only_graph.nil?
+      cmd << '--full-size-mode' unless @full_size_mode.nil?
+      cmd << "--lower-limit=#{@lower_limit}" unless @lower_limit.nil?
+      cmd << "--upper-limit=#{@upper_limit}" unless @upper_limit.nil?
+      cmd << '--rigid' unless @rigid.nil?
+      cmd << "--no-legend" unless @no_legend.nil?
+      cmd << "--legend-position=\"#{@legend_position}\"" unless @legend_position.nil?
+      cmd << "--legend-direction=\"#{@legend_direction}\"" unless @legend_direction.nil?
+      cmd << "--base=#{@base}" unless @base.nil?
+      cmd << "--border=#{@border}" unless @border.nil?
+      cmd << "--zoom=#{@zoom}" unless @zoom.nil?
+      cmd << "--imgformat=\"#{@imgformat}\"" unless @imgformat.nil?
+      cmd << "--watermark=\"#{@watermark}\"" unless @watermark.nil?
+
+      @entities.each do |k, v|
+        next if v.empty?
+        v.each do |e|
+          cmd << e.to_s
+        end
+      end
+
+      # Exectute
+      PRRD.execute cmd.join ' '
+    end
+  end
+end

data/lib/prrd/graph/area.rb

@@ -0,0 +1,50 @@
+# File: area.rb
+# Time-stamp: <2014-10-01 20:31:25 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Area class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Area class
+    class Area < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :value,
+          :color,
+          :legend,
+          :stack
+        ]
+
+        super values
+      end
+
+      # Transform to a AREA formatted string
+      def to_s
+        fail 'Empty area object' if @data.empty?
+
+        validate_presence :value
+
+        chunks = []
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          case k
+          when :value
+            chunks << "AREA:%s%s" % [@data[k], @data[:color]]
+          when :legend
+            chunks << "\"%s\"" % @data[k]
+          when :stack
+            chunks << "STACK"
+          when :color
+            # nope
+          else
+            chunks << @data[k]
+          end
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end

data/lib/prrd/graph/colors.rb

@@ -0,0 +1,28 @@
+# File: color.rb
+# Time-stamp: <2014-10-01 20:31:49 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Color class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Color class
+    class Color < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :colortag,
+          :color
+        ]
+
+        super values
+      end
+
+      # Transform to a COLOR formatted string
+      def to_s
+        fail 'Empty color object' if @data.empty?
+
+        "--color %s%s " % [@data[:colortag], @data[:color]]
+      end
+    end
+  end
+end

data/lib/prrd/graph/comment.rb

@@ -0,0 +1,29 @@
+# File: comment.rb
+# Time-stamp: <2014-10-01 20:32:12 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Comment class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Comment Line class
+    class Comment < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :text
+        ]
+
+        super values
+      end
+
+      # Transform to a COMMENT formatted string
+      def to_s
+        fail 'Empty comment object' if @data.empty?
+
+        validate_presence :text
+
+        "COMMENT:\"%s\"" % @data[:text]
+      end
+    end
+  end
+end

data/lib/prrd/graph/definition.rb

@@ -0,0 +1,47 @@
+# File: definition.rb
+# Time-stamp: <2014-10-01 21:14:18 pierre>
+# Copyright (C) 2014 Pierre Lecocq
+# Description: Definition class for PRRD
+
+module PRRD
+  class Graph
+    # PRRD Graph Definition class
+    class Definition < PRRD::Entity
+      # Constructor
+      def initialize(values = nil)
+        @keys = [
+          :vname,
+          :rrdfile,
+          :ds_name,
+          :cf,
+          :step,
+          :start,
+          :end
+        ]
+
+        super values
+      end
+
+      # Transform to a DEF formatted string
+      def to_s
+        fail 'Empty definition object' if @data.empty?
+
+        chunks = []
+
+        @keys.each do |k|
+          next unless @data.key?(k)
+          case k
+          when :vname
+            chunks << "DEF:%s=%s" % [@data[k], @data[:rrdfile]]
+          when :rrdfile
+            # nope
+          else
+            chunks << @data[k]
+          end
+        end
+
+        chunks.join ':'
+      end
+    end
+  end
+end