cucumber-voip 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log/*.log

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# develop
+
+# [v0.1.0](https://github.com/benlangfeld/cucumber-voip/compare/f34e659a9ee5ecbb739aafc88f8e760260366b10...v0.1.0) - [2012-03-14](https://rubygems.org/gems/cucumber-voip/versions/0.1.0)
+* First public release

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cucumber-voip.gemspec
+gemspec
+
+if RUBY_PLATFORM =~ /darwin/
+  gem 'growl_notify'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ben Langfeld
+
+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,62 @@
+cucumber-voip
+===========
+
+Automated functional testing of voice applications is typically difficult and expensive. Not so when we can specify our systems using Cucumber. cucumber-voip provides a powerful set of features based on Punchblock and rspec-rayo which allow you, using the Rayo protocol, to drive a voice application using plain English Cucumber scenarios as if you're the end user.
+
+Features
+--------
+
+* Rayo connection manager and Cucumber step definitions for common functional testing scenarios
+
+Requirements
+------------
+
+* A Rayo server, eg rayo-server on Voxeo PRISM
+
+Install
+-------
+
+    gem install cucumber-voip FIXME (gem install, anything else)
+
+Examples
+--------
+
+See the features/ directory
+
+Author
+------
+
+Original author: Ben Langfeld
+
+Links
+-----
+* [Source](https://github.com/benlangfeld/cucumber-voip)
+* [Documentation](http://rdoc.info/github/benlangfeld/cucumber-voip/master/frames)
+* [Bug Tracker](https://github.com/benlangfeld/cucumber-voip/issues)
+
+TODO
+----
+
+There is a huge list of things that need to be done in order for this project to be more useful:
+
+* A whole bunch more step definitions need to be added
+* Generators should be provided for in-app and standalone usage
+* A boat-load of documentation is required on the following topics:
+  * How to setup cucumber-voip in your application or stand-alone
+  * How to write features
+  * How to write extra step definitions
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2011 Ben Langfeld. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--tags ~@jruby} unless defined?(JRUBY_VERSION)
+end
+
+Cucumber::Rake::Task.new(:wip) do |t|
+  t.cucumber_opts = %w{-p wip}
+end
+
+task :default => :cucumber

data/cucumber-voip.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cucumber-voip/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cucumber-voip"
+  s.version     = CucumberVoIP::VERSION
+  s.authors     = ["Ben Langfeld"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = "https://github.com/benlangfeld/cucumber-voip"
+  s.summary     = %q{Plain-english functional testing of voice systems}
+  s.description = %q{Automated functional testing of voice applications is typically difficult and expensive. Not so when we can specify our systems using Cucumber.}
+
+  s.rubyforge_project = "cucumber-voip"
+
+  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_runtime_dependency 'cucumber', '>= 1.0.2'
+  s.add_runtime_dependency 'activesupport', '>= 3.0.10'
+  s.add_runtime_dependency 'rspec-rayo', '>= 0.3.0'
+
+  s.add_development_dependency 'bundler', '>= 1.0.0'
+  s.add_development_dependency 'yard', '>= 0.6.0'
+  s.add_development_dependency 'rake', '>= 0'
+  s.add_development_dependency 'guard-cucumber'
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --tags ~@wip
+wip: --wip --tags @wip

data/features/outbound_calls.feature

@@ -0,0 +1,28 @@
+Feature: Outbound calls
+  As an awesome Ruby telephony developer
+  In order to check the most basic operation of my application
+  I want to be able to make outbound calls and perform assertions on their progress
+
+  Scenario: Making a call which is accepted and then hung up
+    Given an app which does:
+      """
+      accept
+      hangup
+      """
+    And a caller ID of 'sip:ben@langfeld.me'
+    When I dial 'sip:usera@127.0.0.1'
+    Then the call should ring
+    And the call should be rejected
+
+  Scenario: Making a call which is accepted, answered and then hung up
+    Given an app which does:
+      """
+      accept
+      answer
+      hangup
+      """
+    And my standard caller ID
+    When I dial my app
+    Then the call should ring
+    And the call should be answered
+    And the call should be hung up

data/features/speaking.feature

@@ -0,0 +1,34 @@
+Feature: Speaking
+  As an awesome Ruby telephony developer
+  In order to imitate a human being during testing
+  I want to be able to use a TTS engine to speak to my app
+
+  Scenario: Saying hello
+    Given an app which does:
+      """
+      accept
+      answer
+      sleep 1
+      hangup
+      """
+    And my standard caller ID
+    When I dial my app
+    Then the call should ring
+    And the call should be answered
+    When I say 'hello world'
+    Then the call should be hung up
+
+  Scenario: Playing DTMF
+    Given an app which does:
+      """
+      accept
+      answer
+      sleep 0.5
+      hangup
+      """
+    And my standard caller ID
+    When I dial my app
+    Then the call should ring
+    And the call should be answered
+    When I press '5'
+    Then the call should be hung up

data/features/step_definitions.rb

@@ -0,0 +1,3 @@
+Given /^an app which does:$/ do |script|
+  RayoDriver.target_instance.script = script
+end

data/features/support/env.rb

@@ -0,0 +1,48 @@
+require 'cucumber-voip/cucumber'
+
+include CucumberVoIP
+
+RayoDriver.options =  {
+                        :standard_caller_id   => 'sip:ben@langfeld.me',
+                        :standard_dial_target => 'sip:usera@127.0.0.1',
+                        # :jid                => 'userb@127.0.0.1',
+                        # :password           => '1',
+                        # :queue_timeout      => 30,
+                        # :write_timeout      => 30,
+                        # :log_file           => 'log/cucumber_voip.log'
+                      }
+
+class RayoDriver
+  attr_accessor :script
+
+  class << self
+    def target_instance
+      @@target_instance ||= new
+    end
+  end
+end
+
+RayoDriver.target_instance.instance_exec do
+  self.options =  {
+                    :jid                => 'usera@127.0.0.1',
+                    # :password           => '1',
+                    # :queue_timeout      => 30,
+                    # :write_timeout      => 30,
+                  }
+
+  start
+
+  Thread.new do
+    while (call = @rayo.call_queue.pop)
+      begin
+        call.instance_eval script
+      rescue => e
+        puts "Exception in the call target script:"
+        puts e.message
+        puts e.backtrace.join("\n")
+      end
+    end
+  end
+end
+
+RayoDriver.start

data/lib/cucumber-voip.rb

@@ -0,0 +1,5 @@
+require "cucumber-voip/version"
+
+module CucumberVoIP
+  # Your code goes here...
+end

data/lib/cucumber-voip/api.rb

@@ -0,0 +1,31 @@
+module CucumberVoIP
+  module API
+    def start_rayo_driver
+      RayoDriver.start
+    end
+
+    def cleanup_calls
+      RayoDriver.cleanup_calls
+    end
+
+    def standard_caller_id
+      RayoDriver.options[:standard_caller_id]
+    end
+
+    def standard_dial_target
+      RayoDriver.options[:standard_dial_target]
+    end
+
+    def dial(options = {})
+      RayoDriver.dial options
+    end
+
+    def audio_ssml(url)
+      "<audio src='#{url}' />"
+    end
+
+    def dtmf_ssml(digit)
+      audio_ssml "dtmf:#{digit}"
+    end
+  end
+end

data/lib/cucumber-voip/core_ext/punchblock/component/component_node.rb

@@ -0,0 +1,19 @@
+module Punchblock
+  module Component
+    class ComponentNode
+      attr_accessor :event_queue
+
+      def initialize(*args)
+        super
+        @event_queue = Queue.new
+        register_event_handler do |event|
+          @event_queue << event
+        end
+      end
+
+      def next_event(timeout = nil)
+        Timeout::timeout(timeout) { event_queue.pop }
+      end
+    end
+  end
+end

data/lib/cucumber-voip/cucumber.rb

@@ -0,0 +1,8 @@
+%w{
+  rayo_driver
+  api
+  hooks
+  step_definitions
+}.each { |f| require "cucumber-voip/#{f}" }
+
+World CucumberVoIP::API

data/lib/cucumber-voip/hooks.rb

@@ -0,0 +1,13 @@
+# TODO: Figure out how to do this before the suite, rather than before each scenario
+Before do
+  # begin
+  #   start_rayo_driver
+  # rescue => e
+  #   puts e.message
+  #   puts e.backtrace.join("\n")
+  # end
+end
+
+After do
+  cleanup_calls
+end

data/lib/cucumber-voip/rayo_driver.rb

@@ -0,0 +1,68 @@
+%w{
+  punchblock
+  rspec-rayo
+  active_support/core_ext/module/delegation
+
+  cucumber-voip/core_ext/punchblock/component/component_node
+}.each { |f| require f }
+
+module CucumberVoIP
+  class RayoDriver
+    attr_reader :options
+
+    delegate :cleanup_calls, :dial, :to => :@rayo
+
+    class << self
+      def tester_instance
+        @@tester_instance ||= new
+      end
+
+      def method_missing(method_name, *args, &block)
+        if tester_instance.respond_to? method_name
+          tester_instance.send method_name, *args, &block
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_name)
+        super || tester_instance.respond_to?(method_name)
+      end
+    end
+
+    def initialize
+      @options = {
+                    :jid            => 'userb@127.0.0.1',
+                    :password       => '1',
+                    :host           => '127.0.0.1',
+                    :queue_timeout  => 30,
+                    :write_timeout  => 30
+                  }
+    end
+
+    def options=(other)
+      options.merge! other
+    end
+
+    def start
+      raise StandardError, 'You cannot start the Rayo driver more than once!' if @rayo
+      @rayo = RSpecRayo::RayoDriver.new :username       => options[:jid],
+                                        :password       => options[:password],
+                                        :host           => options[:host],
+                                        :port           => options[:port],
+                                        :queue_timeout  => options[:queue_timeout],
+                                        :write_timeout  => options[:write_timeout]
+      begin
+        @rayo.wait_for_connection 10
+      rescue Timeout::Error
+        abort 'Could not connect to Rayo Server. Aborting!'
+      end
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new options[:log_file]
+    end
+  end
+end

data/lib/cucumber-voip/step_definitions.rb

@@ -0,0 +1,45 @@
+Given /^a caller ID of '([\w\d\s\.\:\@]+)'$/ do |caller_id|
+  @outbound_caller_id = caller_id
+end
+
+Given /^my standard caller ID$/ do
+  @outbound_caller_id = standard_caller_id
+end
+
+When /^I dial my app$/ do
+  @call = dial :from => @outbound_caller_id, :to => standard_dial_target
+end
+
+When /^I dial '([\w\d\s\.\:\@]+)'$/ do |target_address|
+  @call = dial :from => @outbound_caller_id, :to => target_address
+end
+
+Then /^the call should ring$/ do
+  @call.next_event.should be_a_valid_ringing_event
+end
+
+Then /^the call should be answered$/ do
+  @call.next_event.should be_a_valid_answered_event
+end
+
+Then /^the call should be hung up$/ do
+  @call.next_event.should be_a_valid_hangup_event
+end
+
+Then /^the call should be rejected$/ do
+  @call.next_event.should be_a_valid_reject_event
+end
+
+When /^I hang up$/ do
+  @call.hangup.should have_executed_correctly
+end
+
+When /^I say '([\w\s]+)'$/ do |phrase|
+  component = @call.say(:text => phrase).should have_executed_correctly
+  component.next_event.should be_a_valid_say_event
+end
+
+When /^I press '([\d\*\#])'$/ do |digit|
+  component = @call.output(:ssml => dtmf_ssml(digit)).should have_executed_correctly
+  component.next_event.should be_a_valid_output_event
+end

data/lib/cucumber-voip/version.rb

@@ -0,0 +1,3 @@
+module CucumberVoIP
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-voip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Langfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &2161551780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161551780
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2161551140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161551140
+- !ruby/object:Gem::Dependency
+  name: rspec-rayo
+  requirement: &2161549600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161549600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2161549060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2161549060
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2161548180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2161548180
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2161538500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161538500
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &2161537600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161537600
+description: Automated functional testing of voice applications is typically difficult
+  and expensive. Not so when we can specify our systems using Cucumber.
+email:
+- ben@langfeld.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cucumber-voip.gemspec
+- cucumber.yml
+- features/outbound_calls.feature
+- features/speaking.feature
+- features/step_definitions.rb
+- features/support/env.rb
+- lib/cucumber-voip.rb
+- lib/cucumber-voip/api.rb
+- lib/cucumber-voip/core_ext/punchblock/component/component_node.rb
+- lib/cucumber-voip/cucumber.rb
+- lib/cucumber-voip/hooks.rb
+- lib/cucumber-voip/rayo_driver.rb
+- lib/cucumber-voip/step_definitions.rb
+- lib/cucumber-voip/version.rb
+- log/.gitkeep
+homepage: https://github.com/benlangfeld/cucumber-voip
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -866167120225335433
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -866167120225335433
+requirements: []
+rubyforge_project: cucumber-voip
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Plain-english functional testing of voice systems
+test_files:
+- features/outbound_calls.feature
+- features/speaking.feature
+- features/step_definitions.rb
+- features/support/env.rb