qmetrics 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae3049cafee32758f34d294bb86246b8f9cc7bdd
+  data.tar.gz: ba4d97cca904ded5689436d108ce7375e08649c7
+SHA512:
+  metadata.gz: 02b65c3c6472a6958b21289462241211c8fac893d7cebdffdd85a383321a1141dfb3a52f80eabd409603337d804cdfb1e299f67d40d0c870cdbc63abf00ebaef
+  data.tar.gz: 56b07f2d90f474895da16e6fa24fef75c24dd85c856473db5ddfd55c21389b5dd27197984850bc337ad1e47c307fef35f2aaaef4297e5218e3500aaf93a7dd83

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/support/*.yml
+*.bundle
+*.so
+*.swp
+*.swo
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+Qmetrics

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin Collette
+
+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,141 @@
+# Qmetrics
+
+Qmetrics is a gem that wraps the Queuemetrics JSON API with Ruby!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qmetrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qmetrics
+
+## Usage
+
+Note that this gem is unfinished! Things still need to be tweaked and tested.
+
+```ruby
+api = Qmetrics::API.new(server: 192.168.1.101, port: 80, user: "foo", pass: "bar")
+api.stats(queue: [4343], from: Time.now-86400, to: Time.now)
+
+p api.stats.all_calls.result
+#=> #<Qmetrics::Response:0x007feac2bdada8 @status="OK", @description="", @time_elapsed="109ms", @qmetrics_version="14.06.2", @result={:all_calls=>{"All calls:"=>"&nbsp;", "N. calls answered by operators:"=>"1,477", "Average call length:"=>"387.1 s.", "Min call length:"=>"0:00", "Max call length:"=>"1:22:45", "Total call length:"=>"158.8 H", "Average call waiting time:"=>"20.8 s.", "Min waiting time:"=>"0:01", "Max waiting time:"=>"7:54", "Total waiting time:"=>"8.6 H", "Average initial position"=>"1.5", "Min initial position"=>"1", "Max initial position"=>"7", "Coverage"=>"99.9%"}}
+```
+
+## Supported Methods
+
+### Stats
+
+  - all_calls
+  - calls_within
+  - agents_on_queue
+  - service_level_agreement
+  - disconnection_causes
+  - transfers
+  - answered_calls_by_queue
+  - answered_calls_by_direction
+  - stints
+  - initial_queue_positions
+  - ivr_selections
+  - dnis
+  - music_on_hold_by_agent
+  - report_header
+  - answered_calls_details
+  - ivr_details
+  - all_unanswered_calls
+  - unanswered_calls_within
+  - disconnection_causes
+  - unanswered_by_queue
+  - unanswered_outbound_calls
+  - unanswered_by_length
+  - inclusive_sla
+  - unanswered_by_key_press
+  - unanswered_stints
+  - all_calls_by_stints
+  - all_calls_initial_queue_position
+  - lost_calls_ivr_selections
+  - all_calls_ivr_selections
+  - lost_calls_dnis
+  - all_calls_dnis
+  - call_overview
+  - inclusive_answered_sla
+  - unanswered_calls_details
+  - area_code_report
+  - answered_calls_by_area
+  - inbound_acd_call_attempts
+  - acd_attempts_by_queue
+  - acd_attempts_by_terminal
+  - answered_call_distribution_by_day
+  - answered_call_wait_time_per_day
+  - unanswered_call_wait_time_per_day
+  - sales_per_day
+  - schedule_adherence_per_day
+  - queue_length_per_day
+  - inclusive_sla_per_day
+  - traffic_analysis_per_day
+  - answered_call_distribution_per_hour
+  - answered_call_wait_time_per_hour
+  - unanswered_call_wait_time_per_hour
+  - sales_per_hour
+  - schedule_adherence_per_hour
+  - queue_length_per_hour
+  - inclusive_sla_per_hour
+  - traffic_analysis_per_hour
+  - answered_call_distribution_per_day_of_week
+  - answered_call_wait_time_per_day_of_week
+  - unanswered_call_wait_time_per_day_of_week
+  - sales_per_day_of_week
+  - schedule_adherence_per_day_of_week
+  - queue_length_per_day_of_week
+  - inclusive_sla_per_day_of_week
+  - traffic_analysis_per_day_of_week
+  - agent_session_detail
+  - session_and_pause_durations
+  - agent_availability
+  - answered_calls
+  - answered_calls_by_custom_group
+  - answered_calls_by_location
+  - answered_calls_by_service_group
+  - agent_performance_by_acd_group
+  - agent_occupancy_report
+  - agent_payable_time_by_hour
+  - agent_billable_time_by_hour
+  - detail_of_agent_pauses
+  - outcomes
+  - call_results_by_outcomes
+  - billable_activities
+  - non_billable_activities
+  - detailed_agent_report
+  - outcomes_per_agent
+  - ivr_traversals
+  - ivr_timing
+  - ivr_goals
+
+### Realtime
+
+  - queues_in_use
+  - calls_being_processed
+  - agents_logged_in
+  - wallboard_top_panel
+  - wall_calls_being_processed
+  - visitor_calls_processed
+  - calls_taken
+  - calls_lost
+  - raw_agent_panel
+  - raw_calls_panel
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/Qmetrics/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/qmetrics.rb

@@ -0,0 +1,14 @@
+#dependencies
+require 'httparty'
+
+#lib
+require "qmetrics/version"
+require "qmetrics/api"
+require "qmetrics/caller"
+require "qmetrics/stats"
+require "qmetrics/realtime"
+require "qmetrics/response"
+
+module Qmetrics
+
+end

data/lib/qmetrics/api.rb

@@ -0,0 +1,45 @@
+module Qmetrics
+  class HTTPStatusError < StandardError
+  end
+
+  class API
+
+    def initialize(server: , port: , user: , pass: )
+      @base_route = "http://#{server}:#{port}/queuemetrics"
+      @auth = { basic_auth: { username: user, password: pass } }
+    end
+
+    def call(api_method,options={})
+      check_status(HTTParty.get("#{@base_route}/#{api_method}",
+                                options.merge(@auth)))
+    end
+
+    def stats(**args)
+      if args.empty?
+        @stats
+      else
+        @stats = Qmetrics::Stats.new(args.merge({api: self}))
+      end
+    end
+
+    def realtime(**args)
+      if args.empty?
+        @realtime
+      else
+        @realtime = Qmetrics::Realtime.new(args.merge({api: self}))
+      end
+    end
+
+    private
+
+    def check_status(r)
+      if r.response.code == "200"
+        r.parsed_response
+      else
+        raise(HTTPStatusError, r.response.code)
+      end
+    end
+
+  end
+
+end

data/lib/qmetrics/caller.rb

@@ -0,0 +1,63 @@
+module Qmetrics
+  class Caller
+
+    class << self 
+      attr_reader :api_methods
+    end
+
+    def initialize(queues: , api: )
+      @queues = queues
+      @api = api
+      clear_blocks
+    end
+
+    def get(*args)
+      clear_blocks
+      args.each do |k|
+        @blocks.push(api_methods[k.to_sym]) if call_exists?(k.to_sym)
+      end
+      execute
+    end
+
+    # url encoded '|' to '%7C'
+    def to_s
+      "/jsonStatsApi.do?queues=#{@queues.join('%7C')}"
+    end
+
+    def self.load_api_methods(file)
+      @api_methods ||= load_yml(file)
+    end
+
+    def api_methods
+      self.class.api_methods
+    end
+
+    private
+    
+    def self.load_yml(file)
+      YAML.load_file(File.join(File.dirname(__FILE__),file))
+    end
+
+    def self.generate_api_methods
+      api_methods.each do |k, v| 
+        define_method(k.to_sym) do
+          @blocks = [v]
+          execute
+        end
+      end
+    end
+
+    def execute
+      Qmetrics::Response.new(@api.call(to_s),api_methods)
+    end
+
+    def call_exists?(call)
+      api_methods.keys.include? call
+    end
+
+    def clear_blocks
+      @blocks = []
+    end
+
+  end
+end

data/lib/qmetrics/realtime.rb

@@ -0,0 +1,12 @@
+module Qmetrics
+  class Realtime < Caller
+    load_api_methods("realtime_methods.yml")
+    generate_api_methods
+
+    def to_s
+      "/QmRealtime" + super +
+      @blocks.map {|b| "&block=#{b}"}.join
+    end
+
+  end
+end

data/lib/qmetrics/realtime_methods.yml

@@ -0,0 +1,13 @@
+---
+  :queues_in_use: "RealtimeDO.RTRiassunto"
+  :calls_being_processed: "RealtimeDO.RTCallsBeingProc"
+  :agents_logged_in: "RealtimeDO.RTAgentsLoggedIn"
+  :wallboard_top_panel: "RealtimeDO.WallRiassunto"
+  :wall_calls_being_processed: "RealtimeDO.WallCallsBeingProc"
+  :visitor_calls_processed: "RealtimeDO.VisitorCallsProc"
+  :calls_taken: "RealtimeDO.VisitorTodaysOk"
+  :calls_lost: "RealtimeDO.VisitorTodaysKo"
+  :raw_agent_panel: "RealtimeDO.RtAgentsRaw"
+  :raw_calls_panel: "RealtimeDO.RtCallsRaw"
+
+

data/lib/qmetrics/response.rb

@@ -0,0 +1,65 @@
+module Qmetrics
+  class Response
+    attr_reader :status, :description, :time_elapsed, :qmetrics_version, :result
+
+    def initialize(qmetrics_result,api_methods)
+      @api_methods        = api_methods
+      @status             = qmetrics_result["result"][0][1]
+      @description        = qmetrics_result["result"][1][1]
+      @time_elapsed       = "#{qmetrics_result["result"][2][1]}ms"
+      @qmetrics_version   = qmetrics_result["result"][3][1]
+
+      qmetrics_result.delete("result")
+      @result = zip_results(qmetrics_result)
+    end
+
+    private
+
+    def zip_results(qmetrics_result)
+      @result = {}
+      qmetrics_result.each do |k, v|
+        @result[translate_method_name(k)] = zip_arrs(v)
+      end
+      @result
+    end
+
+    def translate_method_name(java_method_name)
+      @api_methods.invert[java_method_name]
+    end
+
+    def zip_arrs(r)
+      r.first.size > 2 ? clean_output(zip_keys_and_values(r)) : hashify_pairs(r)
+    end
+
+    def zip_keys_and_values(results)
+      h = purge_entities_arr(results.first)
+      results[1..results.size].inject([]) do |a, v|
+        a.push(Hash[h.zip(purge_entities_arr(v))])
+      end
+    end
+
+    def clean_output(output)
+      output.map { |n| n.select { |k, v| !(junk_data?(k) && junk_data?(v)) } }
+    end
+
+    def hashify_pairs(results)
+      results.inject({}) do |a, v|
+        a.merge(purge_entities(v.first) => purge_entities(v.last))
+      end
+    end
+
+    def purge_entities_arr(values)
+      values.map {|n| purge_entities(n) }
+    end
+
+    def purge_entities(value)
+      [' ', '<'].each{|t| value.gsub!(t,"")}
+      value.strip
+    end
+
+    def junk_data?(value)
+      ["...","","-"].include? value
+    end
+
+  end
+end

data/lib/qmetrics/stats.rb

@@ -0,0 +1,20 @@
+module Qmetrics
+  class Stats < Caller
+    load_api_methods("stats_methods.yml")
+    generate_api_methods
+
+    def initialize(from: , to: , **args)
+      super(args)
+      @from = from
+      @to = to
+    end
+
+    def to_s
+      "/QmStats" + super +
+      "&from=#{@from.strftime("%F.%H:%M:%S")}" \
+      "&to=#{@to.strftime("%F.%H:%M:%S")}" +
+      @blocks.map {|b| "&block=#{b}"}.join
+    end
+
+  end
+end

data/lib/qmetrics/stats_methods.yml

@@ -0,0 +1,86 @@
+---
+  :all_calls: "OkDO.RiassAllCalls"
+  :calls_within: "OkDO.RiassFullyWithin"
+  :agents_on_queue: "OkDO.AgentsOnQueue"
+  :service_level_agreement: "OkDO.ServiceLevelAgreement"
+  :disconnection_causes: "OkDO.DisconnectionCauses"
+  :transfers: "OkDO.Transfers"
+  :answered_calls_by_queue: "OkDO.AnsweredcallsByQueue"
+  :answered_calls_by_direction: "OkDO.AnsweredcallsByDirection"
+  :stints: "OkDO.StintsOk"
+  :initial_queue_positions: "OkDO.QPosOk"
+  :ivr_selections: "OkDO.IvrOk"
+  :dnis: "OkDO.DnisOk"
+  :music_on_hold_by_agent: "OkDO.MOHOk"
+  :report_header: "OkDO.HDRRpt"
+  :answered_calls_details: "DetailsDO.CallsOK"
+  :ivr_details: "DetailsDO.CallsIVR"
+  :all_unanswered_calls: "KoDO.ReportKoAll"
+  :unanswered_calls_within: "KoDO.ReportKoFully"
+  :disconnection_causes: "KoDO.DiscCauses"
+  :unanswered_by_queue: "KoDO.UnansByQueue"
+  :unanswered_outbound_calls: "KoDO.OutboundKo"
+  :unanswered_by_length: "KoDO.UnansByLen"
+  :inclusive_sla: "KoDO.InclusiveSLA"
+  :unanswered_by_key_press: "KoDO.ReportKoKeyPress"
+  :unanswered_stints: "KoDo.StintsKo"
+  :all_calls_by_stints: "KoDO.StintsOkKo"
+  :all_calls_initial_queue_position: "KoDO.QPosOkKo"
+  :lost_calls_ivr_selections: "KoDO.IvrKo"
+  :all_calls_ivr_selections: "KoDO.IvrOkKo"
+  :lost_calls_dnis: "KoDO.DnisKo"
+  :all_calls_dnis: "KoDO.DnisOkKo"
+  :call_overview: "KoDO.OverviewOkKo"
+  :inclusive_answered_sla: "KoDO.InclusiveAnswSLA" 
+  :unanswered_calls_details: "DetailsDO.CallsKO"
+  :area_code_report: "AreaAnDO.Setup"
+  :answered_calls_by_area: "AreaAnDO.CallsKO"
+  :inbound_acd_call_attempts: "DistrDO.ReportAcd"
+  :acd_attempts_by_queue: "DistrDO.AcdByQueue"
+  :acd_attempts_by_terminal: "DistrDO.AcdByTerminals"
+  :answered_call_distribution_by_day: "CallDistrDO.AnsDistrPerDay"
+  :answered_call_wait_time_per_day: "CallDistrDO.AnsWaitPerDay"
+  :unanswered_call_wait_time_per_day: "CallDistrDO.UnansWaitPerDay"
+  :sales_per_day: "CallDistrDO.SalesPerDay"
+  :schedule_adherence_per_day: "CallDistrDO.StaffPerDay"
+  :queue_length_per_day: "CallDistrDO.QPosPerDay"
+  :inclusive_sla_per_day: "CallDistrDO.InclSlaPerDay"
+  :traffic_analysis_per_day: "CallDistrDO.TrafficAnPerDay"
+  :answered_call_distribution_per_hour: "CallDistrDO.AnsDistrPerHr"
+  :answered_call_wait_time_per_hour: "CallDistrDO.AnsWaitPerHr"
+  :unanswered_call_wait_time_per_hour: "CallDistrDO.UnansWaitPerHr"
+  :sales_per_hour: "CallDistrDO.SalesPerHr"
+  :schedule_adherence_per_hour: "CallDistrDO.StaffPerHr"
+  :queue_length_per_hour: "CallDistrDO.QPosPerHr"
+  :inclusive_sla_per_hour: "CallDistrDO.InclSlaPerHr"
+  :traffic_analysis_per_hour: "CallDistrDO.TrafficAnPerHr"
+  :answered_call_distribution_per_day_of_week: "CallDistrDO.AnsDistrPerDOW"
+  :answered_call_wait_time_per_day_of_week: "CallDistrDO.AnsWaitPerDOW"
+  :unanswered_call_wait_time_per_day_of_week: "CalldistrDO.UnansWaitPerDOW"
+  :sales_per_day_of_week: "CallDistrDO.SalesPerDOW"
+  :schedule_adherence_per_day_of_week: "CallDistrDO.StaffPerDOW"
+  :queue_length_per_day_of_week: "CallDistrDO.QPosPerDOW"
+  :inclusive_sla_per_day_of_week: "CallDistrDO.InclSlaPerDOW"
+  :traffic_analysis_per_day_of_week: "CallDistrDO.TrafficAnPerDOW"
+  :agent_session_detail: "AgentsDO.ReportAgents"
+  :session_and_pause_durations: "AgentsDO.SessionPauseDur"
+  :agent_availability: "AgentsDO.AgentAvail"
+  :answered_calls: "AgentsDO.AnsCallsQueues"
+  :answered_calls_by_custom_group: "AgentsDO.AnsCallsCG"
+  :answered_calls_by_location: "AgentsDO.AnsCallsLocation"
+  :answered_calls_by_service_group: "AgentsDO.AnsCallsSG"
+  :agent_performance_by_acd_group: "AgentsDO.PerformanceAcdGroups"
+  :agent_occupancy_report: "AgentsDO.AgentOccupancy"
+  :agent_payable_time_by_hour: "AgentsDO.AgentPayableTimeByHour"
+  :agent_billable_time_by_hour: "AgentsDO.AgentBillableTimeByHour"
+  :detail_of_agent_pauses: "DetailsDO.AgentPauses"
+  :outcomes: "OutcomesDO.GeneralRep"
+  :call_results_by_outcomes: "OutcomesDO.CallResByOutcome"
+  :billable_activities: "OutcomesDO.ActivBillable"
+  :non_billable_activities: "OutcomesDO.ActivNotBillable"
+  :detailed_agent_report: "OutcomesDO.AgentReportDetailed"
+  :outcomes_per_agent: "OutcomesDO.AgentOutcomes"
+  :ivr_traversals: "IvrDO.IvrReport"
+  :ivr_timing: "IvrDO.IvrTiming"
+  :ivr_goals: "IvrDO.IvrGoals"
+

data/lib/qmetrics/version.rb

@@ -0,0 +1,3 @@
+module Qmetrics
+  VERSION = "0.1.3"
+end

data/qmetrics.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qmetrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qmetrics"
+  spec.version       = Qmetrics::VERSION
+  spec.authors       = ["Kevin Collette"]
+  spec.email         = ["kevcollette@gmail.com"]
+  spec.summary       = %q{A gem that wraps the Queuemetrics JSON API with Ruby}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_runtime_dependency "httparty", "~> 0.13.3"
+end

data/spec/lib/qmetrics/api_spec.rb

@@ -0,0 +1,53 @@
+describe Qmetrics::API do
+
+  let(:api) { Qmetrics::API.new(@api_config.to_h) }
+  
+  before :all do
+    @api_config = APIConfig.new
+  end
+  
+  describe "#new" do
+    it "should return a new Qmetrics::API object" do
+      expect(api).to be_a(Qmetrics::API)
+    end
+  end
+
+  describe "#call" do
+    context "it is passed invalid auth credentials" do
+
+      it "should throw an exception" do
+        api_config = {server: @api_config.server,
+                      port: @api_config.port,
+                      user: "foo", pass: "bar" }
+        wrong_api = Qmetrics::API.new(api_config.to_h)
+        expect{wrong_api.call("agent/jsonEditorApi.do")}.to raise_exception("501")
+      end
+    end
+
+    context "it is passed an invalid api method" do
+      it "should throw an exception" do
+        expect{api.call("agt/jsonEditorApi.do")}.to raise_exception("500")
+      end
+    end
+
+    context "it is passed a valid Queuemetrics api method" do
+      it "should return an array" do
+        expect(api.call("agent/jsonEditorApi.do")).to be_an(Array)
+      end
+    end
+
+  end
+
+  describe "#stats" do
+    let(:q_stats) { { queues: [1],
+                      from: Time.now-86400,
+                      to: Time.now } }
+
+    it "should return a Qmetrics::Stats object" do
+      expect(api.stats(q_stats)).to be_an_instance_of(Qmetrics::Stats)
+    end
+
+  end
+
+end
+

data/spec/lib/qmetrics/realtime_spec.rb

@@ -0,0 +1,5 @@
+realtime_config = RealtimeConfig.new
+
+describe Qmetrics::Realtime do
+  it_behaves_like 'a Qmetrics::Caller', realtime_config
+end

data/spec/lib/qmetrics/response_spec.rb

@@ -0,0 +1,64 @@
+describe Qmetrics::Response do
+
+  let(:api) { Qmetrics::API.new(@api_config.to_h)}
+  let(:stats) { api.stats(@stats_config.to_h) }
+  let(:response) { stats.get(:stints,:answered_calls,:all_calls) }
+
+  before :all do
+    @api_config = APIConfig.new
+    @stats_config = StatsConfig.new
+  end
+
+  describe "#result" do
+    it "should respond" do
+      expect{response.result}.not_to raise_exception
+    end
+
+    context "The result is for multiple agents" do
+      let(:result) { stats.answered_calls.result }
+
+      it "should be an Array of Hashes" do
+        expect(result[:answered_calls]).to be_an(Array)
+        expect(result[:answered_calls].first).to be_a(Hash)
+      end
+
+    end
+
+    context "The result is for all agents" do
+      let(:result) { stats.all_calls.result } 
+
+      it "should be a Hash" do
+        expect(result[:all_calls]).to be_a(Hash)
+      end
+
+    end
+
+    it "should remove HTML character entities from output" do
+      result = stats.agent_payable_time_by_hour.result
+      result[:agent_payable_time_by_hour].each do |n|
+        n.each do |k,v|
+          expect(k).to_not include(" ")
+          expect(v).to_not include(" ")
+          expect(k).to_not include("<")
+          expect(v).to_not include("<")
+        end
+      end
+    end
+
+    it "should remove superflous key-value pairs" do
+      result = stats.unanswered_calls_details.result
+      junk = ["...","-",""]
+      result[:unanswered_calls_details].each do |n|
+        n.each do |k,v|
+          if junk.include?(k)
+            expect(junk).not_to include(v)
+          elsif junk.include?(v)
+            expect(junk).not_to include(k)
+          end 
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lib/qmetrics/stats_spec.rb

@@ -0,0 +1,7 @@
+require 'support/shared_examples_for_caller'
+
+stats_config = StatsConfig.new
+
+describe Qmetrics::Stats do
+  it_behaves_like 'a Qmetrics::Caller', stats_config
+end

data/spec/lib/qmetrics/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Qmetrics do
+  it "should define its version" do
+    expect(Qmetrics::VERSION).not_to be_nil
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'yaml'
+require 'qmetrics'
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = 'random'
+end

data/spec/support/api_config.rb

@@ -0,0 +1,17 @@
+class APIConfig
+  attr_reader :server, :port, :user, :pass
+
+  def initialize
+    @api_config = YAML.load_file(File.join(File.dirname(__FILE__),
+                                          "api_config.yml"))
+    @server = @api_config[:server]
+    @port   = @api_config[:port]
+    @user   = @api_config[:user]
+    @pass   = @api_config[:pass]
+  end
+
+  def to_h
+    @api_config
+  end
+
+end

data/spec/support/realtime_config.rb

@@ -0,0 +1,18 @@
+class RealtimeConfig
+  attr_reader :queues
+
+  def initialize
+    @realtime_config = YAML.load_file(File.join(File.dirname(__FILE__),
+                                                "realtime_config.yml"))
+    @api_config = APIConfig.new
+    @queues = @realtime_config[:queues]
+    @api = Qmetrics::API.new(@api_config.to_h)
+  end
+
+  def to_h
+    @realtime_config[:api] = @api
+    @realtime_config
+  end
+
+end
+

data/spec/support/shared_examples_for_caller.rb

@@ -0,0 +1,46 @@
+RSpec.shared_examples 'a Qmetrics::Caller' do |config_obj|
+  
+  caller = described_class.new(config_obj.to_h)
+
+  describe "#api_methods" do
+    it "should exist" do
+      expect{caller.api_methods}.not_to raise_exception
+    end
+  end
+
+  caller.api_methods.each do |k, v|
+    describe "##{k}" do
+      before :all do
+        @response = caller.public_send(k)
+      end
+
+      let(:response) { @response.dup }
+
+      it "should return an API Response" do
+        expect(response).to be_a(Qmetrics::Response)
+      end
+
+      it "should return a response with the API call's key" do
+        expect(response.result).to have_key(k)
+      end
+    end
+  end
+
+  describe "#get" do
+    let(:method) { caller.api_methods.first.first }
+    let(:method2) { caller.api_methods.take(2).last.first }
+    let(:response) { caller.get(method, method2) }
+    it "should return responses for all api methods passed to it." do
+      expect(response).to be_a(Qmetrics::Response)
+      expect(response.result).to have_key(method)
+      expect(response.result).to have_key(method2)
+    end
+  end
+
+  describe "#to_s" do
+    it "should return a string" do
+      expect(caller.to_s).to be_a(String)
+    end
+  end
+
+end

data/spec/support/stats_config.rb

@@ -0,0 +1,22 @@
+class StatsConfig
+  attr_reader :queues, :from, :to
+
+  def initialize
+    @stats_config = YAML.load_file(File.join(File.dirname(__FILE__),
+                                             "stats_config.yml"))
+    @api_config = APIConfig.new
+    @queues = @stats_config[:queues]
+    @from = Time.parse(@stats_config[:from])
+    @to = Time.parse(@stats_config[:to])
+    @api = Qmetrics::API.new(@api_config.to_h) 
+  end
+
+  def to_h
+    @stats_config[:from] = @from
+    @stats_config[:to] = @to
+    @stats_config[:api] = @api
+    @stats_config
+  end
+
+end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: qmetrics
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Kevin Collette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+description: ''
+email:
+- kevcollette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qmetrics.rb
+- lib/qmetrics/api.rb
+- lib/qmetrics/caller.rb
+- lib/qmetrics/realtime.rb
+- lib/qmetrics/realtime_methods.yml
+- lib/qmetrics/response.rb
+- lib/qmetrics/stats.rb
+- lib/qmetrics/stats_methods.yml
+- lib/qmetrics/version.rb
+- qmetrics.gemspec
+- spec/lib/qmetrics/api_spec.rb
+- spec/lib/qmetrics/realtime_spec.rb
+- spec/lib/qmetrics/response_spec.rb
+- spec/lib/qmetrics/stats_spec.rb
+- spec/lib/qmetrics/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_config.rb
+- spec/support/realtime_config.rb
+- spec/support/shared_examples_for_caller.rb
+- spec/support/stats_config.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem that wraps the Queuemetrics JSON API with Ruby
+test_files:
+- spec/lib/qmetrics/api_spec.rb
+- spec/lib/qmetrics/realtime_spec.rb
+- spec/lib/qmetrics/response_spec.rb
+- spec/lib/qmetrics/stats_spec.rb
+- spec/lib/qmetrics/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/api_config.rb
+- spec/support/realtime_config.rb
+- spec/support/shared_examples_for_caller.rb
+- spec/support/stats_config.rb