queri 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8ff886a7b69a9fdfe36380d9203f402fb8ed330
+  data.tar.gz: 8ee9d637892fe1cf67970193e4ddaf8e9389f9a3
+SHA512:
+  metadata.gz: d7d5dd17f5d435eaf4aa22c97273af719770e3b44bf67b955ef7300010951c14444021a362618313802aef9b5acf478ac8a9785d6a3c06a238a8ad9f80a06799
+  data.tar.gz: 031a8cfe9662fdb113fdada643bbdd209b6a2b603a4c9df3aac027150d97ea4f48099e5d4bdfcd126788bc870440dba790c30088f0c2b06eb4aee014df258c2a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/config.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in queri.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Rice
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Queri
+
+Queri, or Queuemetrics Reporting Interface, sends requests to XMLRPC Client to return stats from Queuemetrics' reporting API platform given a valid set of client configurations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'queri'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queri
+
+## Usage
+
+### Configuring
+
+Configurations for connecting to a Queuemetrics XMLRPC client are needed to send requests for analyses. They can be viewed with:
+
+    Queri::config
+
+You can set these configurations with the following:
+
+    Queri::configure({username: "new\_user", password: "new\_password"})
+
+or with a local YAML file:
+
+    Queri::configure_with("/path/to/a/config.yml")
+
+### Basic Usage
+
+    queues = ["1234"]
+    period_start = Time.now - 3600
+    period_end = Time.now
+    Queri::Stats::AgentsAndSessions::AgentAvailability.new( queues, period_start, period_end )
+    #=> 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.
+
+### Available Analyses
+
+Currently returns analyses from two methods: QM.stats and QM.realtime.
+  * Stats
+    * AgentsAndSessions
+      * AgentAvailability
+    * AnsweredCalls
+      * AgentsOnQueue
+      * AllCalls
+    * UnansweredCalls
+      * AllCalls
+  * Realtime
+    * Agents
+    * Queues
+
+### Required Arguments
+
+Required arguments differ for the report classes.
+
+Any subclass of Queri::Stats requires timestamps for period start and end, and will correct cases in which beginning times are greater than ending times.
+
+Any subclass of Queri::Realtime will accept timestamps for period, but they will be ignored in the returned response, as the QM.realtime method does not accept a period restriction.
+
+### Returned Values
+
+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.
+Aggregate reports return a single Hash; the composite metrics for the requested analysis.
+  * Agent-level reports
+    * Stats
+      * AgentsAndSessions
+        * AgentAvailability
+      * AnsweredCalls
+        * AgentsOnQueue
+    * Realtime
+      * Agents
+      * Queues
+  * Aggregate reports
+    * Stats
+      * AnsweredCalls
+        * AllCalls
+      * UnansweredCalls
+        * AllCalls
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/queri/realtime/agents.rb

@@ -0,0 +1,80 @@
+module Queri
+  class Realtime
+    class Agents
+      attr_reader :response
+
+      class << self
+        def xml_code
+          Realtime.xml_code + ".RTAgentsLoggedIn"
+        end
+
+        def query_method
+          Realtime.query_method
+        end
+
+        def key_translations
+          Hash[
+            :ready_state, "&nbsp;",
+            :empty_column, "&nbsp;",
+            :agent, "Agent &nbsp;",
+            :login_time, "Last logon &nbsp;",
+            :assigned_queues, "Queue(s):",
+            :extension, "Extension &nbsp;",
+            :pause, "On pause &nbsp;",
+            :server, "Srv",
+            :time_last_call_ended, "Last call",
+            :on_queue, "On queue",
+            :magic_wand, "&nbsp;"
+          ]
+        end
+
+        def keys
+          # This response is a conversion of a table view, and contains non-unique
+          # key values, so this method must be statically recorded, as to maintain
+          # order of keys.
+          [
+            :ready_state,
+            :empty_column,
+            :agent,
+            :login_time,
+            :assigned_queues,
+            :extension,
+            :pause,
+            :server,
+            :time_last_call_ended,
+            :on_queue,
+            :magic_wand
+          ]
+        end
+      end
+
+      def initialize *args
+        raise ArgumentError, "expected argument: queues(Array)" unless valid_args?(args)
+        @queues = args.first
+        @response = parse_response
+      end
+
+      private
+
+        def valid_args? args
+          valid = true
+          valid = false if args[0].class != Array
+          if valid and args[0].empty?
+            raise ArgumentError, "queues array cannot be empty"
+          end
+          return valid
+        end
+
+        def parse_response
+          r = Queri.send_request(@queues, self)
+          agent_metrics = []
+          r.each_with_index do |agent,i|
+            if i > 0
+              agent_metrics << Hash[self.class.keys.zip(agent)]
+            end
+          end
+          return agent_metrics
+        end
+    end
+  end
+end

data/lib/queri/realtime/queues.rb

@@ -0,0 +1,64 @@
+module Queri
+  class Realtime
+    class Queues
+      attr_reader :response
+
+      class << self
+        def xml_code
+          Realtime.xml_code + ".RTRiassunto"
+        end
+
+        def query_method
+          Realtime.query_method
+        end
+
+        def key_translations
+          Hash[
+            :empty_column, "&nbsp;",
+            :queue, "Queue &nbsp;",
+            :agents_logged_on, "N. agents",
+            :ready_agents, "Ready agents",
+            :paused_agents, "On pause",
+            :nonmembers_on_calls, "Unk",
+            :members_on_call_in_another_queue, "Bsy",
+            :calls_waiting, "N. Calls waiting",
+            :agents_handling_inbound_calls, "On phone inbound",
+            :agents_handling_outbound_calls, "On phone outbound"
+          ]
+        end
+
+        def keys
+          key_translations.keys
+        end
+      end
+
+      def initialize *args
+        raise ArgumentError, "expected argument: queues(Array)" unless valid_args?(args)
+        @queues = args.first
+        @response = parse_response
+      end
+
+      private
+
+        def valid_args? args
+          valid = true
+          valid = false if args[0].class != Array
+          if valid and args[0].empty?
+            raise ArgumentError, "queues array cannot be empty"
+          end
+          return valid
+        end
+
+        def parse_response
+          r = Queri.send_request(@queues, self)
+          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

data/lib/queri/realtime.rb

@@ -0,0 +1,14 @@
+module Queri
+  class Realtime
+    @@query_method = "QM.realtime"
+    @@xml_code = "RealtimeDO"
+
+    def self.query_method
+      @@query_method
+    end
+
+    def self.xml_code
+      @@xml_code
+    end
+  end
+end

data/lib/queri/stats/agents_and_sessions/agent_availability.rb

@@ -0,0 +1,76 @@
+module Queri
+  class Stats
+    class AgentsAndSessions
+      class AgentAvailability
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AgentsAndSessions.xml_code + ".AgentAvail"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :level, "Level",
+              :agent, "Agent",
+              :time, "Time",
+              :total_pause_time, "On pause",
+              :billable_pause_time, "Billable",
+              :non_billable_pause_time, "Non bill.",
+              :billable_non_billable_overlap_time, "Overlapping",
+              :pause_percentage_of_total_time, "&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/agents_and_sessions.rb

@@ -0,0 +1,11 @@
+module Queri
+  class Stats
+    class AgentsAndSessions
+      @@xml_code = "AgentsDo"
+
+      def self.xml_code
+        @@xml_code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class AgentsOnQueue
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".AgentsOnQueue"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :agent, "Agent",
+              :number_of_calls, "N. Calls",
+              :percentage_of_all_calls_handled, "&nbsp;",
+              :placeholder_for_bar_graph, "...",
+              :total_call_time, "Total call time",
+              :average_call_time, "Average call time"
+            ]
+          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/all_calls.rb

@@ -0,0 +1,81 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      class AllCalls
+        attr_reader :response
+
+        class << self
+          def xml_code
+            AnsweredCalls.xml_code + ".RiassAllCalls"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :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_wait_time, "Average call waiting time:",
+              :minimum_wait_time, "Min waiting time:",
+              :maximum_wait_time, "Max waiting time:",
+              :total_wait_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.rb

@@ -0,0 +1,11 @@
+module Queri
+  class Stats
+    class AnsweredCalls
+      @@xml_code = "OkDO"
+
+      def self.xml_code
+        @@xml_code
+      end
+    end
+  end
+end

data/lib/queri/stats/unanswered_calls/all_calls.rb

@@ -0,0 +1,80 @@
+module Queri
+  class Stats
+    class UnansweredCalls
+      class AllCalls
+        attr_reader :response
+
+        class << self
+          def xml_code
+            UnansweredCalls.xml_code + ".ReportKoAll"
+          end
+
+          def query_method
+            Stats.query_method
+          end
+
+          def key_translations
+            Hash[
+              :calls_unanswered, "N.of unanswered calls:",
+              :average_wait_before_disconnect, "Average wait time before disconnection:",
+              :minimum_wait_before_disconnect, "Min wait time before disconnection:",
+              :maximum_wait_before_disconnect, "Max wait time before disconnection:",
+              :total_wait_before_disconnect, "Total wait time before disconnection:",
+              :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",
+              :average_queue_position_at_disconnect, "Average queue position at disconnection:",
+              :minimum_queue_position_at_disconnect, "Min queue position at disconnection:",
+              :maximum_queue_position_at_disconnect, "Max queue position at disconnection:"
+            ]
+          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/unanswered_calls.rb

@@ -0,0 +1,11 @@
+module Queri
+  class Stats
+    class UnansweredCalls
+      @@xml_code = "KoDO"
+
+      def self.xml_code
+        @@xml_code
+      end
+    end
+  end
+end

data/lib/queri/stats.rb

@@ -0,0 +1,9 @@
+module Queri
+  class Stats
+    @@query_method = "QM.stats"
+
+    def self.query_method
+      @@query_method
+    end
+  end
+end

data/lib/queri/version.rb

@@ -0,0 +1,3 @@
+module Queri
+  VERSION = "0.0.2"
+end