opensips-mi 0.0.5 → 0.0.10

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWFhOGFlYTdhZTU4N2I1MDdjYzVkNDU4ZWE3MWM1MzgwOTJmNGYzMw==
-  data.tar.gz: !binary |-
-    ZjE5MWRkYmQ5MThiNGM4ZjdkY2QxYWMyYmMwMzc4ZjA4YjRjMDIyOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MDU0ODY2NGUwYTA4Y2RjM2M1NmJlMWRhNjJjZDcyMzgwNWM3OTdmMzZlOTcw
-    ODU3M2JiY2IwYTNkYjk2ODlmNDYwOWVhYWMzYWI3NDdjZTVjNDFjMzM5MTFm
-    YWM1NzMwYjkyZDUzMTY4NWQyYzM3Y2YzN2YzYzYwMGJjYWQzNjM=
-  data.tar.gz: !binary |-
-    Yzc5NWMzYjYwZjQ1NzJiMzA1NDYzMzU4OGU4ODQ5ODUyZGFkNmE0Y2Y0MGQ4
-    Y2Q1MDRlZWMyZmQ4YmFiZTkyM2ZlZTc3NjdmOGU3NjZiOTE3MmMyZTczYTM4
-    NDdhNWFjNmNlNmY4OWI3NmZjNjFjNWZlNTBlZWI3MWFmZWEzYzM=
+SHA256:
+  metadata.gz: 135298241a7da04c8011bdc51fd903c62b04dbfb05de49cce7610544fee9f274
+  data.tar.gz: 25a7bede110b7b35b121baddb04c2da6588d6fb8de3d9914cc84f6fd79041ef2
+SHA512:
+  metadata.gz: 273474a444d49d471180eb7051cd57dc34e1c8c21146429cb649fab1134c5b4c6f604c0762a3a97005c4f340c7c4d379e95a0e89935d7511a1f5c1654c7edbc6
+  data.tar.gz: 7aca0cdf36610f3f4db77864d215ec9b214acaebfcac25345e2f8042997614f62e44f47e8914f06717f0d1cb9186e62df391524a2ae5bcef7246f7c3adb278c4

data/.gitignore

@@ -7,6 +7,7 @@
 Gemfile*.lock
 .bundle
 .config
+.byebug_history
 coverage
 log
 InstalledFiles

data/.rspec

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

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.3.8

data/Gemfile

@@ -1,9 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-group :test do
-  gem 'coveralls', require: false
-  gem 'simplecov' #, :require => false
-  gem 'mocha'
-end
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'simplecov', require: false, group: :test
 
 gemspec

data/README.md

@@ -73,12 +73,14 @@ opensips = Opensips::MI.connect :fifo,
 require 'opensips/mi'
 opensips = Opensips::MI.connect :datagram, 
                                 :host => "sipproxy.com", 
-                                :port => 8809
+                                :port => 8809,
+                                :timeout => 5
 ```
 **Parameters hash:**
 
 * 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 3 seconds.
 
 ### XMLRPC
 ```ruby
@@ -141,6 +143,7 @@ There are several helper methods which return conveniently formatted data:
 * cache_fetch
 * ul_show_contact
 * dlg_list
+* ps
 
 See example files for details.
 

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/clean"
 require 'opensips/mi/version'
+require 'rspec/core/rake_task'
 
 require "rdoc/task"
 Rake::RDocTask.new do |rd|
@@ -10,11 +11,6 @@ Rake::RDocTask.new do |rd|
   rd.title = "OpenSIPs management interface " << Opensips::MI::VERSION
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  #test.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/opensips/mi/command.rb

@@ -26,9 +26,6 @@ module Opensips
 
       # Interface to mi methods direct call
       def method_missing(md, *params, &block)  
-        response = command 'which'
-        raise NoMethodError, 
-          "Method #{md} does not exists" unless response.rawdata.include?(md.to_s)
         response = command md.to_s, params
         # return special helper output if exists
         return response unless response.success
@@ -78,15 +75,15 @@ module Opensips
       #
       def uac_dlg method, ruri, hf, next_hop = ?., socket = ?., body = nil
         mandatory_hf = Array['To', 'From']
-        mandatory_hf += ['Content-Type', 'Content-Length'] unless body.nil?
+        mandatory_hf += ['Content-Type'] unless body.nil?
         mandatory_hf.map{|h|h.downcase}.each do |n|
           raise ArgumentError, 
             "Missing mandatory header #{n.capitalize}" unless hf.keys.map{|h| h.downcase}.include?(n)
         end
         # compile headers to string
         headers = hf.map{|name,val| name.eql?("nl") ? "" : "#{name}: #{val}"}.join "\r\n"
-        headers << "\r\n"
-        
+        headers << "\r\n\r\n"
+
         # set_header is a hack for xmlrpc which fails if headers are quoted
         params = [method, ruri, next_hop, socket, set_header(headers)]
         params << body unless body.nil?
@@ -122,7 +119,7 @@ module Opensips
         hf['To'] = "<#{uri}>" unless hf.keys.map{|k|k.downcase}.include?('to')
         hf['From'] = "<#{uri}>;tag=#{SecureRandom.hex}" unless hf.keys.map{|k|k.downcase}.include?('from')
         hf['Event'] = EVENTNOTIFY[event]
-        
+
         uac_dlg "NOTIFY", uri, hf
       end
 
@@ -151,7 +148,6 @@ module Opensips
           'Event'             => "message-summary",
           'Subscription-State'=> "active",
           'Content-Type'      => "application/simple-message-summary",
-          'Content-Length'    => mbody.map{|k,v| "#{k}: #{v}"}.join("\r\n").length,
           'nl'                => "",
         ]
 
@@ -172,7 +168,6 @@ module Opensips
             "Invalid port #{params[:port]}" unless (1..(2**16-1)).include?(params[:port])
           true
         end
-      
     end
   end
 end

data/lib/opensips/mi/response.rb

@@ -10,7 +10,7 @@ module Opensips
           '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
@@ -22,26 +22,34 @@ module Opensips
         @success = (200..299).include?(@code)
 
         # successfull responses have additional new line
-        data.pop if @success
         @rawdata = data
         @result = nil
       end
-      
+
       # Parse user locations records to Hash
       def ul_dump
-        return nil unless /^Domain:: location table=\d+ records=(\d+)$/ =~ @rawdata.shift
-        records = Hash.new
-        aor = ''
+        res = {}
+        aor = nil
+        contact = nil
+
         @rawdata.each do |r|
-          if /\tAOR:: (?<peer>.+)$/ =~ r
-            aor = peer
-            records[aor] = Hash.new
-          end
-          if /^\t{2,3}(?<key>[^:]+):: (?<val>.*)$/ =~ r
-            records[aor][key] = val if aor
+          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 = records
+
+        @result = res
         self
       end
 
@@ -73,24 +81,25 @@ module Opensips
         @result = OpenStruct.new res
         self
       end
-      
+
       # returns Array of registered contacts
       def ul_show_contact
-        res = Array.new
+        result = []
         @rawdata.each do |r|
-          cont = Hash.new
-          r.split(?;).each do |rec|
-            if /^Contact:: (.*)$/ =~ rec
-              cont[:contact] = $1
-            else
-              key,val = rec.split ?=
-              cont[key.to_sym] = val
-            end
+          _, 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
-          res << cont
+          result << res
         end
-        @result = res
-        self
+        @result = result
       end
 
       # returns hash of dialogs
@@ -124,19 +133,39 @@ module Opensips
         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
-         Hash[
-           @rawdata.map do |gw|
-             if /\AID::\s+(?<id>[^\s]+)\s+IP=(?<ip>[^:\s]+):?(?<port>\d+)?\s+Enabled=(?<status>yes|no)/ =~ gw
-               [id, {
-                 enabled: status.eql?('yes'),
-                 ipaddr: ip,
-                 port: port
-               }]
-             end
+         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

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

@@ -1,8 +1,11 @@
+require 'timeout'
+
 module Opensips
   module MI
     module Transport
       class Datagram < Opensips::MI::Command
         RECVMAXLEN = 2**16 - 1
+        TIMEOUT = 3
 
         class << self
           def init(params)
@@ -14,6 +17,7 @@ module Opensips
           host_valid? params
           @sock = UDPSocket.new
           @sock.connect params[:host], params[:port]
+          @timeout = params[:timeout].to_i
         end
 
         def command(cmd, params = [])
@@ -21,12 +25,20 @@ module Opensips
           params.each do |c|
             request << "#{c}\n"
           end
-          @sock.send request, 0
+          Timeout::timeout(tout, nil, "Timeout send request to datagram MI") {
+            @sock.send request, 0
+          }
           # will raise Errno::ECONNREFUSED if failed to connect
-          response, = @sock.recvfrom RECVMAXLEN
+          Timeout::timeout(tout,nil,"Timeout receive respond from datagram MI") {
+            response, = @sock.recvfrom RECVMAXLEN
+          }
           Opensips::MI::Response.new response.split(?\n)
         end
 
+        def tout
+          @timeout > 0 ? @timeout : TIMEOUT
+        end
+
       end
     end
   end

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

@@ -28,7 +28,7 @@ module Opensips
                           params[:reply_dir]
                         end
           raise ArgumentError,
-            "Fifo reply directory does not exists #{@reply_dir}" unless Dir.exists? @reply_dir 
+            "Fifo reply directory does not exists #{@reply_dir}" unless Dir.exist? @reply_dir 
 
           # fifo_name is required parameter
           raise ArgumentError, 
@@ -36,10 +36,10 @@ module Opensips
 
           @fifo_name      = params[:fifo_name]
           raise ArgumentError,
-            "OpenSIPs fifo_name file does not exist: #{@fifo_name}" unless File.exists? @fifo_name
+            "OpenSIPs fifo_name file does not exist: #{@fifo_name}" unless File.exist? @fifo_name
           raise ArgumentError,
             "File #{@fifo_name} is not pipe" unless File.pipe? @fifo_name
-          
+
           # set finalizing method
           reply_file = File.expand_path(@reply_fifo, @reply_dir) 
           ObjectSpace.define_finalizer(self, proc{self.class.finalize(reply_file)})
@@ -81,7 +81,7 @@ module Opensips
         end
 
         def self.finalize(reply_file)
-          File.unlink(reply_file) if File.exists?(reply_file)
+          File.unlink(reply_file) if File.exist?(reply_file)
         end
 
       end

data/lib/opensips/mi/version.rb

@@ -1,5 +1,5 @@
 module Opensips
   module MI
-    VERSION = "0.0.5"
+    VERSION = "0.0.10"
   end
 end

data/opensips-mi.gemspec

@@ -3,21 +3,23 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'opensips/mi/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "opensips-mi"
-  gem.version       = Opensips::MI::VERSION
-  gem.authors       = ["Stas Kobzar"]
-  gem.email         = ["stas@modulis.ca"]
-  gem.description   = %q{Ruby module for interacting with OpenSIPs management interface}
-  gem.summary       = %q{OpenSIPs management interface}
-  gem.homepage      = "http://github.com/staskobzar/opensips-mi"
+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"
 
-  gem.files         = `git ls-files`.split($/).reject{|f| %r|^examples/.*|.match f}
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  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"]
 
-  gem.add_development_dependency('bundler', '~> 1.3')
-  gem.add_development_dependency('rdoc')
-  gem.add_development_dependency('rake')
+  spec.add_dependency "xmlrpc", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~>2.2.5"
+  spec.add_development_dependency "rake", "~>13.0.3"
+  spec.add_development_dependency "rspec", "~>3.10.0"
 end

data/spec/command_spec.rb

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

data/spec/response_spec.rb

@@ -0,0 +1,117 @@
+include Opensips::MI
+
+describe Response do
+  it "must raise if parameter is not Array" do
+    expect {Response.new "foo"}.to raise_error InvalidResponseData
+  end
+
+  it "must raise if response data id empty array" do
+    expect {Response.new Array[]}.to raise_error EmptyResponseData
+  end
+
+  it "must raise if invalid response data" do
+    expect {Response.new(["invalid param","343",222])}.
+      to raise_error InvalidResponseData
+  end
+
+  it "must parse successfull response" do
+    resp = Response.new ["200 it is OK", "data", ""]
+    expect(resp.success).to be_truthy
+    expect(resp.code).to be(200)
+    expect(resp.message).to match("it is OK")
+  end
+
+  it "must parse unsuccessfull response" do
+    resp = Response.new ["500 command 'unknown' not available"]
+    expect(resp.success).to be_falsey
+    expect(resp.code).to be(500)
+    expect(resp.message).to match("command 'unknown' not available")
+  end
+
+  it "parse ul dump response" do
+    res = Response.new(fixture('ul_dump'))
+    ul = res.ul_dump
+    expect(ul.result["7962"]).not_to be_nil
+    expect(ul.result["7962"][0][:callid]).to match("5e7a1e47da91c41c")
+  end
+
+  it "process uptime response" do
+    res = Response.new [
+      "200 OK",
+      "Now:: Fri Apr 12 22:04:27 2013",
+      "Up since:: Thu Apr 11 21:43:01 2013",
+      "Up time:: 87686 [sec]",
+      ""
+    ]
+    resp = res.uptime
+    expect(resp.result.uptime).to be(87686)
+    expect(resp.result.since.thursday?).to be_truthy
+    expect(resp.result.since.hour).to be(21)
+    expect(resp.result.since.mon).to be(4)
+  end
+
+  it "must fetch cache value" do
+    res = Response.new [
+      "200 OK",
+      "userdid = [18005552211]",
+      ""
+    ]
+    resp= res.cache_fetch
+    expect(resp.result.userdid).to match("18005552211")
+  end
+
+  it "must return userloc contacts" do
+    contacts = ["200 OK",
+      "Contact:: <sip:7747@10.132.113.198>;q=;expires=100;flags=0x0;cflags=0x0;socket=<udp:10.130.8.21:5060>;methods=0x1F7F;user_agent=<PolycomSoundStationIP-SSIP_6000-UA/3.3.5.0247_0004f2f18103>",
+      "Contact:: <sip:7747@10.130.8.100;line=628f4ffdfa7316e>;q=;expires=3593;flags=0x0;cflags=0x0;socket=<udp:10.130.8.21:5060>;methods=0xFFFFFFFF;user_agent=<Linphone/3.5.2 (eXosip2/3.6.0)>",
+      ""]
+    response = Response.new contacts
+    res = response.ul_show_contact
+    expect(res.size).to be(2)
+    expect(res.first[:socket]).to match("<udp:10.130.8.21:5060>")
+    expect(res.last[:expires]).to match("3593")
+  end
+
+  it "must process dialogs list" do
+    response = Response.new fixture('dlg_list')
+    res = response.dlg_list.result
+    expect(res.size).to be(1)
+    expect(res["3212:2099935485"][:callid]).to match("1854719653")
+  end
+
+  it "must process dr_gw_status response in hash" do
+    gw_list = [
+      "200 OK",
+      "ID:: gw1 IP=212.182.133.202:5060 Enabled=no ",
+      "ID:: gw2 IP=213.15.222.97:5060 Enabled=yes",
+      "ID:: gw3 IP=200.182.132.201:5060 Enabled=yes",
+      "ID:: gw4 IP=200.182.135.204:5060 Enabled=yes",
+      "ID:: pstn1 IP=199.18.14.101:5060 Enabled=yes",
+      "ID:: pstn2 IP=199.18.14.102:5060 Enabled=no",
+      "ID:: pstn3 IP=199.18.12.103:5060 Enabled=yes",
+      "ID:: pstn4 IP=199.18.12.104:5060 Enabled=yes",
+      ""
+    ]
+    response = Response.new gw_list
+    drgws = response.dr_gw_status
+    expect(drgws.result.size).to be(8)
+    expect(drgws.result["pstn4"][:ipaddr]).to match("199.18.12.104")
+    expect(drgws.result["pstn3"][:port]).to match("5060")
+    expect(drgws.result["gw1"][:enabled]).to be_falsey
+    expect(drgws.result["gw4"][:enabled]).to be_truthy
+  end
+
+  it "must return raw data if dr_gw_status is run with arguments" do
+    gw = [ "200 OK", "Enabled:: yes", "" ]
+    response = Response.new gw
+    drgws = response.dr_gw_status
+    expect(drgws.enabled).to be_truthy
+  end
+
+  it "result must be empty if command send to dr_gw_status" do 
+    response = Response.new [ "200 OK", "" ]
+    drgws = response.dr_gw_status
+    expect(drgws.result).to be_nil
+    expect(drgws.success).to be_truthy
+  end
+end