librevox 0.2.1 → 0.3

data/spec/librevox/listener/spec_inbound.rb

@@ -1,5 +1,5 @@
-require 'spec/helper'
-require 'spec/librevox/listener'
+require './spec/helper'
+require './spec/librevox/listener'
 
 require 'librevox/listener/inbound'
 

data/spec/librevox/listener/spec_outbound.rb

@@ -1,11 +1,11 @@
-require 'spec/helper'
-require 'spec/librevox/listener'
+require './spec/helper'
+require './spec/librevox/listener'
 
 require 'librevox/listener/outbound'
 
 module Librevox::Applications
-  def sample_app(name, *args, &b)
-    execute_app name, args.join(" "), &b
+  def sample_app name, *args
+    application name, args.join(" ")
   end
 end
 
@@ -15,22 +15,28 @@ class OutboundTestListener < Librevox::Listener::Outbound
   end
 end
 
-def receive_event_and_linger_replies
-  @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK Events Enabled\n\n")
-  @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK will linger\n\n")
+def event_and_linger_replies
+  command_reply "Reply-Text" => "+OK Events Enabled"
+  command_reply "Reply-Text" => "+OK will linger"
 end
 
 describe "Outbound listener" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundTestListener.new(nil)
-    @listener.receive_data("Content-Type: command/reply\nCaller-Caller-ID-Number: 8675309\n\n")
-    receive_event_and_linger_replies
+    command_reply(
+      "Caller-Caller-Id-Number" => "8675309",
+      "Unique-ID"               => "1234",
+      "variable_some_var"       => "some value"
+    )
+    event_and_linger_replies
   end
 
   should "connect to freeswitch and subscribe to events" do
-    @listener.outgoing_data.shift.should.equal "connect\n\n"
-    @listener.outgoing_data.shift.should.equal "myevents\n\n"
-    @listener.outgoing_data.shift.should.equal "linger\n\n"
+    @listener.should send_command "connect"
+    @listener.should send_command "myevents"
+    @listener.should send_command "linger"
   end
 
   should "establish a session" do
@@ -38,111 +44,139 @@ describe "Outbound listener" do
   end
 
   should "call session callback after establishing new session" do
-    @listener.read_data.should.equal "session was initiated"
+    @listener.outgoing_data.pop.should == "session was initiated"
   end
 
-  should "make channel variables available through session" do
+  should "make headers available through session" do
     @listener.session[:caller_caller_id_number].should.equal "8675309"
   end
 
+  should "make channel variables available through #variable" do
+    @listener.variable(:some_var).should == "some value"
+  end
+
   behaves_like "events"
   behaves_like "api commands"
-
-  should "register app" do
-    @listener.respond_to?(:sample_app).should.be.true?
-  end
 end
 
 class OutboundListenerWithNestedApps < Librevox::Listener::Outbound
   def session_initiated
-    sample_app "foo" do
-      sample_app "bar"
-    end
+    sample_app "foo"
+    sample_app "bar"
   end
 end
 
 describe "Outbound listener with apps" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundListenerWithNestedApps.new(nil)
 
-    # Establish session and get rid of connect-string
-    @listener.receive_data("Content-Type: command/reply\nEstablish-Session: OK\n\n")
-    receive_event_and_linger_replies
+    command_reply "Establish-Session" => "OK",
+                  "Unique-ID"         => "1234"
+    event_and_linger_replies
     3.times {@listener.outgoing_data.shift}
   end
 
   should "only send one app at a time" do
-    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: foo\n\n"
-    @listener.read_data.should == nil
+    @listener.should send_application "foo"
+    @listener.should send_nothing
+
+    command_reply "Reply-Text" => "+OK"
+    @listener.should update_session
+    channel_data
 
-    @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK\n\n")
-    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: bar\n\n"
-    @listener.read_data.should == nil
+    @listener.should send_application "bar"
+    @listener.should send_nothing
   end
 
   should "not be driven forward by events" do
-    @listener.read_data # sample_app "foo"
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 45\n\nEvent-Name: CHANNEL_EXECUTE\nSession-Var: Some\n\n")
-    @listener.read_data.should == nil
+    @listener.should send_application "foo"
+
+    command_reply :body => {
+      "Event-Name"  => "CHANNEL_EXECUTE",
+      "Session-Var" => "Some"
+    }
+
+    @listener.should send_nothing
   end
 
   should "not be driven forward by api responses" do
-    @listener.read_data # sample_app "foo"
-    @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\nFoo")
-    @listener.read_data.should == nil
+    @listener.should send_application "foo"
+
+    api_response :body => "Foo"
+
+    @listener.should send_nothing
   end
 
   should "not be driven forward by disconnect notifications" do
-    @listener.read_data # sample_app "foo"
-    @listener.receive_data("Content-Type: text/disconnect-notice\nContent-Length: 9\n\nLingering")
-    @listener.read_data.should == nil
+    @listener.should send_application "foo"
+
+    response "Content-Type" => "text/disconnect-notice",
+             :body          => "Lingering"
+
+    @listener.should send_nothing
   end
 end
 
 module Librevox::Applications
-  def reader_app(&b)
-    execute_app 'reader_app', [], {:read_var => 'a_reader_var'}, &b
+  def reader_app
+    application 'reader_app', "", {:variable => 'app_var'}
   end
 end
 
 class OutboundListenerWithReader < Librevox::Listener::Outbound
   def session_initiated
-    reader_app do |data|
-      send_data "read this: #{data}"
-    end
+    data = reader_app
+    application "send", data
   end
 end
 
 describe "Outbound listener with app reading data" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundListenerWithReader.new(nil)
 
-    # Establish session and get rid of connect-string
-    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
-    receive_event_and_linger_replies
+    command_reply "Session-Var" => "First",
+                  "Unique-ID"   => "1234"
+    event_and_linger_replies
     3.times {@listener.outgoing_data.shift}
+
+    @listener.should send_application "reader_app"
   end
 
   should "not send anything while missing response" do
-    @listener.read_data # the command executing reader_app
-    @listener.read_data.should == nil
+    @listener.should send_nothing
   end
 
   should "send uuid_dump to get channel var, after getting response" do
-    @listener.receive_data("Content-Type: command/reply\nReply-Text: +OK\n\n")
-    @listener.read_data.should == "api uuid_dump 1234\n\n"
+    command_reply "Reply-Text" => "+OK"
+    @listener.should update_session 1234
   end
 
   should "update session with new data" do
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
-    @listener.receive_data("Content-Type: api/response\nContent-Length: 44\n\nEvent-Name: CHANNEL_DATA\nSession-Var: Second\n\n")
+    command_reply :body => "+OK"
+
+    @listener.should update_session 1234
+    api_response :body => {
+      "Event-Name"  => "CHANNEL_DATA",
+      "Session-Var" => "Second"
+    }
+
     @listener.session[:session_var].should == "Second"
   end
 
-  should "pass value of channel variable to block" do
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 59\n\nEvent-Name: CHANNEL_DATA\nvariable_a-reader-var: some value\n\n")
-    @listener.read_data.should == "read this: some value"
+  should "return value of channel variable" do
+    command_reply :body => "+OK"
+
+    @listener.should update_session 1234
+    api_response :body => {
+      "Event-Name"       => "CHANNEL_DATA",
+      "variable_app_var" => "Second"
+    }
+
+    @listener.should send_application "send", "Second"
   end
 end
 
@@ -150,99 +184,110 @@ class OutboundListenerWithNonNestedApps < Librevox::Listener::Outbound
   attr_reader :queue
   def session_initiated
     sample_app "foo"
-    reader_app do |data|
-      send_data "the end: #{data}"
-    end
+    data = reader_app
+    application "send", "the end: #{data}"
   end
 end
 
 describe "Outbound listener with non-nested apps" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundListenerWithNonNestedApps.new(nil)
 
-    # Establish session and get rid of connect-string
-    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
-    receive_event_and_linger_replies
+    command_reply "Session-Var" => "First",
+                  "Unique-ID"   => "1234"
+    event_and_linger_replies
     3.times {@listener.outgoing_data.shift}
   end
 
-  should "wait for response before calling next proc" do
-    # response to sample_app
-    @listener.read_data.should.not.match /the end/
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+  should "wait for response before calling next app" do
+    @listener.should send_application "foo"
+    command_reply :body => "+OK"
+    @listener.should update_session
+    channel_data "Unique-ID" => "1234"
 
-    # response to reader_app
-    @listener.read_data.should.not.match /the end/
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+    @listener.should send_application "reader_app"
+    command_reply :body => "+OK"
 
-    # response to uuid_dump caused by reader_app
-    @listener.read_data.should.not.match /the end/
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 59\n\nEvent-Name: CHANNEL_DATA\nvariable_a-reader-var: some value\n\n")
+    @listener.should update_session
+    api_response :body => {
+      "Event-Name"       => "CHANNEL_DATA",
+      "variable_app_var" => "Second"
+    }
 
-    @listener.read_data.should == "the end: some value"
+    @listener.should send_application "send", "the end: Second"
   end
 end
 
 module Librevox::Commands
-  def sample_cmd(cmd, *args, &b)
-    execute_cmd cmd, *args, &b
+  def sample_cmd cmd, *args
+    command cmd, *args
   end
 end
 
 class OutboundListenerWithAppsAndApi < Librevox::Listener::Outbound
   def session_initiated
-    sample_app "foo" do
-      api :sample_cmd, "bar" do
-        sample_app "baz"
-      end
-    end
+    sample_app "foo"
+    api.sample_cmd "bar"
+    sample_app "baz"
   end
 end
 
 describe "Outbound listener with both apps and api calls" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundListenerWithAppsAndApi.new(nil)
 
-    # Establish session and get rid of connect-string
-    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
-    receive_event_and_linger_replies
+    command_reply "Session-Var" => "First",
+                  "Unique-ID"   => "1234"
+    event_and_linger_replies
     3.times {@listener.outgoing_data.shift}
   end
 
-  should "wait for response before calling next proc" do
-    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: foo\n\n"
-    @listener.receive_data("Content-Type: command/reply\nContent-Length: 3\n\n+OK\n\n")
+  should "wait for response before calling next app/cmd" do
+    @listener.should send_application "foo"
+    command_reply :body => "+OK"
+    @listener.should update_session
+    channel_data
 
-    @listener.read_data.should == "api bar\n\n"
-    @listener.receive_data("Content-Type: api/response\nContent-Length: 3\n\n+OK\n\n")
+    @listener.should send_command "api bar"
+    api_response :body => "+OK"
 
-    @listener.read_data.should == "sendmsg\ncall-command: execute\nexecute-app-name: baz\n\n"
+    @listener.should send_application "baz"
   end
 end
 
 class OutboundListenerWithUpdateSessionCallback < Librevox::Listener::Outbound
   def session_initiated
-    update_session do
-      send_data "yay, #{session[:session_var]}"
-    end
+    update_session
+    application "send", "yay, #{session[:session_var]}"
   end
 end
 
 describe "Outbound listener with update session callback" do
+  extend Librevox::Test::Matchers
+
   before do
     @listener = OutboundListenerWithUpdateSessionCallback.new(nil)
-    @listener.receive_data("Content-Type: command/reply\nSession-Var: First\nUnique-ID: 1234\n\n")
-    receive_event_and_linger_replies
+    command_reply "Session-Var" => "First",
+                  "Unique-ID"   => "1234"
+    event_and_linger_replies
     3.times {@listener.outgoing_data.shift}
 
-    @listener.receive_data("Content-Type: api/response\nContent-Length: 44\n\nEvent-Name: CHANNEL_DATA\nSession-Var: Second\n\n")
+    @listener.should update_session
+    api_response :body => {
+      "Event-Name"  => "CHANNEL_DATA",
+      "Session-Var" => "Second"
+    }
   end
 
   should "execute callback" do
-    @listener.read_data.should =~ /^yay,/
+    @listener.outgoing_data.shift.should =~ /yay,/
   end
 
   should "update session before calling callback" do
-    @listener.read_data.should == "yay, Second"
+    @listener.should send_application "send", "yay, Second"
   end
 end

data/spec/librevox/spec_applications.rb

@@ -1,4 +1,4 @@
-require 'spec/helper'
+require './spec/helper'
 require 'librevox/applications'
 
 module AppTest
@@ -6,12 +6,11 @@ module AppTest
 
   extend self
 
-  def execute_app(name, args=[], params={}, &block)
+  def application name, args="", params={}
     {
       :name   => name,
       :args   => args,
-      :params => params,
-      :block  => block
+      :params => params
     }
   end
 end
@@ -129,7 +128,7 @@ describe Librevox::Applications do
       app = AppTest.play_and_get_digits "please-enter", "wrong-try-again"
       app[:name].should == "play_and_get_digits"
       app[:args].should == "1 2 3 5000 # please-enter wrong-try-again read_digits_var \\d+"
-      app[:params][:read_var].should == "read_digits_var"
+      app[:params][:variable].should == "read_digits_var"
     end
 
     should "take params" do
@@ -139,11 +138,11 @@ describe Librevox::Applications do
         :tries        => 4,
         :terminators  => "0",
         :timeout      => 10000,
-        :read_var     => "other_var",
+        :variable     => "other_var",
         :regexp       => "[125]"
 
       app[:args].should == "2 3 4 10000 0 please-enter invalid-choice other_var [125]"
-      app[:params][:read_var].should == "other_var"
+      app[:params][:variable].should == "other_var"
     end
   end
 
@@ -165,7 +164,7 @@ describe Librevox::Applications do
       app = AppTest.read "please-enter.wav"
       app[:name].should == "read"
       app[:args].should == "1 2 please-enter.wav read_digits_var 5000 #"
-      app[:params][:read_var].should == "read_digits_var"
+      app[:params][:variable].should == "read_digits_var"
     end
 
     should "take params" do
@@ -174,10 +173,10 @@ describe Librevox::Applications do
         :max          => 3,
         :terminators  => "0",
         :timeout      => 10000,
-        :read_var     => "other_var"
+        :variable     => "other_var"
 
       app[:args].should == "2 3 please-enter.wav other_var 10000 0"
-      app[:params][:read_var].should == "other_var"
+      app[:params][:variable].should == "other_var"
     end
   end
 
@@ -203,6 +202,12 @@ describe Librevox::Applications do
     end
   end
 
+  should "respond with code" do
+    app = AppTest.respond 403
+    app[:name].should == "respond"
+    app[:args].should == "403"
+  end
+
   should "set" do
     app = AppTest.set("foo", "bar")
     app[:name].should == "set"