Full test coverage and API documentation

.travis.yml

@@ -9,6 +9,7 @@ matrix:
   allow_failures:
     - rvm: 2.0.0
     - rvm: jruby-19mode
+    - rvm: rbx-19mode
     - rvm: ruby-head
 notifications:
   irc: "irc.freenode.org#adhearsion"

README.markdown

@@ -161,7 +161,7 @@ Each command below can take [SIPp attributes](http://sipp.sourceforge.net/doc/re
 
 Don't want your scenario to end up in the same directory as your script? Need the filename to be different than the scenario name? No problem!
 
-For the `sippy_cup` YAML specification, use `scenario`:
+For the `sippy_cup` manifest, use `scenario`:
 
 ```YAML
 ---
@@ -171,17 +171,17 @@ scenario: /path/to/scenario.xml
 Or, in Ruby:
 
 ```Ruby
-my_opts = { source: '192.168.5.5:10001', destination: '10.10.0.3:19995', filename: '/path/to/somewhere' }
-s = SippyCup::Scenario.new 'SippyCup', my_opts do
+s = SippyCup::Scenario.new 'SippyCup', source: '192.168.5.5:10001', destination: '10.10.0.3:19995', filename: '/path/to/somewhere' do
   # scenario definitions here...
 end
+s.compile!
 ```
 
-This will create the files `somewhere.xml`, `somewhere.pcap`, and `somewhere.yml` in the `/path/to/` directory.
+This will create the files `somewhere.xml` and `somewhere.pcap` in the `/path/to/` directory.
 
 ### Customizing the Test Run
 
-Each parameter has an impact on the test, and may either be changed once the YAML file is generated or specified in the options hash for `SippyCup::Scenario.new`. In addition to the default parameters, some additional parameters can be set:
+Each parameter has an impact on the test, and may either be changed once the XML file is generated or specified in the options hash for `SippyCup::Scenario.new`. In addition to the default parameters, some additional parameters can be set:
 <dl>
   <dt>stats_file</dt>
   <dd>Path to a file where call statistics will be stored in a CSV format, defaults to not storing stats</dd>

bin/sippy_cup

@@ -6,7 +6,7 @@ require 'getoptlong'
 def usage
   puts "#{$0} [OPTS] </path/to/sippy_cup_definition.yml>"
   puts
-  puts "--compile, -c  Compile the given scenario YAML to XML and PCAP"
+  puts "--compile, -c  Compile the given scenario manifest to XML and PCAP"
   puts "--run, -r      Run the scenario. If used without -c, must supply a previously"
   puts "               compiled SippyCup file"
   puts "--help, -h     Print this usage information"

lib/sippy_cup/runner.rb

@@ -1,4 +1,3 @@
-require 'yaml'
 require 'logger'
 require 'active_support/core_ext/hash'