RubyGems - opensips-mi - Versions diffs - 0.0.1 - Mend

opensips-mi 0.0.1

Files changed (24) hide show

checksums.yaml +15 -0
data/.gitignore +28 -0
data/.travis.yml +3 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +275 -0
data/Rakefile +20 -0
data/lib/opensips.rb +4 -0
data/lib/opensips/mi.rb +23 -0
data/lib/opensips/mi/command.rb +167 -0
data/lib/opensips/mi/response.rb +122 -0
data/lib/opensips/mi/transport.rb +10 -0
data/lib/opensips/mi/transport/datagram.rb +40 -0
data/lib/opensips/mi/transport/fifo.rb +90 -0
data/lib/opensips/mi/transport/xmlrpc.rb +43 -0
data/lib/opensips/mi/version.rb +5 -0
data/opensips-mi.gemspec +24 -0
data/test/fixtures/dlg_list +20 -0
data/test/fixtures/ul_dump +168 -0
data/test/helper.rb +53 -0
data/test/test_command.rb +110 -0
data/test/test_response.rb +101 -0
data/test/test_transport.rb +187 -0
metadata +127 -0

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'stringio'
+require 'opensips/mi'
+require 'pp'
+class MiniTest::Unit::TestCase
+  def init_class_fifo
+    Dir.stubs(:exists?).once.returns(true)
+    File.stubs(:exists?).once.returns(true)
+    File.stubs(:pipe?).once.returns(true)
+    directory = '/tmp/opensips/fifo'
+    fifo_name = '/tmp/opensips_fifo'
+    replayfifo= 'fifo_reply_file_name'
+    Opensips::MI::Transport::Fifo.new  :fifo_name  => fifo_name,
+                                       :reply_dir  => directory,
+                                       :reply_fifo => replayfifo
+  end
+  def response_data_cmd_which
+    Array[
+      "200 OK", "get_statistics", "reset_statistics", "uptime", "version",
+      "pwd", "arg", "which", "ps", "kill", "debug", "cache_store",
+      "cache_fetch", "cache_remove", "event_subscribe", "help", "list_blacklists",
+      "t_uac_dlg", "t_uac_cancel", "t_hash", "t_reply", "ul_rm", "ul_rm_contact",
+      "ul_dump", "ul_flush", "ul_add", "ul_show_contact", "ul_sync", ""
+    ]
+  end
+  def response_uldump
+    fix = File.expand_path('fixtures/ul_dump',File.dirname(__FILE__))
+    File.readlines(fix).map{|l| l.chomp}
+  end
+  def response_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)>",
+      "",
+    ]
+  end
+  def response_dlg_list
+    fix = File.expand_path('fixtures/dlg_list',File.dirname(__FILE__))
+    File.readlines(fix).map{|l| l.chomp}
+  end
+end

data/test/test_command.rb ADDED Viewed

@@ -0,0 +1,110 @@
+require 'helper'
+include Opensips::MI
+describe Command, "commands for transport classes" do
+  before do
+  end
+  after do
+  end
+  describe "missing methods" do
+    it "must raise if parameter is not Array" do
+      mi = init_class_fifo
+      mi.expects(:command).with('which').returns(mock(:rawdata => ['meth1', 'meth2']))
+      proc {
+        mi.unknown_command
+      }.must_raise NoMethodError
+    end
+    it "must raise when missing basic mandatory headers" do
+      mi = init_class_fifo
+      ret = proc {
+        mi.uac_dlg  "NOTIFY",
+                    "sip:alice@wanderland.com",
+                    {"From" => "<sip:opensips@sipproxy.com>"}
+      }.must_raise ArgumentError
+      ret.message.must_match(/header To/)
+    end
+    it "must raise when missing body mandatory headers" do
+      mi = init_class_fifo
+      ret = proc {
+        mi.uac_dlg  "NOTIFY",
+                    "sip:alice@wanderland.com",
+                    {"From" => "<sip:opensips>", "To" => "<sip:bob>", "content-type" => "xml"},
+                    ?., ?., "<body>Hello</body>"
+      }.must_raise ArgumentError
+      ret.message.must_match(/header Content-length/)
+    end
+    it "must have good parameters" do
+      mi = init_class_fifo
+      mi.expects(:command).with('t_uac_dlg', [
+                                "NOTIFY",
+                                "sip:alice@wanderland.com",
+                                ".",
+                                ".",
+                                %Q/"From: <sip:opensips@sipproxy.com>\r\nTo: <sip:alice@wanderland.com>\r\n"/
+                               ])
+      mi.uac_dlg  "NOTIFY",
+                  "sip:alice@wanderland.com",
+                  {
+                    "From"  => "<sip:opensips@sipproxy.com>",
+                    "To"    => "<sip:alice@wanderland.com>"
+                  }
+    end
+    it "must raise when invalid event" do
+      mi = init_class_fifo
+      event = :unknown_event
+      res = proc {
+        mi.event_notify "sip:alice@proxy.com", event
+      }.must_raise ArgumentError
+      res.message.must_match(/#{event.to_s}/)
+    end
+    it "must send notify event" do
+      mi = init_class_fifo
+      tag = "123456"
+      uri = "sip:alice@wanderland.com"
+      SecureRandom.stubs(:hex).returns(tag)
+      mi.expects(:uac_dlg).with("NOTIFY",
+                                uri,
+                                {
+                                  "To"    => "<#{uri}>",
+                                  "From"  => "<#{uri}>;tag=#{tag}",
+                                  "Event" => "check-sync"
+                                }
+                               )
+      mi.event_notify uri, :polycom_check_cfg
+    end
+    it "must send MWI notify" do
+      mi = init_class_fifo
+      tag = "123456"
+      uri = "sip:alice@wanderland.com"
+      new_vm = 5
+      old_vm = 3
+      SecureRandom.stubs(:hex).returns(tag)
+      mi.expects(:uac_dlg).with("NOTIFY",
+                                uri,
+                                {
+                                  'To' => "<#{uri}>",
+                                  'From' => "<#{uri}>;tag=#{tag}",
+                                  'Event' => 'message-summary',
+                                  'Subscription-State' => 'active',
+                                  'Content-Type' => 'application/simple-message-summary',
+                                  'Content-Length' => 86,
+                                  'nl' => '',
+                                  'Messages-Waiting' => 'yes',
+                                  'Message-Account' => 'sip:*97@asterisk.com',
+                                  'Voice-Message' => "#{new_vm}/#{old_vm} (0/0)"
+                                })
+      mi.mwi_update uri, 'sip:*97@asterisk.com', new_vm, old_vm
+    end
+  end
+end

data/test/test_response.rb ADDED Viewed

@@ -0,0 +1,101 @@
+require 'helper'
+include Opensips::MI
+describe Response, "response class" do
+  before do
+    @which = response_data_cmd_which
+    @data_ok  = ["200 it is OK", "data", ""]
+    @data_nok = ["500 command 'unknown' not available"]
+  end
+  after do
+  end
+  describe "processing response" do
+    it "must raise if parameter is not Array" do
+      proc {
+        Response.new "String"
+      }.must_raise InvalidResponseData
+    end
+    it "must raise if response data id empty array" do
+      proc {
+        Response.new Array[]
+      }.must_raise EmptyResponseData
+    end
+    it "must return Response class" do
+      r = Response.new(@data_ok)
+      r.must_be_instance_of Response
+    end
+    it "must raise if invalid response data" do
+      proc {
+        Response.new(["invalid param","343",222])
+      }.must_raise InvalidResponseData
+    end
+    it "must parse successfull response" do
+      r = Response.new(@data_ok)
+      r.success.must_equal true
+      r.code.must_equal 200
+      r.message.must_equal "it is OK"
+    end
+    it "must parse unsuccessfull response" do
+      r = Response.new(@data_nok)
+      r.success.must_equal false
+      r.code.must_equal 500
+      r.message.must_equal "command 'unknown' not available"
+    end
+    it "parse ul dump response" do
+      res = Response.new(response_uldump)
+      ul = res.ul_dump
+      ul.result["7962"].wont_equal nil
+      ul.result["7962"]['Callid'].must_equal "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]",
+        ""
+      ]
+      response = res.uptime
+      response.result.uptime.must_equal 87686
+      response.result.since.thursday?.must_equal true
+      response.result.since.hour.must_equal 21
+      response.result.since.mon.must_equal 4
+    end
+    it "must fetch cache value" do
+      res = Response.new [
+        "200 OK",
+        "userdid = [18005552211]",
+        ""
+      ]
+      response = res.cache_fetch
+      response.result.userdid.must_equal "18005552211"
+    end
+    it "must return userloc contacts" do
+      response = Response.new response_contacts
+      res = response.ul_show_contact.result
+      res.must_be_instance_of Array
+      res.size.must_equal 2
+      res.first[:socket].must_equal "<udp:10.130.8.21:5060>"
+      res.last[:expires].must_equal "3593"
+    end
+    it "must process dialogs list" do
+      response = Response.new response_dlg_list
+      res = response.dlg_list.result
+      res.size.must_equal 1
+      res["3212:2099935485"][:callid].must_equal "1854719653"
+    end
+  end
+end

data/test/test_transport.rb ADDED Viewed

@@ -0,0 +1,187 @@
+require 'helper'
+describe Opensips::MI::Transport, "testing MI transport layers" do
+  before do
+    @fifo_params = {:fifo_name => '/tmp/opensips_fifo'}
+  end
+  after do
+  end
+  # Fifo
+  describe "test fifo transport layer" do
+    it "must retrun fifo class instance" do
+      File.stubs(:exists?).once.returns(true)
+      File.stubs(:pipe?).twice.returns(true)
+      Kernel.stubs(:system).returns(true)
+      Opensips::MI.connect(:fifo,@fifo_params).must_be_instance_of Opensips::MI::Transport::Fifo
+    end
+    it "must raise when using unknown transport method" do
+      proc {
+        Opensips::MI.connect(:unknown_transport_method,{})
+      }.must_raise NameError
+    end
+    it "must raise when no fifo_nameInstanceOf.new parameter passed" do
+      proc {
+        Opensips::MI.connect :fifo, {}
+      }.must_raise ArgumentError
+    end
+    it "must raise when fifo_name file not exists" do
+      File.stubs(:exists?).once.returns(false)
+      proc {
+        Opensips::MI.connect :fifo, :fifo_name => '/file/not/exists'
+      }.must_raise ArgumentError
+    end
+    it "must raise when fifo_name file is not pipe" do
+      File.stubs(:exists?).once.returns(true)
+      File.stubs(:pipe?).once.returns(false)
+      proc {
+        Opensips::MI.connect :fifo, :fifo_name => '/tmp/opensips_fifo'
+      }.must_raise ArgumentError
+    end
+    it "must raise if fifo reply directory not exists" do
+      Dir.stubs(:exists?).once.returns false
+      proc {
+        Opensips::MI.connect :fifo, :fifo_name => '/tmp/opensips_fifo',
+                                    :reply_dir => '/tmp'
+      }.must_raise ArgumentError
+    end
+    it "must set attributes for class instance" do
+      Dir.stubs(:exists?).once.returns(true)
+      File.stubs(:exists?).once.returns(true)
+      File.stubs(:pipe?).once.returns(true)
+      directory = '/tmp/opensips/fifo'
+      fifo_name = '/tmp/opensips_fifo'
+      replayfifo= 'fifo_reply_file_name'
+      fifo = Opensips::MI::Transport::Fifo.new  :fifo_name  => fifo_name,
+                                                :reply_dir  => directory,
+                                                :reply_fifo => replayfifo
+      fifo.reply_dir.must_equal directory
+      fifo.fifo_name.must_equal fifo_name
+      fifo.reply_dir.must_equal directory
+    end
+    it "must create temporary fifo reply file" do
+      fifo = init_class_fifo
+      Kernel.stubs(:system).returns(true)
+      File.stubs(:pipe?).returns(true)
+      fifo.open
+    end
+    it "must raise if can not create reply fifo" do
+      fifo = init_class_fifo
+      Kernel.stubs(:system).returns(true)
+      File.stubs(:pipe?).returns(false)
+      proc { fifo.open }.must_raise SystemCallError
+    end
+    it "must send command to fifo" do
+      File.stubs(:exists?).returns(true)
+      File.stubs(:pipe?).returns(true)
+      IO.stubs(:sysopen).returns(5)
+      io_obj = mock()
+      io_obj.expects(:close).twice()
+      io_obj.expects(:syswrite)
+      io_obj.expects(:gets).returns(nil)
+      IO.stubs(:open).twice().returns(io_obj)
+      Opensips::MI::Response.expects(:new).returns(true)
+      fifo = Opensips::MI.connect(:fifo,@fifo_params)
+      fifo.command('which')
+    end
+  end
+  # Datagram
+  describe "test datagram transport layer" do
+    it "must raise if empty host" do
+      proc {
+        Opensips::MI.connect :datagram, {}
+      }.must_raise ArgumentError
+    end
+    it "must raise if empty port" do
+      proc {
+        Opensips::MI.connect :datagram, {:host => "10.10.10.10"}
+      }.must_raise ArgumentError
+    end
+    it "must raise if invalid host" do
+      host = "256.0.0.300"
+      res = proc {
+        Opensips::MI.connect :datagram, {:host => host, :port => 8088}
+      }.must_raise SocketError
+      res.message.must_match(/#{host}/)
+    end
+    it "must raise if invalid port" do
+      proc {
+        Opensips::MI.connect :datagram, {:host => "10.0.0.1", :port => (2**16 + 1)}
+      }.must_raise SocketError
+      proc {
+        Opensips::MI.connect :datagram, {:host => "10.0.0.1", :port => 0}
+      }.must_raise SocketError
+    end
+    it "must connect to socket" do
+      UDPSocket.expects(:new).returns(mock(:connect => true))
+      res = Opensips::MI.connect :datagram,
+                                 :host => "192.168.122.128",
+                                 :port => 8809
+      res.respond_to?(:uac_dlg).must_equal true
+    end
+  end
+  # XMLRPC
+  describe "test xmlrpc transport layer" do
+    it "must raise if empty host" do
+      proc {
+        Opensips::MI.connect :xmlrpc, {}
+      }.must_raise ArgumentError
+    end
+    it "must raise if empty port" do
+      proc {
+        Opensips::MI.connect :xmlrpc, {:host => "10.10.10.10"}
+      }.must_raise ArgumentError
+    end
+    it "must raise if invalid host" do
+      host = "256.0.0.300"
+      res = proc {
+        Opensips::MI.connect :xmlrpc, {:host => host, :port => 8088}
+      }.must_raise SocketError
+      res.message.must_match(/#{host}/)
+    end
+    it "must raise if invalid port" do
+      proc {
+        Opensips::MI.connect :xmlrpc, {:host => "10.0.0.1", :port => (2**16 + 1)}
+      }.must_raise SocketError
+      proc {
+        Opensips::MI.connect :xmlrpc, {:host => "10.0.0.1", :port => 0}
+      }.must_raise SocketError
+    end
+    it "must connect to xmlrpc server" do
+      host = "192.168.122.128"
+      port = 8080
+      XMLRPC::Client.stubs(:new_from_uri).
+        with("http://#{host}:#{port}/#{Opensips::MI::Transport::Xmlrpc::RPCSEG}",nil,3)
+      res = Opensips::MI.connect :xmlrpc,
+                                 :host => host,
+                                 :port => port
+      res.respond_to?(:uac_dlg).must_equal true
+    end
+  end
+end