ApiWrapperFor8x8 0.0.1

data/.gitignore

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

data/.rspec

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

data/ApiWrapperFor8x8.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/ApiWrapperFor8x8/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ApiWrapperFor8x8"
+  spec.version       = ApiWrapperFor8x8::VERSION
+  spec.authors       = ["daifu"]
+  spec.email         = ["daifu.ye@gmail.com"]
+  spec.description   = %q{8x8 Phone System api wrapper to handle reporting.}
+  spec.summary       = %q{8x8 Phone System api wrapper}
+  spec.homepage      = "https://github.com/daifu/api-wrapper-for-8x8"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.11.0"
+  spec.add_development_dependency "debugger"
+
+  spec.add_dependency "bundler" , ">= 1.0.0"
+  spec.add_dependency "httparty", ">= 0.9.0"
+  spec.add_dependency "json"    , "~> 1.8.0"
+
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 daifu
+
+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,30 @@
+# Api Wrapper For 8x8 phonesystem reporting api
+
+Since 8x8 phone system api suck, and here is the ruby gem that act as the
+api wrapper to make your life a little bit easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ApiWrapperFor8x8'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ApiWrapperFor8x8
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,11 @@
+#!/usr/bin/env rake
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/ApiWrapperFor8x8'
+  t.test_files = FileList['spec/lib/ApiWrapperFor8x8/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/ApiWrapperFor8x8.rb

@@ -0,0 +1,8 @@
+require 'httparty'
+require 'json'
+require "uri"
+require 'ApiWrapperFor8x8/error'
+require 'ApiWrapperFor8x8/agent'
+require 'ApiWrapperFor8x8/agents'
+require 'ApiWrapperFor8x8/channel'
+require 'ApiWrapperFor8x8/connection'

data/lib/ApiWrapperFor8x8/agent.rb

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

data/lib/ApiWrapperFor8x8/agents.rb

@@ -0,0 +1,31 @@
+module ApiWrapperFor8x8
+  module Agents
+    include ApiWrapperFor8x8::Agent
+
+    def agent_list(params={})
+      get('/stats/agents.json', params)
+    end
+
+    def agents_detail(params={}, filtered_options={})
+      details = []
+      filtered_agents(agent_list(params), filtered_options).each do |agent|
+        details << agent_detail(agent['agent-id'], params)
+      end
+      details.flatten
+    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

@@ -0,0 +1,31 @@
+module ApiWrapperFor8x8
+  module Channel
+
+    def channel_list(options={})
+      get "/stats/channels.json", options
+    end
+
+    # Get one details on the channel
+    # guid: the id of the channel
+    # options: {
+    #   'd'  => date range
+    #   'tz' => time zone
+    #   'media-type' => {media-type, including T, }
+    #   'n'  => {offset} limited 50 records per request,
+    #   'queue-id' => {queue-id for agent for query variables}
+    # }
+    # filter_options is to filtered out the attributes from the object
+    def channel_details(guid, params_options={}, filtered_options={})
+      get("/stats/channels/#{guid}/statistics.json", params_options, filtered_options)
+    end
+
+    # It is easier for geting the sum of a value from the
+    # an array of records with the restriction you can set
+    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
+      sum || 0
+    end
+
+  end
+end

data/lib/ApiWrapperFor8x8/connection.rb

@@ -0,0 +1,97 @@
+module ApiWrapperFor8x8
+  class Connection
+    include HTTParty
+
+    include ApiWrapperFor8x8::Channel
+    include ApiWrapperFor8x8::Agents
+
+    RECORDS_LIMIT = 50
+    MAX_TRY       = 3
+    VALID_SEGMENT = ['channels', 'agents', 'statistics']
+
+    base_uri "#{ENV['PHONE_SYSTEM_URL']}"
+    format :json
+
+    def initialize(creds={})
+      @configuration = {}
+      ApiWrapperFor8x8::Connection.api_token_keys.each do |key|
+        @configuration[key] = creds[key].to_s
+      end
+    end
+
+    def request(method, url, options={})
+      raise "Please set usranme and password" unless api_token_keys_valid?
+      options[:basic_auth] = @configuration
+      self.class.__send__(method, url, options).parsed_response
+    end
+
+    def api_token_keys_valid?
+      return ApiWrapperFor8x8::Connection.api_token_keys.detect {|key| @configuration[key] == ''} == nil
+    end
+
+    def self.api_token_keys
+      [:username, :password].freeze
+    end
+
+    def get(url, params={}, filtered_opts={})
+      offset = params[:n] || 1
+      params[:n] = offset unless params[:n]
+
+      unless params.empty?
+        url = "#{url}?#{serialize_param(params)}"
+      end
+
+      tries  = 1
+      resp   = []
+      begin
+        resp_tmp = get_stat(request(:get, url, {}), url)
+        resp.concat(apply_filter(resp_tmp, filtered_opts)) if resp_tmp
+        tries += 1
+
+        # update the url to increase the offset
+        offset += RECORDS_LIMIT
+        url.gsub!(/n=[0-9]*/, "n=#{offset}")
+      end while (size_of(resp_tmp) >= RECORDS_LIMIT && tries <= MAX_TRY)
+      resp
+    end
+
+    def serialize_param(params)
+      params.sort.map {|key, value| URI.escape("#{key}=#{value}")}.join('&')
+    end
+
+    def size_of(details)
+      details ||= []
+      details.size
+    end
+
+    def validate_and_extract_url(url)
+      uri = URI(url)
+      last_seg = uri.path.split('/').last
+      if last_seg =~ /(#{VALID_SEGMENT.join('|')})\.json$/
+        return last_seg.split('.').first
+      else
+        raise ApiWrapperFor8x8::ResponseError.new(nil, "URL path is incorrect! please double check your url.")
+      end
+    end
+
+    def get_stat(resp, url)
+      if root_name = validate_and_extract_url(url)
+        return [] if (resp && resp.size == 0)
+        return resp[root_name][root_name[0...-1]]
+      end
+    end
+
+    def apply_filter(list, filtered_options)
+      if filtered_options.size == 0
+        return list
+      end
+      list.select do |ele|
+        flag = true
+        filtered_options.each do |key, value|
+          flag = false unless (ele[key] && ele[key] == value)
+        end
+        flag
+      end
+    end
+  end
+end

data/lib/ApiWrapperFor8x8/error.rb

@@ -0,0 +1,27 @@
+module ApiWrapperFor8x8
+  class ResponseError < Exception
+    attr_reader :response
+
+    def initialize(response, message=nil)
+      self.set_backtrace(caller[1..-1]) if self.backtrace.nil?
+      @response = response
+      super((message || @response.message))
+    end
+
+    def code
+      @response.code
+    end
+
+    def common_solutions
+      if @response.code.to_i == 401
+        "Check your credentials and make sure they are correct and not expired"
+      end
+    end
+
+    def detailed_message
+      if @response.is_a? Hash
+        @response[:error][:message] if @response[:error]
+      end
+    end
+  end
+end

data/lib/ApiWrapperFor8x8/version.rb

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

data/spec/.rspec

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

data/spec/agents_spec.rb

@@ -0,0 +1,36 @@
+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.agent_list
+    end
+  end
+
+  describe "agents_detail" do
+    it "should receive an array of agent with their details" do
+      agent_id = 'agentId'
+      agents   = [{'agent-id' => agent_id}]
+      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)
+      @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

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ApiWrapperFor8x8::Channel do
+  before :each do
+    @resp = [{'accepted-count' => 3, 'entered-count' => 10, 'queue-name' => 'inbound'}, {'accepted-count' => 2, 'entered-count' => 5, 'queue-name' => 'outbound'}]
+    @filters = {'queue-name' => 'inbound'}
+  end
+
+  describe "channel_list" do
+    it "should GET /stats/channels.json" do
+      @api.should_receive(:get).with('/stats/channels.json', {})
+      @api.channel_list
+    end
+
+  end
+
+  describe "GET channel_details statistics" do
+    it "should GET /stats/channels/guid/statistics.json without options" do
+      @api.should_receive(:get).with('/stats/channels/1/statistics.json', {}, {})
+      @api.channel_details(1)
+    end
+
+    it "should GET channel details with date range" do
+      date_range = {:d => Time.now.iso8601+','+(Time.now-3600).iso8601}
+      @api.should_receive(:get).with('/stats/channels/1/statistics.json', date_range, {})
+      @api.channel_details(1, date_range)
+    end
+  end
+
+  describe "channel_sum_x" do
+    before :each do
+      expect(@api).to receive(:get).with('/stats/channels/0/statistics.json', {}, {}).and_return(@resp)
+    end
+
+    it "should Get the sum of x" do
+      sum = @api.channel_sum_x('accepted-count')
+      sum.should == 5
+    end
+  end
+end

data/spec/connection_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe ApiWrapperFor8x8::Connection do
+  before do
+    @net_http_response = Net::HTTPOK.new('1.1', 200, 'OK')
+    @net_http_response.stub(:body => '{}')
+    @httparty_response = double("HTTPartyResponse", :parsed_response => {}, :body => '{}', :success? => true)
+  end
+  describe "GET" do
+    describe "connection method" do
+      it "should have valid key tokens" do
+        @api.api_token_keys_valid?.should == true
+      end
+
+      it "should have invalid key tokens" do
+        @conn = ApiWrapperFor8x8::Connection.new({:username => '', :password => nil})
+        @conn.api_token_keys_valid?.should == false
+      end
+
+      it "should have incorrect url" do
+        url = "/stats/agent.json"
+        lambda {
+          @api.validate_and_extract_url(url)
+        }.should raise_error(ApiWrapperFor8x8::ResponseError)
+      end
+
+      it "should have correct url" do
+        urls = ["/stats/agents.json", "/stats/channels.json", "/stats/statistics.json"]
+        urls.each do |url|
+          @api.validate_and_extract_url(url).size.should > 0
+        end
+      end
+    end
+
+    describe "get_stat" do
+      before :each do
+        expect(@api).to receive(:validate_and_extract_url).with('').and_return('statistics')
+        @resp1 = {'statistics' => {'statistic' => []}}
+        @resp2 = {'statistics' => {'statistic' => [{}, {}]}}
+      end
+
+      it "should get empty stat" do
+        @api.get_stat(@resp1, '').should == []
+      end
+
+      it "should get correct stat" do
+        @api.get_stat(@resp2, '').should == [{}, {}]
+      end
+    end
+
+    describe "get" do
+      it "should have more than 50 records from the response" do
+        @api.stub(:request)
+        @api.stub(:parsed_response)
+        url    = '/stats/channels/1/statistics.json'
+        params = {:n => 1}
+        expect(@api).to receive(:get_stat).exactly(ApiWrapperFor8x8::Connection::MAX_TRY)
+                        .and_return([{}]*(ApiWrapperFor8x8::Connection::RECORDS_LIMIT))
+        @api.get(url, {:n => 1}).size.should == ApiWrapperFor8x8::Connection::RECORDS_LIMIT * ApiWrapperFor8x8::Connection::MAX_TRY
+      end
+    end
+
+    describe "apply_filter" do
+      before :each do
+        @resp = [{'accepted-count' => 3, 'entered-count' => 10, 'queue-name' => 'inbound'}, {'accepted-count' => 2, 'entered-count' => 5, 'queue-name' => 'outbound'}]
+        @filters = {'queue-name' => 'inbound'}
+      end
+      context "with filter options" do
+        it "should gat a list of hash that meet the filter options" do
+          list = @api.apply_filter(@resp, @filters)
+          list.size.should == 1
+          list[0]['queue-name'].should == 'inbound'
+        end
+      end
+
+      context "without filter option" do
+        it "should get a list of original hash" do
+          list = @api.apply_filter(@resp, {})
+          list.size.should == @resp.size
+        end
+      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)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rspec'
+require 'bundler/setup'
+require 'rspec/expectations'
+require 'httparty'
+require 'json'
+
+Dir[File.dirname(__FILE__)+'/../lib/ApiWrapperFor8x8/*.rb'].each{|file| require file}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    @api = ApiWrapperFor8x8::Connection.new({:username => ENV['PHONE_SYSTEM_UN'], :password => ENV['PHONE_SYSTEM_TOKEN']})
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ApiWrapperFor8x8::VERSION do
+  it { should_not be_nil }
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: ApiWrapperFor8x8
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- daifu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: 8x8 Phone System api wrapper to handle reporting.
+email:
+- daifu.ye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- ApiWrapperFor8x8.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ApiWrapperFor8x8.rb
+- lib/ApiWrapperFor8x8/agent.rb
+- lib/ApiWrapperFor8x8/agents.rb
+- lib/ApiWrapperFor8x8/channel.rb
+- lib/ApiWrapperFor8x8/connection.rb
+- lib/ApiWrapperFor8x8/error.rb
+- lib/ApiWrapperFor8x8/version.rb
+- spec/.rspec
+- spec/agent_spec.rb
+- spec/agents_spec.rb
+- spec/channel_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+homepage: https://github.com/daifu/api-wrapper-for-8x8
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: 8x8 Phone System api wrapper
+test_files:
+- spec/.rspec
+- spec/agent_spec.rb
+- spec/agents_spec.rb
+- spec/channel_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb