rspec-rayo 0.1.14

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

@@ -0,0 +1,60 @@
+RSpec::Matchers.define :be_a_valid_successful_input_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::Input::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 input event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid successful input 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_input_noinput_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Input::Complete::NoInput
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The input event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid noinput input event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_input_nomatch_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Input::Complete::NoMatch
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The input event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid nomatch input event"
+  end
+end

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

@@ -0,0 +1,56 @@
+RSpec::Matchers.define :be_a_valid_joined_event do
+  chain :with_other_call_id do |other_call_id|
+    @other_call_id = other_call_id
+  end
+
+  chain :with_mixer_id do |mixer_id|
+    @mixer_id = mixer_id
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Joined do
+      @error = "The other call ID was not correct. Expected '#{@other_call_id}', got '#{event.other_call_id}'" if @other_call_id && event.other_call_id != @other_call_id
+      @error = "The mixer ID was not correct. Expected '#{@mixer_id}', got '#{event.mixer_id}'" if @mixer_id && event.mixer_id != @mixer_id
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The joined event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid joined event".tap do |d|
+      d << " with other call ID '#{@other_call_id}'" if @other_call_id
+      d << " with mixer ID '#{@mixer_id}'" if @mixer_id
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_unjoined_event do
+  chain :with_other_call_id do |other_call_id|
+    @other_call_id = other_call_id
+  end
+
+  chain :with_mixer_id do |mixer_id|
+    @mixer_id = mixer_id
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Unjoined do
+      @error = "The other call ID was not correct. Expected '#{@other_call_id}', got '#{event.other_call_id}'" if @other_call_id && event.other_call_id != @other_call_id
+      @error = "The mixer ID was not correct. Expected '#{@mixer_id}', got '#{event.mixer_id}'" if @mixer_id && event.mixer_id != @mixer_id
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The unjoined event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid unjoined event".tap do |d|
+      d << " with other call ID '#{@other_call_id}'" if @other_call_id
+      d << " with mixer ID '#{@mixer_id}'" if @mixer_id
+    end
+  end
+end
+

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

@@ -0,0 +1,15 @@
+RSpec::Matchers.define :be_a_valid_output_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Output::Complete::Success
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The output event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid successful output event"
+  end
+end

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

@@ -0,0 +1,32 @@
+RSpec::Matchers.define :be_a_valid_complete_recording_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.recording, Punchblock::Component::Record::Recording
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The recording event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid complete recording event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_stopped_recording_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Event::Complete::Stop
+      match_type event.recording, Punchblock::Component::Record::Recording
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The recording event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid stopped recording event"
+  end
+end

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

@@ -0,0 +1,15 @@
+RSpec::Matchers.define :be_a_valid_say_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Say::Complete::Success
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The say event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid successful say event"
+  end
+end

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

@@ -0,0 +1,31 @@
+RSpec::Matchers.define :be_a_valid_transfer_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Transfer::Complete::Success
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The transfer event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid transfer event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_transfer_timeout_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Component::Tropo::Transfer::Complete::Timeout
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The transfer event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid transfer timeout event"
+  end
+end

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

@@ -0,0 +1,138 @@
+require 'rspec/expectations'
+
+def execution_expired?(event)
+  if event == "execution expired"
+    @error = 'event was not delivered to queue before read timeout'
+    raise RSpec::Expectations::ExpectationNotMetError
+  end
+end
+
+def uuid_match?(uuid, type)
+  if uuid.match(/\A[\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}/).nil?
+    @error = "#{type} == #{uuid} - expected a GUID"
+    raise RSpec::Expectations::ExpectationNotMetError
+  end
+end
+
+def match_type(object, type)
+  unless object.is_a?(type)
+    @error = "expected reason to be #{type}, got #{object}"
+    raise RSpec::Expectations::ExpectationNotMetError
+  end
+end
+
+def basic_validation(object, klass, validate_component_id = false)
+  execution_expired? object
+
+  match_type object, klass
+
+  uuid_match? object.call_id, 'call_id'
+  uuid_match? object.component_id, 'cmd_id' if validate_component_id
+
+  yield if block_given?
+
+  object unless @error
+end
+
+%w{
+  ask
+  call_control
+  conference
+  dtmf
+  input
+  join
+  output
+  recording
+  say
+  transfer
+}.each { |matcher| require "rspec-rayo/rayo/matchers/#{matcher}" }
+
+RSpec::Matchers.define :have_executed_correctly do
+  match_for_should do |command|
+    basic_validation command, Punchblock::CommandNode do
+      unless command.executing?
+        @error = "expected status to be #{:executing.inspect}, got #{command.state_name}"
+        raise RSpec::Expectations::ExpectationNotMetError
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The command failed to execute: #{@error}"
+  end
+
+  description do
+    "execute correctly"
+  end
+end
+
+RSpec::Matchers.define :have_dialed_correctly do
+  match_for_should do |call|
+    basic_validation call, RSpecRayo::Call do
+      call.ring_event.should be_a_valid_ringing_event
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The command failed to execute: #{@error}"
+  end
+
+  description do
+    "execute correctly"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_complete_hangup_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Event::Complete::Hangup
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The complete hangup event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid complete hangup event"
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_complete_error_event do
+  chain :with_message do |message|
+    @message = message
+  end
+
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Event::Complete::Error
+      @error = "The error message was not correct. Expected '#{@message}', got '#{event.reason.details}'" if @message && event.reason.details != @message
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The complete error event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid complete error event".tap do |d|
+      d << " with message '#{@message}'" if @message
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_complete_stopped_event do
+  match_for_should do |event|
+    basic_validation event, Punchblock::Event::Complete, true do
+      match_type event.reason, Punchblock::Event::Complete::Stop
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "The stopped event was not valid: #{@error}"
+  end
+
+  description do
+    "be a valid stopped event"
+  end
+end

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

@@ -0,0 +1,51 @@
+module RSpecRayo
+  class Tropo1Driver
+    require 'drb'
+    require 'net/http'
+    require 'uri'
+    require 'countdownlatch'
+
+    attr_accessor :script_content, :result, :drb, :config
+
+    def initialize(uri = nil, latch_timeout = 5)
+      @uri            = uri || "druby://0.0.0.0:8787"
+      @latch_timeout  = latch_timeout
+      @config         = {}
+      reset!
+    end
+
+    def start_drb
+      @drb = DRb.start_service @uri, self
+    end
+
+    def stop_drb
+      @drb.stop_service
+    end
+
+    def reset!
+      @script_content = nil
+      @result = nil
+      @latches = {}
+    end
+
+    def trigger(latch_name)
+      latch = @latches[latch_name]
+      raise RuntimeError, "No latch by that name" unless latch
+      latch.countdown!
+    end
+
+    def add_latch(latch_name, count = 1)
+      @latches[latch_name] = CountDownLatch.new count
+    end
+
+    def wait(latch_name)
+      latch = @latches[latch_name]
+      raise RuntimeError, "No latch by that name" unless latch
+      latch.wait @latch_timeout
+    end
+
+    def place_call(session_url)
+      Net::HTTP.get URI.parse(session_url)
+    end
+  end
+end

data/lib/rspec-rayo/version.rb

@@ -0,0 +1,3 @@
+module RSpecRayo
+  VERSION = "0.1.14"
+end

data/lib/rspec-rayo.rb

@@ -0,0 +1,7 @@
+%w{
+  rspec-rayo/tropo1/driver
+
+  rspec-rayo/rayo/driver
+  rspec-rayo/rayo/call
+  rspec-rayo/rayo/matchers
+}.each { |lib| require lib }

data/rspec-rayo.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rspec-rayo/version"
+
+Gem::Specification.new do |s|
+  s.name        = %q{rspec-rayo}
+  s.version     = RSpecRayo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ["MIT"]
+  s.authors     = ["Jason Goecke", "Ben Langfeld"]
+  s.email       = %q{jsgoecke@voxeo.com, ben@langfeld.me}
+  s.homepage    = %q{http://github.com/tropo/rspec-rayo}
+  s.summary     = %q{Rspec2 for Rayo}
+  s.description = %q{Rspec2 Matchers for Rayo}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency %q<rspec>, [">= 2.6.0"]
+  s.add_dependency %q<punchblock>, [">= 0.4.0"]
+  s.add_dependency %q<countdownlatch>, [">= 1.0.0"]
+  s.add_dependency %q<future-resource>, [">= 0.0.2"]
+
+  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
+  s.add_development_dependency %q<rcov>, [">= 0"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
+end

data/spec/rspec-rayo/rayo/matchers/ask_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe "Rayo Ask matchers" do
+  describe "an ask complete event" do
+    subject do
+      Punchblock::Event::Complete.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+        event << reason
+      end
+    end
+
+    describe "that's successful" do
+      let :reason do
+        Punchblock::Component::Tropo::Ask::Complete::Success.new.tap do |success|
+          success << '<utterance>blah</utterance>'
+          success << '<interpretation>blah</interpretation>'
+        end
+      end
+
+      it { should be_a_valid_successful_ask_event }
+      it { should be_a_valid_successful_ask_event.with_utterance('blah') }
+      it { should_not be_a_valid_successful_ask_event.with_utterance('woo') }
+      it { should be_a_valid_successful_ask_event.with_interpretation('blah') }
+      it { should_not be_a_valid_successful_ask_event.with_interpretation('woo') }
+    end
+
+    describe "that stopped" do
+      let(:reason) { Punchblock::Event::Complete::Stop.new }
+      it { should be_a_valid_complete_stopped_event }
+    end
+
+    describe "that got no input" do
+      let(:reason) { Punchblock::Component::Tropo::Ask::Complete::NoInput.new }
+      it { should be_a_valid_ask_noinput_event }
+    end
+
+    describe "that got no match" do
+      let(:reason) { Punchblock::Component::Tropo::Ask::Complete::NoMatch.new }
+      it { should be_a_valid_ask_nomatch_event }
+    end
+  end
+end

data/spec/rspec-rayo/rayo/matchers/call_control_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe "Rayo call control matchers" do
+  describe "a call event" do
+    let(:headers) do
+      {
+        :content_type   => "application/sdp",
+        :contact        => "<sip:10.0.1.11:5060;transport=udp>",
+        :cseq           => "1 INVITE",
+        :max_forwards   => "70",
+        :to             => "sip:usera@10.0.1.11",
+        :call_id        => "1bu9qwbcz2cum",
+        :content_length => "444",
+        :from           => "<sip:Tropo@10.6.69.201>;tag=1unfb1cousd2z",
+        :via            => "SIP/2.0/UDP 10.0.1.11:5060;branch=z9hG4bK10psx2ki47qe5;rport=5060",
+        :x_vdirect      => "true"
+      }
+    end
+
+    subject do
+      Punchblock::Event::Offer.new.tap do |offer|
+        offer.call_id = "8df3437f-285f-406e-9ba2-9d14af1b72c4"
+        offer.to = "sip:usera@10.0.1.11"
+        offer.headers = headers
+      end
+    end
+
+    it { should be_a_valid_offer_event }
+  end
+
+  describe "an answered event" do
+    subject do
+      Punchblock::Event::Answered.new.tap do |event|
+        event.call_id = "3b7720bf-d5dc-4f4f-a837-d7338ec18b3a@10.0.1.11"
+      end
+    end
+
+    it { should be_a_valid_answered_event }
+  end
+
+  describe "a hangup event" do
+    subject do
+      Punchblock::Event::End.new.tap do |end_event|
+        end_event.call_id = "3b7720bf-d5dc-4f4f-a837-d7338ec18b3a@10.0.1.11"
+        end_event << Punchblock::RayoNode.new('hangup')
+      end
+    end
+
+    it { should be_a_valid_hangup_event }
+  end
+
+  describe "a ringing event" do
+    subject do
+      Punchblock::Event::Ringing.new.tap do |event|
+        event.call_id = "3b7720bf-d5dc-4f4f-a837-d7338ec18b3a@10.0.1.11"
+      end
+    end
+
+    it { should be_a_valid_ringing_event }
+  end
+
+  describe "a redirect event" do
+    subject do
+      Punchblock::Event::End.new.tap do |end_event|
+        end_event.call_id = "3b7720bf-d5dc-4f4f-a837-d7338ec18b3a@10.0.1.11"
+        end_event << Punchblock::RayoNode.new('redirect')
+      end
+    end
+
+    it { should be_a_valid_redirect_event }
+  end
+
+  describe "a reject event" do
+    subject do
+      Punchblock::Event::End.new.tap do |end_event|
+        end_event.call_id = "3b7720bf-d5dc-4f4f-a837-d7338ec18b3a@10.0.1.11"
+        end_event << Punchblock::RayoNode.new('reject')
+      end
+    end
+
+    it { should be_a_valid_reject_event }
+  end
+end

data/spec/rspec-rayo/rayo/matchers/conference_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "Rayo Conference matchers" do
+  describe "a conference event" do
+    subject do
+      Punchblock::Component::Tropo::Conference::OffHold.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+      end
+    end
+
+    it { should be_a_valid_conference_offhold_event }
+  end
+
+  describe "a speaking event" do
+    subject do
+      Punchblock::Component::Tropo::Conference::Speaking.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+        event.write_attr :'call-id', 'abc123'
+      end
+    end
+
+    it { should be_a_valid_speaking_event }
+    it { should be_a_valid_speaking_event.for_call_id('abc123') }
+    it { should_not be_a_valid_speaking_event.for_call_id('123abc') }
+  end
+
+  describe "a finished-speaking event" do
+    subject do
+      Punchblock::Component::Tropo::Conference::FinishedSpeaking.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+        event.write_attr :'call-id', 'abc123'
+      end
+    end
+
+    it { should be_a_valid_finished_speaking_event }
+    it { should be_a_valid_finished_speaking_event.for_call_id('abc123') }
+    it { should_not be_a_valid_finished_speaking_event.for_call_id('123abc') }
+  end
+
+  describe "a conference complete terminator event" do
+    subject do
+      Punchblock::Event::Complete.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+        event << Punchblock::Component::Tropo::Conference::Complete::Terminator.new
+      end
+    end
+
+    it { should be_a_valid_conference_complete_terminator_event }
+  end
+end

data/spec/rspec-rayo/rayo/matchers/dtmf_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "Rayo DTMF matchers" do
+  describe "a DTMF event" do
+    subject do
+      Punchblock::Event::DTMF.new.tap do |dtmf_event|
+        dtmf_event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        dtmf_event.signal = 3
+      end
+    end
+
+    it { should be_a_valid_dtmf_event }
+    it { should be_a_valid_dtmf_event.with_signal('3') }
+    it { should_not be_a_valid_dtmf_event.with_signal('5') }
+  end
+end

data/spec/rspec-rayo/rayo/matchers/input_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe "Rayo Input matchers" do
+  describe "an input complete event" do
+    subject do
+      Punchblock::Event::Complete.new.tap do |event|
+        event.call_id = '5d6fe904-103d-4551-bd47-cf212c37b8c7'
+        event.component_id = '6d5bf745-8fa9-4e78-be18-6e6a48393f13'
+        event << reason
+      end
+    end
+
+    describe "that's successful" do
+      let :reason do
+        Punchblock::Component::Input::Complete::Success.new.tap do |success|
+          success << '<utterance>blah</utterance>'
+          success << '<interpretation>blah</interpretation>'
+        end
+      end
+
+      it { should be_a_valid_successful_input_event }
+      it { should be_a_valid_successful_input_event.with_utterance('blah') }
+      it { should_not be_a_valid_successful_input_event.with_utterance('woo') }
+      it { should be_a_valid_successful_input_event.with_interpretation('blah') }
+      it { should_not be_a_valid_successful_input_event.with_interpretation('woo') }
+    end
+
+    describe "that stopped" do
+      let(:reason) { Punchblock::Event::Complete::Stop.new }
+      it { should be_a_valid_complete_stopped_event }
+    end
+
+    describe "that got no input" do
+      let(:reason) { Punchblock::Component::Input::Complete::NoInput.new }
+      it { should be_a_valid_input_noinput_event }
+    end
+
+    describe "that got no match" do
+      let(:reason) { Punchblock::Component::Input::Complete::NoMatch.new }
+      it { should be_a_valid_input_nomatch_event }
+    end
+  end
+end