ApiWrapperFor8x8 0.0.1 → 0.0.3

data/.gitignore

@@ -19,3 +19,4 @@ ctags
 __Tagbar__
 tags
 Makefile
+spec/fixture/*

data/README.md

@@ -19,7 +19,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+###Setup
+```ruby
+@api_connection = ApiWrapperFor8x8::Connection.new({
+    :username => 'foo', # your username for 8x8
+    :password => 'bar'  # your password for 8x8
+})
+```
+
+###Params for each call
+Date range: it has to be a iso8601 format and a string with comma separated, Ex "#{(Time.now-3600*24).iso8601,Time.now.iso8601}"
+Timezone: it need to be following: list_of_timezone[http://en.wikipedia.org/wiki/List_of_zoneinfo_time_zones], Ex. America/Los_Angeles
+It has more params, which can be seen on 8x8 site[http://www.8x8.com/Support/BusinessSupport/Documentation/VirtualContactCenterDocumentation/VirtualContactCenterStats.aspx]
+
+###Channel
+
+Get a list of channels
+```ruby
+@api_coonection.channel_list
+```
+
+Get a list of agnets
+```ruby
+@api_coonection.agent_list
+```
+
+Get a list of agnet details
+```ruby
+@api_coonection.agents_details({:d => 'YOUR DATE RANGE', :tz => 'YOUR TIMEZONE'}, {FILTER OPTIONS})
+```
+
 
 ## Contributing
 

data/lib/ApiWrapperFor8x8.rb

@@ -5,4 +5,5 @@ require 'ApiWrapperFor8x8/error'
 require 'ApiWrapperFor8x8/agent'
 require 'ApiWrapperFor8x8/agents'
 require 'ApiWrapperFor8x8/channel'
+require 'ApiWrapperFor8x8/stats'
 require 'ApiWrapperFor8x8/connection'

data/lib/ApiWrapperFor8x8/agent.rb

@@ -1,8 +1,8 @@
 module ApiWrapperFor8x8
   module Agent
 
-    def agent_detail(id, params)
-      get("/stats/agents/#{id}/statistics.json", params)
+    def agent_detail(id, params, filtered_options)
+      get("/stats/agents/#{id}/statistics.json", params, filtered_options)
     end
 
   end

data/lib/ApiWrapperFor8x8/agents.rb

@@ -2,30 +2,24 @@ module ApiWrapperFor8x8
   module Agents
     include ApiWrapperFor8x8::Agent
 
-    def agent_list(params={})
-      get('/stats/agents.json', params)
+    # Get a list of all the agents
+    #
+    def agent_list(filtered_options={})
+      get('/stats/agents.json', {}, filtered_options)
     end
 
+    # Get all the details of agents
+    #
+    # Ex. Get details for date range of '2013-09-04T00:00:00-07:00,2013-09-04T23:59:59-07:00'
+    # and filtered with queue-name and agent-id
+    # @api_connection.agents_detail({:d => '2013-09-04T00:00:00-07:00,2013-09-04T23:59:59-07:00'},
+    #                               {"agent-id"=>"foo", "queue-name"=>"bar"})
     def agents_detail(params={}, filtered_options={})
       details = []
-      filtered_agents(agent_list(params), filtered_options).each do |agent|
-        details << agent_detail(agent['agent-id'], params)
+      agent_list.each do |agent|
+        details.concat(agent_detail(agent['agent-id'], params, filtered_options))
       end
-      details.flatten
+      details
     end
-
-    def filtered_agents(agent_list, filtered_options)
-      if filtered_options.size == 0
-        return list
-      end
-      agent_list.select do |agent|
-        flag = true
-        filtered_options.each do |key, value|
-          flag = false unless (agent[key] && agent[key] == value)
-        end
-        flag
-      end
-    end
-
   end
 end

data/lib/ApiWrapperFor8x8/channel.rb

@@ -1,8 +1,10 @@
 module ApiWrapperFor8x8
   module Channel
 
-    def channel_list(options={})
-      get "/stats/channels.json", options
+    # Get a list of channels
+    #
+    def channel_list(filtered_options={})
+      get "/stats/channels.json", {}, filtered_options
     end
 
     # Get one details on the channel
@@ -21,6 +23,13 @@ module ApiWrapperFor8x8
 
     # It is easier for geting the sum of a value from the
     # an array of records with the restriction you can set
+    #
+    # Ex. Get a sum of 'accepted-count' from channel_id: 1, date range
+    # , filtered_options, and queue-name
+    # @api_connection.channel_sum_x('accepted-count',
+    #                               1,
+    #                               {:d => '2013-09-04T00:00:00-07:00,2013-09-04T23:59:59-07:00'},
+    #                               {"agent-id"=>"foo", "queue-name"=>"bar"}}
     def channel_sum_x(x, guid=0,  params_options={}, filtered_options={})
       details = channel_details(guid, params_options, filtered_options)
       sum = details.map {|detail| detail[x]}.inject(:+) if details

data/lib/ApiWrapperFor8x8/connection.rb

@@ -4,12 +4,13 @@ module ApiWrapperFor8x8
 
     include ApiWrapperFor8x8::Channel
     include ApiWrapperFor8x8::Agents
+    include ApiWrapperFor8x8::Stats
 
     RECORDS_LIMIT = 50
     MAX_TRY       = 3
     VALID_SEGMENT = ['channels', 'agents', 'statistics']
 
-    base_uri "#{ENV['PHONE_SYSTEM_URL']}"
+    base_uri "https://na3.mycontactual.com/api"
     format :json
 
     def initialize(creds={})
@@ -20,9 +21,11 @@ module ApiWrapperFor8x8
     end
 
     def request(method, url, options={})
-      raise "Please set usranme and password" unless api_token_keys_valid?
+      unless api_token_keys_valid?
+        raise ApiWrapperFor8x8::ResponseError.new(nil, "Please set username and password correctly")
+      end
       options[:basic_auth] = @configuration
-      self.class.__send__(method, url, options).parsed_response
+      parsed_response(self.class.__send__(method, url, options))
     end
 
     def api_token_keys_valid?
@@ -93,5 +96,19 @@ module ApiWrapperFor8x8
         flag
       end
     end
+
+    def parsed_response(response)
+      if response.is_a? Net::HTTPResponse
+        unless response.is_a? Net::HTTPSuccess
+          raise ApiWrapperFor8x8::ResponseError.new(response)
+        end
+        JSON.parse(response.body)
+      else
+        unless response.success?
+          raise ApiWrapperFor8x8::ResponseError.new(response)
+        end
+        response.parsed_response
+      end
+    end
   end
 end

data/lib/ApiWrapperFor8x8/error.rb

@@ -15,6 +15,8 @@ module ApiWrapperFor8x8
     def common_solutions
       if @response.code.to_i == 401
         "Check your credentials and make sure they are correct and not expired"
+      elsif @response.code.to_i >= 500 && @response.code.to_i < 600
+        "Check the format of your json"
       end
     end
 

data/lib/ApiWrapperFor8x8/stats.rb

@@ -0,0 +1,50 @@
+module ApiWrapperFor8x8
+  module Stats
+
+    DEFAULT_STAT_ATTR = ["entered-count", "accepted-count", "abandoned-count", "time-waiting"]
+    # Since the api only aggregate the records by half an
+    # hour, so why not they have aggregate by hour
+    def stats_per_hour(url, params={}, filtered_opts={}, stats_attr=[])
+      raise ApiWrapperFor8x8::ResponseError.new({}, "Required date range!") unless params[:d]
+      if stats_attr.include?('queue-name') || stats_attr.include?('time-stamp')
+        raise ApiWrapperFor8x8::ResponseError.new({}, "Does not support queue-name or time-stamp as stat attribute")
+      end
+
+      stats = get(url, params, filtered_opts)
+      stats_attr = DEFAULT_STAT_ATTR if stats_attr.size == 0
+      times = params[:d].split(',')
+      start = Time.parse(times.first)
+      stop  = Time.parse(times.last)
+      hash = {}
+
+      # init the hash object
+      (beginning_of_hour(start).to_i..end_of_hour(stop).to_i).step(3600) do |h|
+        hour     = Time.at(h)
+        hour_key = hour.iso8601
+        hash[hour_key] = {}
+        hash[hour_key]['timestamp'] = hour
+        stats_attr.each { |key| hash[hour_key][key] = 0 }
+      end
+
+      # insert stats data to hash with timestamp as key
+      stats.each do |stat|
+        timestamp = stat["time-stamp"]
+        timekey = hash[timestamp] ? timestamp : (Time.parse(timestamp) - 1800).iso8601
+        stats_attr.each do |stat_attr|
+          stats_by_time = hash[timekey] || {}
+          stats_by_time[stat_attr] += stat[stat_attr] if stats_by_time[stat_attr] && stat[stat_attr]
+        end
+      end if stats
+      return hash.collect{ |key, value| value }
+    end
+
+    def beginning_of_hour(time)
+      Time.mktime(time.year, time.month, time.day, time.hour).send(Time.now.gmt? ? :gmt : :localtime)
+    end
+
+    def end_of_hour(time)
+      beginning_of_hour(time)+3600
+    end
+
+  end
+end

data/lib/ApiWrapperFor8x8/version.rb

@@ -1,3 +1,3 @@
 module ApiWrapperFor8x8
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/agent_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Agent' do
+  describe "get_detail" do
+    it "should have call get with correct params" do
+      id = 0
+      expect(@api).to receive(:get).with("/stats/agents/#{id}/statistics.json", {}, {})
+      @api.agent_detail(id, {}, {})
+    end
+  end
+end

data/spec/agents_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ApiWrapperFor8x8::Agents do
   describe "agent_list" do
     it "should GET /stats/agents.json" do
-      @api.should_receive(:get).with('/stats/agents.json', {})
+      @api.should_receive(:get).with('/stats/agents.json', {}, {})
       @api.agent_list
     end
   end
@@ -15,22 +15,9 @@ describe ApiWrapperFor8x8::Agents do
       resp     = {'statistics' => {'statistic' => agents}}
       agent_details = [{'agent-id' => agent_id, 'accepted-count' => 23}]
       @api.stub(:agent_list)
-      expect(@api).to receive(:filtered_agents).with(agents, {}).and_return(agents)
-      expect(@api).to receive(:agent_list).with({}).and_return(agents)
-      expect(@api).to receive(:agent_detail).with(agent_id, {}).and_return(agent_details)
+      expect(@api).to receive(:agent_list).and_return(agents)
+      expect(@api).to receive(:agent_detail).with(agent_id, {}, {}).and_return(agent_details)
       @api.agents_detail.should == agent_details
     end
   end
-
-  describe "filtered_agents" do
-    before :each do
-      @agent1 = {"agent-id" => "a", "enabled" => 'Y'}
-      @agent2 = {"agent-id" => 'b', "enabled" => 'D'}
-      @agent_lists = [@agent1, @agent2]
-    end
-    it "should filter agents with enabled" do
-      @api.filtered_agents(@agent_lists, {"enabled" => "Y"}).should == [@agent1]
-      @api.filtered_agents(@agent_lists, {"enabled" => "D"}).should == [@agent2]
-    end
-  end
 end

data/spec/channel_spec.rb

@@ -8,7 +8,7 @@ describe ApiWrapperFor8x8::Channel do
 
   describe "channel_list" do
     it "should GET /stats/channels.json" do
-      @api.should_receive(:get).with('/stats/channels.json', {})
+      @api.should_receive(:get).with('/stats/channels.json', {}, {})
       @api.channel_list
     end
 

data/spec/connection_spec.rb

@@ -81,12 +81,11 @@ describe ApiWrapperFor8x8::Connection do
       end
     end
 
-
-    it "should get /stats/agents.json" do
-      url = "/stats/agents.json"
-      @api.should_receive(:get_stat).with(@httparty_response, url).and_return([{}])
-      @api.should_receive(:request).with(:get, url, {}).and_return(@httparty_response)
-      @api.get(url)
+    describe "base_uri" do
+      it "should not be empty or nil" do
+        ApiWrapperFor8x8::Connection::base_uri.should_not be_nil
+        ApiWrapperFor8x8::Connection::base_uri.size.should_not be_zero
+      end
     end
 
   end

data/spec/error_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ApiWrapperFor8x8::ResponseError do
+  describe "For OAth response" do
+    before do
+      @net_http_response = Net::HTTPSuccess.new('1.1', '200', 'OK')
+      @error = ApiWrapperFor8x8::ResponseError.new(@net_http_response)
+    end
+
+    it "response should return Net::HTTP response" do
+      @error.response.should == @net_http_response
+    end
+
+    it "code should return response code" do
+      @error.code.should == '200'
+    end
+
+    describe "message" do
+      it "should return response message" do
+        @error.message.should == 'OK'
+      end
+
+      it "should return specified message" do
+        error = ApiWrapperFor8x8::ResponseError.new(@net_http_response, "No way")
+        error.message.should == 'No way'
+      end
+    end
+
+
+    describe "common_solutions" do
+      describe "on 401" do
+        it "should suggest to check credentials" do
+          net_http_response = Net::HTTPUnauthorized.new('1.1', '401', 'Unauthorized Access')
+          error = ApiWrapperFor8x8::ResponseError.new(net_http_response)
+          error.common_solutions.should match /Check your credentials/i
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'rspec/expectations'
 require 'httparty'
 require 'json'
 
+require_relative '../lib/ApiWrapperFor8x8/stats.rb'
 Dir[File.dirname(__FILE__)+'/../lib/ApiWrapperFor8x8/*.rb'].each{|file| require file}
 
 RSpec.configure do |config|

data/spec/stats_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "ApiWrapperFor8x8::Stats" do
+  describe "stats_per_hour" do
+
+    context "should return correct data with valid params" do
+      before :each do
+        @url    = "/stats/channels/1/statistics.json"
+        @params = {:d => '2013-05-28T12:54:55-07:00,2013-05-28T19:54:55-07:00', :tz => 'America/Los_Angeles'}
+        @resp   = [{"time-stamp" => "2013-05-28T13:30:00-07:00",
+                    "entered-count"   => 3,
+                    "accepted-count"  => 2,
+                    "abandoned-count" => 1,
+                    "time-waiting"    => 24
+                  },{"time-stamp"  => "2013-05-28T14:00:00-07:00",
+                    "entered-count"   => 10,
+                    "accepted-count"  => 8,
+                    "abandoned-count" => 2,
+                    "time-waiting"    => 124},
+                   {"time-stamp"      => "2013-05-28T19:00:00-07:00",
+                    "entered-count"   => 20,
+                    "accepted-count"  => 19,
+                    "abandoned-count" => 1,
+                    "time-waiting"    => 144}]
+      end
+
+      it "should return an array of hash that includes all the stat attr and the timestamp" do
+        expect(@api).to receive(:get).with(@url, @params, {}).and_return(@resp)
+        ret = @api.stats_per_hour(@url, @params, {})
+
+        ret.size.should == 9
+        ret.map {|r| r['entered-count']}.inject {|sum,num| sum+num}.should == 33
+        ret.map {|r| r['accepted-count']}.inject {|sum,num| sum+num}.should == 29
+        ret.map {|r| r['abandoned-count']}.inject {|sum,num| sum+num}.should == 4
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ApiWrapperFor8x8
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,13 +143,16 @@ files:
 - lib/ApiWrapperFor8x8/channel.rb
 - lib/ApiWrapperFor8x8/connection.rb
 - lib/ApiWrapperFor8x8/error.rb
+- lib/ApiWrapperFor8x8/stats.rb
 - lib/ApiWrapperFor8x8/version.rb
 - spec/.rspec
 - spec/agent_spec.rb
 - spec/agents_spec.rb
 - spec/channel_spec.rb
 - spec/connection_spec.rb
+- spec/error_spec.rb
 - spec/spec_helper.rb
+- spec/stats_spec.rb
 - spec/version_spec.rb
 homepage: https://github.com/daifu/api-wrapper-for-8x8
 licenses:
@@ -182,5 +185,7 @@ test_files:
 - spec/agents_spec.rb
 - spec/channel_spec.rb
 - spec/connection_spec.rb
+- spec/error_spec.rb
 - spec/spec_helper.rb
+- spec/stats_spec.rb
 - spec/version_spec.rb