queri 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ff886a7b69a9fdfe36380d9203f402fb8ed330
-  data.tar.gz: 8ee9d637892fe1cf67970193e4ddaf8e9389f9a3
+  metadata.gz: 612927a2b34f04be0e348fe2e912d394c76f090f
+  data.tar.gz: 4190fbb0234b4030c19d99c27b657f46ed04aa83
 SHA512:
-  metadata.gz: d7d5dd17f5d435eaf4aa22c97273af719770e3b44bf67b955ef7300010951c14444021a362618313802aef9b5acf478ac8a9785d6a3c06a238a8ad9f80a06799
-  data.tar.gz: 031a8cfe9662fdb113fdada643bbdd209b6a2b603a4c9df3aac027150d97ea4f48099e5d4bdfcd126788bc870440dba790c30088f0c2b06eb4aee014df258c2a
+  metadata.gz: 94e0ac64d458d469c8cf265ba2ba992ce9dff4b6db946a92b86352540159a886923ca83d29b4f51e9c864cef890ef680df96a05ea2448d2cc7da4e3bb43b7601
+  data.tar.gz: 5dbf0d3d62ccfa59d13b0585fe29646ef9b30da8ba7460debc9a2aeff502894936817c5056fa0d09005eace22ecc95c725a6fe3f0d27962d0710ee7a2d55c294

data/README.md

@@ -26,7 +26,7 @@ Configurations for connecting to a Queuemetrics XMLRPC client are needed to send
 
 You can set these configurations with the following:
 
-    Queri::configure({username: "new\_user", password: "new\_password"})
+    Queri::configure({username: "new_user", password: "new_password"})
 
 or with a local YAML file:
 
@@ -38,7 +38,7 @@ or with a local YAML file:
     period_start = Time.now - 3600
     period_end = Time.now
     Queri::Stats::AgentsAndSessions::AgentAvailability.new( queues, period_start, period_end )
-    #=> report\_object
+    #=> report_object
 
 These report objects respond to the method #response, which returns either an Array or a Hash, depending on whether the report is an agent-level or aggregate analysis.
 Keys for this response can be found by calling ::keys on the object class. ::key\_translations for the object class returns a hash associating these keys with the raw data keys returned from the XMLRPC client.
@@ -52,6 +52,20 @@ Currently returns analyses from two methods: QM.stats and QM.realtime.
     * AnsweredCalls
       * AgentsOnQueue
       * AllCalls
+      * AnsweredCallsByDirection
+      * AnsweredCallsByQueue
+      * AnsweredCallsByStints
+      * CallsFullyWithinGivenTimeInterval
+      * DisconnectionCauses
+      * DnisUsed
+      * IvrSelection
+      * MusicOnHoldByAgent
+      * QueuePosition
+      * ServiceLevelAgreement
+      * Transfers
+    * DetailsOfAgentSessionsAndPauses
+      * DetailOfAgentSessions
+      * DetailOfAgentPauses
     * UnansweredCalls
       * AllCalls
   * Realtime
@@ -70,7 +84,9 @@ Any subclass of Queri::Realtime will accept timestamps for period, but they will
 
 Returned values vary between agent-level and aggregate reports.
 Agent-level reports return an Array of Hashes, each Hash corresponding to an agent's metrics for the requested analysis.
+Composite agent-level reports return a Hash associating agent usernames with an Array of Hashes (each record for the requested analysis).
 Aggregate reports return a single Hash; the composite metrics for the requested analysis.
+Composite aggregate reports return an Array of Hashes, each Hash corresponding to various criteria for the composite metrics of the request analysis.
   * Agent-level reports
     * Stats
       * AgentsAndSessions
@@ -80,12 +96,32 @@ Aggregate reports return a single Hash; the composite metrics for the requested
     * Realtime
       * Agents
       * Queues
+  * Composite agent-level reports
+    * Stats
+      * AnsweredCalls
+        * MusicOnHoldByAgent
+      * DetailsOfAgentSessionsAndPauses
+        * DetailOfAgentSessions
+        * DetailOfAgentPauses
   * Aggregate reports
     * Stats
       * AnsweredCalls
         * AllCalls
+        * CallsFullyWithinGivenTimeInterval
       * UnansweredCalls
         * AllCalls
+  * Composite aggregate reports
+    * Stats
+      * AnsweredCalls
+        * AnsweredCallsByDirection
+        * AnsweredCallsByQueue
+        * AnsweredCallsByStints
+        * DisconnectionCauses
+        * DnisUsed
+        * IvrSelection
+        * QueuePosition
+        * ServiceLevelAgreement
+        * Transfers
 
 ## Contributing
 

data/lib/queri.rb

@@ -56,7 +56,7 @@ module Queri
   end
 
   def self.send_request *args
-    raise LoadError, "client configs not set. Assign by passing a hash to Queri.configure or a yaml file path to Queri.configure_with" if (@config.nil? || @config.empty?)
+    raise LoadError, "client configs not set. Assign by passing a hash to Queri.configure or a yaml file path to Queri.configure_with" if @@server.nil?
     request = Request.new(*args)
     response = @@server.call(*request.parameters)
     return response[request.report.class.xml_code]

data/lib/queri/stats/answered_calls/answered_calls_by_direction.rb

@@ -0,0 +1,74 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class AnsweredCallsByDirection
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".AnsweredcallsByDirection"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :direction_icon, "&nbsp;",
+              :direction, "Direction",
+              :number_of_calls, "N. Calls",
+              :percentage_of_calls, "&nbsp;",
+              :placeholder_for_bar_graph, "..."
+            ]
+          end
+
+          def keys
+            key_translations.keys
+          end
+
+        end
+
+        def initialize *args
+          raise ArgumentError, "expected arguments: queues(Array), period_start(Time), period_end(Time)" unless valid_args?(args)
+          @queues, @period_start, @period_end = normalize_times(*args)
+          @response = parse_response
+        end
+
+        private
+
+          def valid_args? args
+            valid = true
+            valid = false if args[0].class != Array
+            valid = false if args[1].class != Time
+            valid = false if args[2].class != Time
+            if valid and args[0].empty?
+              raise ArgumentError, "queues array cannot be empty"
+            end
+            return valid
+          end
+
+          def normalize_times queues, period_start, period_end
+            if period_start > period_end
+              tmp = period_start
+              period_start = period_end
+              period_end = tmp
+            end
+            return [queues, period_start, period_end]
+          end
+
+          def parse_response
+            r = Queri.send_request(@queues, self, @period_start, @period_end)
+            xml_keys_to_human_readable_keys = self.class.key_translations.invert
+            new_keys = r.shift.map {|k| xml_keys_to_human_readable_keys[k]}
+            agent_metrics = []
+            r.each do |agent|
+              agent_metrics << Hash[new_keys.zip(agent)]
+            end
+            return agent_metrics
+          end
+
+      end
+    end
+  end
+end

data/lib/queri/stats/answered_calls/answered_calls_by_queue.rb

@@ -0,0 +1,74 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class AnsweredCallsByQueue
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".AnsweredcallsByQueue"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :empty_column, "&nbsp;",
+              :queue, "Queue",
+              :number_of_calls, "N. Calls",
+              :percentage_of_calls, "&nbsp;",
+              :placeholder_for_bar_graph, "..."
+            ]
+          end
+
+          def keys
+            key_translations.keys
+          end
+
+        end
+
+        def initialize *args
+          raise ArgumentError, "expected arguments: queues(Array), period_start(Time), period_end(Time)" unless valid_args?(args)
+          @queues, @period_start, @period_end = normalize_times(*args)
+          @response = parse_response
+        end
+
+        private
+
+          def valid_args? args
+            valid = true
+            valid = false if args[0].class != Array
+            valid = false if args[1].class != Time
+            valid = false if args[2].class != Time
+            if valid and args[0].empty?
+              raise ArgumentError, "queues array cannot be empty"
+            end
+            return valid
+          end
+
+          def normalize_times queues, period_start, period_end
+            if period_start > period_end
+              tmp = period_start
+              period_start = period_end
+              period_end = tmp
+            end
+            return [queues, period_start, period_end]
+          end
+
+          def parse_response
+            r = Queri.send_request(@queues, self, @period_start, @period_end)
+            xml_keys_to_human_readable_keys = self.class.key_translations.invert
+            new_keys = r.shift.map {|k| xml_keys_to_human_readable_keys[k]}
+            agent_metrics = []
+            r.each do |agent|
+              agent_metrics << Hash[new_keys.zip(agent)]
+            end
+            return agent_metrics
+          end
+
+      end
+    end
+  end
+end

data/lib/queri/stats/answered_calls/answered_calls_by_stints.rb

@@ -0,0 +1,73 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class AnsweredCallsByStints
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".StintsOk"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :number_of_stints, "Number of stints",
+              :number_of_calls, "N. Calls",
+              :percentage_of_calls, "&nbsp;",
+              :placeholder_for_bar_graph, "..."
+            ]
+          end
+
+          def keys
+            key_translations.keys
+          end
+
+        end
+
+        def initialize *args
+          raise ArgumentError, "expected arguments: queues(Array), period_start(Time), period_end(Time)" unless valid_args?(args)
+          @queues, @period_start, @period_end = normalize_times(*args)
+          @response = parse_response
+        end
+
+        private
+
+          def valid_args? args
+            valid = true
+            valid = false if args[0].class != Array
+            valid = false if args[1].class != Time
+            valid = false if args[2].class != Time
+            if valid and args[0].empty?
+              raise ArgumentError, "queues array cannot be empty"
+            end
+            return valid
+          end
+
+          def normalize_times queues, period_start, period_end
+            if period_start > period_end
+              tmp = period_start
+              period_start = period_end
+              period_end = tmp
+            end
+            return [queues, period_start, period_end]
+          end
+
+          def parse_response
+            r = Queri.send_request(@queues, self, @period_start, @period_end)
+            xml_keys_to_human_readable_keys = self.class.key_translations.invert
+            new_keys = r.shift.map {|k| xml_keys_to_human_readable_keys[k]}
+            agent_metrics = []
+            r.each do |agent|
+              agent_metrics << Hash[new_keys.zip(agent)]
+            end
+            return agent_metrics
+          end
+
+      end
+    end
+  end
+end

data/lib/queri/stats/answered_calls/calls_fully_within_the_given_time_interval.rb

@@ -0,0 +1,82 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class CallsFullyWithinTheGivenTimeInterval
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".RiassFullyWithin"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :calls_fully_within_the_given_time_interval, "Calls fully within the given time interval:",
+              :calls_answered, "N. calls answered by operators:",
+              :average_call_length, "Average call length:",
+              :minimum_call_length, "Min call length:",
+              :maximum_call_length, "Max call length:",
+              :total_call_length, "Total call length:",
+              :average_call_waiting_time, "Average call waiting time:",
+              :minimum_call_waiting_time, "Min waiting time:",
+              :maximum_call_waiting_time, "Max waiting time:",
+              :total_call_waiting_time, "Total waiting time:",
+              :average_initial_queue_position, "Average initial position",
+              :minimum_initial_queue_position, "Min initial position",
+              :maximum_initial_queue_position, "Max initial position",
+              :queue_position_coverage, "Coverage"
+            ]
+          end
+
+          def keys
+            key_translations.keys
+          end
+        end
+
+        def initialize *args
+          raise ArgumentError, "expected arguments: queues(Array), period_start(Time), period_end(Time)" unless valid_args?(args)
+          @queues, @period_start, @period_end = normalize_times(*args)
+          @response = parse_response
+        end
+
+        private
+
+          def valid_args? args
+            valid = true
+            valid = false if args[0].class != Array
+            valid = false if args[1].class != Time
+            valid = false if args[2].class != Time
+            if valid and args[0].empty?
+              raise ArgumentError, "queues array cannot be empty"
+            end
+            return valid
+          end
+
+          def normalize_times queues, period_start, period_end
+            if period_start > period_end
+              tmp = period_start
+              period_start = period_end
+              period_end = tmp
+            end
+            return [queues, period_start, period_end]
+          end
+
+          def parse_response
+            r = Queri.send_request(@queues, self, @period_start, @period_end)
+            xml_keys_to_human_readable_keys = self.class.key_translations.invert
+            r.each_with_index do |metric,i|
+              if i > 0
+                metric[0] = xml_keys_to_human_readable_keys[ metric[0] ]
+              end
+            end
+            r.shift
+            Hash[*r.flatten]
+          end
+      end
+    end
+  end
+end

data/lib/queri/stats/answered_calls/disconnection_causes.rb

@@ -0,0 +1,73 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class DisconnectionCauses
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".DisconnectionCauses"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :disconnection_cause, "Cause",
+              :number_of_calls, "N. Calls",
+              :percentage_of_calls, "&nbsp;",
+              :placeholder_for_bar_graph, "..."
+            ]
+          end
+
+          def keys
+            key_translations.keys
+          end
+
+        end
+
+        def initialize *args
+          raise ArgumentError, "expected arguments: queues(Array), period_start(Time), period_end(Time)" unless valid_args?(args)
+          @queues, @period_start, @period_end = normalize_times(*args)
+          @response = parse_response
+        end
+
+        private
+
+          def valid_args? args
+            valid = true
+            valid = false if args[0].class != Array
+            valid = false if args[1].class != Time
+            valid = false if args[2].class != Time
+            if valid and args[0].empty?
+              raise ArgumentError, "queues array cannot be empty"
+            end
+            return valid
+          end
+
+          def normalize_times queues, period_start, period_end
+            if period_start > period_end
+              tmp = period_start
+              period_start = period_end
+              period_end = tmp
+            end
+            return [queues, period_start, period_end]
+          end
+
+          def parse_response
+            r = Queri.send_request(@queues, self, @period_start, @period_end)
+            xml_keys_to_human_readable_keys = self.class.key_translations.invert
+            new_keys = r.shift.map {|k| xml_keys_to_human_readable_keys[k]}
+            agent_metrics = []
+            r.each do |agent|
+              agent_metrics << Hash[new_keys.zip(agent)]
+            end
+            return agent_metrics
+          end
+
+      end
+    end
+  end
+end