qabot 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a4a77bc1c0e5d1a1667b935df168d08e7d34e71
+  data.tar.gz: d892ff34caba0b887d45396ac3aa6f49c5e28e21
+SHA512:
+  metadata.gz: 004704ab96d13f2ed72231a711d837be00bea93c7d341fbe5d2dc640d577620cd518e12f595636d7b9ecd55d199d95a297b2257e91062b9b5380d41d20c69579
+  data.tar.gz: dbdff29081158455c92ed69be4ab107869e8744463ee2094d9d14cd303cf0969514c096808bc87f3b71822b26ed4988c98eb836d64b6e918a3ed3101b3d21fbd

data/lib/dbclasses.rb

@@ -0,0 +1,499 @@
+# sequel class fro the qacategory table
+module BlackStack
+    class User < Sequel::Model(:user)
+        one_to_many :boolflags, :class=>:'BlackStack::QABot::BoolFlag', :key=>:id_user
+        one_to_many :intflags, :class=>:'BlackStack::QABot::IntFlag', :key=>:id_user
+        one_to_many :floatflags, :class=>:'BlackStack::QABot::FloatFlag', :key=>:id_user
+        one_to_many :categories, :class=>:'BlackStack::QABot::Category', :key=>:id_user
+
+        # return all flags of this user
+        def flags()
+            return self.boolflags + self.intflags + self.floatflags
+        end
+
+    end # class User
+
+    class Client < Sequel::Model(:client)
+        # return all flags of all the users of this client
+        def flags()
+            return self.users.map{|u| u.flags}.flatten
+        end
+
+        # return all categories of all the users of this client
+        def categories()
+            return self.users.map{|u| u.categories}.flatten
+        end
+
+    end # class Client
+
+    module QABot
+        # 
+        class Category < Sequel::Model(:qacategory) 
+            BlackStack::QABot::Category.dataset = BlackStack::QABot::Category.dataset.disable_insert_output
+            many_to_one :user, :class=>:'BlackStack::User', :key=>:id_user
+            one_to_many :boolflags, :class=>:'BlackStack::BoolFlag', :key=>:id_qacategory
+            one_to_many :intflags, :class=>:'BlackStack::IntFlag', :key=>:id_qacategory
+            one_to_many :floatflags, :class=>:'BlackStack::FloatFlag', :key=>:id_qacategory
+        end # class Category
+
+        # 
+        class Alert < Sequel::Model(:qaalert) 
+            many_to_one :user, :class=>:'BlackStack::User', :key=>:id_user
+            many_to_one :receiver, :class=>:'BlackStack::User', :key=>:id_receiver
+            
+        end # class Alert
+
+        # 
+        class BoolFlag < Sequel::Model(:qaboolflag)             
+            BlackStack::QABot::BoolFlag.dataset = BlackStack::QABot::BoolFlag.dataset.disable_insert_output
+            include BlackStack::QABot::Flag
+            many_to_one :user, :class=>:'BlackStack::User', :key=>:id_user
+            many_to_one :category, :class=>:'BlackStack::QABot::Category', :key=>:id_category
+            one_to_many :alerts, :class=>:'BlackStack::QABot::Alert', :key=>:id_qaxflag
+
+            # map the attributes of this object to a hash.
+            # add custom elements to the hash: `:up_to_date`, `:last_update_description`
+            # return such a hash.
+            def to_hash()
+                {
+                    :id => self.id,
+                    :type => BlackStack::QABot::BOOL,
+                    :id_qacategory => self.id_qacategory,
+                    :create_time => self.create_time,
+                    :delete_time => self.delete_time,
+                    :id_user => self.id_user,
+                    :name => self.name,
+                    :html_description => self.html_description,
+                    # how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                    :trace_frequency_period => self.trace_frequency_period,
+                    :trace_frequency_units => self.trace_frequency_units,
+                    # show this flag public in the web
+                    :public => self.public,
+                    # what is the latest value reported
+                    :value => self.value,
+                    # what is the value to show red (true or false).
+                    :trigger_red => self.trigger_red,
+                    # each time the value is changed, you can show a comment about the last status.
+                    :alert_comments => self.alert_comments,
+                    # if it is currently red
+                    :stat_red => self.stat_red,
+                    # order to show it inside the category, in the dashboard
+                    :order => self.order,
+                    # sharing this with other people, so other people can add my alert on their dashboards.
+                    :share => self.share,
+                    # activate this flag to show in the flags column of the dashboard
+                    :show_as_flag => self.show_as_flag,
+                    # activate tis flag to show in the timelines column of the dashboard
+                    :show_as_timeline => self.show_as_timeline,
+                    # custom elements
+                    :up_to_date => self.up_to_date?,
+                    :last_update_description => self.last_update_description,
+                }
+            end # def to_hash() 
+
+            # it is red if the `value` is the same than the value assigned to `trigger_red`
+            def is_red?
+                self.value == self.trigger_red
+            end
+
+            # map the attributes of the hash `h` to this object.
+            def parse(h)
+                self.value = h[:value] == true
+                self.value_red = h[:value_red] == true
+                q = "
+                    UPDATE qaboolflag
+                    SET
+                        id_qacategory = '#{h[:id_qacategory]}',
+                        --create_time = '#{h[:create_time]}',
+                        --delete_time = '#{h[:delete_time]}',
+                        id_user = '#{h[:id_user]}',
+                        name = '#{h[:name].to_s.to_sql}',
+                        html_description = '#{h[:html_description].to_s.to_sql}',
+                        -- how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                        trace_frequency_period = '#{h[:trace_frequency_period]}',
+                        trace_frequency_units = #{h[:trace_frequency_units]},
+                        -- show this flag public in the web
+                        [public] = #{h[:public] == true ? 1 : 0},
+                        -- what is the latest value reported
+                        [value] = #{h[:value] == true ? 1 : 0},
+                        -- what is the value to show red (true or false). Default value is `false`.
+                        trigger_red = #{h[:trigger_red] == true ? 1 : 0},
+                        -- each time the value is changed, you can show a comment about the last status.
+                        alert_comments = '#{h[:alert_comments].to_s.to_sql}',
+                        -- if it is currently red
+                        stat_red = #{self.is_red? ? 1 : 0},
+                        -- order to show it inside the category, in the dashboard
+                        [order] = #{h[:order].to_i},
+                        -- sharing this with other people, so other people can add my alert on their dashboards.
+                        share = #{h[:share] == true ? 1 : 0},
+                        -- activate this flag to show in the flags column of the dashboard
+                        show_as_flag = #{h[:show_as_flag] == true ? 1 : 0},
+                        -- activate tis flag to show in the timelines column of the dashboard
+                        show_as_timeline = #{h[:show_as_timeline] == true ? 1 : 0}
+                    WHERE
+                        id = '#{h[:id]}'
+                "
+#puts
+#puts
+#puts q
+#puts
+#puts
+                DB.execute(q)
+            end # def parse(h)
+
+            # create a new object.
+            # map the attributes of the hash `h` to this object.
+            # return such an object.
+            def self.create(client, h)
+                u = client.users.first # TODO: the email of the user should be included in the hash descriptor, and validate the user exists and is belonging this client.
+                g = client.categories.select { |g| g.name == h[:category] }.first
+                if g.nil?
+                    g = BlackStack::QABot::Category.new
+                    g.id = guid()
+                    g.create_time = now()
+                    g.id_user = u.id
+                    g.name = h[:category]
+                    g.save
+                end # g.nil?
+                o = BlackStack::QABot::BoolFlag.new
+                h[:id] = guid()
+                h[:id_qacategory] = g.id
+                h[:id_user] = u.id
+                h[:create_time] = now()
+                o.parse(h)
+                o
+            end # def create(h)
+
+            # return true if the flag has been updated after `dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())`
+            def up_to_date?
+                !DB["
+                    select top 1 id
+                    from qaboolflagtrace with (nolock)
+                    where trace_time > dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())
+                    and id_qaboolflag = '#{self.id}'
+                "].first.nil?
+            end
+
+            # return a label to describe when this flag has been updated the last time
+            def last_update_description
+                row = DB["
+                    select top 1 dbo.fnTimeAgoDescription(trace_time, getdate()) as timeago
+                    from qaboolflagtrace with (nolock)
+                    where id_qaboolflag = '#{self.id}'
+                    order by trace_time desc
+                "].first
+                return !row.nil? ? row[:timeago] : 'never'
+            end
+        end # class BoolFlag
+
+        # 
+        class IntFlag < Sequel::Model(:qaintflag) 
+            BlackStack::QABot::IntFlag.dataset = BlackStack::QABot::IntFlag.dataset.disable_insert_output
+            include BlackStack::QABot::Flag
+            many_to_one :user, :class=>:'BlackStack::User', :key=>:id_user
+            many_to_one :category, :class=>:'BlackStack::QABot::Category', :key=>:id_category
+            one_to_many :alerts, :class=>:'BlackStack::QABot::Alert', :key=>:id_qaxflag
+
+            # map the attributes of this object to a hash.
+            # add custom elements to the hash: `:up_to_date`, `:last_update_description`
+            # return such a hash.
+            def to_hash()
+                {
+                    :id => self.id,
+                    :type => BlackStack::QABot::INT,
+                    :id_qacategory => self.id_qacategory,
+                    :create_time => self.create_time,
+                    :delete_time => self.delete_time,
+                    :id_user => self.id_user,
+                    :name => self.name,
+                    :html_description => self.html_description,
+                    # how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                    :trace_frequency_period => self.trace_frequency_period,
+                    :trace_frequency_units => self.trace_frequency_units,
+                    # show this flag public in the web
+                    :public => self.public,
+                    # what is the latest value reported
+                    :value => self.value,
+                    # what is the value to decide to go green or red.
+                    value_threshold => self.value_threshold,                 
+                    # what is the value to show red (true or false).
+                    :trigger_red => self.trigger_red,
+                    # each time the value is changed, you can show a comment about the last status.
+                    :alert_comments => self.alert_comments,
+                    # if it is currently red
+                    :stat_red => self.stat_red,
+                    # order to show it inside the category, in the dashboard
+                    :order => self.order,
+                    # sharing this with other people, so other people can add my alert on their dashboards.
+                    :share => self.share,
+                    # activate this flag to show in the flags column of the dashboard
+                    :show_as_flag => self.show_as_flag,
+                    # activate tis flag to show in the timelines column of the dashboard
+                    :show_as_timeline => self.show_as_timeline,
+                    # custom elements
+                    :up_to_date => self.up_to_date?,
+                    :last_update_description => self.last_update_description,
+                }
+            end # def to_hash() 
+
+            # it is red if the `value` is the same than the value assigned to `trigger_red`
+            def is_red?
+                if self.trigger_red == BlackStack::QABot::LOWER_OR_EQUAL
+                    return self.value <= self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::LOWER
+                    return self.value < self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::EQUAL
+                    return self.value == self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::GREATER
+                    return self.value > self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::GREATER_OR_EQUAL
+                    return self.value >= self.value_threshold
+                else
+                    return nil
+                end
+            end
+
+            # map the attributes of the hash `h` to this object.
+            def parse(h)
+                self.value = h[:value].to_i
+                self.value_threshold = h[:value_threshold].to_i
+                self.value_red = h[:value_red].to_i
+                q = "
+                    UPDATE qaboolflag
+                    SET
+                        id_qacategory = '#{h[:id_qacategory]}',
+                        --create_time = '#{h[:create_time]}',
+                        --delete_time = '#{h[:delete_time]}',
+                        id_user = '#{h[:id_user]}',
+                        name = '#{h[:name].to_s.to_sql}',
+                        html_description = '#{h[:html_description].to_s.to_sql}',
+                        -- how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                        trace_frequency_period = '#{h[:trace_frequency_period]}',
+                        trace_frequency_units = #{h[:trace_frequency_units]},
+                        -- show this flag public in the web
+                        [public] = #{h[:public] == true ? 1 : 0},
+                        -- what is the latest value reported
+                        [value] = #{h[:value].to_i.to_s},
+                        -- what is the value to decide to go green or red.
+                        value_threshold = #{h[:value_threshold].to_i.to_s},            
+                        -- what is the value to show red (true or false). Default value is `false`.
+                        trigger_red = #{h[:trigger_red].to_i.to_s},
+                        -- each time the value is changed, you can show a comment about the last status.
+                        alert_comments = '#{h[:alert_comments].to_s.to_sql}',
+                        -- if it is currently red
+                        stat_red = #{self.is_red? ? 1 : 0},
+                        -- order to show it inside the category, in the dashboard
+                        [order] = #{h[:order].to_i},
+                        -- sharing this with other people, so other people can add my alert on their dashboards.
+                        share = #{h[:share] == true ? 1 : 0},
+                        -- activate this flag to show in the flags column of the dashboard
+                        show_as_flag = #{h[:show_as_flag] == true ? 1 : 0},
+                        -- activate tis flag to show in the timelines column of the dashboard
+                        show_as_timeline = #{h[:show_as_timeline] == true ? 1 : 0}
+                    WHERE
+                        id = '#{h[:id]}'
+                "
+                DB.execute(q)
+            end # def parse(h)
+
+            # create a new object.
+            # map the attributes of the hash `h` to this object.
+            # return such an object.
+            def self.create(client, h)
+                u = client.users.first # TODO: the email of the user should be included in the hash descriptor, and validate the user exists and is belonging this client.
+                g = client.categories.select { |g| g.name == h[:category] }.first
+                if g.nil?
+                    g = BlackStack::QABot::Category.new
+                    g.id = guid()
+                    g.create_time = now()
+                    g.id_user = u.id
+                    g.name = h[:category]
+                    g.save
+                end # g.nil?
+                o = BlackStack::QABot::IntFlag.new
+                h[:id] = guid()
+                h[:id_qacategory] = g.id
+                h[:id_user] = u.id
+                h[:create_time] = now()
+                o.parse(h)
+                o
+            end # def parse(h)
+
+            # return true if the flag has been updated after `dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())`
+            def up_to_date?
+                !DB["
+                    select top 1 id
+                    from qaintflagtrace with (nolock)
+                    where trace_time > dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())
+                    and id_qaintflag = '#{self.id}'
+                "].first.nil?
+            end
+
+            # return a label to describe when this flag has been updated the last time
+            def last_update_description
+                row = DB["
+                    select top 1 dbo.fnTimeAgoDescription(trace_time, getdate()) as timeago
+                    from qaintflagtrace with (nolock)
+                    where id_qaintflag = '#{self.id}'
+                    order by trace_time desc
+                "].first
+                return !row.nil? ? row[:timeago] : 'never'
+            end
+        end # class IntFlag
+
+        # 
+        class FloatFlag < Sequel::Model(:qafloatflag) 
+            BlackStack::QABot::FloatFlag.dataset = BlackStack::QABot::FloatFlag.dataset.disable_insert_output
+            include BlackStack::QABot::Flag
+            many_to_one :user, :class=>:'BlackStack::User', :key=>:id_user
+            many_to_one :category, :class=>:'BlackStack::QABot::Category', :key=>:id_category
+            one_to_many :alerts, :class=>:'BlackStack::QABot::Alert', :key=>:id_qaxflag
+
+            # map the attributes of this object to a hash.
+            # add custom elements to the hash: `:up_to_date`, `:last_update_description`
+            # return such a hash.
+            def to_hash()
+                {
+                    :id => self.id,
+                    :type => BlackStack::QABot::FLOAT,
+                    :id_qacategory => self.id_qacategory,
+                    :create_time => self.create_time,
+                    :delete_time => self.delete_time,
+                    :id_user => self.id_user,
+                    :name => self.name,
+                    :html_description => self.html_description,
+                    # how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                    :trace_frequency_period => self.trace_frequency_period,
+                    :trace_frequency_units => self.trace_frequency_units,
+                    # show this flag public in the web
+                    :public => self.public,
+                    # what is the latest value reported
+                    :value => self.value,
+                    # what is the value to decide to go green or red.
+                    value_threshold => self.value_threshold,                 
+                    # what is the value to show red (true or false).
+                    :trigger_red => self.trigger_red,
+                    # each time the value is changed, you can show a comment about the last status.
+                    :alert_comments => self.alert_comments,
+                    # if it is currently red
+                    :stat_red => self.stat_red,
+                    # order to show it inside the category, in the dashboard
+                    :order => self.order,
+                    # sharing this with other people, so other people can add my alert on their dashboards.
+                    :share => self.share,
+                    # activate this flag to show in the flags column of the dashboard
+                    :show_as_flag => self.show_as_flag,
+                    # activate tis flag to show in the timelines column of the dashboard
+                    :show_as_timeline => self.show_as_timeline,
+                    # custom elements
+                    :up_to_date => self.up_to_date?,
+                    :last_update_description => self.last_update_description,
+                }
+            end # def to_hash() 
+
+            # it is red if the `value` is the same than the value assigned to `trigger_red`
+            def is_red?
+                if self.trigger_red == BlackStack::QABot::LOWER_OR_EQUAL
+                    return self.value <= self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::LOWER
+                    return self.value < self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::EQUAL
+                    return self.value == self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::GREATER
+                    return self.value > self.value_threshold
+                elsif self.trigger_red == BlackStack::QABot::GREATER_OR_EQUAL
+                    return self.value >= self.value_threshold
+                else
+                    return nil
+                end
+            end
+
+            # map the attributes of the hash `h` to this object.
+            def parse(h)
+                self.value = h[:value].to_f
+                self.value_threshold = h[:value_threshold].to_f
+                self.value_red = h[:value_red].to_f
+                q = "
+                    UPDATE qaboolflag
+                    SET
+                        id_qacategory = '#{h[:id_qacategory]}',
+                        --create_time = '#{h[:create_time]}',
+                        --delete_time = '#{h[:delete_time]}',
+                        id_user = '#{h[:id_user]}',
+                        name = '#{h[:name].to_s.to_sql}',
+                        html_description = '#{h[:html_description].to_s.to_sql}',
+                        -- how often run this qa check - what is the frequency to show the timeline -- ss, mi, hh, mm, dd, qq, yy
+                        trace_frequency_period = '#{h[:trace_frequency_period]}',
+                        trace_frequency_units = #{h[:trace_frequency_units]},
+                        -- show this flag public in the web
+                        [public] = #{h[:public] == true ? 1 : 0},
+                        -- what is the latest value reported
+                        [value] = #{h[:value].to_f.to_s},
+                        -- what is the value to decide to go green or red.
+                        value_threshold = #{h[:value_threshold].to_f.to_s},            
+                        -- what is the value to show red (true or false). Default value is `false`.
+                        trigger_red = #{h[:trigger_red].to_f.to_s},
+                        -- each time the value is changed, you can show a comment about the last status.
+                        alert_comments = '#{h[:alert_comments].to_s.to_sql}',
+                        -- if it is currently red
+                        stat_red = #{self.is_red? ? 1 : 0},
+                        -- order to show it inside the category, in the dashboard
+                        [order] = #{h[:order].to_i},
+                        -- sharing this with other people, so other people can add my alert on their dashboards.
+                        share = #{h[:share] == true ? 1 : 0},
+                        -- activate this flag to show in the flags column of the dashboard
+                        show_as_flag = #{h[:show_as_flag] == true ? 1 : 0},
+                        -- activate tis flag to show in the timelines column of the dashboard
+                        show_as_timeline = #{h[:show_as_timeline] == true ? 1 : 0}
+                    WHERE
+                        id = '#{h[:id]}'
+                "
+                DB.execute(q)
+            end # def parse(h)
+
+            # create a new object.
+            # map the attributes of the hash `h` to this object.
+            # return such an object.
+            def self.create(h)
+                u = client.users.first # TODO: the email of the user should be included in the hash descriptor, and validate the user exists and is belonging this client.
+                g = client.categories.select { |g| g.name == h[:category] }.first
+                if g.nil?
+                    g = BlackStack::QABot::Category.new
+                    g.id = guid()
+                    g.create_time = now()
+                    g.id_user = u.id
+                    g.name = h[:category]
+                    g.save
+                end # g.nil?
+                o = BlackStack::QABot::FloatFlag.new
+                h[:id] = guid()
+                h[:id_qacategory] = g.id
+                h[:id_user] = u.id
+                h[:create_time] = now()
+                o.parse(h)
+                o
+            end # def parse(h)
+
+            # return true if the flag has been updated after `dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())`
+            def up_to_date?
+                !DB["
+                    select top 1 id
+                    from qafloatflagtrace with (nolock)
+                    where trace_time > dateadd(#{self.trace_frequency_period}, -#{self.trace_frequency_units}, getdate())
+                    and id_qafloatflag = '#{self.id}'
+                "].first.nil?
+            end
+
+            # return a label to describe when this flag has been updated the last time
+            def last_update_description
+                row = DB["
+                    select top 1 dbo.fnTimeAgoDescription(trace_time, getdate()) as timeago
+                    from qafloatflagtrace with (nolock)
+                    where id_qafloatflag = '#{self.id}'
+                    order by trace_time desc
+                "].first
+                return !row.nil? ? row[:timeago] : 'never'
+            end
+        end # class FloatFlag
+    end # module QABot
+end # module BlackStack

data/lib/qabot.rb

@@ -0,0 +1,249 @@
+
+# sequel class fro the qacategory table
+module BlackStack
+    module QABot
+        BOOL = 'bool'
+        INT = 'int'
+        FLOAT = 'float'
+
+        SS = 'ss'
+        MI = 'mi'
+        HH = 'hh'
+        DD = 'dd'
+        WW = 'ww'
+        MM = 'mm'
+        QQ = 'qq'
+        YY = 'yy'
+
+        LOWER_OR_EQUAL = -2
+        LOWER = -1
+        EQUAL = 0
+        GREATER = 1
+        GREATER_OR_EQUAL = 2
+
+        @@flags_descriptors = [] 
+
+        def self.require_db_classes()
+            # CRM classes
+            require_relative '../lib/dbclasses.rb'
+        end    
+
+        def self.flag_descriptors()
+            @@flags_descriptors
+        end
+
+        def self.types()
+            [
+                BlackStack::QABot::BOOL,
+                BlackStack::QABot::INT,
+                BlackStack::QABot::FLOAT,
+            ]
+        end
+
+        def self.periods()
+            [
+                BlackStack::QABot::SS, 
+                BlackStack::QABot::MI, 
+                BlackStack::QABot::HH, 
+                BlackStack::QABot::DD, 
+                BlackStack::QABot::WW, 
+                BlackStack::QABot::MM, 
+                BlackStack::QABot::QQ, 
+                BlackStack::QABot::YY,
+            ]
+        end 
+
+        def self.trigger_red_values()
+            [
+                BlackStack::QABot::LOWER_OR_EQUAL, 
+                BlackStack::QABot::LOWER, 
+                BlackStack::QABot::EQUAL, 
+                BlackStack::QABot::GREATER_OR_EQUAL, 
+                BlackStack::QABot::GREATER,
+            ]
+        end
+
+        # Validate the values of the hash, after executing the `:value_function` procedure
+        def self.validate_descriptor_values(h)
+            errors = []
+            # VALIDATE: if `:type` is `BOOL`, `:value` must be boolean.
+            errors << "`:value` must be boolean" if h[:type] == BlackStack::QABot::BOOL && ![true, false].include?(h[:value])
+            # VALIDATE: if `:type` is `INT`, `:value` must be integer.
+            errors << "`:value` must be integer" if h[:type] == BlackStack::QABot::INT && !h[:value].is_a?(Integer)
+            # VALIDATE: if `:type` is `FLOAT`, `:value` must be float.
+            errors << "`:value` must be float" if h[:type] == BlackStack::QABot::FLOAT && !h[:value].is_a?(Float)
+            # return 
+            errors
+        end
+
+        # Validate the values of the hash, prior executing the `:value_function` procedure
+        def self.validate_descriptor_parameters_except_functions(h)
+            errors = []
+            # VALIDATE: the `:type` is a valid value
+            errors << "Invalid type: #{h[:type]}" unless BlackStack::QABot.types().include?(h[:type])
+            # VALIDATE: the ':category' is a string no longer than 500 chars
+            errors << "Invalid category: #{h[:category]}. Must be string lower than 500 chars." unless h[:category].is_a?(String) && h[:category].length <= 500
+            # VALIDATE: the `:name` is a string no longer than 500 chars
+            errors << "Invalid name: #{h[:name]}. Must be string lower than 500 chars." unless h[:name].is_a?(String) && h[:name].length <= 500
+            # VALIDATE: the `:description` is a string no longer than 8000 chars
+            errors << "Invalid description: #{h[:description]}. Must be string lower than 8000 chars." unless h[:description].is_a?(String) && h[:description].length <= 8000
+            # VALIDATE: the ':trace_fraquency_period` is a valid value
+            errors << "Invalid trace_frequency_period: #{h[:trace_frequency_period]}" unless BlackStack::QABot.periods().include?(h[:trace_frequency_period])
+            # VALIDATE: the `:trace_frequency_units` is an integer higher than 0
+            errors << "Invalid trace_frequency_units: #{h[:trace_frequency_units]}. Must be integer higher than 0." unless h[:trace_frequency_units].is_a?(Integer) && h[:trace_frequency_units] > 0
+            # VALIDATE: the `:show_as_flag` is a boolean
+            errors << "Invalid show_as_flag: #{h[:show_as_flag]}. Must be boolean." unless h[:show_as_flag].is_a?(TrueClass) || h[:show_as_flag].is_a?(FalseClass)
+            # VALIDATE: the `:show_as_timeline` is a boolean
+            errors << "Invalid show_as_timeline: #{h[:show_as_timeline]}. Must be boolean." unless h[:show_as_timeline].is_a?(TrueClass) || h[:show_as_timeline].is_a?(FalseClass)
+            # VALIDATE: the `:public` is a boolean
+            errors << "Invalid public: #{h[:public]}. Must be boolean." unless h[:public].is_a?(TrueClass) || h[:public].is_a?(FalseClass)
+            # VALIDATE: the `:share` is a boolean
+            errors << "Invalid share: #{h[:share]}. Must be boolean." unless h[:share].is_a?(TrueClass) || h[:share].is_a?(FalseClass)
+            # VALIDATE: if `:type` is `BOOL`, then `:trigger_red` must be a boolean
+            errors << "Invalid trigger_red: #{h[:trigger_red]}. Must be boolean." if h[:type] == BlackStack::QABot::BOOL && !(h[:trigger_red].is_a?(TrueClass) || h[:trigger_red].is_a?(FalseClass))
+            # VALIDATE: if `:type` is `INT` OR `FLOAT`, then `:trigger_red` must be beloning `trigger_red_values`
+            errors << "Invalid trigger_red: #{h[:trigger_red]}. Must be one of #{trigger_red_values.to_s}" if (h[:type] == BlackStack::QABot::INT || h[:type] == BlackStack::QABot::FLOAT) && !trigger_red_values.include?(h[:trigger_red])
+            # VALIDATE: if `:type` is 'INT', then `:value_threshold` must ba an integer.
+            errors << "Invalid trigger_red: #{h[:value_threshold]}. Must be integer." if h[:type] == BlackStack::QABot::INT && !h[:value_threshold].is_a?(Integer)
+            # VALIDATE: if `:ty[e` is `FLOAT`, then `:trigger_red` must be a float.
+            errors << "Invalid trigger_red: #{h[:value_threshold]}. Must be float." if h[:type] == BlackStack::QABot::FLOAT && !h[:value_threshold].is_a?(Float)
+            # return errors
+            errors
+        end # def self.validate_descriptor_parameters_except_functions
+
+        # return a `flag` object belonging this client, with this name
+        def self.find(client, name)
+            return nil if client.nil? || name.nil?
+            return nil if client.flags.nil?
+            client.flags.each do |flag|
+                return flag if flag.name == name
+            end
+            nil
+        end
+
+        # return `true` if exists a flag belonging this client, with this name
+        def self.exists?(client, name)
+            !BlackStack::QABot::find(client, name).nil?
+        end
+
+        # create a new flag belonging this client, with this name
+        def self.create(client, h)
+            o = nil
+            o = BlackStack::QABot::BoolFlag.create(client, h) if h[:type] == BlackStack::QABot::BOOL
+            o = BlackStack::QABot::IntFlag.create(client, h) if h[:type] == BlackStack::QABot::INT
+            o = BlackStack::QABot::FloatFlag.create(client, h) if h[:type] == BlackStack::QABot::FLOAT
+            o
+        end # def self.create
+
+        # update the flag belonging this client, with this name, with the values in the hash descriptor
+        def self.parse(client, h)
+            o = BlackStack::QABot::find(client, h[:name])
+            return nil if o.nil?
+            h[:id] = o.id
+
+            g = client.categories.select { |g| g.name == h[:category] }.first
+            if g.nil?
+                g = BlackStack::QABot::Category.new
+                g.id = guid()
+                g.create_time = now()
+                g.id_user = u.id
+                g.name = h[:category]
+                g.save
+            end # g.nil?
+            h[:id_qacategory] = g.id
+            h[:id_user] = client.users.first.id # TODO: I should receive the email of the email in the hash descriptor, and validate the email is belonging the client.
+            h[:html_description] = h[:description]
+            o.parse(h)
+            o
+        end # def self.parse
+
+        # return `true` if exists a flag belonging this client, with this name
+        def self.exists_by_id?(client, id)
+            return false if client.nil? || id.nil?
+            return false if client.flags.nil?
+            client.flags.each do |flag|
+                return true if flag.id == id
+            end
+            false
+        end
+
+        # return `true` if exists a flag belonging this client, with this name
+        def self.exists_by_id_and_name?(client, id, name)
+            return false if client.nil? || id.nil? || name.nil?
+            return false if client.flags.nil?
+            client.flags.each do |flag|
+                return true if flag.id == id && flag.name == name
+            end
+            false
+        end
+
+        # return `true` if exists a flag belonging this client, with this name
+        def self.exists_by_name?(client, name)
+            return false if client.nil? || name.nil?
+            return false if client.flags.nil?
+            client.flags.each do |flag|
+                return true if flag.name == name
+            end
+            false
+        end
+
+        # return `true` if exists a flag belonging this client, with this name
+        def self.exists_by_name_and_id?(client, name, id)
+            return false if client.nil? || name.nil? || id.nil?
+            return false if client.flags.nil?
+            client.flags.each do |flag|
+                return true if flag.name == name && flag.id == id
+            end
+            false
+        end
+
+        # 
+        def self.add_flag(h)
+            # get the errors on all parameters except functions
+            errors = BlackStack::QABot::validate_descriptor_parameters_except_functions(h)
+            # VALIDATE: the `:value_function` is a procedure
+            errors << "Invalid value_function. Must be procedure." unless h[:value_function].is_a?(Proc)
+            # VALIDATE: the `:alert_comments_function` is a procedure
+            errors << "Invalid alert_comments_function. Must be procedure." unless h[:alert_comments_function].is_a?(Proc)
+            # raise an exception if `errors` has any element
+            raise errors.join("\n") if errors.length > 0
+            # add `h` to `@@flags_descriptors`
+            @@flags_descriptors << h
+            # return the array
+            @@flags_descriptors
+        end # def self.add_flag
+
+        def self.run_all()
+            @@flags_descriptors.each do |h|
+                BlackStack::QABot.run(h)
+            end
+        end
+
+        def self.run(h)
+            h[:value] = h[:value_function].call()
+            h[:alert_comments] = h[:alert_comments_function].call()
+            BlackStack::QABot::Flag.push(h)
+        end
+
+        # this module contains methods that are commons to any kind flags
+        module Flag
+            # return true of the latest trace is `stat_red==true`, and the previous trace is `stat_red==false`.
+            def should_alert?
+                # TODO: Code Me!
+                false
+            end # def should_alert?
+
+            # send an email notification to all the receivers of this flag.
+            def alert()
+                # TODO: Code Me!
+            end # def alert()
+
+            # submit a flag descriptor to the server, via REST-API.
+            def self.push(h)
+                url = "#{BlackStack::Pampa::api_url}/api.1.1.0/qabot/push.json"
+                api_key = BlackStack::Pampa::api_key
+                BlackStack::Netting::api_call( url, {:api_key => api_key}.merge(h) )
+            end
+        end # module Flag
+    end # module QABot
+end # module BlackStack

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: qabot
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+- !ruby/object:Gem::Dependency
+  name: pampa_workers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.36
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.36
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.36
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.36
+description: 'THIS GEM IS STILL IN DEVELOPMENT STAGE. Find documentation here: https://github.com/leandrosardi/pampa_dispatcher.'
+email: leandro.sardi@expandedventure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dbclasses.rb
+- lib/qabot.rb
+homepage: https://rubygems.org/gems/pampa_deployer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: THIS GEM IS STILL IN DEVELOPMENT STAGE. Distribute work along a pool of Pampa
+  workers.
+test_files: []