opensips-mi 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf5f5bbbc6e55802390c34cfc14d9786a3a66cae096150d2bf7ae9f58ca3bc6
-  data.tar.gz: 2d2e16891fe1c6d0489c04df6a3ad03eb7971247f388cd19b29b456adb6cc34f
+  metadata.gz: 1956c21f6f508a1106aed87e99dbdc17925f529dc2d799554e6080a3ece2a23d
+  data.tar.gz: 0f2e9e1dbc906f5ed4fc92dd6cae377e1fd1e0d38866d66318258465832a9b54
 SHA512:
-  metadata.gz: a31f00548de585c638296aa97b8fe4889c6d5d85deb7afe83be364a555941b476836f73d053516e05add7d8999f75fc0027a2008adbcdf1e8b2e57c12ae9fad1
-  data.tar.gz: '028af90298a552a3bfff6054de1543acb519aeb846e78074e28b5c638d539a48734ef38eab3eb0cb2374e3b5f59167b655f7c32fa16b198cffff68c91c7fb689'
+  metadata.gz: 3c23130f92a3209b265ffe553fde481ae9c70897b1b13c31514358bdbfc6ed2329455ec3826fa4e99627498cd2a820a05a1e18c1ce51e22f4bb54b60e0c729e0
+  data.tar.gz: 5fa13a5dc0c8652625e1c1e14b740e816a8cdec36a2a32b50c688ffb8f642c4d92578a39a15da0d4e23a8dda6b152d669e65e5945fdd78fe862990a33f04fea6

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,10 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-group :test do
-  gem 'minitest'
-  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/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

@@ -83,7 +83,7 @@ module Opensips
         # compile headers to string
         headers = hf.map{|name,val| name.eql?("nl") ? "" : "#{name}: #{val}"}.join "\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?
@@ -119,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
 
@@ -168,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

@@ -84,28 +84,22 @@ module Opensips
 
       # returns Array of registered contacts
       def ul_show_contact
-        res = {}
-        aor = nil
-        contact = nil
-
+        result = []
         @rawdata.each do |r|
-          r = r.strip
-          key, val = r.split(":: ")
+          _, contact = r.strip.split("Contact:: ")
+          next unless contact
 
-          if key == "AOR"
-            aor = val
-            res[aor] = []
-            next
-          elsif key == "Contact"
-            contact = {}
-            res[aor] << contact if res[aor]
-          end
+          params = contact.split(';')
 
-          contact[key.gsub(?-, ?_).downcase.to_sym] = val if key
-        end
+          res = {contact: params.shift}
 
-        @result = res
-        self
+          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
@@ -146,7 +140,7 @@ module Opensips
           l.slice! "Process::  "
           h = {}
 
-          l.split(" ", 3).each do |x| 
+          l.split(" ", 3).each do |x|
             key, val = x.split("=", 2)
             h[key.downcase.to_sym] = val
           end
@@ -160,17 +154,18 @@ module Opensips
 
       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/version.rb

@@ -1,5 +1,5 @@
 module Opensips
   module MI
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   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.authors       = ["Stas Kobzar"]
+  spec.email         = ["stas@modulis.ca"]
+  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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency('rdoc')
 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

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+
+require 'simplecov'
+SimpleCov.start
+
+require 'opensips/mi'
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+def fixture(name)
+  path = File.expand_path('fixtures', File.dirname(__FILE__))
+  file = File.expand_path(name, path)
+  File.readlines(file).map{|l| l.chomp}
+end
+

data/spec/transport_spec.rb

@@ -0,0 +1,102 @@
+include Opensips::MI
+
+describe Transport do
+  context "fifo" do
+    it "must raise when using unknown transport method" do
+      expect {
+        Opensips::MI.connect(:unknown_transport_method,{})
+      }.to raise_error NameError
+    end
+
+    it "must raise when no fifo_nameInstanceOf.new parameter passed" do
+      expect {
+        Opensips::MI.connect :fifo, {}
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise when fifo_name file not exists" do
+      allow(File).to receive(:exists?).and_return(false)
+      expect {
+        Opensips::MI.connect :fifo, :fifo_name => '/file/not/exists'
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise when fifo_name file is not pipe" do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:pipe?).and_return(false)
+      expect {
+        Opensips::MI.connect :fifo, :fifo_name => '/tmp/opensips_fifo'
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise if fifo reply directory not exists" do
+      allow(Dir).to receive(:exists?).and_return(false)
+      expect {
+        Opensips::MI.connect :fifo, :fifo_name => '/tmp/opensips_fifo',
+        :reply_dir => '/tmp'
+      }.to raise_error ArgumentError
+    end
+  end
+
+  context "datagram" do
+    it "must raise if empty host" do
+      expect {
+        Opensips::MI.connect :datagram, {}
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise if empty port" do
+      expect {
+        Opensips::MI.connect :datagram, {:host => "10.10.10.10"}
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise if invalid host" do
+      host = "256.0.0.300"
+      expect {
+        Opensips::MI.connect :datagram, {:host => host, :port => 8088}
+      }.to raise_error(SocketError, /#{host}/)
+    end
+
+    it "must raise if invalid port" do
+      expect {
+        Opensips::MI.connect :datagram, {:host => "10.0.0.1", :port => (2**16 + 1)}
+      }.to raise_error SocketError
+
+      expect {
+        Opensips::MI.connect :datagram, {:host => "10.0.0.1", :port => 0}
+      }.to raise_error SocketError
+    end
+  end
+
+  context "datagram" do
+    it "must raise if empty host" do
+      expect {
+        Opensips::MI.connect :xmlrpc, {}
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise if empty port" do
+      expect {
+        Opensips::MI.connect :xmlrpc, {:host => "10.10.10.10"}
+      }.to raise_error ArgumentError
+    end
+
+    it "must raise if invalid host" do
+      host = "256.0.0.300"
+      expect {
+        Opensips::MI.connect :xmlrpc, {:host => host, :port => 8088}
+      }.to raise_error(SocketError, /#{host}/)
+    end
+
+    it "must raise if invalid port" do
+      expect {
+        Opensips::MI.connect :xmlrpc, {:host => "10.0.0.1", :port => (2**16 + 1)}
+      }.to raise_error SocketError
+
+      expect {
+        Opensips::MI.connect :xmlrpc, {:host => "10.0.0.1", :port => 0}
+      }.to raise_error SocketError
+    end
+  end
+end

metadata

@@ -1,45 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: opensips-mi
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Stas Kobzar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmlrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -60,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -75,13 +104,12 @@ files:
 - lib/opensips/mi/transport/xmlrpc.rb
 - lib/opensips/mi/version.rb
 - opensips-mi.gemspec
-- test/fifo/.keep
-- test/fixtures/dlg_list
-- test/fixtures/ul_dump
-- test/helper.rb
-- test/test_command.rb
-- test/test_response.rb
-- test/test_transport.rb
+- 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
 licenses: []
 metadata: {}
@@ -101,15 +129,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: OpenSIPs management interface
 test_files:
-- test/fifo/.keep
-- test/fixtures/dlg_list
-- test/fixtures/ul_dump
-- test/helper.rb
-- test/test_command.rb
-- test/test_response.rb
-- test/test_transport.rb
+- spec/command_spec.rb
+- spec/fixtures/dlg_list
+- spec/fixtures/ul_dump
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/transport_spec.rb

data/test/helper.rb

@@ -1,85 +0,0 @@
-require 'simplecov'
-require 'coveralls'
-Coveralls.wear!
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start 
-
-require 'minitest/autorun'
-require 'mocha/setup'
-require 'stringio'
-require 'opensips/mi'
-
-def init_class_fifo
-  Dir.stubs(:exists?).once.returns(true)
-  File.stubs(:exists?).once.returns(true)
-  File.stubs(:pipe?).once.returns(true)
-  directory = File.expand_path 'test/fifo', Dir.pwd
-  fifo_name = File.expand_path 'test/fifo/opensips_fifo', Dir.pwd
-  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_dr_gw_status_cmd
-  Array[
-    "200 OK",
-    ""
-  ]
-end
-
-def response_dr_gw_status_single
-  Array[
-    "200 OK",
-    "Enabled:: yes",
-    ""
-  ]
-end
-
-def response_dr_gw_status_list
-  Array[
-    "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",
-    ""
-  ]
-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

data/test/test_command.rb

@@ -1,97 +0,0 @@
-require 'helper'
-include Opensips::MI
-
-describe Command, "commands for transport classes" do
-  before do
-  end
-
-  after do
-  end
-
-  describe "missing methods" do
-
-    it "must send command" do
-      mi = init_class_fifo
-      mi.expects(:command).with('ul_sync',[]).returns(Opensips::MI::Response.new(["200 OK",""]))
-      mi.ul_sync.code.must_equal 200
-    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 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\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', 
-                                  '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

@@ -1,124 +0,0 @@
-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
-
-    it "must process dr_gw_status response in hash" do
-      response = Response.new response_dr_gw_status_list
-      drgws = response.dr_gw_status
-      drgws.result.size.must_equal 8
-      drgws.result["pstn4"][:ipaddr].must_equal "199.18.12.104"
-      drgws.result["pstn3"][:port].must_equal "5060"
-      drgws.result["gw1"][:enabled].must_equal false
-      drgws.result["gw4"][:enabled].must_equal true
-    end
-
-    it "must return raw data if dr_gw_status is run with arguments" do
-      response = Response.new response_dr_gw_status_single
-      drgws = response.dr_gw_status
-      drgws.enabled.must_equal true
-    end
-
-    it "result must be empty if command send to dr_gw_status" do 
-      response = Response.new response_dr_gw_status_cmd
-      drgws = response.dr_gw_status
-      drgws.result.must_equal nil
-      drgws.success.must_equal true
-    end
-  end
-
-end

data/test/test_transport.rb

@@ -1,209 +0,0 @@
-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
-
-    it "must send valid command to socket" do
-      cmd = 'command'
-      params = ["aaa","bbb","ccc"]
-
-      sock = mock('UDPSocket')
-      sock.stubs(:connect)
-      sock.stubs(:send).with([":#{cmd}:", *params].join(?\n) + ?\n, 0)
-      sock.stubs(:recvfrom).returns( response_data_cmd_which )
-      UDPSocket.expects(:new).returns(sock)
-      res = Opensips::MI.connect :datagram, 
-                                 :host => "192.168.122.128", 
-                                 :port => 8809
-      res.command(cmd, params).code.must_equal 200
-    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
-      rpc = mock('XMLRPC::Client')
-      rpc.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
-      
-      params = ["aaa","bbb"]
-      cmd    = "command"
-      rpc.stubs(:call).with(cmd, *params).returns( response_data_cmd_which )
-      res.command(cmd, params) #.must_be_instance_of Opensips::MI::Response
-    end
-
-  end
-
-end