freec 0.2.6 → 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df2fa8a96256734d308ad216676ff07f879d6266
+  data.tar.gz: 7408f1183efa35c140a83515a9d8e40078823980
+SHA512:
+  metadata.gz: 4d6ade697846f0b75566dedf0c0ccc3d0ea78895e8ffe4f42265544c6a8d5620678563717ad22fdf387b18dcfbefa859d4dc1ca674e892d85ec5612b43ff3472
+  data.tar.gz: 4283bc10510063f7a100a5a7bb7025f18b7932506e9b6bc978b1962192b49bd6b10a0cea97c42a595caf6a79d88411b07ab2c99869cd15221e10762412f922a5

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.8)
+      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

@@ -6,20 +6,20 @@ Freec is a framework you can build voice applications on top of. It makes use of
 
 = Usage
 1. Install Freeswitch and point a chosen extension to the IP where your app will run:
-  
+
   <extension name="telfa">
     <condition field="destination_number" expression="^.*$">
       <action application="socket" data="127.0.0.1:8084 async full" />
     </condition>
   </extension>
-  
+
 2. Create a file with the main class of your application (e.g. Jukebox) and make it a subclass of Freec. Name the file according to the class name (e.g. jukebox.rb). Implement
    a step method instructions for which will follow. Simple example:
- 
+
   #jukebox.rb
   require 'rubygems'
   require 'freec'
-  class Jukebox < Freec
+  class Jukebox < FreecBase
     def step
       @step ||= 1
       case @step
@@ -34,10 +34,12 @@ Freec is a framework you can build voice applications on top of. It makes use of
     end
   end
 
+  start
+
 3. Run it with:
   ruby jukebox.rb
 
-= How does it work 
+= How does it work
 The step method is called after each even is finished (e.g. file is played, recording is finished). Here is what you can do:
 * read call variables from the hash in call_vars
 * call one of the following methods (Freeswitch apps):
@@ -49,25 +51,16 @@ The step method is called after each even is finished (e.g. file is played, reco
  * set_variable(name, value)
  * any other via execute_app(app_name, params)
 If you return nil or false from the step method, the call will be hungup.
-  
+
 = Cool stuff
 * Your application's main file as well as everything you might have in the lib directory will be reloaded on each step in development mode.
-* Passing -d will daemonize the application and automatically implies production mode. 
+* Passing -d will daemonize the application and automatically implies production mode.
 * The log directory contains the log file and the pid file.
 * There is a hidden feature.
 
 = 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 :-)
-
-= License
-Copyright © 2009 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/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/version.rb

@@ -0,0 +1,3 @@
+module Freec
+  VERSION = "0.2.8"
+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
@@ -44,9 +46,9 @@ def freec_app_configuration_file
   "#{ROOT}/config/config.yml"
 end
 
-unless defined?(TEST)
-  ROOT = File.expand_path(File.dirname($0))
-  ENVIRONMENT = ARGV[0] == '-d' ? 'production' : 'development'
+ROOT = File.expand_path(File.dirname($0))
+ENVIRONMENT = ARGV[0] == '-d' ? 'production' : 'development'
+def start
   create_freec_app_log_dir
   load_freec_app_config
   if ARGV[0] == '-d'
@@ -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_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