electric_slide 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b6b7652ebb0629af9310a93d7c6ac0352fd92c8
+  data.tar.gz: f5fd82735d7d8949b14a4ea8ee318c096820092f
+SHA512:
+  metadata.gz: 9b9bafc665557361a51d504d71d94d2775a8e68924a22600e23a68f8b53acb7a2fcb85a3197e797e0c8af7cccc272f606d63f651c9a654f0aa9e2dc2aa69ac7a
+  data.tar.gz: 85da4abe01db3cd099748cc11ada5c59383c38b8ac1e1994adaa01f98d9d6af05db659e767e6dae6cdef3c4fbae42c414689d9af2d09a670142b1355ec820caa

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 The Adhearsion Foundation, Inc.
+
+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.markdown

@@ -0,0 +1,3 @@
+AhnQueue - Automatic Call Distribution (ACD) Services for Adhearsion
+====================================================================
+

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# -*- ruby -*-
+ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin spec).join(File::PATH_SEPARATOR)}"
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'ci/reporter/rake/rspec'
+task :ci => ['ci:setup:rspec', :spec]
+task :default => :spec
+

data/config/ahn_acd.yml

@@ -0,0 +1 @@
+# You can use this file for component-specific configuration.

data/electric_slide.gemspec

@@ -0,0 +1,32 @@
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = "electric_slide"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Klang"]
+
+  s.date = Date.today.to_s
+  s.description = "Automatic Call Distributor (ACD) for Adhearsion. Currently implements only Round Robin distribution strategies."
+  s.email = "dev&adhearsion.com"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.has_rdoc = true
+  s.homepage = "http://github.com/adhearsion/electric_slide"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.2.0"
+  s.summary = "Automatic Call Distributor for Adhearsion"
+
+  s.add_runtime_dependency 'adhearsion'
+  s.add_runtime_dependency 'countdownlatch'
+  s.add_runtime_dependency 'activesupport'
+  s.add_development_dependency 'rspec', ['>= 2.5.0']
+  s.add_development_dependency 'flexmock', ['>= 0.9.0']
+  s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+
+  s.specification_version = 2
+end

data/lib/electric_slide.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+require 'active_support/dependencies/autoload'
+require 'adhearsion/foundation/thread_safety'
+
+class ElectricSlide < Adhearsion::Plugin
+  extend ActiveSupport::Autoload
+
+  autoload :QueueStrategy
+  autoload :RoundRobin
+  autoload :RoundRobinMeetme
+
+  include Singleton
+
+  def initialize
+    @queues = {}
+  end
+
+  def create(name, queue_type, agent_type = Agent)
+    synchronize do
+      @queues[name] = queue_type.new unless @queues.has_key?(name)
+      @queues[name].extend agent_type
+    end
+  end
+
+  def get_queue(name)
+    synchronize do
+      @queues[name]
+    end
+  end
+
+  def self.method_missing(method, *args, &block)
+    instance.send method, *args, &block
+  end
+
+  module Agent
+    def work(agent_call)
+      loop do
+        agent_call.execute 'Bridge', @queue.next_call
+      end
+    end
+  end
+
+  class CalloutAgent
+    def work(agent_channel)
+      @queue.next_call.each do |next_call|
+        next_call.dial agent_channel
+      end
+    end
+  end
+
+  class MeetMeAgent
+    include Agent
+
+    def work(agent_call)
+      loop do
+        agent_call.join agent_conf, @queue.next_call
+      end
+    end
+  end
+
+  class BridgeAgent
+    include Agent
+  end
+end
+

data/lib/electric_slide/queue_strategy.rb

@@ -0,0 +1,18 @@
+class ElectricSlide
+  module QueueStrategy
+    def wrap_call(call)
+      call = QueuedCall.new(call) unless call.respond_to?(:queued_time)
+      call
+    end
+
+    def priority_enqueue(call)
+      # TODO: Add this call to the front of the line
+      enqueue call
+    end
+
+    def enqueue(call)
+      call.hold
+    end
+  end
+end
+

data/lib/electric_slide/queued_call.rb

@@ -0,0 +1,24 @@
+require 'countdownlatch'
+
+class ElectricSlide
+  class QueuedCall
+    attr_accessor :call, :queued_time
+
+    def initialize(call)
+      @call = call
+      @queued_time = Time.now
+    end
+
+    def hold
+      call.execute 'StartMusicOnHold'
+      @latch = CountDownLatch.new 1
+      @latch.wait
+      call.execute 'StopMusicOnHold'
+    end
+
+    def make_ready!
+      @latch.countdown!
+    end
+  end
+end
+

data/lib/electric_slide/round_robin.rb

@@ -0,0 +1,46 @@
+require 'thread'
+require 'electric_slide/queue_strategy'
+
+class ElectricSlide
+  class RoundRobin
+    include QueueStrategy
+    attr_reader :queue
+
+    def initialize
+      @queue = []
+      @agents_waiting = []
+      @conditional = ConditionVariable.new
+    end
+
+    def next_call
+      call = nil
+      synchronize do
+        @agents_waiting << Thread.current
+        @conditional.wait(@mutex) if @queue.length == 0
+        @agents_waiting.delete Thread.current
+        call = @queue.shift
+      end
+
+      call.make_ready!
+      call
+    end
+
+    def agents_waiting
+      synchronize do
+        @agents_waiting.dup
+      end
+    end
+
+    # TODO: Add mechanism to add calls with higher priority to the front of the queue.
+
+    def enqueue(call)
+      call = wrap_call(call)
+      synchronize do
+        @queue << call
+        @conditional.signal if @queue.length == 1
+      end
+      super
+    end
+  end
+end
+

data/lib/electric_slide/round_robin_meetme.rb

@@ -0,0 +1,34 @@
+class ElectricSlide
+  class RoundRobinMeetme
+    include QueueStrategy
+
+    def initialize(call)
+      @queue = []
+    end
+
+    def next_call
+      call = synchronize do
+        @queue.pop
+      end
+
+      call.make_ready!
+      call
+    end
+
+    def priority_enqueue(call)
+      call = wrap_call(call)
+
+      synchronize do
+        @queue.unshift call
+      end
+      super
+    end
+
+    def enqueue(call)
+      synchronize do
+        @queue << call
+      end
+    end
+  end
+end
+

data/spec/electric_slide/queue_strategy_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe ElectricSlide::QueueStrategy do
+  include ElectricSlide::QueueStrategy
+
+  describe '#wrap_call' do
+    it 'should pass through a QueuedCall object' do
+      obj = ElectricSlide::QueuedCall.new dummy_call
+      wrap_call(obj).should be obj
+    end
+
+    it 'should wrap any object that does not respond to #queued_time' do
+      wrap_call(dummy_call).should be_a ElectricSlide::QueuedCall
+    end
+  end
+end

data/spec/electric_slide/queued_call_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ElectricSlide::QueuedCall do
+  it 'should initialize the queued_time to the current time' do
+    now = Time.now
+    flexmock(Time).should_receive(:now).once.and_return now
+    qcall = ElectricSlide::QueuedCall.new dummy_call
+    qcall.instance_variable_get(:@queued_time).should == now
+  end
+
+  it 'should start and stop music on hold when put on hold and released' do
+    # Both tests are combined here so we do not leave too many suspended threads lying about
+    queued_caller = dummy_call
+    flexmock(queued_caller).should_receive(:execute).once.with('StartMusicOnHold')
+    flexmock(queued_caller).should_receive(:execute).once.with('StopMusicOnHold')
+    qcall = ElectricSlide::QueuedCall.new queued_caller
+
+    # Place the call on hold and wait for it to enqueue
+    Thread.new { qcall.hold }
+    sleep 0.5
+
+    # Release the call from being on hold and sleep to ensure we get the Stop MOH signal
+    qcall.make_ready!
+    sleep 0.5
+  end
+
+  it 'should block the call when put on hold' do
+    queued_caller = dummy_call
+    flexmock(queued_caller).should_receive(:execute).once.with('StartMusicOnHold')
+    flexmock(queued_caller).should_receive(:execute).once.with('StopMusicOnHold')
+    qcall = ElectricSlide::QueuedCall.new queued_caller
+
+    hold_thread = Thread.new { qcall.hold }
+
+    # Give the holding thread a chance to block...
+    sleep 0.5
+    hold_thread.status.should == "sleep"
+    qcall.make_ready!
+    sleep 0.5
+    hold_thread.status.should be false
+  end
+end

data/spec/electric_slide/round_robin_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe ElectricSlide::RoundRobin do
+  def dummy_queued_call
+    dqc = ElectricSlide::QueuedCall.new dummy_call
+    flexmock(dqc).should_receive(:hold).once
+    flexmock(dqc).should_receive(:make_ready!).once
+    dqc
+  end
+
+  before :each do
+    @queue = ElectricSlide::RoundRobin.new
+  end
+
+  describe "Queue is empty at start" do
+    subject { ElectricSlide::RoundRobin.new }
+    its(:queue) { should have(0).items }
+  end
+
+  it 'should properly enqueue a call' do
+    call = ElectricSlide::QueuedCall.new dummy_call
+    flexmock(call).should_receive(:hold).once
+    @queue.enqueue call
+    @queue.instance_variable_get(:@queue).first.should be call
+  end
+
+  it 'should return the call object that is passed in' do
+    call = dummy_queued_call
+    @queue.enqueue call
+    @queue.next_call.should be call
+  end
+
+  it 'should block an agent requesting a call until a call becomes available' do
+    call = dummy_queued_call
+    agent_thread = Thread.new { @queue.next_call }
+
+    # Give the agent thread a chance to block...
+    sleep 0.5
+
+    @queue.agents_waiting.count.should == 1
+
+    @queue.enqueue call
+
+    # Give the agent thread a chance to retrieve the call...
+    sleep 0.5
+    @queue.agents_waiting.count.should == 0
+    agent_thread.kill
+  end
+
+  it 'should unblock only one agent per call entering the queue' do
+    call = dummy_queued_call
+    agent1_thread = Thread.new { @queue.next_call }
+    agent2_thread = Thread.new { @queue.next_call }
+
+    # Give the agent threads a chance to block...
+    sleep 0.5
+
+    @queue.agents_waiting.count.should == 2
+
+    @queue.enqueue call
+
+    # Give the agent thread a chance to retrieve the call...
+    sleep 0.5
+    @queue.agents_waiting.count.should == 1
+    agent1_thread.kill
+    agent2_thread.kill
+  end
+
+  it 'should properly enqueue calls and return them in the same order' do
+    call1 = dummy_queued_call
+    call2 = dummy_queued_call
+    call3 = dummy_queued_call
+    threads = {}
+
+    threads[:call1] = Thread.new { @queue.enqueue call1 }
+    sleep 0.5
+    threads[:call2] = Thread.new { @queue.enqueue call2 }
+    sleep 0.5
+    threads[:call3] = Thread.new { @queue.enqueue call3 }
+    sleep 0.5
+
+
+    @queue.next_call.should be call1
+    @queue.next_call.should be call2
+    @queue.next_call.should be call3
+  end
+end

data/spec/electric_slide_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+Thread.abort_on_exception = true
+
+%w{
+  adhearsion
+  electric_slide
+  electric_slide/queued_call
+  electric_slide/queue_strategy
+  electric_slide/round_robin
+  rspec/core
+  flexmock
+  flexmock/rspec
+}.each { |r| require r }
+
+RSpec.configure do |config|
+  config.mock_framework = :flexmock
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.color_enabled = true
+end
+
+def dummy_call
+  Object.new
+end
+

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: electric_slide
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ben Klang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adhearsion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: countdownlatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatic Call Distributor (ACD) for Adhearsion. Currently implements
+  only Round Robin distribution strategies.
+email: dev&adhearsion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- config/ahn_acd.yml
+- electric_slide.gemspec
+- lib/electric_slide.rb
+- lib/electric_slide/queue_strategy.rb
+- lib/electric_slide/queued_call.rb
+- lib/electric_slide/round_robin.rb
+- lib/electric_slide/round_robin_meetme.rb
+- spec/electric_slide/queue_strategy_spec.rb
+- spec/electric_slide/queued_call_spec.rb
+- spec/electric_slide/round_robin_spec.rb
+- spec/electric_slide_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/adhearsion/electric_slide
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 2
+summary: Automatic Call Distributor for Adhearsion
+test_files: []
+has_rdoc: true