sevenscale-adhearsion 0.7.1003 → 0.8.0

data/spec/voip/asterisk/config_file_generators/test_queues.rb

@@ -1,325 +0,0 @@
-require File.join(File.dirname(__FILE__), *%w[.. .. .. test_helper])
-require 'adhearsion/voip/asterisk/config_generators/queues.conf'
-
-context "The queues.conf config file generator" do
-  
-  include QueuesConfigFileGeneratorTestHelper
-  
-  attr_reader :queues
-  before:each do
-    reset_queues!
-  end
-  
-  test 'should set autofill=yes by default' do
-    generated_config_should_have_pair :autofill => 'yes'
-  end
-  
-  test 'should have a [general] section' do
-    queues.conf.should.include "[general]\n"
-  end
-  
-  test 'should yield a Queues object in its constructor' do
-    Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Queues.new do |config|
-      config.should.be.kind_of Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Queues
-    end
-  end
-  
-  test 'should add the warning message to the to_s output' do
-    queues.conf.should =~ /^\s*;.{10}/
-  end
-  
-end
-
-context "The queues.conf config file queues's QueueDefinition" do
-  
-  include QueuesConfigFileGeneratorTestHelper
-  
-  attr_reader :queues
-  before:each do
-    reset_queues!
-  end
-  
-  test 'should include [queue_name]' do
-    name_of_queue = "leet_hax0rz"
-    queues.queue(name_of_queue).to_s.should.include "[#{name_of_queue}]"
-  end
-  
-  test '#member should create a valid Agent "channel driver" to the member definition list' do
-    sample_queue = queues.queue "sales" do |sales|
-      sales.member 123
-      sales.member "Jay"
-      sales.member 'SIP/jay-desk-650'
-      sales.member 'IAX2/12345@voipms/15554443333'
-    end
-    sample_queue.members.should == %w[Agent/123 Agent/Jay SIP/jay-desk-650 IAX2/12345@voipms/15554443333]
-  end
-  
-  test 'should automatically enable the two AMI-related events' do
-    @queues = queues.queue 'name'
-    generated_config_should_have_pair :eventwhencalled   => 'vars'
-    generated_config_should_have_pair :eventmemberstatus => 'yes'
-  end
-  
-  test '#strategy should only allow the pre-defined settings' do
-    [:ringall, :roundrobin, :leastrecent, :fewestcalls, :random, :rrmemory].each do |strategy|
-      the_following_code {
-        q = queues.queue 'foobar'
-        q.strategy strategy
-      }.should.not.raise
-    end
-    
-    the_following_code {
-      queues.queue('qwerty').strategy :this_is_not_a_valid_strategy
-    }.should.raise ArgumentError
-    
-  end
-  
-  test '#sound_files raises an argument error when it sees an unrecognized key' do
-    the_following_code {
-      queues.queue 'foobar' do |foobar|
-        foobar.sound_files \
-          :you_are_next          => rand.to_s,
-          :there_are             => rand.to_s,
-          :calls_waiting         => rand.to_s,
-          :hold_time             => rand.to_s,
-          :minutes               => rand.to_s,
-          :seconds               => rand.to_s,
-          :thank_you             => rand.to_s,
-          :less_than             => rand.to_s,
-          :report_hold           => rand.to_s,
-          :periodic_announcement => rand.to_s
-      end
-    }.should.not.raise
-
-    [:x_you_are_next, :x_there_are, :x_calls_waiting, :x_hold_time, :x_minutes,
-     :x_seconds, :x_thank_you, :x_less_than, :x_report_hold, :x_periodic_announcement].each do |bad_key|
-       the_following_code {
-         queues.queue("foobar") do |foobar|
-           foobar.sound_files bad_key => rand.to_s
-         end
-       }.should.raise ArgumentError
-    end
-
-  end
-  
-end
-
-context "The private, helper methods in QueueDefinition" do
-  
-  include QueuesConfigFileGeneratorTestHelper
-  
-  attr_reader :queue
-  before:each do
-    reset_queues!
-    @queue = @queues.queue "doesn't matter"
-  end
-  
-  test '#boolean should convert a boolean into "yes" or "no"' do
-    mock_of_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_of_properties.should_receive(:[]=).once.with("icanhascheezburger", "yes")
-    flexmock(queue).should_receive(:properties).and_return mock_of_properties
-    queue.send(:boolean, "icanhascheezburger" => true)
-  end
-  
-  test '#int should raise an argument error when its argument is not Numeric' do
-    the_following_code {
-      queue.send(:int, "eisley" => :i_break_things!)
-    }.should.raise ArgumentError
-  end
-  
-  test '#int should coerce a String into a Numeric if possible' do
-    mock_of_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_of_properties.should_receive(:[]=).once.with("chimpanzee", 1337)
-    flexmock(queue).should_receive(:properties).and_return mock_of_properties
-    queue.send(:int, "chimpanzee" => "1337")
-  end
-  
-  test '#string should add the argument directly to the properties' do
-    mock_of_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_of_properties.should_receive(:[]=).once.with("eins", "zwei")
-    flexmock(queue).should_receive(:properties).and_return mock_of_properties
-    queue.send(:string, "eins" => "zwei")
-  end
-  
-  test '#one_of() should add its successful match to the properties attribute' do
-    mock_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_properties.should_receive(:[]=).once.with(:doesnt_matter, 5)
-    flexmock(queue).should_receive(:properties).once.and_return mock_properties
-    
-    queue.send(:one_of, 1..100, :doesnt_matter => 5)
-  end
-  
-  test "one_of() should convert booleans to yes/no" do
-    mock_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_properties.should_receive(:[]=).once.with(:doesnt_matter, 'yes')
-    flexmock(queue).should_receive(:properties).once.and_return mock_properties
-    queue.send(:one_of, [true, false, :strict], :doesnt_matter => true)
-    
-    mock_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_properties.should_receive(:[]=).once.with(:doesnt_matter, :strict)
-    flexmock(queue).should_receive(:properties).once.and_return mock_properties
-    queue.send(:one_of, [true, false, :strict], :doesnt_matter => :strict)
-    
-    mock_properties = flexmock "mock of the properties instance variable of a QueueDefinition"
-    mock_properties.should_receive(:[]=).once.with(:doesnt_matter, 'no')
-    flexmock(queue).should_receive(:properties).once.and_return mock_properties
-    queue.send(:one_of, [true, false, :strict], :doesnt_matter => false)
-  end
-  
-  test '#one_of() should raise an ArgumentError if a value is not in the criteria' do
-    the_following_code {
-      queue.send(:one_of, [:jay, :thomas, :phillips], :sister => :jill)
-    }.should.raise ArgumentError
-  end
-end
-
-context 'The queues.conf config file generator when ran against a really big example' do
-  
-  include QueuesConfigFileGeneratorTestHelper
-  
-  attr_reader :queues, :default_config
-  before:each do
-    reset_queues!
-    @default_config = default_config = <<-CONFIG
-[general]
-persistentmembers=yes
-autofill=yes
-monitor-type=MixMonitor
-
-[markq]
-musicclass=default
-announce=queue-markq
-strategy=ringall
-servicelevel=60
-context=qoutcon
-timeout=15
-retry=5
-weight=0
-wrapuptime=15
-autofill=yes
-autopause=yes
-maxlen=0
-setinterfacevar=yes
-announce-frequency=90
-periodic-announce-frequency=60
-announce-holdtime=once
-announce-round-seconds=10
-queue-youarenext=queue-youarenext
-queue-thereare=queue-thereare
-queue-callswaiting=queue-callswaiting
-queue-holdtime=queue-holdtime
-queue-minutes=queue-minutes
-queue-seconds=queue-seconds
-queue-thankyou=queue-thankyou
-queue-lessthan=queue-less-than
-queue-reporthold=queue-reporthold
-periodic-announce=queue-periodic-announce
-monitor-format=gsm
-monitor-type=MixMonitor
-joinempty=yes
-leavewhenempty=yes
-eventwhencalled=vars
-eventmemberstatus=yes
-reportholdtime=no
-ringinuse=no
-memberdelay=0
-timeoutrestart=no
-
-member => Zap/1
-member => Agent/007
-CONFIG
-  end
-  
-  test "a sample config with multiple queues" do
-    
-    generated = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Queues.new do |config|
-      config.persistent_members true
-      config.monitor_type :mix_monitor
-      
-      config.queue 'markq' do |markq|
-        markq.music_class :default
-        markq.play_on_connect 'queue-markq'
-        markq.strategy :ringall
-        markq.service_level 60
-        markq.exit_to_context_on_digit_press 'qoutcon'
-        markq.ring_timeout 15
-        markq.retry_after_waiting 5
-        markq.weight 0
-        markq.wrapup_time 15
-        markq.autopause true
-        markq.maximum_length 0
-        markq.queue_status_announce_frequency 90
-        markq.announce_hold_time :once
-        markq.announce_round_seconds 10
-        markq.sound_files \
-          :you_are_next  => "queue-youarenext",
-          :there_are     => "queue-thereare",
-          :calls_waiting => "queue-callswaiting",
-          :hold_time     => "queue-holdtime",
-          :minutes       => "queue-minutes",
-          :seconds       => "queue-seconds",
-          :thank_you     => "queue-thankyou",
-          :less_than     => "queue-less-than",
-          :report_hold   => "queue-reporthold"
-        markq.periodically_announce "queue-periodic-announce"
-        markq.monitor_format :gsm
-        markq.monitor_type :mix_monitor
-        markq.join_empty true
-        markq.leave_when_empty true
-        markq.report_hold_time false
-        markq.ring_in_use false
-        markq.delay_connection_by 0
-        markq.timeout_restart false
-        
-        markq.member 'Zap/1'
-        markq.member '007'
-      end
-    end
-    
-    cleaned_up_default_config = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::
-      AsteriskConfigGenerator.create_sanitary_hash_from(default_config)
-    
-    cleaned_up_generated_config = generated.to_sanitary_hash
-    
-    cleaned_up_generated_config.should == cleaned_up_default_config
-  end
-  
-end
-
-context "ConfigFileGeneratorTestHelper" do
-  
-  include QueuesConfigFileGeneratorTestHelper
-  
-  attr_reader :queues
-  
-  test "generated_config_has_pair() works properly" do
-    @queues = flexmock "A fake queues with just one pair", :to_s => "foo=bar"
-    generated_config_has_pair(:foo => "bar").should.be true
-    
-    @queues = flexmock "A fake queues with just one pair", :to_s => "[general]\n\nqaz=qwerty\nagent => 1,2,3"
-    generated_config_has_pair(:qaz => "qwerty").should.be true
-    generated_config_has_pair(:foo => "bar").should.be false
-  end
-  
-end
-
-BEGIN {
-module QueuesConfigFileGeneratorTestHelper
-  
-  def reset_queues!
-    @queues = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Queues.new
-  end
-  
-  def generated_config_should_have_pair(pair)
-    generated_config_has_pair(pair).should.equal true
-  end
-  
-  def generated_config_has_pair(pair)
-    queues.to_s.grep(/=[^>]/).each do |line|
-      key, value = line.strip.split('=')
-      return true if pair == {key.to_sym => value}
-    end
-    false
-  end
-end
-}

data/spec/voip/asterisk/config_file_generators/test_voicemail.rb

@@ -1,306 +0,0 @@
-require File.join(File.dirname(__FILE__), *%w[.. .. .. test_helper])
-require 'adhearsion/voip/asterisk/config_generators/voicemail.conf'
-
-context 'Basic requirements of the Voicemail config generator' do
-  attr_reader :config
-  before :each do
-    @config = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new
-  end
-  
-  test 'should have a [general] context' do
-    config.to_sanitary_hash.has_key?('[general]').should.equal true
-  end
-  
-  test 'should set the format to "wav" by default in the general section' do
-    config.to_sanitary_hash['[general]'].should.include 'format=wav'
-  end
-  
-  test 'an exception should be raised if the context name is "general"' do
-    the_following_code {
-      config.context(:general) {|_|}
-    }.should.raise ArgumentError
-  end
-  
-end
-
-context 'Defining recording-related settings of the Voicemail config file' do
-  
-  attr_reader :recordings
-  before :each do
-    @recordings = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail::RecordingDefinition.new
-  end
-  
-  test 'the recordings setting setter' do
-    Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new.recordings.should.be.kind_of? recordings.class
-  end
-  
-  test 'recordings format should only allow a few options' do
-    the_following_code {
-      recordings.format :wav 
-      recordings.format :wav49
-      recordings.format :gsm
-    }.should.not.raise
-    
-    the_following_code {
-      recordings.format :lolcats
-    }.should.raise ArgumentError
-  end
-  
-end
-
-context 'Defining email-related Voicemail settings' do
-  
-  attr_reader :email
-  before :each do
-    @email = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail::EmailDefinition.new
-  end
-  
-  test 'the [] operator is overloaded to return conveniences for the body() and subject() methods' do
-    variables = %{#{email[:name]} #{email[:mailbox]} #{email[:date]} #{email[:duration]} } + 
-                %{#{email[:message_number]} #{email[:caller_id]} #{email[:caller_id_number]} } +
-                %{#{email[:caller_id_name]}}
-    formatted = %{${VM_NAME} ${VM_MAILBOX} ${VM_DATE} ${VM_DUR} ${VM_MSGNUM} ${VM_CALLERID} ${VM_CIDNUM} ${VM_CIDNAME}}      
-    email.body variables
-    email.subject variables
-    email.properties[:emailbody].should == formatted
-    email.properties[:emailsubject].should == formatted
-  end
-  
-  test 'when defining a body, newlines should be escaped and carriage returns removed' do
-    unescaped, escaped = "one\ntwo\n\r\r\nthree\n\n\n", 'one\ntwo\n\nthree\n\n\n'
-    email.body unescaped
-    email.properties[:emailbody].should == escaped
-  end
-  
-  test 'the body must not be allowed to exceed 512 characters' do
-    the_following_code {
-      email.body "X" * 512
-    }.should.not.raise ArgumentError
-    
-    the_following_code {
-      email.body "X" * 513
-    }.should.raise ArgumentError
-    
-    the_following_code {
-      email.body "X" * 1000
-    }.should.raise ArgumentError
-  end
-  
-  test 'should store away the email command properly' do
-    mail_command = "/usr/sbin/sendmail -f alice@wonderland.com -t"
-    email.command mail_command
-    email.properties[:mailcmd].should == mail_command
-  end
-  
-end
-
-context 'A mailbox definition' do
-  attr_reader :mailbox
-  before :each do
-    @mailbox = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail::ContextDefinition::MailboxDefinition.new("123")
-  end
-  
-  test 'setting the name should be reflected in the to_hash form of the definition' do
-    mailbox.name "Foobar"
-    mailbox.to_hash[:name].should == "Foobar"
-  end
-  
-  test 'setting the pin_number should be reflected in the to_hash form of the definition' do
-    mailbox.pin_number 555
-    mailbox.to_hash[:pin_number].should.equal 555
-  end
-  
-  test 'the mailbox number should be available in the mailbox_number getter' do
-    Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail::ContextDefinition::MailboxDefinition.new '123'
-    mailbox.mailbox_number.should.equal '123'
-  end
-  
-  test 'an ArgumentError should be raised if the mailbox_number is not numeric' do
-    the_following_code {
-      Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail::ContextDefinition::MailboxDefinition.new("this is not numeric")
-    }.should.raise ArgumentError
-  end
-  
-  test 'an ArgumentError should be raised if the pin_number is not numeric' do
-    the_following_code {
-      mailbox.pin_number "this is not numeric"
-    }.should.raise ArgumentError
-  end
-  
-  test "the string representation should be valid" do
-    expected = "123 => 1337,Jay Phillips,ahn@adhearsion.com"
-    mailbox.pin_number 1337
-    mailbox.name "Jay Phillips"
-    mailbox.email "ahn@adhearsion.com"
-    mailbox.to_s.should == expected
-  end
-  
-  test 'should not add a trailing comma when the email is left out' do
-    mailbox.pin_number 1337
-    mailbox.name "Jay Phillips"
-    mailbox.to_s.ends_with?(',').should.equal false
-  end
-  
-  test 'should not add a trailing comma when the email and name is left out' do
-    mailbox.pin_number 1337
-    mailbox.to_s.ends_with?(',').should.equal false
-  end
-  
-end
-
-context "A Voicemail context definition" do
-  
-  test "should ultimately add a [] context definition to the string output" do
-    voicemail = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new
-    voicemail.context "monkeys" do |config|
-      config.should.be.kind_of voicemail.class::ContextDefinition
-      config.mailbox 1234 do |mailbox|
-        mailbox.pin_number 3333
-        mailbox.email "alice@wonderland.com"
-        mailbox.name "Alice Little"
-      end
-    end
-    voicemail.to_sanitary_hash.has_key?('[monkeys]').should.equal true
-  end
-  
-  test 'should raise a LocalJumpError if no block is given' do
-    the_following_code {
-      Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new.context('lols')
-    }.should.raise LocalJumpError
-  end
-  
-  test 'its string representation should begin with a context declaration' do
-    vm = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new
-    vm.context("jay") {|_|}.to_s.starts_with?("[jay]").should.equal true
-  end
-  
-end
-
-context 'Defining Voicemail contexts with mailbox definitions' do
-  
-end
-
-context 'An expansive example of the Voicemail config generator' do
-  
-  before :each do
-    @employees = [
-      {:name => "Tango",  :pin_number => 7777, :mailbox_number => 10},
-      {:name => "Echo",   :pin_number => 7777, :mailbox_number => 20},
-      {:name => "Sierra", :pin_number => 7777, :mailbox_number => 30},
-      {:name => "Tango2", :pin_number => 7777, :mailbox_number => 40}
-    ].map { |hash| OpenStruct.new(hash) }
-    
-    @groups = [
-      {:name => "Brand New Cadillac", :pin_number => 1111, :mailbox_number => 1},
-      {:name => "Jimmy Jazz",         :pin_number => 2222, :mailbox_number => 2},
-      {:name => "Death or Glory",     :pin_number => 3333, :mailbox_number => 3},
-      {:name => "Rudie Can't Fail",   :pin_number => 4444, :mailbox_number => 4},
-      {:name => "Spanish Bombs",      :pin_number => 5555, :mailbox_number => 5}
-    ].map { |hash| OpenStruct.new(hash) }
-  end
-  
-  test 'a huge, brittle integration test' do
-    vm = Adhearsion::VoIP::Asterisk::ConfigFileGenerators::Voicemail.new do |voicemail|
-      voicemail.context :default do |context|
-        context.mailbox 123 do |mailbox|
-          mailbox.name "Administrator"
-          mailbox.email "jabberwocky@wonderland.com"
-          mailbox.pin_number 9876
-        end
-      end
-
-      voicemail.context :employees do |context|
-        @employees.each do |employee|
-          context.mailbox employee.mailbox_number do |mailbox|
-            mailbox.pin_number 1337
-            mailbox.name employee.name
-          end
-        end
-      end
-
-      voicemail.context :groups do |context|
-        @groups.each do |group|
-          context.mailbox group.mailbox_number do |mailbox|
-            mailbox.pin_number 1337
-            mailbox.name group.name
-            mailbox.email "foo@qaz.org"
-          end
-        end
-      end
-
-      voicemail.execute_on_pin_change "/path/to/my/changer_script.rb"
-      ############################################################################
-      ############################################################################
-
-      signature = "Your Friendly Phone System"
-
-      # execute_after_email "netcat 192.168.1.2 12345"
-      # greeting_maximum 1.minute
-      # time_jumped_with_skip_key 3.seconds # milliseconds!
-      # logging_in do |config|
-      #   config.maximum_attempts 3
-      # end
-
-      voicemail.recordings do |config|
-        config.format :wav # ONCE YOU PICK A FORMAT, NEVER CHANGE IT UNLESS YOU KNOW THE CONSEQUENCES!
-        config.allowed_length 3.seconds..5.minutes
-        config.maximum_silence 10.seconds
-        # config.silence_threshold 128 # wtf?
-      end
-
-      voicemail.emails do |config|
-        config.from :name => signature, :email => "noreply@adhearsion.com"
-        config.attach_recordings true
-        config.command '/usr/sbin/sendmail -f alice@wonderland.com -t'
-        config.subject "New voicemail for #{config[:name]}"
-        config.body <<-BODY.unindent
-          Dear #{config[:name]}:
-          
-          The caller #{config[:caller_id]} left you a #{config[:duration]} long voicemail
-          (number #{config[:message_number]}) on #{config[:date]} in mailbox #{config[:mailbox]}.
-          
-          #{ "The recording is attached to this email.\n" if config.attach_recordings? }
-          - #{signature}
-        BODY
-      end
-    end
-    internalized = vm.to_sanitary_hash
-    internalized.size.should.equal 5 # general, zonemessages, default, employees, groups
-    
-    target_config = <<-CONFIG
-[general]
-attach=yes
-emailbody=Dear ${VM_NAME}:\\nThe caller ${VM_CALLERID} left you a ${VM_DUR} long voicemail\\n(number ${VM_MSGNUM}) on ${VM_DATE} in mailbox ${VM_MAILBOX}.\\nThe recording is attached to this email.\\n- Your Friendly Phone System\\n
-emailsubject=New voicemail for ${VM_NAME}
-externpass=/path/to/my/changer_script.rb
-format=wav
-fromstring=Your Friendly Phone System
-mailcmd=/usr/sbin/sendmail -f alice@wonderland.com -t
-serveremail=noreply@adhearsion.com
-
-[zonemessages]
-eastern=America/New_York|'vm-received' Q 'digits/at' IMp
-central=America/Chicago|'vm-received' Q 'digits/at' IMp
-central24=America/Chicago|'vm-received' q 'digits/at' H N 'hours'
-military=Zulu|'vm-received' q 'digits/at' H N 'hours' 'phonetic/z_p'
-european=Europe/Copenhagen|'vm-received' a d b 'digits/at' HM
-[default]
-123 => 9876,Administrator,jabberwocky@wonderland.com
-
-[employees]
-10 => 1337,Tango
-20 => 1337,Echo
-30 => 1337,Sierra
-40 => 1337,Tango2
-
-[groups]
-1 => 1337,Brand New Cadillac,foo@qaz.org
-2 => 1337,Jimmy Jazz,foo@qaz.org
-3 => 1337,Death or Glory,foo@qaz.org
-4 => 1337,Rudie Can't Fail,foo@qaz.org
-5 => 1337,Spanish Bombs,foo@qaz.org
-    CONFIG
-    vm.to_s.grep(/^$|^[^;]/).join.strip.should == target_config.strip
-    
-  end
-end