opensips-mi 0.0.11 → 1.1.0

data/lib/opensips/mi/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Opensips
   module MI
-    VERSION = "0.0.11"
+    VERSION = "1.1.0"
   end
 end

data/lib/opensips/mi.rb

@@ -1,22 +1,28 @@
-require 'ostruct'
-require 'fcntl'
-require 'securerandom'
-require 'socketry'
-require 'xmlrpc/client'
+# frozen_string_literal: true
 
 require "opensips/mi/version"
-require "opensips/mi/response"
 require "opensips/mi/command"
 require "opensips/mi/transport"
 
 module Opensips
+  # OpenSIPS Managemen Interface core module
   module MI
-    def self.connect(transport, params)
-      # send to transport class
-      Transport.const_get(transport.to_s.capitalize).init params
-    rescue NameError
-      raise NameError, "Unknown transport method: " << transport.to_s
+    class Error < StandardError; end
+    class ErrorHTTPReq < Error; end
+    class ErrorParams < Error; end
+    class ErrorResolveTimeout < Error; end
+    class ErrorSendTimeout < 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
+                 raise Error, "Unknown transport method: #{transport_proto}"
+               end
+      Command.new(transp)
     end
   end
 end
-

data/lib/opensips.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require "opensips/mi"
 
+# Ruby module to connect OpenSIPS Management Interface
+# to send commands and read responses
 module Opensips
 end

data/sig/opensips/mi.rbs

@@ -0,0 +1,6 @@
+module Opensips
+  module Mi
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensips-mi
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 1.1.0
 platform: ruby
 authors:
 - Stas Kobzar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xmlrpc
@@ -24,72 +24,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: socketry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby module for interacting with OpenSIPs management interface
+description: Ruby module for interacting with OpenSIPs management interface. Supports
+  OpenSIPS v3+ MI with JSON-RPC protocol
 email:
 - staskobzar@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,23 +41,23 @@ files:
 - lib/opensips.rb
 - lib/opensips/mi.rb
 - lib/opensips/mi/command.rb
-- lib/opensips/mi/response.rb
 - 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
-- opensips-mi.gemspec
-- spec/command_spec.rb
-- spec/fixtures/dlg_list
-- spec/fixtures/ul_dump
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/transport_spec.rb
-homepage: http://github.com/staskobzar/opensips-mi
+- sig/opensips/mi.rbs
+homepage: https://github.com/staskobzar/opensips-mi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/staskobzar/opensips-mi
+  source_code_uri: https://github.com/staskobzar/opensips-mi
+  changelog_uri: https://github.com/staskobzar/opensips-mi/releases
+  github_repo: https://github.com/staskobzar/opensips-mi.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -122,21 +66,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
-summary: OpenSIPs management interface
-test_files:
-- spec/command_spec.rb
-- spec/fixtures/dlg_list
-- spec/fixtures/ul_dump
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/transport_spec.rb
+summary: Ruby OpenSIPs management interface
+test_files: []

data/.gitignore

@@ -1,30 +0,0 @@
-# Ignore temporary files
-.*swp
-*~
-
-*.gem
-*.rbc
-Gemfile*.lock
-.bundle
-.config
-.byebug_history
-coverage
-log
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-
-.DS_Store
-results.html
-html
-

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.3

data/lib/opensips/mi/response.rb

@@ -1,176 +0,0 @@
-module Opensips
-  module MI
-    class Response
-      attr_reader :code, :success, :message
-      attr_reader :rawdata # raw data array
-      attr_reader :result  # formatted data
-
-      def initialize(data)
-        raise InvalidResponseData, 
-          'Invalid parameter' unless data.is_a? Array
-        raise EmptyResponseData, 
-          'Empty parameter array' if data.empty?
-
-        if /^(?<code>\d+) (?<message>.+)$/ =~ data.shift.to_s
-          @code = code.to_i
-          @message = message
-        else
-          raise InvalidResponseData,
-            'Invalid response parameter. Can not parse'
-        end
-
-        @success = (200..299).include?(@code)
-
-        # successfull responses have additional new line
-        @rawdata = data
-        @result = nil
-      end
-
-      # Parse user locations records to Hash
-      def ul_dump
-        res = {}
-        aor = nil
-        contact = nil
-
-        @rawdata.each do |r|
-          next if r.start_with?("Domain")
-          r = r.strip
-          key, val = r.split(":: ")
-
-          if key == "AOR"
-            aor = val
-            res[aor] = []
-            next
-          elsif key == "Contact"
-            contact = {}
-            res[aor] << contact
-          end
-
-          contact[key.gsub(?-, ?_).downcase.to_sym] = val if key
-        end
-
-        @result = res
-        self
-      end
-
-      # returns struct
-      def uptime
-        res = Hash.new
-        @rawdata.each do |r|
-          next if /^Now::/ =~ r
-          if /^Up since:: [^\s]+ (?'mon'[^\s]+)\s+(?'d'\d+) (?'h'\d+):(?'m'\d+):(?'s'\d+) (?'y'\d+)/ =~ r
-            res[:since] = Time.local(y,mon,d,h,m,s)
-          end
-          if /^Up time:: (?'sec'\d+) / =~ r
-            res[:uptime] = sec.to_i
-          end
-        end
-        @result = OpenStruct.new res
-        self
-      end
-
-      # returns struct
-      def cache_fetch
-        res = Hash.new
-        @rawdata.each do |r|
-          if /^(?'label'[^=]+)=\s+\[(?'value'[^\]]+)\]/ =~ r
-            label.strip!
-            res[label.to_sym] = value
-          end
-        end
-        @result = OpenStruct.new res
-        self
-      end
-
-      # returns Array of registered contacts
-      def ul_show_contact
-        result = []
-        @rawdata.each do |r|
-          _, contact = r.strip.split("Contact:: ")
-          next unless contact
-
-          params = contact.split(';')
-
-          res = {contact: params.shift}
-
-          params.each do |p|
-            key, val = p.split('=')
-            res[key.gsub(?-, ?_).downcase.to_sym] = val
-          end
-          result << res
-        end
-        @result = result
-      end
-
-      # returns hash of dialogs
-      def dlg_list
-        # parse dialogs information into array
-        # assuming new block always starts with "dialog::  hash=..."
-        calls, key = Hash.new, nil
-        @rawdata.each do |l|
-          l.strip!
-          if l.match(/^dialog::\s+hash=(.*)$/)
-            key = $1
-            calls[key] = Hash.new
-            next
-          end
-          # building dialog array
-          if l.match(/^([^:]+)::\s+(.*)$/)
-            calls[key][$1.to_sym] = $2
-          end
-        end
-        @result = calls
-        self
-      end
-
-      def dr_gw_status
-        return self if @rawdata.empty?
-        if /\AEnabled::\s+(?<status>yes|no)/ =~ @rawdata[0]
-          self.class.send(:define_method, :enabled, proc{status.eql?('yes')})
-          return self
-        end
-        @result = dr_gws_hash
-        self
-      end
-
-      # returns array containing list of opensips processes
-      def ps
-        processes = []
-        @rawdata.each do |l|
-          l.slice! "Process::  "
-          h = {}
-
-          l.split(" ", 3).each do |x|
-            key, val = x.split("=", 2)
-            h[key.downcase.to_sym] = val
-          end
-
-          processes << OpenStruct.new(h)
-        end
-
-        @result = processes
-        self
-      end
-
-      private
-       def dr_gws_hash
-         return nil if @rawdata.empty?
-         res = {}
-         @rawdata.map do |gw|
-           if /\AID::\s+(?<id>[^\s]+)\s+IP=(?<ip>[^:\s]+):?(?<port>\d+)?\s+Enabled=(?<status>yes|no)/ =~ gw
-             res[id] = {
-               enabled: status.eql?('yes'),
-               ipaddr: ip,
-               port: port
-             }
-           end
-         end
-         res.empty? ? nil : res
-       end
-
-    end # END class
-
-    class InvalidResponseData < Exception;end
-    class EmptyResponseData < Exception;end
-  end
-end

data/opensips-mi.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'opensips/mi/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "opensips-mi"
-  spec.version       = Opensips::MI::VERSION
-  spec.licenses      = ['MIT']
-  spec.authors       = ["Stas Kobzar"]
-  spec.email         = ["staskobzar@gmail.com"]
-  spec.description   = %q{Ruby module for interacting with OpenSIPs management interface}
-  spec.summary       = %q{OpenSIPs management interface}
-  spec.homepage      = "http://github.com/staskobzar/opensips-mi"
-
-  spec.files         = `git ls-files`.split($/).reject{|f| %r|^examples/.*|.match f}
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "xmlrpc", "~> 0.3"
-  spec.add_dependency "socketry", "~> 0.5"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-end

data/spec/command_spec.rb

@@ -1,4 +0,0 @@
-include Opensips::MI
-
-describe Command do
-end

data/spec/fixtures/dlg_list

@@ -1,20 +0,0 @@
-200 OK
-dialog::  hash=3212:2099935485
-	state:: 4
-	user_flags:: 0
-	timestart:: 1365817158
-	timeout:: 1365824358
-	callid:: 1854719653
-	from_uri:: sip:7747@voip.etsmtl.ca
-	to_uri:: sip:95142842020@voip.etsmtl.ca
-	caller_tag:: 1614235294
-	caller_contact:: sip:7747@10.130.8.100
-	callee_cseq:: 0
-	caller_route_set:: 
-	caller_bind_addr:: udp:10.130.8.21:5060
-	callee_tag:: as2e60b080
-	callee_contact:: sip:95142842020@10.130.8.240:5060
-	caller_cseq:: 20
-	callee_route_set:: 
-	callee_bind_addr:: udp:10.130.8.21:5060
-

data/spec/fixtures/ul_dump

@@ -1,168 +0,0 @@
-200 OK
-Domain:: location table=512 records=15
-	AOR:: 7962
-		Contact:: sip:7962@10.164.112.13 Q=
-			Expires:: 143
-			Callid:: 5e7a1e47da91c41c
-			Cseq:: 31401
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7329
-		Contact:: sip:7329@10.132.113.171 Q=
-			Expires:: 95
-			Callid:: 504e5ee5baf3e7d8
-			Cseq:: 10412
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7863
-		Contact:: sip:7863@10.132.113.172 Q=
-			Expires:: 142
-			Callid:: d808729f9d47ec2d
-			Cseq:: 28091
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 3812
-		Contact:: sip:3812@10.132.113.163 Q=
-			Expires:: 58
-			Callid:: a59c4a46f79d7317
-			Cseq:: 19050
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 3810
-		Contact:: sip:3810@10.132.113.166 Q=
-			Expires:: 87
-			Callid:: dd38e788e386a79d
-			Cseq:: 18259
-			User-agent:: Avaya IP Phone 1140E (SIP1140e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7519
-		Contact:: sip:7519@10.132.113.174 Q=
-			Expires:: 63
-			Callid:: f0a2566a33a42295
-			Cseq:: 28149
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7259
-		Contact:: sip:7259@10.164.112.18 Q=
-			Expires:: 32
-			Callid:: 7f0d07e8c1415bbc
-			Cseq:: 32493
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7577
-		Contact:: sip:7577@10.132.113.178 Q=
-			Expires:: 159
-			Callid:: 5eca2b3d1062416b
-			Cseq:: 12767
-			User-agent:: Avaya IP Phone 1140E (SIP1140e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 3901
-		Contact:: sip:3901@10.132.113.160 Q=
-			Expires:: 132
-			Callid:: a57d709ba8c7d6d7
-			Cseq:: 27476
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7806
-		Contact:: sip:7806@10.132.113.175 Q=
-			Expires:: 132
-			Callid:: 0fb4baf2782a89b3
-			Cseq:: 23944
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7402
-		Contact:: sip:7402@10.132.113.168 Q=
-			Expires:: 47981
-			Callid:: ef8fa87d63302751
-			Cseq:: 13537
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 3822
-		Contact:: sip:3822@10.132.113.162 Q=
-			Expires:: 97
-			Callid:: f534f0b8d8a070e7
-			Cseq:: 50129
-			User-agent:: Avaya IP Phone 1220 (SIP12x0.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7641
-		Contact:: sip:7641@10.164.112.28 Q=
-			Expires:: 98
-			Callid:: df0f22a80302737a
-			Cseq:: 33571
-			User-agent:: Avaya IP Phone 1140E (SIP1140e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7423
-		Contact:: sip:7423@10.164.113.25 Q=
-			Expires:: 109
-			Callid:: ab10dabda2f0f257
-			Cseq:: 39074
-			User-agent:: Avaya IP Phone 1120E (SIP1120e.04.03.12.00)
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 7551
-	AOR:: 7747
-		Contact:: sip:7747@10.132.113.198 Q=
-			Expires:: 69
-			Callid:: 8c026d6f-9afd173e-c4d03305@10.132.113.198
-			Cseq:: 41286
-			User-agent:: PolycomSoundStationIP-SSIP_6000-UA/3.3.5.0247_0004f2f18103
-			State:: CS_SYNC
-			Flags:: 0
-			Cflag:: 0
-			Socket:: udp:10.130.8.21:5060
-			Methods:: 8063
-