freeswitcher 0.6.12 → 0.6.13

data/examples/generic_outbound_router.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/fsr', __FILE__)
+require "fsr/listener/outbound"
+$stdout.flush
+
+# Example of a single Outbound Socket listener which dispatches the call
+# based on a freeswitch variable ("action", in this case).
+# With this you can use the following in a dialplan:
+#
+# <extension name="dtmf_demo">
+#   <condition field="destination_number" expression="^97701$">
+#     <action application="set" data="action=echo_dtmf" />
+#     <action application="socket" data="localhost:8184 sync full" />
+#   </condition>
+# </extension>
+#
+# Then dialing 97701 would send you to the 'echo_dtmf' method in this class.
+#
+# The power is being able to reuse that :8184 socket with this single listener
+# to handle many tasks, by setting the 'action' variable in the dialplan before
+# calling the socket application.  Have fun with this, feedback desired in #rubyists on
+# freenode about what it takes to overwhelm one listener.
+
+class OutboundRouter < FSR::Listener::Outbound
+
+  def session_initiated
+    @exten = @session.headers[:caller_caller_id_number]
+    FSR::Log.info "Answering incoming call from #{@exten}"
+
+    if action = @session.headers[:variable_action]
+      FSR::Log.info "Action is #{action}"
+      send(action) if respond_to?(action)
+    else
+      FSR::Log.info "No action specified, hanging up"
+      hangup
+    end
+  end
+
+  def echo_dtmf
+    answer do
+      FSR::Log.info "Reading DTMF from #{@exten}"
+      #######################################################
+      ## NOTE YOU MUST MAKE SURE YOU PASS A VALID WAV FILE ##
+      #######################################################
+      read("ivr/8000/ivr-please_enter_extension_followed_by_pound.wav", 4, 10, "input", 7000) do |read_var|
+        FSR::Log.info "Success, grabbed #{read_var.to_s.strip} from #{@exten}"
+        # Tell the caller what they entered
+        # If you have mod_flite installed you should hear speech
+        fs_sleep(1000) {
+          playback("ivr/8000/ivr-you_entered.wav") {
+            say(read_var.to_s.strip, say_method: 'iterated') { hangup }
+          }
+        }
+      end
+    end
+  end
+
+  def receive_reply(reply)
+    FSR::Log.info "Received #{reply.inspect}"
+  end
+
+
+end
+
+FSR.start_oes! OutboundRouter, :port => 8184, :host => "127.0.0.1"

data/examples/inbound_callerid_app.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+require "fsr/listener/outbound"
+$stdout.flush
+
+class InboundCallerId < FSR::Listener::Outbound
+
+  def session_initiated
+    caller_number = @session.headers[:caller_caller_id_number]
+    FSR::Log.info "*** Answering incoming call from #{exten}"
+
+    answer do
+      # Lookup number in the database
+      caller_name = Ldap.find(telephoneNumber: caller_number).givenName
+      set(caller_caller_id_name: caller_name) { continue }
+    end
+
+  end
+
+end
+
+FSR.start_oes! InboundCallerId, :port => 8084, :host => "127.0.0.1"

data/examples/play_and_get_digits.rb

@@ -1,34 +1,26 @@
 #!/usr/bin/env ruby
 
-require File.join(File.dirname(__FILE__), "..", 'lib', 'fsr')
+require 'fsr'
 require "fsr/listener/outbound"
-$stdout.flush
+require 'securerandom'
 
 class PlayAndGetDigitsDemo < FSR::Listener::Outbound
+  SWEET_WAV = "/usr/local/freeswitch/sounds/music/8000/sweet.wav"
+  NOT_WAV = "/usr/local/freeswitch/sounds/music/8000/not.wav"
 
   def session_initiated
     exten = @session.headers[:caller_caller_id_number]
     FSR::Log.info "*** Answering incoming call from #{exten}"
 
     answer do
-      FSR::Log.info "***Reading DTMF from #{exten}"
-      #######################################################
-      ## NOTE YOU MUST MAKE SURE YOU PASS A VALID WAV FILE ##
-      #######################################################
-      play_and_get_digits("/usr/local/freeswitch/sounds/music/8000/sweet.wav","/usr/local/freeswitch/sounds/music/8000/not.wav", :chan_var => rand(10000).to_s) do |read_var|
-          FSR::Log.info "***Success, grabbed #{read_var.to_s.strip} from #{exten}"
-          # Tell the caller what they entered
-          # If you have mod_flite installed you should hear speech
-          speak("Got the DTMF of: #{read_var.to_s.strip}") { hangup }
-      end
-    end
+      FSR::Log.info "*** Reading DTMF from #{exten}"
 
-    def receive_reply(reply)
-      FSR::Log.info "Received #{reply.inspect}"
+      play_and_get_digits(SWEET_WAV, NOT_WAV, chan_var: SecureRandom.uuid) do |digits|
+        FSR::Log.info "*** Success, grabbed #{digits.to_s.strip} from #{exten}"
+        speak("Got the DTMF of: #{digits.to_s.strip}") { hangup }
+      end
     end
-
   end
-
 end
 
-FSR.start_oes! PlayAndGetDigitsDemo, :port => 8084, :host => "0.0.0.0"
+FSR.start_oes! PlayAndGetDigitsDemo, port: 8084, host: "0.0.0.0"

data/lib/fsr/app/hangup.rb

@@ -8,13 +8,8 @@ module FSR
       end
 
       def arguments
-        @cause
+        [@cause]
       end
-
-      def sendmsg
-        "call-command: execute\nexecute-app-name: %s\nexecute-app-arg: %s\n\n" % [app_name, arguments]
-      end
-
     end
 
     register(:hangup, Hangup)

data/lib/fsr/app/say.rb

@@ -0,0 +1,26 @@
+
+require "fsr/app"
+module FSR
+  module App
+    class Say < Application
+      # http://wiki.freeswitch.org/wiki/Misc._Dialplan_Tools_say
+      attr_reader :message
+
+      def initialize(message, opts = {})
+        # wav file you wish to play, full path
+        @message = message
+        @language = opts[:language] || "en"
+        @data_type = opts[:data_type] || "number"
+        @say_method = opts[:say_method] || "pronounced"
+        @gender = opts[:gender] || "feminine"
+      end
+
+      def arguments
+        [@language, @data_type, @say_method, @gender, @message]
+      end
+
+    end
+
+    register(:say, Say)
+  end
+end

data/lib/fsr/cmd/calls.rb

@@ -23,13 +23,8 @@ module FSR
         unless resp["body"] == "0 total."
           call_info, count = resp["body"].split("\n\n")
           require "fsr/model/call"
-          begin
-            require "fastercsv"
-            @calls = FCSV.parse(call_info)
-          rescue LoadError
-            require "csv"
-            @calls = CSV.parse(call_info)
-          end
+          require "csv"
+          @calls = CSV.parse(call_info)
           return @calls[1 .. -1].map { |c| FSR::Model::Call.new(@calls[0],*c) }
         end
         []

data/lib/fsr/cmd/channels.rb

@@ -11,8 +11,9 @@ module FSR
         end
       end
 
-      def initialize(fs_socket = nil, distinct = true)
-        @distinct = distinct
+      def initialize(fs_socket = nil, filter = nil)
+        @filter = filter
+        @filter = nil if filter === true && filter === false
         @fs_socket = fs_socket # FSR::CommandSocket obj
       end
 
@@ -24,21 +25,22 @@ module FSR
         unless resp["body"] == "0 total."
           call_info, count = resp["body"].split("\n\n")
           require "fsr/model/channel"
-          begin
-            require "fastercsv"
-            @channels = FCSV.parse(call_info)
-          rescue LoadError
-            require "csv"
-            @channels = CSV.parse(call_info)
+          require "csv"
+          channels = CSV.parse(call_info) 
+          headers = channels[0]
+          @channels = channels[1 .. -1].map { |c| FSR::Model::Channel.new(headers ,*c) }
+          if @filter
+            return @channels.select { |f| f.match @filter }
+          else
+            return @channels
           end
-          return @channels[1 .. -1].map { |c| FSR::Model::Channel.new(@channels[0],*c) }
         end
         []
       end
 
       # This method builds the API command to send to the freeswitch event socket
       def raw
-        orig_command = @distinct ? "show distinct_channels" : "show channels"
+        "show channels"
       end
     end
 

data/lib/fsr/cmd/valet_info.rb

@@ -0,0 +1,25 @@
+require "fsr/app"
+module FSR
+  module Cmd
+    class ValetInfo < Command
+
+      def initialize(fs_socket = nil)
+        @fs_socket = fs_socket # FSR::CommandSocket obj
+      end
+
+      # Send the command to the event socket, using bgapi by default.
+      def run(api_method = :api)
+        orig_command = "%s %s" % [api_method, raw]
+        Log.debug "saying #{orig_command}"
+        @fs_socket.say(orig_command)
+      end
+
+      # This method builds the API command to send to the freeswitch event socket
+      def raw
+        orig_command = "valet_info"
+      end
+    end
+
+    register(:valet_info, ValetInfo)
+  end
+end

data/lib/fsr/listener/inbound.rb

@@ -85,7 +85,10 @@ module FSR
           hash_content = headers_2_hash(content).merge(:body => content.split("\n\n",2)[1].to_s)
         when "text/event-json"
           require "json"
-          hash_content = JSON.parse(content)
+          hash_content = {}
+          JSON.parse(content).each do |k, v|
+            hash_content[k.downcase.gsub(/-/,"_").intern] = v
+          end 
         when "auth/request"
           FSR::Log.info "#{@host} Authorizing..."
           return

data/lib/fsr/version.rb

@@ -1,3 +1,3 @@
 module FSR
-  VERSION = "0.6.12"
+  VERSION = "0.6.13"
 end

data/spec/fsr/app/say.rb

@@ -0,0 +1,11 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("say")
+
+describe "Testing FSR::App::Say" do
+  it "Says number, pronounced, masculine" do
+    say = FSR::App::Say.new("12345", language: "en", data_type: "number", say_method: "pronounced", gender: "masculine")
+    say.sendmsg.should == "call-command: execute\nexecute-app-name: say\nexecute-app-arg: en number pronounced masculine 12345\n\n"
+  end
+
+end

data/spec/fsr/app/speak.rb

@@ -0,0 +1,11 @@
+require 'spec/helper'
+require "fsr/app"
+FSR::App.load_application("speak")
+
+describe "Testing FSR::App::Speak" do
+  it "Speaks a string" do
+    speak = FSR::App::Speak.new("Say my name", engine: "flite", voice: "cms")
+    speak.sendmsg.should == "call-command: execute\nexecute-app-name: speak\nexecute-app-arg: flite|cms|Say my name\nevent-lock:true\n\n"
+  end
+
+end

data/spec/fsr/cmd/channels.rb

@@ -5,14 +5,19 @@ FSR::Cmd.load_command("channels")
 describe "Testing FSR::Cmd::Channels" do
   ## Channels ##
   # Interface to channels
-  it "FSR::Cmd::Channels should send show channels" do
+  it "FSR::Cmd::Channels (false as the filter) 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
+  it "FSR::Cmd::Channels (true as the filter) should send show channels" do
     sofia = FSR::Cmd::Channels.new(nil, true)
-    sofia.raw.should == "show distinct_channels"
+    sofia.raw.should == "show channels"
+  end
+
+  it "FSR::Cmd::Channels (regex as the filter) should send show channels" do
+    sofia = FSR::Cmd::Channels.new(nil, /something/)
+    sofia.raw.should == "show channels"
   end
 
 end

data/spec/fsr/cmd/valet_info.rb

@@ -0,0 +1,13 @@
+require 'spec/helper'
+require "fsr/cmd"
+FSR::Cmd.load_command("valet_info")
+
+describe "Testing FSR::Cmd::ValetInfo" do
+  ## ValetInfo ##
+  # Interface to valet_info
+  it "FSR::Cmd::ValetInfo should send valet_info" do
+    cmd = FSR::Cmd::ValetInfo.new
+    cmd.raw.should == "valet_info"
+  end
+
+end

data/spec/fsr/loading.rb

@@ -4,7 +4,7 @@ require 'spec/helper'
 describe "Testing FSR module loading methods" do
   # When you add applications  you must modify the expected apps_loaded behavior
   it "Loads all applications" do
-    all_apps = [:play_and_get_digits, :uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log, :limit, :bind_meta_app, :execute_app, :callcenter, :ring_ready, :pre_answer, :valet_park]
+    all_apps = [:play_and_get_digits, :uuid_dump, :uuid_setvar, :uuid_getvar, :read, :set, :say, :transfer, :speak, :fs_sleep, :playback, :answer, :fifo, :bridge, :hangup, :conference, :fs_break, :log, :limit, :bind_meta_app, :execute_app, :callcenter, :ring_ready, :pre_answer, :valet_park]
     # Add any apps which will load to this set
     apps_loaded = FSR.load_all_applications
     apps_loaded.kind_of?(Array).should == true
@@ -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, :call_center, :channels, :enum, :sched_hangup, :sched_transfer, :uuid_transfer, :uuid_send_dtmf, :conference] # 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, :sched_hangup, :sched_transfer, :uuid_transfer, :uuid_send_dtmf, :conference, :valet_info] # 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|

data/tasks/bacon.rake

@@ -19,7 +19,7 @@ task :bacon => :install_dependencies do
   specs.each_with_index do |spec, idx|
     print(left_format % [idx + 1, specs_size, spec])
 
-    Open3.popen3(RUBY, spec) do |sin, sout, serr|
+    Open3.popen3(FileUtils::RUBY, spec) do |sin, sout, serr|
       out = sout.read.strip
       err = serr.read.strip
 

data/tasks/gem.rake

@@ -1,4 +1,4 @@
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 
 desc "make a gemspec"
 task :gemspec => [:manifest, :changelog, :authors] do
@@ -17,7 +17,7 @@ task :uninstall => [:clean] do
   sh %{gem uninstall -x #{GEMSPEC.name}}
 end
 
-Rake::GemPackageTask.new(GEMSPEC) do |p|
+Gem::PackageTask.new(GEMSPEC) do |p|
   p.need_tar = true
   p.need_zip = true
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: freeswitcher
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 12
-  version: 0.6.12
+  prerelease: 
+  version: 0.6.13
 platform: ruby
 authors: 
 - Jayson Vaughn
@@ -17,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 -05:00
+date: 2012-01-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +24,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -42,7 +36,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gems
 - .gitignore
+- .rvmrc
+- .travis.yml
 - AUTHORS
 - CHANGELOG
 - License.txt
@@ -50,6 +47,8 @@ files:
 - NEWS
 - README
 - Rakefile
+- examples/generic_outbound_router.rb
+- examples/inbound_callerid_app.rb
 - examples/inbound_event_socket.rb
 - examples/inbound_socket_events.rb
 - examples/outbound_event_socket.rb
@@ -74,6 +73,7 @@ files:
 - lib/fsr/app/pre_answer.rb
 - lib/fsr/app/read.rb
 - lib/fsr/app/ring_ready.rb
+- lib/fsr/app/say.rb
 - lib/fsr/app/set.rb
 - lib/fsr/app/speak.rb
 - lib/fsr/app/transfer.rb
@@ -99,6 +99,7 @@ files:
 - lib/fsr/cmd/uuid_dump.rb
 - lib/fsr/cmd/uuid_send_dtmf.rb
 - lib/fsr/cmd/uuid_transfer.rb
+- lib/fsr/cmd/valet_info.rb
 - lib/fsr/command_socket.rb
 - lib/fsr/database.rb
 - lib/fsr/database/call_limit.rb
@@ -156,7 +157,9 @@ files:
 - spec/fsr/app/playback.rb
 - spec/fsr/app/pre_answer.rb
 - spec/fsr/app/ring_ready.rb
+- spec/fsr/app/say.rb
 - spec/fsr/app/set.rb
+- spec/fsr/app/speak.rb
 - spec/fsr/app/transfer.rb
 - spec/fsr/app/valet_park.rb
 - spec/fsr/cmd.rb
@@ -173,6 +176,7 @@ files:
 - spec/fsr/cmd/uuid_dump.rb
 - spec/fsr/cmd/uuid_send_dtmf.rb
 - spec/fsr/cmd/uuid_transfer.rb
+- spec/fsr/cmd/valet_info.rb
 - spec/fsr/file_methods.rb
 - spec/fsr/listener.rb
 - spec/fsr/listener/header_and_content_response.rb
@@ -374,21 +378,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: freeswitcher
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform
@@ -410,7 +410,9 @@ test_files:
 - spec/fsr/app/playback.rb
 - spec/fsr/app/pre_answer.rb
 - spec/fsr/app/ring_ready.rb
+- spec/fsr/app/say.rb
 - spec/fsr/app/set.rb
+- spec/fsr/app/speak.rb
 - spec/fsr/app/transfer.rb
 - spec/fsr/app/valet_park.rb
 - spec/fsr/cmd.rb
@@ -427,6 +429,7 @@ test_files:
 - spec/fsr/cmd/uuid_dump.rb
 - spec/fsr/cmd/uuid_send_dtmf.rb
 - spec/fsr/cmd/uuid_transfer.rb
+- spec/fsr/cmd/valet_info.rb
 - spec/fsr/file_methods.rb
 - spec/fsr/listener.rb
 - spec/fsr/listener/header_and_content_response.rb