librevox 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f95eefd05cef30353abe1f4f6d1ccc52a94f76e9cda32e7310d3d6fadf4a88c
-  data.tar.gz: 54ffebf6ea63c600fa318a3dd157c2952cf7c521ae0725dc7476a3101ebeee67
+  metadata.gz: fadfc835daf0f70edfe72c9a1fb2fb8ff709dc649e2105b06e0e304537b4a1aa
+  data.tar.gz: 6b6d55db19a6d4d8f3079148c5e0da1af6bd3b31491dc7238967c24188579332
 SHA512:
-  metadata.gz: dc81d98faac06579bd731e2775475912feb28cc790c1aae59287889741a2ae5ce2b2585b1939e61b57a2a209807dbd634448589a811ddf48b170c98a35f39182
-  data.tar.gz: b8b7b694902ee40f43b910f340011578b5dda2e74ae238e008732bfc62c84d7dd6e672c513487437432a9ab94a06facc7cac0f0350cf090e8047c62ae94670dc
+  metadata.gz: ade75b396dfaf64a08de980507b3a3ad47c6b3c91d0112196eceb9cc9f787ef96e0e0423583b0bfcb50dca63ce7f7d881b8166c5d28ec8763b0be6297d62566b
+  data.tar.gz: 62950a76f942a2021f05c0594daf0dfa7c9227e50218f7f78cf485e4edda45356a893cb6eb6aeffb9042a3535429a0cecb1bcf151619017afbd6303c13ea27e3

data/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img src=".github/banner.svg" alt="Librevox" width="100%">
+</p>
+
 # Librevox
 
 A Ruby library for interacting with [FreeSWITCH](http://www.freeswitch.org) through [mod_event_socket](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Modules/mod_event_socket_1048924/), using async I/O.
@@ -267,12 +271,12 @@ being processed until the current application completes.
 Librevox runs two fibers for each outbound connection:
 
 - **Session fiber** (`run_session`) — runs the setup sequence and then
-  `session_initiated`. Each `command` or `application` call blocks the fiber
+  `session_initiated`. Each `send_message` or `application` call blocks the fiber
   until the reply arrives.
 - **Read fiber** (`read_loop`) — reads messages from the socket and dispatches
   them to `Async::Queue` instances, waking the session fiber.
 
-An `Async::Semaphore(1)` mutex on `command` ensures only one command is
+An `Async::Semaphore(1)` mutex on `send_message` ensures only one command is
 in-flight at a time, so replies are always delivered to the correct caller.
 This also serializes commands issued by event hooks (which run in their own
 fibers) with the main session flow.

data/lib/librevox/applications.rb

@@ -150,9 +150,7 @@ module Librevox
       args = [min, max, tries, timeout, terminators, file, invalid_file,
         variable, regexp].join " "
 
-      params = {variable: variable}
-
-      application "play_and_get_digits", args, params
+      application "play_and_get_digits", args, variable: variable
     end
 
     # Plays a sound file on the current channel.
@@ -182,9 +180,7 @@ module Librevox
       arg_string = "%s %s %s %s %s %s" % [min, max, file, variable, timeout,
         terminators]
 
-      params = {variable: variable}
-
-      application "read", arg_string, params
+      application "read", arg_string, variable: variable
     end
 
     # Records a message, with an optional limit on the maximum duration of the

data/lib/librevox/command_socket.rb

@@ -16,16 +16,19 @@ module Librevox
     end
 
     def connect
-      @socket = TCPSocket.open(@server, @port)
-      stream = IO::Stream(@socket)
+      socket = TCPSocket.open(@server, @port)
+      stream = IO::Stream(socket)
       @connection = Protocol::Connection.new(stream)
-      @connection.write "auth #{@auth}\n\n"
+      send_message "auth #{@auth}"
+    end
+
+    def send_message(msg)
+      @connection.send_message(msg)
       read_response
     end
 
     def command(*args)
-      @connection.write "#{super(*args)}\n\n"
-      read_response
+      send_message(super(*args))
     end
 
     def read_response
@@ -34,6 +37,19 @@ module Librevox
       end
     end
 
+    def application(uuid, app, args = nil, **params)
+      headers = params
+        .merge(
+          event_lock:       true,
+          call_command:     "execute",
+          execute_app_name: app,
+          execute_app_arg:  args,
+        )
+        .map { |key, value| "#{key.to_s.tr('_', '-')}: #{value}" }
+
+      send_message "sendmsg #{uuid}\n#{headers.join("\n")}"
+    end
+
     def close
       @connection.close
     end

data/lib/librevox/listener/base.rb

@@ -6,7 +6,7 @@ require 'async/semaphore'
 module Librevox
   module Listener
     class Base
-      def initialize(connection = nil)
+      def initialize(connection)
         @connection = connection
         @reply_queue = Async::Queue.new
         @command_mutex = Async::Semaphore.new(1)
@@ -34,7 +34,7 @@ module Librevox
         end
 
         def command(*args)
-          @listener.command(super(*args))
+          @listener.send_message(super(*args))
         end
       end
 
@@ -48,9 +48,9 @@ module Librevox
         @command_delegate ||= CommandDelegate.new(self)
       end
 
-      def command(msg)
+      def send_message(msg)
         @command_mutex.acquire do
-          write "#{msg}\n\n"
+          @connection.send_message(msg)
           @reply_queue.dequeue
         end
       end
@@ -81,10 +81,6 @@ module Librevox
       def on_event(event)
       end
 
-      def write(data)
-        @connection&.write(data)
-      end
-
       def run_session
       end
 

data/lib/librevox/listener/inbound.rb

@@ -24,7 +24,7 @@ module Librevox
         barrier.async { client.run }
       end
 
-      def initialize(connection = nil, args = {})
+      def initialize(connection, args = {})
         super(connection)
         @auth = args[:auth] || "ClueCon"
       end
@@ -32,15 +32,15 @@ module Librevox
       def run_session
         Librevox.logger.info "Connected."
 
-        command "auth #{@auth}"
+        send_message "auth #{@auth}"
 
         events = self.class.subscribe_events || ['ALL']
-        command "event plain #{events.join(' ')}"
+        send_message "event plain #{events.join(' ')}"
 
         filters = self.class.subscribe_filters || {}
         filters.each do |header, values|
           [*values].each do |value|
-            command "filter #{header} #{value}"
+            send_message "filter #{header} #{value}"
           end
         end
 

data/lib/librevox/listener/outbound.rb

@@ -13,23 +13,24 @@ module Librevox
         barrier.async { server.run }
       end
 
-      def application(app, args = nil, params = {})
-        parts = ["call-command: execute", "execute-app-name: #{app}"]
-        parts << "execute-app-arg: #{args}" if args && !args.empty?
-        parts << "event-lock: true"
+      def application(app, args = nil, **params)
+        variable_name = params.delete(:variable)
 
-        response = sendmsg parts.join("\n")
-        @session = response.content
+        headers = params
+          .merge(
+            event_lock:        true,
+            call_command:      "execute",
+            execute_app_name:  app,
+            execute_app_arg:   args,
+          )
+          .map { |key, value| "#{key.to_s.tr('_', '-')}: #{value}" }
 
-        params[:variable] ? variable(params[:variable]) : nil
-      end
+        send_message "sendmsg\n#{headers.join("\n")}"
 
-      def sendmsg(msg)
-        @command_mutex.acquire do
-          write "sendmsg\n#{msg}\n\n"
-          @reply_queue.dequeue          # command/reply ack
-        end
-        @app_complete_queue.dequeue     # CHANNEL_EXECUTE_COMPLETE
+        response = @app_complete_queue.dequeue
+        @session = response.content
+
+        variable(variable_name) if variable_name
       end
 
       attr_accessor :session
@@ -38,16 +39,16 @@ module Librevox
       def session_initiated
       end
 
-      def initialize(connection = nil)
+      def initialize(connection)
         super(connection)
         @session = nil
         @app_complete_queue = Async::Queue.new
       end
 
       def run_session
-        @session = command("connect").headers
-        command "myevents"
-        command "linger"
+        @session = send_message("connect").headers
+        send_message "myevents"
+        send_message "linger"
         session_initiated
         sleep # keep session alive for event hooks and child tasks
       end

data/lib/librevox/protocol/connection.rb

@@ -30,8 +30,8 @@ module Librevox
         end
       end
 
-      def write(data)
-        @stream.write(data)
+      def send_message(msg)
+        @stream.write("#{msg}\n\n")
         @stream.flush
       end
 

data/lib/librevox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Librevox
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librevox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Harry Vangberg