rspec-rayo 0.1.14

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,17 @@
+Gemfile.lock
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+pkg
+
+spec/reports

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--tty
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Voxeo Corporation
+
+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,72 @@
+rspec-rayo
+============
+
+This library extends the Rspec testing library for Rayo specific expectations. The library also provides classes for Tropo1 and Rayo drivers.
+
+Howto Install
+-------------
+
+	gem install rspec-rayo
+
+Example Driver Setup
+--------------------
+
+	ap "Starting RayoDriver to manage events over XMPP."
+	@rayo = RSpecRayo::RayoDriver.new :username         => @config['rayo_server']['jid'],
+	                                  :password         => @config['rayo_server']['password'],
+	                                  :wire_logger      => Logger.new(@config['rayo_server']['wire_log']),
+	                                  :transport_logger => Logger.new(@config['rayo_server']['transport_log'])
+
+	ap "Starting Tropo1Driver to host scripts via DRb and launch calls via HTTP."
+	@tropo1 = RSpecRayo::Tropo1Driver.new(@config['tropo1']['druby_uri'])
+
+Custom Matchers
+---------------
+
+* have_executed_correctly
+* have_dialed_correctly
+* be_a_valid_complete_hangup_event
+* be_a_valid_complete_error_event
+* be_a_valid_complete_stopped_event
+
+* be_a_valid_successful_ask_event
+* be_a_valid_ask_noinput_event
+* be_a_valid_ask_nomatch_event
+
+* be_a_valid_offer_event
+* be_a_valid_answered_event
+* be_a_valid_hangup_event
+* be_a_valid_ringing_event
+* be_a_valid_redirect_event
+* be_a_valid_reject_event
+
+* be_a_valid_conference_offhold_event
+* be_a_valid_speaking_event
+* be_a_valid_finished_speaking_event
+* be_a_valid_conference_complete_terminator_event
+
+* be_a_valid_dtmf_event
+
+* be_a_valid_successful_input_event
+* be_a_valid_input_noinput_event
+* be_a_valid_input_nomatch_event
+
+* be_a_valid_joined_event
+* be_a_valid_unjoined_event
+
+* be_a_valid_output_event
+
+* be_a_valid_complete_recording_event
+* be_a_valid_stopped_recording_event
+
+* be_a_valid_say_event
+
+* be_a_valid_transfer_event
+* be_a_valid_transfer_timeout_event
+
+
+Copyright
+---------
+
+Copyright (c) 2011 Voxeo Corporation. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'ci/reporter/rake/rspec'
+task :hudson => ['ci:setup:rspec', :spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/rspec-rayo/rayo/call.rb

@@ -0,0 +1,135 @@
+require 'future-resource'
+
+module RSpecRayo
+  class Call
+    attr_accessor :status, :call_id
+    attr_reader :queue
+
+    def initialize(options)
+      @call_event     = FutureResource.new
+      self.call_event = options[:call_event] if options[:call_event]
+      @ring_event     = FutureResource.new
+      @protocol       = options[:protocol]
+      @queue          = options[:queue]
+      @read_timeout   = options[:read_timeout] || 5
+      @write_timeout  = options[:write_timeout] || 5
+      @status         = :offered
+    end
+
+    def accept
+      write(Punchblock::Command::Accept.new).tap do |response|
+        @status = :accepted if response
+      end
+    end
+
+    def answer
+      write Punchblock::Command::Answer.new
+    end
+
+    def ask(options = {})
+      write Punchblock::Component::Tropo::Ask.new(options)
+    end
+
+    def conference(options = {})
+      write Punchblock::Component::Tropo::Conference.new(options)
+    end
+
+    def dial(options = {})
+      write Punchblock::Command::Dial.new(options)
+    end
+
+    def hangup
+      write(Punchblock::Command::Hangup.new).tap do |response|
+        @status = :finished if response
+      end
+    end
+
+    def redirect(options = {})
+      write Punchblock::Command::Redirect.new(options)
+    end
+
+    def reject(reason = nil)
+      write(Punchblock::Command::Reject.new(reason)).tap do |response|
+        @status = :finished if response
+      end
+    end
+
+    def say(options = {})
+      write Punchblock::Component::Tropo::Say.new(options)
+    end
+
+    def transfer(options = {})
+      write Punchblock::Component::Tropo::Transfer.new(options)
+    end
+
+    def record(options = {})
+      write Punchblock::Component::Record.new(options)
+    end
+
+    def output(options = {})
+      write Punchblock::Component::Output.new(options)
+    end
+
+    def input(options = {})
+      write Punchblock::Component::Input.new(options)
+    end
+
+    def join(options = {})
+      write Punchblock::Command::Join.new(options)
+    end
+
+    def unjoin(options = {})
+      write Punchblock::Command::Unjoin.new(options)
+    end
+
+    def mute
+      write Punchblock::Command::Mute.new
+    end
+
+    def unmute
+      write Punchblock::Command::Unmute.new
+    end
+
+    def dtmf(tones)
+      write Punchblock::Command::DTMF.new(:tones => tones)
+    end
+
+    def last_event?(timeout = 2)
+      begin
+        next_event timeout
+      rescue Timeout::Error
+        true
+      end
+    end
+
+    def next_event(timeout = nil)
+      Timeout::timeout(timeout || @read_timeout) { @queue.pop }
+    end
+
+    def call_event
+      @call_event.resource @write_timeout
+    end
+
+    def call_event=(other)
+      raise ArgumentError, 'Call event must be a Punchblock::Event::Offer' unless other.is_a? Punchblock::Event::Offer
+      @call_event.resource  = other
+      @call_id              = other.call_id
+    end
+
+    def ring_event
+      @ring_event.resource @write_timeout
+    end
+
+    def ring_event=(other)
+      raise ArgumentError, 'Ring event must be a Punchblock::Event::Ringing' unless other.is_a? Punchblock::Event::Ringing
+      @ring_event.resource = other
+    end
+
+    private
+
+    def write(msg)
+      response = @protocol.write @call_id, msg
+      msg if response
+    end
+  end
+end

data/lib/rspec-rayo/rayo/driver.rb

@@ -0,0 +1,110 @@
+module RSpecRayo
+  class RayoDriver
+    attr_reader :event_queue, :threads
+    attr_accessor :calls
+
+    def initialize(options)
+      @calls            = {}
+      @call_queue       = Queue.new
+      @queue_timeout    = options[:queue_timeout] || 5
+      @write_timeout    = options[:write_timeout] || 5
+      @threads          = []
+
+      initialize_rayo options
+    end
+
+    def get_call
+      read_queue @call_queue
+    end
+
+    def cleanup_calls
+      @calls.each_pair do |call_id, call|
+        call.hangup unless call.status == :finished
+      end
+      @calls = {}
+    end
+
+    def dial(options)
+      Call.new(:protocol => @rayo, :queue => Queue.new, :read_timeout => @queue_timeout, :write_timeout => @write_timeout).tap do |call|
+        dial = call.dial options
+        call.call_id = dial.call_id
+        @calls.merge! call.call_id => call
+      end
+    end
+
+    def start_event_dispatcher
+      @threads << Thread.new do
+        event = nil
+
+        until event == 'STOP' do
+          event = @event_queue.pop
+          case event
+          when Punchblock::Event::Offer
+            call = Call.new :call_event     => event,
+                            :protocol       => @rayo,
+                            :queue          => Queue.new,
+                            :read_timeout   => @queue_timeout,
+                            :write_timeout  => @write_timeout
+            @calls.merge! event.call_id => call
+            @call_queue.push call
+          when Punchblock::Event::Ringing
+            call = @calls[event.call_id]
+            call.ring_event = event if call
+          else
+            # Temp based on this nil returned on conference: https://github.com/tropo/punchblock/issues/27
+            begin
+              if event.is_a?(Punchblock::Event::End)
+                @calls[event.call_id].status = :finished
+              end
+              @calls[event.call_id].queue.push event unless event.nil?
+            rescue => error
+              # Event nil issue to be addressed here: https://github.com/tropo/rspec-rayo/issues/2
+            end
+          end
+        end
+
+      end
+    end
+
+    def read_queue(queue)
+      Timeout::timeout(@queue_timeout) { queue.pop }
+    end
+
+    def initialize_rayo(options)
+      initialize_logging options
+
+      # Setup our Rayo environment
+      @rayo = Punchblock::Connection.new :username         => options[:username],
+                                         :password         => options[:password],
+                                         :wire_logger      => @wire_logger,
+                                         :transport_logger => @transport_logger,
+                                         :auto_reconnect   => false,
+                                         :write_timeout    => options[:write_timeout]
+      @event_queue = @rayo.event_queue
+
+      start_rayo
+    end
+
+    def initialize_logging(options)
+      @wire_logger = options[:wire_logger]
+      @wire_logger.level = options[:log_level]
+      #@wire_logger.info "Starting up..." if @wire_logger
+
+      @transport_logger = options[:transport_logger]
+      @transport_logger.level = options[:log_level]
+      #@transport_logger.info "Starting up..." if @transport_logger
+    end
+
+    def start_rayo
+      # Launch the Rayo thread
+      @threads << Thread.new do
+        begin
+          @rayo.run
+        rescue => e
+          puts "Exception in XMPP thread! #{e.message}"
+          puts e.backtrace.join("\t\n")
+        end
+      end
+    end
+  end
+end

data/lib/rspec-rayo/rayo/matchers/ask.rb

@@ -0,0 +1,60 @@
+RSpec::Matchers.define :be_a_valid_successful_ask_event do
+  chain :with_utterance do |utterance|
+    @utterance = utterance
+  end
+
+  chain :with_interpretation do |interpretation|
+    @interpretation = interpretation
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Ask::Complete::Success
+      @error = "The utterance was not correct. Expected '#{@utterance}', got '#{event.reason.utterance}'" if @utterance && event.reason.utterance != @utterance
+      @error = "The interpretation was not correct. Expected '#{@interpretation}', got '#{event.reason.interpretation}'" if @interpretation && event.reason.interpretation != @interpretation
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The ask event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid successful ask event".tap do |d|
+      d << " with utterance '#{@utterance}'" if @utterance
+      d << " with interpretation '#{@interpretation}'" if @interpretation
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_ask_noinput_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Ask::Complete::NoInput
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The ask event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid noinput ask event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_ask_nomatch_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Ask::Complete::NoMatch
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The ask event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid nomatch ask event"
+  end
+end

data/lib/rspec-rayo/rayo/matchers/call_control.rb

@@ -0,0 +1,105 @@
+RSpec::Matchers.define :be_a_valid_offer_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Offer do
+      event.headers_hash.each do |k,v|
+        if v.nil?
+          @error = "#{k.to_s} is nil - expected a value"
+          raise RSpec::Expectations::ExpectationNotMetError
+        end
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The offer event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid offer event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_answered_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Answered
+  end
+
+  failure_message_for_should do |actual|
+    "The answer event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid answered event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_hangup_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::End do
+      unless event.reason == :hangup
+        @error = "got #{event.reason.inspect} - expected :hangup"
+        raise RSpec::Expectations::ExpectationNotMetError
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The hangup event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid hangup event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_ringing_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Ringing
+  end
+
+  failure_message_for_should do |actual|
+    "The ring event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid ringing event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_redirect_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::End do
+      unless event.reason == :redirect
+        @error = "got #{event.reason.inspect} - expected :redirect"
+        raise RSpec::Expectations::ExpectationNotMetError
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The reject event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid redirect event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_reject_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::End do
+      unless event.reason == :reject
+        @error = "got #{event.reason.inspect} - expected :reject"
+        raise RSpec::Expectations::ExpectationNotMetError
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The reject event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid reject event"
+  end
+end

data/lib/rspec-rayo/rayo/matchers/conference.rb

@@ -0,0 +1,73 @@
+RSpec::Matchers.define :be_a_valid_conference_offhold_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Component::Tropo::Conference::OffHold, true
+  end
+
+  failure_message_for_should do |actual|
+    "The ask event was not valid: #{@error}"
+  end
+
+  description do
+    "Validate an ask event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_speaking_event do
+  chain :for_call_id do |call_id|
+    @call_id = call_id
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Component::Tropo::Conference::Speaking, true do
+      @error = "The speaking call ID was not correct. Expected '#{@call_id}', got '#{event.speaking_call_id}'" if @call_id && event.speaking_call_id != @call_id
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The speaking event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid speaking event".tap do |d|
+      d << " with call ID '#{@call_id}'" if @call_id
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_finished_speaking_event do
+  chain :for_call_id do |call_id|
+    @call_id = call_id
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Component::Tropo::Conference::FinishedSpeaking, true do
+      @error = "The finished-speaking call ID was not correct. Expected '#{@call_id}', got '#{event.speaking_call_id}'" if @call_id && event.speaking_call_id != @call_id
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The finished speaking event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid finished speaking event".tap do |d|
+      d << " with call ID '#{@call_id}'" if @call_id
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_conference_complete_terminator_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Conference::Complete::Terminator
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The conference complete terminator event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid conference complete terminator event"
+  end
+end

data/lib/rspec-rayo/rayo/matchers/dtmf.rb

@@ -0,0 +1,21 @@
+RSpec::Matchers.define :be_a_valid_dtmf_event do
+  chain :with_signal do |signal|
+    @signal = signal
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::DTMF do
+      @error = "The signal was not correct. Expected '#{@signal}', got '#{event.signal}'" if @signal && event.signal != @signal
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The DTMF event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid DTMF event".tap do |d|
+      d << " with signal '#{@signal}'" if @signal
+    end
+  end
+end