opensips-mi 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c1a5116b4c5981ca39236ffe7f8595e6d2b7c493c648fcaae5c05ba2f698e05
-  data.tar.gz: d2f9b66b04887bc02412e225b0119f7d437ffd875207eaefbad9b2446e304536
+  metadata.gz: e13c9966a4b4c84d25ec9e900d1b640f3650f6d33989c152070ccd67a707cc51
+  data.tar.gz: e22c248064c8ae003c45a84dc871d24c4070f01ac1951ffcf7504e2351792cc3
 SHA512:
-  metadata.gz: 037cdb3d26bfb7b85424f352330c8660723f09f4af1cb9f6a3e880a71ca6383c62643ce89eddbda15a598649432a73324f2ee9ab8ee7cd13b640f874956f385e
-  data.tar.gz: 673d02eb93d30b4b43eeaa9ce19b1204ec0dc09efd1362e2cc1d24cb6a76e438240a58ca0161f4542116b298a2d2a8ff92261ec11f9d7d3761ae3c6d3359e3fc
+  metadata.gz: 77fefce67ccc8ef925daeca1726e8efb22fc1746889108aa6fbbb571f07857b305b9ccf4de62a2cf229481cf7bbf628a5bfc3e5df8a9a04a03bb281fa0667e29
+  data.tar.gz: 552c0cbfaaf7d5c38bf0a931acd1a05bd6eb5f6649d23175943ca291a19474e62ceaaeb36e74f1d89cb157f2d90aee9d39663e57dcfd40c30d2060e21355f215

data/README.md

@@ -9,6 +9,7 @@ OpenSIPs management interface library.
 This library supports following management interfaces OpenSIPs modules:
 
 - mi_datagram
+- mi_fifo
 - mi_http
 - mi_xmlrpc
 
@@ -46,17 +47,13 @@ Parameters:
 _INTRFACE_ - interface name. One of the following:
 
 - :datagram
+- :fifo
 - :http
 - :xmlrpc
 
 _PARAMS_ - connection parameters. Depends on interface. See below.
 
 This function will raise exceptions if there are parameters' or environment errors.
-Function returns instance of one of the following classes:
-
-- Opensips::MI::Transport::Datagram
-- Opensips::MI::Transport::HTTP
-- Opensips::MI::Transport::Xmlrpc
 
 ### Datagram
 
@@ -72,7 +69,25 @@ opensips = Opensips::MI.connect :datagram,
 
 - host: Hostname or IP address of OpenSIPs server
 - port: Datagram port. See mi_datagram module configuration parameter: `modparam("mi_datagram", "socket_name", "udp:192.168.2.133:8080")`
-- timeout: Timeout in seconds to wait send/recv commands. Optional. Default 5 seconds.
+- timeout: (OPTIONAL) Timeout in seconds to wait send/recv commands. Default 5 seconds.
+
+### FIFO
+
+```ruby
+require 'opensips/mi'
+opensips = Opensips::MI.connect :fifo, 
+                                :fifo_name => '/tmp/opensips_fifo',
+                                :reply_fifo => 'opensips_reply' . $$,
+                                :reply_dir => '/tmp'
+
+```
+
+**Parameters hash:** 
+
+- fifo_name: OpenSIPs fifo file. See mi_fifo module parameter: `modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo")`.
+- reply_dir:  (OPTIONAL) Path to directory of reply fifo file. This directory is defined by opensips module parameter
+`modparam("mi_fifo", "reply_dir", "/home/opensips/tmp/")`. Default is "/tmp"
+- timeout: (OPTIONAL) Timeout in seconds read/write file timeout. Default 5 seconds.
 
 ### HTTP
 
@@ -87,6 +102,7 @@ opensips = Opensips::MI.connect :http,
 
 - url: HTTP MI url. Check OpenSIPS module mi_http for setting of IP, port and root path.
 - timeout: Timeout in seconds to wait send/recv commands. Optional. Default 5 seconds.
+- timeout: (OPTIONAL) Timeout in seconds to wait send/recv commands. Default 5 seconds.
 
 ### XMLRPC
 
@@ -100,7 +116,7 @@ opensips = Opensips::MI.connect :xmlrpc,
 **Parameters hash:**
 
 - url: HTTP MI url. Check OpenSIPS module mi_http for setting of IP, port and root path.
-- timeout: Timeout in seconds to wait send/recv commands. Optional. Default 5 seconds.
+- timeout: (OPTIONAL) Timeout in seconds to wait send/recv commands. Default 5 seconds.
 
 ### Command function
 

data/lib/opensips/mi/transport/fifo.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "abstract"
+require "fcntl"
+require "pathname"
+require "tempfile"
+require "timeout"
+
+module Opensips
+  module MI
+    module Transport
+      # FIFO transport to communicate with MI
+      class Fifo < Abstract
+        def initialize(args)
+          super()
+          raise_invalid_params unless args.is_a?(Hash)
+          @fifo_name, @reply_dir, @timeout = args.values_at(:fifo_name, :reply_dir, :timeout)
+          raise_invalid_params if @fifo_name.nil?
+          @reply_dir ||= "/tmp"
+          @timeout ||= 5
+        end
+
+        def send(rpc)
+          reply_file = create_reply_file
+          write(reply_file, rpc)
+          read(reply_file)
+        ensure
+          reply_file.unlink if reply_file&.exist?
+        end
+
+        protected
+
+        def raise_invalid_params
+          raise Opensips::MI::ErrorParams,
+                "invalid params. Expecting a hash with :fifo_name and optional :reply_dir"
+        end
+
+        private
+
+        def write(reply_file, rpc)
+          Timeout.timeout(@timeout, Opensips::MI::ErrorSendTimeout) do
+            fifo_wr = IO.open(IO.sysopen(@fifo_name, Fcntl::O_WRONLY))
+            fifo_wr.syswrite(%(:#{reply_file.basename}:#{rpc}\n))
+            fifo_wr.flush
+          ensure
+            fifo_wr&.close
+          end
+        end
+
+        def read(reply_file)
+          Timeout.timeout(@timeout, Opensips::MI::ErrorSendTimeout) do
+            fifo_rd = IO.open(IO.sysopen(reply_file, Fcntl::O_RDONLY))
+            fifo_rd.read
+          ensure
+            fifo_rd&.close
+          end
+        end
+
+        def create_reply_file
+          tmpfile = Tempfile.create("opensips-mi-reply-", @reply_dir)
+          File.unlink(tmpfile)
+
+          File.mkfifo(tmpfile)
+          File.chmod(0o666, tmpfile)
+          Pathname.new(tmpfile)
+        end
+      end
+    end
+  end
+end

data/lib/opensips/mi/transport.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "transport/datagram"
+require_relative "transport/fifo"
 require_relative "transport/http"
 require_relative "transport/xmlrpc"
 

data/lib/opensips/mi/version.rb

@@ -2,6 +2,6 @@
 
 module Opensips
   module MI
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/opensips/mi.rb

@@ -8,14 +8,15 @@ module Opensips
   # OpenSIPS Managemen Interface core module
   module MI
     class Error < StandardError; end
+    class ErrorHTTPReq < Error; end
     class ErrorParams < Error; end
     class ErrorResolveTimeout < Error; end
     class ErrorSendTimeout < Error; end
-    class ErrorHTTPReq < Error; end
 
     def self.connect(transport_proto, params = {})
       transp = case transport_proto
                when :datagram then Transport::Datagram.new(params)
+               when :fifo then Transport::Fifo.new(params)
                when :http then Transport::HTTP.new(params)
                when :xmlrpc then Transport::Xmlrpc.new(params)
                else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensips-mi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stas Kobzar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xmlrpc
@@ -44,6 +44,7 @@ files:
 - lib/opensips/mi/transport.rb
 - lib/opensips/mi/transport/abstract.rb
 - lib/opensips/mi/transport/datagram.rb
+- lib/opensips/mi/transport/fifo.rb
 - lib/opensips/mi/transport/http.rb
 - lib/opensips/mi/transport/xmlrpc.rb
 - lib/opensips/mi/version.rb