freeswitcher 0.4.10 → 0.5.0

data/spec/fsr/cmd/channels.rb

@@ -0,0 +1,18 @@
+require 'spec/helper'
+require "fsr/cmd"
+FSR::Cmd.load_command("channels")
+
+describe "Testing FSR::Cmd::Channels" do
+  ## Channels ##
+  # Interface to channels
+  it "FSR::Cmd::Channels should send show channels" do
+    sofia = FSR::Cmd::Channels.new(nil, false)
+    sofia.raw.should == "show channels"
+  end
+
+  it "FSR::Cmd::Channels should send show channels" do
+    sofia = FSR::Cmd::Channels.new(nil, true)
+    sofia.raw.should == "show distinct_channels"
+  end
+
+end

data/spec/fsr/cmd/enum.rb

@@ -0,0 +1,19 @@
+require 'spec/helper'
+require "fsr/cmd"
+FSR::Cmd.load_command("enum")
+
+describe "Testing FSR::Cmd::Enum" do
+  ## Enum  ##
+  # Interface to enum 
+  it "FSR::Cmd::Enum should send enum <did>" do
+    cmd = FSR::Cmd::Enum.new(nil, "13012221111")
+    cmd.raw.should == "enum 13012221111"
+  end
+
+  it "FSR::Cmd::Enum should return nil if response is 'No Match!'" do
+    cmd = FSR::Cmd::Enum.new(nil, "13012221111")
+    response={"Content-Type"=>"api/response", "Content-Length"=>"366", "body"=>"Offered Routes:\nOrder\tPref\tService   \tRoute\n==============================================================================\n5\t10\tE2U+h323  \topal/h323:+13012221111@128.121.41.89:1720\n\nSupported Routes:\nOrder\tPref\tService   \tRoute\n==============================================================================\n5\t10\tE2U+h323  \topal/h323:+13012221111@128.121.41.89:1720"}
+    cmd.parse(response).route == "opal/h323:+13012221111@128.121.41.89:1720"
+  end
+
+end

data/spec/fsr/file_methods.rb

@@ -0,0 +1,36 @@
+require "spec/helper"
+require "fsr/file_methods"
+
+describe "Basic FSR::App::FileMethods module" do
+
+  before do
+    @testee = Class.new do
+      include ::FSR::App::FileMethods
+    end.new
+    
+  end
+
+  it "should have a test_files method" do
+    @testee.test_files("bla").should.equal true
+  end
+
+  it "should only test files with an absolute path" do
+    lambda { @testee.test_files("/path/file") }.
+      should.raise(Errno::ENOENT)
+  end
+
+  it "should handle multiple files" do
+    @testee.test_files("bla.wav", "fasel.wav").should.equal true
+  end
+
+  it "should handle mixed absolute and relative files" do
+    lambda { @testee.test_files("some_file.wav", "/path/file") }.
+      should.raise(Errno::ENOENT)
+  end
+
+  it "should not raise if file is present" do
+    file_name = File.expand_path(__FILE__)
+    lambda { @testee.test_files(file_name) }.
+      should.not.raise
+  end
+end

data/spec/fsr/listener/inbound.rb

@@ -67,24 +67,24 @@ EM.describe InboundListener do
   end
 
   should "be able to receive an event and call the on_event callback method" do
-    @listener.receive_data("Content-Length: 22\n\nEvent-Name: test_event\n\n")
+    @listener.receive_data("Content-Length: 22\nContent-Type: text/event-plain\n\nEvent-Name: test_event\n\n")
     @listener.recvd_event.first.content[:event_name].should.equal "test_event"
     done
   end
 
   should "be able to add custom event hooks on instances in the pre_session (before_session)" do
-    @listener.receive_data("Content-Length: 18\n\nEvent-Name: CUSTOM\n\n")
+    @listener.receive_data("Content-Length: 18\nContent-Type: text/event-plain\n\nEvent-Name: CUSTOM\n\n")
     @listener.custom_event.should.not.be.nil
     @listener.custom_event.content[:event_name].should == "CUSTOM"
     @listener.custom_event.should.equal @listener.recvd_event.first
-    @listener2.receive_data("Content-Length: 22\n\nEvent-Name: TEST_EVENT\n\n")
+    @listener2.receive_data("Content-Length: 22\nContent-Type: text/event-plain\n\nEvent-Name: TEST_EVENT\n\n")
     @listener2.test_event.content[:event_name].should.equal "TEST_EVENT"
     done
   end
 
   should "be able to add custom event hooks with sub events" do
     listener = InboundListener3.new(1234, {:auth => 'SecretPassword'})
-    @listener.receive_data("Content-Length: 22\n\nEvent-Name: CUSTOM\n\n")
+    @listener.receive_data("Content-Length: 22\nContent-Type: text/event-plain\n\nEvent-Name: CUSTOM\n\n")
     @listener.custom_event.should.equal @listener.recvd_event.first
     done
   end
@@ -92,7 +92,7 @@ EM.describe InboundListener do
   should "be able to add custom event hooks on classes, before instantiation" do
     FSL::Inbound.add_event_hook(:HANGUP_EVENT) { |instance, event| instance.test_event = event }
     listener = InboundListener2.new(1234, {:auth => 'SecretPassword'})
-    listener.receive_data("Content-Length: 24\n\nEvent-Name: HANGUP_EVENT\n\n")
+    listener.receive_data("Content-Length: 24\nContent-Type: text/event-plain\n\nEvent-Name: HANGUP_EVENT\n\n")
     listener.test_event.content[:event_name].should.equal "HANGUP_EVENT"
     done
   end
@@ -100,7 +100,7 @@ EM.describe InboundListener do
   should "be able to add custom event hooks on classes, after instantiation" do
     listener = InboundListener2.new(1234, {:auth => 'SecretPassword'})
     FSL::Inbound.add_event_hook(:HANGUP_EVENT) { |instance, event| instance.test_event = event }
-    listener.receive_data("Content-Length: 24\n\nEvent-Name: HANGUP_EVENT\n\n")
+    listener.receive_data("Content-Length: 24\nContent-Type: text/event-plain\n\nEvent-Name: HANGUP_EVENT\n\n")
     listener.test_event.content[:event_name].should.equal "HANGUP_EVENT"
     done
   end

data/spec/fsr/loading.rb

@@ -16,7 +16,7 @@ describe "Testing FSR module loading methods" do
 
   # When you add commands  you must modify the expected cmds_loaded behavior
   it "Loads all commands" do
-    all_commands = [:uuid_dump, :originate, :sofia, :fsctl, :sofia_contact, :status, :calls] # If you add a command add it to this set
+    all_commands = [:uuid_dump, :originate, :sofia, :fsctl, :sofia_contact, :status, :calls, :call_center, :channels, :enum] # If you add a command add it to this set
     cmds_loaded = FSR.load_all_commands
     cmds_loaded.kind_of?(Array).should == true
     all_commands.each do |cmd|

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  version: 0.4.10
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -12,20 +17,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-22 00:00:00 -06:00
+date: 2010-11-20 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: &id001 |
+  type: :runtime
+  version_requirements: *id001
+description: &id002 |
   =========================================================
   FreeSWITCHeR
   Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry) 
@@ -84,27 +92,83 @@ description: &id001 |
   --------------------------------------------------------------------------
   
     #!/usr/bin/ruby
-    require 'pp'
     require 'fsr'
     require "fsr/listener/inbound"
   
-    # EXAMPLE 1 
-    # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example
-    FSL::Inbound.add_event_hook(:CHANNEL_CREATE) { FSR::Log.info "*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!" }
+    class MyEventListener < FSR::Listener::Inbound
+      def before_session
+        # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example
+        add_event(:CHANNEL_CREATE) { |e| p e }
   
-    # EXAMPLE 2
-    # Define a method to handle CHANNEL_HANGUP events.
-    def custom_channel_hangup_handler(event)
-      FSR::Log.info "*** [#{event.content[:unique_id]}] Channel hangup. The event:"
-      pp event
-    end
+        # This adds a hook on CHANNEL_HANGUP events with a callback method.
+        add_event(:CHANNEL_HANGUP) { |e| channel_hangup(e) }
+      end
+  
+      def channel_hangup(event)
+        p event
+      end
   
-    # This adds a hook for EXAMPLE 2
-    FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) { custom_channel_hangup_handler(event) }
+      def on_event(event)
+        # This gets called for _every_ event that's subscribed (through add_event)
+        p event
+      end
+    end
   
   
     # Start FSR Inbound Listener
-    FSR.start_ies!(FSL::Inbound, :host => "localhost", :port => 8021)
+    FSR.start_ies!(MyEventListener, :host => "localhost", :port => 8021)
+  
+  A More Advanced Example, Publishing Events To A Web Socket:
+  -----------------------------------------------------------
+  
+    class MyWebSocketClient < Struct.new(:reporter, :socket, :channel_id)
+      Channel = EM::Channel.new
+  
+      def initialize(reporter, socket)
+        self.reporter, self.socket = reporter, socket
+        socket.onopen(&method(:on_open))
+        socket.onmessage(&method(:on_message))
+        socket.onclose(&method(:on_close))
+      end
+  
+      def on_message(json)
+        msg = JSON.parse(json)
+        FSR::Log.info "Websocket got #{msg}"
+      end
+  
+      def send(msg)
+        socket.send(msg.to_json)
+      end
+  
+      def on_open
+        FSR::Log.info("Subscribed listener")
+        self.channel_id = Channel.subscribe { |message| send(message) }
+      end
+  
+      def on_close
+        Channel.unsubscribe(channel_id)
+        FSR::Log.info("Unsubscribed listener")
+      end
+    end
+  
+    # Add the Channel to your event listener
+    class MyEventListener
+      def on_event(event)
+        MyWebSocketClient::Channel << event.content
+      end
+    end
+  
+    # Start Listener within and EM.run
+    EM.epoll
+    EM.run do
+      server, port = '127.0.0.1', 8021
+      EventMachine.connect(server, port, MyEventListener, auth: 'MyPassword') do |listener|
+        FSR::Log.info "MyEventListener connected to #{server} on #{port}"
+        EventMachine.start_server('0.0.0.0'), 8080, EventSocket::WebSocket::Connection, {}) do |websocket|
+          MyWebSocketClient.new(reporter, websocket)
+        end
+      end
+    end
   
   
   An Inbound Event Socket Listener example using the on_event callback method instead of hooks:
@@ -169,6 +233,7 @@ files:
 - examples/inbound_event_socket.rb
 - examples/inbound_socket_events.rb
 - examples/outbound_event_socket.rb
+- examples/play_and_get_digits.rb
 - freeswitcher.gemspec
 - lib/fsr.rb
 - lib/fsr/app.rb
@@ -193,7 +258,10 @@ files:
 - lib/fsr/app/uuid_getvar.rb
 - lib/fsr/app/uuid_setvar.rb
 - lib/fsr/cmd.rb
+- lib/fsr/cmd/call_center.rb
 - lib/fsr/cmd/calls.rb
+- lib/fsr/cmd/channels.rb
+- lib/fsr/cmd/enum.rb
 - lib/fsr/cmd/fsctl.rb
 - lib/fsr/cmd/originate.rb
 - lib/fsr/cmd/sofia.rb
@@ -211,14 +279,22 @@ files:
 - lib/fsr/database/voicemail_default.rb
 - lib/fsr/event_socket.rb
 - lib/fsr/fake_socket.rb
+- lib/fsr/file_methods.rb
 - lib/fsr/listener.rb
 - lib/fsr/listener/header_and_content_response.rb
 - lib/fsr/listener/inbound.rb
 - lib/fsr/listener/inbound/event.rb
 - lib/fsr/listener/mock.rb
 - lib/fsr/listener/outbound.rb
+- lib/fsr/model.rb
+- lib/fsr/model/agent.rb
 - lib/fsr/model/call.rb
+- lib/fsr/model/channel.rb
+- lib/fsr/model/enum.rb
+- lib/fsr/model/queue.rb
+- lib/fsr/model/tier.rb
 - lib/fsr/version.rb
+- lib/rack/middleware.rb
 - tasks/authors.rake
 - tasks/bacon.rake
 - tasks/changelog.rake
@@ -233,31 +309,66 @@ files:
 - tasks/yard.rake
 - spec/helper.rb
 - spec/fsr_listener_helper.rb
+- spec/fsr/app.rb
+- spec/fsr/app/answer.rb
+- spec/fsr/app/bind_meta_app.rb
+- spec/fsr/app/bridge.rb
+- spec/fsr/app/conference.rb
+- spec/fsr/app/execute_app.rb
+- spec/fsr/app/fifo.rb
+- spec/fsr/app/fs_break.rb
+- spec/fsr/app/fs_sleep.rb
+- spec/fsr/app/hangup.rb
+- spec/fsr/app/limit.rb
+- spec/fsr/app/log.rb
+- spec/fsr/app/play_and_get_digits.rb
+- spec/fsr/app/playback.rb
+- spec/fsr/app/set.rb
+- spec/fsr/app/transfer.rb
+- spec/fsr/cmd.rb
+- spec/fsr/cmd/call_center.rb
+- spec/fsr/cmd/calls.rb
+- spec/fsr/cmd/channels.rb
+- spec/fsr/cmd/enum.rb
+- spec/fsr/cmd/originate.rb
+- spec/fsr/cmd/sofia.rb
+- spec/fsr/cmd/sofia/profile.rb
+- spec/fsr/cmd/uuid_dump.rb
+- spec/fsr/file_methods.rb
+- spec/fsr/listener.rb
+- spec/fsr/listener/header_and_content_response.rb
+- spec/fsr/listener/inbound.rb
+- spec/fsr/listener/outbound.rb
+- spec/fsr/loading.rb
 has_rdoc: true
 homepage: http://code.rubyists.com/projects/fs
 licenses: []
 
-post_install_message: *id001
+post_install_message: *id002
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: freeswitcher
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform
@@ -279,11 +390,15 @@ test_files:
 - spec/fsr/app/set.rb
 - spec/fsr/app/transfer.rb
 - spec/fsr/cmd.rb
+- spec/fsr/cmd/call_center.rb
 - spec/fsr/cmd/calls.rb
+- spec/fsr/cmd/channels.rb
+- spec/fsr/cmd/enum.rb
 - spec/fsr/cmd/originate.rb
 - spec/fsr/cmd/sofia.rb
 - spec/fsr/cmd/sofia/profile.rb
 - spec/fsr/cmd/uuid_dump.rb
+- spec/fsr/file_methods.rb
 - spec/fsr/listener.rb
 - spec/fsr/listener/header_and_content_response.rb
 - spec/fsr/listener/inbound.rb