freec 0.2.6 → 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2914222ca5a7510ef0738b9d28eeb18fe5c41e03
+  data.tar.gz: 973b2970fb112031e662cf533f87e922a2e6fa60
+SHA512:
+  metadata.gz: 145213091d5bca8cb8f56211f3cb1539d90a3576f60ac6a5b7c5e8baffb6abf30cf62618c930f20dd4298f28670978c45772a889db0975d7da4276ced64c5287
+  data.tar.gz: a4d1df85b3f5083b3addb6227411fd45cd819b74b16bf3776f428e8671139f4e7beca0e4374961391c0e9cd3cf5b510151e0228c519f926afc100e1d2b27ae05

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+doc
+Manifest
+*gem
+.rspec_status

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    freec (0.2.7)
+      daemons (~> 1.2.4)
+      gserver (~> 0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    daemons (1.2.4)
+    diff-lcs (1.3)
+    gserver (0.0.1)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  freec!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.14.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jan Kubr
+
+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.rdoc

@@ -58,7 +58,7 @@ If you return nil or false from the step method, the call will be hungup.
 
 = Stinks?
 What Freec can do at the moment was enough for me to implement Telfa (http://telfapbx.com). If it doesn't fit your needs, you can:
-1. Complain to hi@jankubr.com .
+1. Complain to mail@jankubr.com .
 2. Fork it and change yourself.
 3. Check Liverpie (http://www.liverpie.com/) or Telegraph (http://code.google.com/p/telegraph/), Freec is inspired by them.
 4. Write yours :-)

data/Rakefile

@@ -1,42 +1,6 @@
-require 'rubygems'
-require 'rake'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-desc 'Clean up files.'
-task :clean do |t|
-  FileUtils.rm_rf "tmp"
-  FileUtils.rm_rf "pkg"
-end
+RSpec::Core::RakeTask.new(:spec)
 
-spec = Gem::Specification.new do |s| 
-  s.name              = "freec"
-  s.version           = '0.2.6'
-  s.author            = "Jan Kubr"
-  s.email             = "mail@jankubr.com"
-  s.homepage          = "http://github.com/jankubr/freec"
-  s.platform          = Gem::Platform::RUBY
-  s.summary           = "The layer between your Ruby voice app and FreeSWITCH."
-  s.files             = FileList["README*",
-                                 "Rakefile",
-                                 "{lib,spec}/**/*"].to_a
-  s.require_path      = "lib"
-  s.rubyforge_project = "freec"
-  s.has_rdoc          = false
-  s.extra_rdoc_files  = FileList["README*"].to_a
-  s.rdoc_options << '--line-numbers' << '--inline-source'
-  s.add_dependency "daemons"
-  s.add_development_dependency 'rspec', '> 2.0.1'
-end
-
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{spec.name}.gemspec", 'w') do |f|
-    f.write spec.to_ruby
-  end
-end
-
-require 'rspec/core/rake_task'
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = FileList['spec/**/*.rb']
-end
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freec.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freec"
+  spec.version       = Freec::VERSION
+  spec.authors       = ["Jan Kubr"]
+  spec.email         = ["mail@jankubr.com"]
+
+  spec.summary       = "The layer between your Ruby voice app and FreeSWITCH."
+  spec.description   = "The layer between your Ruby voice app and FreeSWITCH."
+  spec.homepage      = "http://github.com/jankubr/freec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'gserver', '~> 0.0.1'
+  spec.add_runtime_dependency 'daemons', '~> 1.2.4'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/freec.rb

@@ -1,6 +1,8 @@
+require 'freec/version'
 lib_dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
-require "freec_base"
+require 'gserver'
+require 'freec_base'
 require 'listener'
 
 require 'fileutils'
@@ -9,7 +11,7 @@ require 'daemons/daemonize'
 include Daemonize
 
 def freec_app_file_name
-  $0.sub(/\.[^\.]*$/, '')  
+  $0.sub(/\.[^\.]*$/, '')
 end
 
 def freec_app_class_name
@@ -21,7 +23,7 @@ def freec_app_log_dir
 end
 
 def create_freec_app_log_dir
-  FileUtils.mkdir_p(freec_app_log_dir)  
+  FileUtils.mkdir_p(freec_app_log_dir)
 end
 
 def freec_app_log_file
@@ -59,9 +61,6 @@ unless defined?(TEST)
     server = Listener.new(freec_app_class_name, @@config)
     server.audit = true
     server.start
-    loop do
-      break if server.stopped?
-      sleep(1)
-    end
+    server.join
   end
 end

data/lib/freec/version.rb

@@ -0,0 +1,3 @@
+module Freec
+  VERSION = "0.2.7"
+end

data/lib/freec_base.rb

@@ -1,28 +1,27 @@
 require 'gserver'
-require 'rubygems'
 require 'uri'
 
 require 'tools'
-require "freeswitch_applications"
-require "call_variables"
+require 'freeswitch_applications'
+require 'call_variables'
 
-class Freec
+class FreecBase
   include FreeswitchApplications
   include CallVariables
-  
+
   attr_reader :call_vars, :event_body, :log, :config
-  
+
   def initialize(io, log, config) #:nodoc:
     @call_vars = {}
     @want_events_from = []
     @last_app_executed = 'initial_step'
-    @io = io    
+    @io = io
     @log = log
     @config = config
   end
-        
+
   def handle_call #:nodoc:
-    call_initialization    
+    call_initialization
     loop do
       subscribe_to_new_channel_events
       if last_event_dtmf? && respond_to?(:on_dtmf)
@@ -38,7 +37,7 @@ class Freec
     hangup unless @io.closed?
     send_and_read('exit') unless @io.closed?
   end
-    
+
   def wait_for(key, value)
     @waiting_for_key = key && key.to_sym
     @waiting_for_value = value
@@ -46,13 +45,13 @@ class Freec
 
   def reset_wait_for
     wait_for(nil, nil)
-    true 
-  end  
-    
+    true
+  end
+
   def execute_completed?
     channel_execute_complete? || channel_destroyed_after_bridge? || disconnect_notice?
   end
-  
+
 private
 
   def call_initialization
@@ -62,17 +61,17 @@ private
 
   def channel_execute_complete?
     return true if @last_app_executed == 'initial_step'
-    complete =  call_vars[:content_type] == 'text/event-plain' && 
+    complete =  call_vars[:content_type] == 'text/event-plain' &&
                 call_vars[:event_name] == 'CHANNEL_EXECUTE_COMPLETE' &&
                 @last_app_executed == call_vars[:application]
     @last_app_executed = nil if complete
     complete
   end
-  
+
   def channel_destroyed_after_bridge?
     call_vars[:application] == 'bridge' && call_vars[:event_name] == 'CHANNEL_DESTROY'
   end
-  
+
   def disconnect_notice?
     @io.closed? || call_vars[:content_type] == 'text/disconnect-notice'
   end
@@ -81,7 +80,7 @@ private
     send(callback_name, *args) if respond_to?(callback_name)
   rescue StandardError => e
     log.error e.message
-    e.backtrace.each {|trace_line| log.error(trace_line)}    
+    e.backtrace.each {|trace_line| log.error(trace_line)}
   end
 
   def reload_application_code
@@ -89,7 +88,7 @@ private
     load($0)
     lib_dir = "#{ROOT}/lib"
     return unless File.exist?(lib_dir)
-    Dir.open(lib_dir).each do |file|      
+    Dir.open(lib_dir).each do |file|
       full_file_name = File.join(lib_dir, file)
       next unless File.file?(full_file_name)
       load(full_file_name)
@@ -100,62 +99,62 @@ private
     send_and_read('connect')
     parse_response
   end
-  
+
   def subscribe_to_events
     send_and_read('events plain all')
-    parse_response    
-    send_and_read("filter Unique-ID #{@unique_id}") 
-    parse_response    
-    send_and_read("divert_events on") 
+    parse_response
+    send_and_read("filter Unique-ID #{@unique_id}")
+    parse_response
+    send_and_read("divert_events on")
     parse_response
   end
-  
+
   def subscribe_to_new_channel_events
     return unless call_vars[:event_name] == 'CHANNEL_BRIDGE'
     @want_events_from << call_vars[:other_leg_unique_id]
     send_and_read("filter Unique-ID #{call_vars[:other_leg_unique_id]}")
   end
-      
+
   def waiting_for_this_response?
     @waiting_for_key && @waiting_for_value && call_vars[@waiting_for_key] == @waiting_for_value
   end
-  
+
   def last_event_dtmf?
     call_vars[:content_type] == 'text/event-plain' && call_vars[:event_name] == 'DTMF'
   end
-          
+
   def send_data(data)
     log.debug "Sending: #{data}"
     @io.write("#{data}\n\n") unless disconnect_notice?
   end
-  
+
   def send_and_read(data)
     send_data(data)
     read_response
   end
-  
+
   def read_and_parse_response
     my_event = false
     until my_event
       read_response
       my_event = parse_response
-    end    
+    end
   end
-  
+
   def read_response
     return if disconnect_notice?
     read_response_info
     read_event_header
     read_event_body
   end
-  
+
   def read_response_info
     @response = ''
     begin
       @response += read_line_from_io
-    end until @response[-2..-1] == "\n\n"    
+    end until @response[-2..-1] == "\n\n"
   end
-  
+
   def read_event_header
     header_length = @response.sub(/^Content-Length: ([0-9]+)$.*/m, '\1').to_i
     return if header_length == 0
@@ -163,23 +162,23 @@ private
     begin
       header += read_line_from_io
     end until header[-2..-1] == "\n\n"
-    @response += header        
+    @response += header
   end
-  
+
   def read_event_body
     body_length = @response.sub(/^Content-Length.*^Content-Length: ([0-9]+)$.*/m, '\1').to_i
     return if body_length == 0
     body = ''
-    begin      
+    begin
       body += read_block_from_io(body_length)
     end until body.length == body_length
-    @response += body    
+    @response += body
   end
-        
+
   def parse_response
     hash = {}
     if @response =~ /^Content-Length.*^Content-Length/m
-      @event_body = @response.sub(/.*\n\n.*\n\n(.*)/m, '\1').strip 
+      @event_body = @response.sub(/.*\n\n.*\n\n(.*)/m, '\1').strip
     else
       @event_body = nil
     end
@@ -198,21 +197,21 @@ private
     @response = ''
     true
   end
-  
+
   def read_line_from_io
     line = @io.gets
     raise io_disconnected_message unless line
     line
   end
-  
+
   def read_block_from_io(length)
     block = @io.read(length)
     raise io_disconnected_message  unless block
     block
   end
-  
+
   def io_disconnected_message
     "IO disconnected - FreeSWITCH crashed?"
   end
-  
-end
+
+end

data/lib/freeswitch_applications.rb

@@ -1,12 +1,12 @@
 module FreeswitchApplications
-  
+
   # Answers the call.
   def answer
     execute_app('answer')
   end
 
   # Plays the file in file_name
-  # file_name is either an absolute path or path relative 
+  # file_name is either an absolute path or path relative
   # to the sound_prefix variable set in Freeswitch's vars.xml configuration file.
   def playback(file_name)
     execute_app('playback', file_name)
@@ -16,36 +16,36 @@ module FreeswitchApplications
   def spell(string)
     execute_app('phrase', "spell,#{string}")
   end
-  
+
   # Says the given string
   # Don't forget to set up your TTS engine and set variables tts_engine and tts_voice accordingly
   # See e.g.: http://wiki.freeswitch.org/wiki/Mod_flite
   def speak(string)
     execute_app('speak', string)
   end
-  
+
   # Bridges the call to the given number or numbers (this param can be a number or an array of numbers).
   def bridge(number_or_numbers, options = {})
     number_or_numbers = number_or_numbers.join(",") if number_or_numbers.is_a?(Array)
     execute_app("bridge", "#{number_or_numbers}")
   end
-  
+
   # Transfers the call to the given extension
   def transfer(extension)
     execute_app("transfer", "#{extension}")
   end
-  
+
   # Records the call to a file with the given file_name
-  # file_name is either an absolute path or path relative 
+  # file_name is either an absolute path or path relative
   # to the sound_prefix variable set in Freeswitch's vars.xml configuration file.
   #
   # Options:
   # * <tt>:time_limit_secs</tt> overrides the default timeout, which is 600 seconds
   def record(file_name, options = {})
-    options = {:time_limit_secs => 600}.merge(options) #no reverse_merge, no fun :-)
+    options = {time_limit_secs: 600}.merge(options) #no reverse_merge, no fun :-)
     execute_app("record", "#{file_name} #{options[:time_limit_secs]}")
   end
-  
+
   # Plays the file in file_name and reads input (key presses) from the user.
   #
   # Options:
@@ -55,10 +55,10 @@ module FreeswitchApplications
   # * <tt>:min and :max</tt> options to override the default maximum and minimum of characters that will be read (both default to 1)
   def read(file_name, options = {})
     options[:terminators] = [options[:terminators]] if options[:terminators].is_a?(String)
-    options = {:timeout => 10, :variable => 'input', :min => 1, :max => 1, :terminators => ['#']}.merge(options)
+    options = {timeout: 10, variable: 'input', min: 1, max: 1, terminators: ['#']}.merge(options)
     execute_app("read", "#{options[:min]} #{options[:max]} #{file_name} #{options[:variable]} #{options[:timeout] * 1000} #{options[:terminators].join(',')}")
   end
-  
+
   # Starts recording the call in file in file_name
   #
   def start_recording(file_name)
@@ -66,11 +66,11 @@ module FreeswitchApplications
   end
 
   # Stops recording the call in file in file_name
-  #  
+  #
   def stop_recording(file_name)
     execute_app('stop_record_session', file_name)
   end
-  
+
   # Sets a variable with the give name to the given value.
   def set_variable(name, value)
     execute_app('set', "#{name}=#{value}")
@@ -78,9 +78,9 @@ module FreeswitchApplications
 
   # Hangs up the call.
   def hangup
-    execute_app('hangup')
-  end  
-  
+    execute_app('hangup', 'USER_BUSY')
+  end
+
   # Executes an app using the sendmsg command of Freeswitch.
   # Use this if there is no method for the application you want to run.
   #
@@ -88,7 +88,7 @@ module FreeswitchApplications
   # * <tt>app</tt> is the application name
   # * <tt>pars</tt> is a string of arguments of the app
   # * <tt>lock</tt> can be set to false so Freeswitch won't wait for this app to finish before running the next one
-  def execute_app(app, pars = '', lock = true, unique_id = nil)    
+  def execute_app(app, pars = '', lock = true, unique_id = nil)
     @last_app_executed = app
     unique_id = @unique_id unless unique_id
     cmd = "sendmsg #{unique_id}"
@@ -97,5 +97,5 @@ module FreeswitchApplications
     cmd << "\nexecute-app-arg: #{pars}" unless pars.blank?
     cmd << "\nevent-lock:#{lock}"
     send_data cmd
-  end  
-end
+  end
+end

metadata

@@ -1,84 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: freec
 version: !ruby/object:Gem::Version
-  version: 0.2.6
-  prerelease: 
+  version: 0.2.7
 platform: ruby
 authors:
 - Jan Kubr
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2017-04-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gserver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70325537302580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *70325537302580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70325537302100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70325537302100
-description: 
-email: mail@jankubr.com
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The layer between your Ruby voice app and FreeSWITCH.
+email:
+- mail@jankubr.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.rdoc
 - Rakefile
+- bin/console
+- bin/setup
+- freec.gemspec
 - lib/call_variables.rb
 - lib/freec.rb
+- lib/freec/version.rb
 - lib/freec_base.rb
 - lib/freec_logger.rb
 - lib/freeswitch_applications.rb
 - lib/listener.rb
 - lib/tools.rb
-- spec/data/event.rb
-- spec/data/event_with_body.rb
-- spec/event_parser_spec.rb
-- spec/freec_base_spec.rb
-- spec/freeswitch_applications_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/jankubr/freec
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options:
-- --line-numbers
-- --inline-source
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: freec
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The layer between your Ruby voice app and FreeSWITCH.
 test_files: []

data/spec/data/event.rb

@@ -1,56 +0,0 @@
-unless defined?(EVENT)
-EVENT=<<STRING
-Content-Length: 1693
-Content-Type: text/event-plain
-
-Event-Name: CHANNEL_EXECUTE
-Core-UUID: 4a78c88d-38cc-4e35-92af-c155def76f9a
-FreeSWITCH-Hostname: air.local
-FreeSWITCH-IPv4: 10.0.1.2
-FreeSWITCH-IPv6: %3A%3A1
-Event-Date-Local: 2009-05-14%2019%3A29%3A09
-Event-Date-GMT: Thu,%2014%20May%202009%2017%3A29%3A09%20GMT
-Event-Date-Timestamp: 1242322149917313
-Event-Calling-File: switch_core_session.c
-Event-Calling-Function: switch_core_session_exec
-Event-Calling-Line-Number: 1460
-Channel-State: CS_EXECUTE
-Channel-State-Number: 4
-Channel-Name: sofia/internal/jan.kubr.gmail.com%4010.0.1.2
-Channel-Destination-Number: 886
-Unique-ID: f3c2d5ee-d064-4f55-9280-5be2a65867e8
-Call-Direction: inbound
-Presence-Call-Direction: inbound
-Answer-State: answered
-Channel-Read-Codec-Name: GSM
-Channel-Read-Codec-Rate: 8000
-Channel-Write-Codec-Name: GSM
-Channel-Write-Codec-Rate: 8000
-Caller-Username: jan.kubr.gmail.com
-Caller-Dialplan: XML
-Caller-Caller-ID-Name: Jan%20Local
-Caller-Caller-ID-Number: jan.kubr.gmail.com
-Caller-Network-Addr: 10.0.1.2
-Caller-Destination-Number: 0
-Caller-Unique-ID: f3c2d5ee-d064-4f55-9280-5be2a65867e8
-Caller-Source: mod_sofia
-Caller-Context: default
-Caller-Channel-Name: sofia/internal/jan.kubr.gmail.com%4010.0.1.2
-Caller-Profile-Index: 1
-Caller-Profile-Created-Time: 1242322142643329
-Caller-Channel-Created-Time: 1242322142643329
-Caller-Channel-Answered-Time: 1242322143798188
-Caller-Channel-Progress-Time: 0
-Caller-Channel-Progress-Media-Time: 1242322142657064
-Caller-Channel-Hangup-Time: 0
-Caller-Channel-Transfer-Time: 0
-Caller-Screen-Bit: true
-Caller-Privacy-Hide-Name: false
-Caller-Privacy-Hide-Number: false
-variable_sip_to_user: 886
-variable_sip_from_user: 1001
-Application: set
-Application-Data: continue_on_fail%3Dtrue
-
-STRING
-end

data/spec/data/event_with_body.rb

@@ -1,25 +0,0 @@
-unless defined?(EVENT_WITH_BODY)
-EVENT_WITH_BODY=<<STRING
-Content-Length: 460
-Content-Type: text/event-plain
-
-Event-Name: DETECTED_SPEECH
-Core-UUID: b61467b4-6d7c-4a6f-ba87-32ade7b79951
-FreeSWITCH-Hostname: air.local
-FreeSWITCH-IPv4: 10.0.1.2
-FreeSWITCH-IPv6: %3A%3A1
-Event-Date-Local: 2009-05-04%2020%3A40%3A48
-Event-Date-GMT: Mon,%2004%20May%202009%2018%3A40%3A48%20GMT
-Event-Date-Timestamp: 1241462448174337
-Event-Calling-File: switch_ivr_async.c
-Event-Calling-Function: speech_thread
-Event-Calling-Line-Number: 1878
-Speech-Type: detected-speech
-Content-Length: 132
-
-<interpretation grammar="battle" score="100">
-  <result name="match">FREESTYLE</result>
-  <input>FREESTYLE</input>
-</interpretation>
-STRING
-end

data/spec/event_parser_spec.rb

@@ -1,84 +0,0 @@
-require "#{File.dirname(__FILE__)}/spec_helper"
-
-describe Freec do
-  before do
-    io = stub(:io)
-    log = FreecLogger.new(STDOUT)
-    log.level = Logger::FATAL
-    @freec = Freec.new(io, log, {})
-  end
-  
-  describe "parses body-less event" do
-    before do
-      @freec.instance_variable_set(:@response, EVENT)
-      @freec.send :parse_response
-    end
-    
-    it "should read unique id from response" do
-      @freec.instance_variable_get(:@unique_id).should == 'f3c2d5ee-d064-4f55-9280-5be2a65867e8'
-    end
-    
-    it "should include channel unique id to the array of ids event variables are read from" do
-      @freec.instance_variable_get(:@want_events_from).should == ['f3c2d5ee-d064-4f55-9280-5be2a65867e8']
-    end
-    
-    it "should parse variables from response" do
-      @freec.call_vars[:call_direction].should == 'inbound'
-      @freec.call_vars[:caller_context].should == 'default'
-      @freec.call_vars[:application].should == 'set'
-    end    
-  
-    it "should make the value of the sip_from_user variable available as a method" do
-      @freec.sip_from_user.should == '1001'
-    end
-
-    it "should make the value of the sip_to_user variable available as a method" do
-      @freec.sip_to_user.should == '886'
-    end
-
-    it "should make the value of the channel_destination_number variable available as a method" do
-      @freec.channel_destination_number.should == '886'
-    end
-  end
-  
-  describe "ignores variables from another channel event" do
-
-    it "should not parse variables from event of another channel" do
-      @freec.instance_variable_set(:@response, EVENT)
-      @freec.send(:parse_response).should be_true
-      another_channel_event = EVENT.sub('Unique-ID: f3c2d5ee-d064-4f55-9280-5be2a65867e8', 'Unique-ID: ffff1111-e72d-48bf-9ecf-d71bd4b60617').
-                                    sub('Application: set', 'Application: bridge')
-      @freec.instance_variable_set(:@response, another_channel_event)
-      @freec.send(:parse_response).should be_false
-      @freec.call_vars[:application].should == 'set'
-    end
-    
-    it "parses variables from disconnect notices" do
-      @freec.instance_variable_set(:@response, EVENT)
-      @freec.send(:parse_response).should be_true
-      @freec.call_vars[:content_type].should == 'text/event-plain'
-      disconnect_notice_event = EVENT.sub('Unique-ID: f3c2d5ee-d064-4f55-9280-5be2a65867e8', 'Unique-ID: ').
-                                    sub('Content-Type: text/event-plain', 'Content-Type: text/disconnect-notice')
-      @freec.instance_variable_set(:@response, disconnect_notice_event)
-      @freec.send(:parse_response).should be_true 
-      @freec.call_vars[:content_type].should == 'text/disconnect-notice'
-    end    
-    
-  end
-
-  describe "parses an event with a body" do
-    before do
-      @freec.instance_variable_set(:@response, EVENT_WITH_BODY)
-      @freec.send :parse_response
-    end
-      
-    it "should parse the variables from the event header" do
-      @freec.call_vars[:event_name].should == 'DETECTED_SPEECH'
-    end
-    
-    it "makes the body of the response available as a public method" do
-      @freec.event_body.should =~ /<\/interpretation>$/
-    end
-
-  end
-end

data/spec/freec_base_spec.rb

@@ -1,213 +0,0 @@
-require "#{File.dirname(__FILE__)}/spec_helper"
-
-module FreecSpecHelper
-  def event_parts(event=EVENT)
-    @parts = event.split("\n\n").map {|p| "#{p}\n\n"}  
-  end
-  
-  def initial_response
-    @initial_response ||= EVENT.split("\n\n")[1] + "\n\n"
-  end
-  
-end
-
-describe Freec do
-  include FreecSpecHelper
-
-  before do
-    @io = stub(:io)
-    @log = FreecLogger.new(STDOUT)
-    @log.level = Logger::FATAL
-    @config = {:config1 => 'value'}
-    @freec = Freec.new(@io, @log, @config)
-  end
-  
-  describe "initialization" do
-
-    it "makes log and config available" do
-      @freec.log.should == @log
-      @freec.config.should == @config
-    end
-
-  end
-
-  describe "call initialization" do
-  
-    it "sends 'connect' command to Freeswitch" do
-      @freec.should_receive(:send_data).with("connect")
-      @freec.should_receive(:send_data)
-      @freec.should_receive(:send_data)
-      @freec.should_receive(:send_data)
-      @io.should_receive(:gets).exactly(4).and_return(initial_response)
-      @freec.send :call_initialization
-    end
-    
-    it "subscribes to events" do
-      @freec.should_receive(:send_data)
-      @freec.should_receive(:send_data).with('events plain all')
-      @freec.should_receive(:send_data).with('filter Unique-ID f3c2d5ee-d064-4f55-9280-5be2a65867e8')
-      @freec.should_receive(:send_data).with('divert_events on')
-      @io.should_receive(:gets).exactly(4).and_return(initial_response)
-      @freec.send :call_initialization
-    end
-    
-  end
-  
-  describe "response reader" do
-  
-    it "reads the full body-less event" do
-      @io.should_receive(:gets).and_return(event_parts(EVENT)[0], event_parts(EVENT)[1])
-      @freec.send(:read_response)
-    end
-
-    it "raises exception if IO is disconnected while reading response info" do
-      @io.should_receive(:gets).and_return(nil)
-      lambda { @freec.send(:read_response) }.should raise_error(RuntimeError, 'IO disconnected - FreeSWITCH crashed?')
-    end
-
-    it "raises exception if IO is disconnected while reading event header" do
-      @io.should_receive(:gets).and_return(event_parts(EVENT)[0], nil)
-      lambda { @freec.send(:read_response) }.should raise_error(RuntimeError, 'IO disconnected - FreeSWITCH crashed?')
-    end
-    
-    it "reads the full event with body" do
-      @io.should_receive(:gets).and_return(event_parts(EVENT_WITH_BODY)[0], 
-                                          event_parts(EVENT_WITH_BODY)[1])
-      @io.should_receive(:read).and_return(event_parts(EVENT_WITH_BODY)[2].strip.chomp)
-      @freec.send(:read_response)
-    end
-    
-    it "raises exception if IO is disconnected while reading body" do
-      @io.should_receive(:gets).and_return(event_parts(EVENT_WITH_BODY)[0], 
-                                          event_parts(EVENT_WITH_BODY)[1])
-      @io.should_receive(:read).and_return(nil)
-      lambda { @freec.send(:read_response) }.should raise_error(RuntimeError, 'IO disconnected - FreeSWITCH crashed?')
-    end
-  
-  end
-  
-  
-  describe "event recognition" do
-
-    it "ignores events for another channel" do
-      @freec.should_receive(:read_response).twice
-      @freec.should_receive(:parse_response).and_return(false, true)
-      @freec.send(:read_and_parse_response)
-    end
-  
-    it "should subscribe to events of other leg channel after bridge" do
-      bridge_event = EVENT.sub('CHANNEL_EXECUTE', 'CHANNEL_BRIDGE').sub('Caller-Profile-Index: 1', 'Other-Leg-Unique-ID: 6c75cb42-e72d-48bf-9ecf-d71bd4b60617')
-      @freec.instance_variable_set(:@response, bridge_event)
-      @freec.send(:parse_response)
-      @freec.should_receive(:send_and_read).with("filter Unique-ID 6c75cb42-e72d-48bf-9ecf-d71bd4b60617")
-      @freec.send(:subscribe_to_new_channel_events)
-      @freec.instance_variable_get(:@want_events_from).should == ["f3c2d5ee-d064-4f55-9280-5be2a65867e8", "6c75cb42-e72d-48bf-9ecf-d71bd4b60617"]
-    end
-    
-    it "should recognize last event was DTMF to call the on_dtmf callback" do
-      dtmf_event = EVENT.sub('CHANNEL_EXECUTE', 'DTMF')
-      @freec.instance_variable_set(:@response, dtmf_event)
-      @freec.send(:parse_response)
-      @freec.send(:last_event_dtmf?).should be_true
-    end
-      
-    it "should recognize an event as a non-DTMF one" do
-      @freec.instance_variable_set(:@response, EVENT)
-      @freec.send(:parse_response)
-      @freec.send(:last_event_dtmf?).should be_false
-    end
-      
-    it "should recognize that app execution has been completed for the last run app" do
-      @freec.instance_variable_set(:@last_app_executed, 'set')
-      set_executed_event = EVENT.sub('CHANNEL_EXECUTE', 'CHANNEL_EXECUTE_COMPLETE')
-      @freec.instance_variable_set(:@response, set_executed_event)
-      @freec.send(:parse_response)      
-    
-      @freec.send(:execute_completed?).should be_true
-      @freec.instance_variable_get(:@last_app_executed).should be_nil
-    end
-      
-    it "should recognize that app execution has been completed but not for the last run one" do
-      @freec.instance_variable_set(:@last_app_executed, 'different')
-      set_executed_event = EVENT.sub('CHANNEL_EXECUTE', 'CHANNEL_EXECUTE_COMPLETE')
-      @freec.instance_variable_set(:@response, set_executed_event)
-      @freec.send(:parse_response)      
-    
-      @freec.send(:execute_completed?).should be_false
-      @freec.instance_variable_get(:@last_app_executed).should == 'different'
-    end
-      
-    it "should hangup the call, send exit command to Freeswitch and disconnect from it when step callback returns nil" do
-      @freec.should_receive(:send_data).with("connect")
-      @freec.should_receive(:send_data).with("events plain all")      
-      @freec.should_receive(:send_data).with('filter Unique-ID f3c2d5ee-d064-4f55-9280-5be2a65867e8')
-      @freec.should_receive(:send_data).with('divert_events on')
-      
-      @io.should_receive(:gets).and_return(initial_response, initial_response, initial_response, initial_response, "bye\n\n")
-      @io.should_receive(:closed?).twice.and_return(false)
-      @freec.should_receive(:step).and_return(nil)
-      @freec.should_receive(:execute_app).with('hangup')
-      @freec.should_receive(:on_hangup)
-      @freec.should_receive(:send_data).with("exit")      
-      @freec.handle_call
-    end
-    
-    it "should exit when Freeswitch disconnects (e.g. caller hangs up) and neither call the step callback nor send any other data to Freeswitch" do
-      disconnect_event = EVENT.sub('text/event-plain', 'text/disconnect-notice')
-      @freec.should_receive(:send_data).with("connect")
-      @freec.should_receive(:send_data).with("events plain all")      
-      @freec.should_receive(:send_data).with('filter Unique-ID f3c2d5ee-d064-4f55-9280-5be2a65867e8')
-      @freec.should_receive(:send_data).with('divert_events on')
-      @io.should_receive(:gets).and_return(initial_response, initial_response, event_parts(disconnect_event)[0], event_parts(disconnect_event)[1])
-      @io.should_receive(:closed?).twice.and_return(true)
-      @freec.should_receive(:step).never
-      @freec.should_receive(:on_hangup)
-      @freec.should_receive(:execute_app).never      
-      @freec.should_receive(:send_data).never
-      @freec.handle_call
-    end
-      
-  end
-  
-  describe "callback exception handling" do  
-    it "should catch and log any exception occurred in a callback" do
-      @freec.should_receive(:callback_name).and_raise(RuntimeError)
-      @freec.log.should_receive(:error).with('RuntimeError')
-      @freec.log.should_receive(:error).at_least(1).times #backtrace
-      lambda { @freec.send(:callback, :callback_name) }.should_not raise_error(Exception)
-    end  
-  end
-  
-  describe "custom waiting conditions" do
-    
-    # it "should return true from waiting_for_this_response? when the conditions for the response are met" do
-    #   @freec.wait_for(:content_type, 'command/reply')
-    #   @freec.instance_variable_set(:@response, EVENT)
-    #   @freec.send(:parse_response)
-    #   @freec.send(:waiting_for_this_response?).should be_true
-    # end
-    #   
-    # it "should return false from waiting_for_this_response? when the conditions for the response are not met" do
-    #   @freec.wait_for(:content_type, 'text/event-plain')
-    #   @freec.instance_variable_set(:@response, EVENT)
-    #   @freec.send(:parse_response)
-    #   @freec.send(:waiting_for_this_response?).should be_false
-    # end
-    #   
-    # it "should reset the waiting conditions after they have been met" do      
-    #   @freec.wait_for(:content_type, 'command/reply')
-    #   @freec.should_receive(:send_data).with("connect")
-    #   @freec.should_receive(:send_data).with("myevents")      
-    #   @io.should_receive(:gets).and_return(EVENT, EVENT, "bye\n\n")
-    #   @freec.instance_variable_set(:@last_app_executed, 'set')
-    #   @freec.should_receive(:step).and_return(nil)
-    #   @freec.should_receive(:execute_app).with('hangup')
-    #   @freec.should_receive(:on_hangup)
-    #   @freec.should_receive(:send_data).with("exit")      
-    #   @freec.handle_call
-    #   @freec.send(:waiting_for_this_response?).should be_nil
-    # end
-    #   
-  end
-
-end

data/spec/freeswitch_applications_spec.rb

@@ -1,128 +0,0 @@
-require "#{File.dirname(__FILE__)}/spec_helper"
-
-module FreeswitchApplicationsSpecHelper
-  def freeswitch_command(app, pars = nil)    
-    cmd = "sendmsg "
-    cmd += "\ncall-command: execute"
-    cmd += "\nexecute-app-name: #{app}"
-    cmd += "\nexecute-app-arg: #{pars}" unless pars.blank?
-    cmd += "\nevent-lock:true"
-    cmd
-  end
-end
-
-describe Freec do
-
-  before do
-    io = stub(:io)
-    log = FreecLogger.new(STDOUT)
-    log.level = Logger::FATAL
-    @freec = Freec.new(io, log, {})
-  end
-
-  describe "executes Freeswitch applications" do
-    include FreeswitchApplicationsSpecHelper
-
-    it "should set the last_app_executed variable to last run app" do
-      @freec.should_receive(:send_data).with(freeswitch_command('answer'))
-      @freec.answer
-      @freec.instance_variable_get(:@last_app_executed).should == 'answer'
-    end
-
-    it "should execute the answer app when called the answer method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('answer'))
-      @freec.answer
-    end
-  
-    it "should execute the playback app when called the playback method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('playback', 'sounds/file.wav'))
-      @freec.playback('sounds/file.wav')
-    end
-
-    it "should execute the phrase app with spell option when called the spell method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('phrase', 'spell,abcd'))
-      @freec.spell('abcd')
-    end
-
-    it "should execute the speak app when called the speak method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('speak', 'hello'))
-      @freec.speak('hello')
-    end
-
-    it "should execute the bridge app when called the bridge method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('bridge', 'user/brian@10.0.1.2'))
-      @freec.bridge('user/brian@10.0.1.2')
-    end
-
-    it "should execute the transfer app when called the transfer method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('transfer', '1000'))
-      @freec.transfer('1000')
-    end
-
-    it "should pass all numbers passed to the bridge method as params of the bridge separated by comma (thus numbers are called simultaneously)" do
-      @freec.should_receive(:send_data).with(freeswitch_command('bridge', 'user/brian@10.0.1.2,user/karl@10.0.1.2'))
-      @freec.bridge(['user/brian@10.0.1.2', 'user/karl@10.0.1.2'])
-    end
-
-    it "should execute the record app when called the record method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('record', 'recordings/file.mp3 600'))
-      @freec.record('recordings/file.mp3')
-    end
-
-    it "should set the time_limit_secs option send to the record method as the max length of the recording" do
-      @freec.should_receive(:send_data).with(freeswitch_command('record', 'recordings/file.mp3 120'))
-      @freec.record('recordings/file.mp3', :time_limit_secs => 120)
-    end
-
-    it "should execute the read app when called the input method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '1 1 sounds/file.mp3 input 10000 #'))
-      @freec.read('sounds/file.mp3')
-    end
-
-    it "should allow to pass the minimum and maximum digits to be read" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '2 5 sounds/file.mp3 input 10000 #'))
-      @freec.read('sounds/file.mp3', :min => 2, :max => 5)
-    end
-
-    it "should allow to pass the timeout in seconds before the read apps before it times out" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '1 1 sounds/file.mp3 input 5000 #'))
-      @freec.read('sounds/file.mp3', :timeout => 5)
-    end
-
-    it "should allow to pass the terminator for the read app" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '1 1 sounds/file.mp3 input 10000 *'))
-      @freec.read('sounds/file.mp3', :terminators => '*')
-    end
-
-    it "should allow to pass the terminators as an array for the read app" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '1 1 sounds/file.mp3 input 10000 #,*'))
-      @freec.read('sounds/file.mp3', :terminators => ['#', '*'])
-    end
-
-    it "should allow to specify the variable name the input is read by the read app" do
-      @freec.should_receive(:send_data).with(freeswitch_command('read', '1 1 sounds/file.mp3 name 10000 #'))
-      @freec.read('sounds/file.mp3', :variable => 'name')
-    end
-
-    it "should execute the record_session app when called the start_recording method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('record_session', 'file.wav'))
-      @freec.start_recording('file.wav')
-    end
-
-    it "should execute the stop_record_session app when called the start_recording method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('stop_record_session', 'file.wav'))
-      @freec.stop_recording('file.wav')
-    end
-  
-    it "should call the set app to set a variable" do
-      @freec.should_receive(:send_data).with(freeswitch_command('set', 'name=value'))
-      @freec.set_variable('name', 'value')
-    end
-  
-    it "should call the hangup app when caled the hangup method" do
-      @freec.should_receive(:send_data).with(freeswitch_command('hangup'))
-      @freec.hangup
-    end
-    
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-require 'rubygems'
-require 'rspec'
-
-$:.unshift(File.join(File.dirname(__FILE__), "..", 'lib')).unshift(File.dirname(__FILE__)).
-  unshift(File.join(File.dirname(__FILE__), 'data'))
-ROOT = File.join(File.dirname(__FILE__), '..') unless defined?(ROOT)
-@@config = ''
-ENVIRONMENT = 'test' unless defined?(ENVIRONMENT)
-TEST = true unless defined?(TEST)
-require 'freec'
-require 'event'
-require 'event_with_body'