opensips-mi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZThhYmE0OGQxNWQ4ZTg2MGI0OWU3YTA2NmE1MjllZDJmYjU0YjIyYQ==
+    MzI1MTJhNjhmOGRmNTc2OGExN2JmZDcwMjI0YjFlODM2OGQ3M2UzYg==
   data.tar.gz: !binary |-
-    MTQ4ZTAyYzViMWE2OGI3YmYzMTRhN2Y4Y2RhYWE3YWFmOTczMTc5Yw==
+    OWMzMmJkYjc4ZTA2YmRjMjZmMDY5YTJmZGQ5Zjk3OWVkMzY3NTA5Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWJmODcxMzQyNWM4MmEwNmYzOTkwYzg0MGI3NTJjY2JkZmE5MzZlYjA3OTNi
-    NmU1YWI0Yjg0NmNlZDI1MmM4NDRjODFhNTRjNTExZDRmYTA0NmEwYjc3YzRi
-    MjljMDJkOWJiZTJlZWI3MzMzYjY1ZTc3NDNlNTk5MjUzYmE2YjM=
+    MWIxZWYyZjRlNDAxZjBiMjg2YjFkM2M5ZmIzOGE2N2E1YzJlNjUwNjQ2Y2Y3
+    NzcyN2I1OTBiNGJlOTdjZWFhYWJjNTBhZjVkYjY1OTM5ZGU0Njk5YzMyMDVi
+    OTc1Yzk4YmZmODJmNTg0NDE2ZGRjYThhODE4ZmUyYmYzNGNhYjE=
   data.tar.gz: !binary |-
-    ZjUwNzE0ZTU2ODJjMTgwMTQ3NzgwZjgyODM5NjA3MWU4MjZjMjUyZGU4MjBk
-    ZmFlYjZkYmRkMjFkYTdhYmE4YWJmYzYzMzMyNGZhOTE1ZmMzYTllNDgzNzBl
-    YTc5MGY4MmIyZTlhNGVmNGU1NzhlZWE0M2VkYjI5ZDY2ZTkyNDg=
+    YzVjNzQ2OGU1MWU0MzQ4MWE4YmMyMTIxNmM5ZjNmNGRjMDI4NmUxNjBmNzM1
+    MjhkNWNkNjA1NmI2OWM3ZTI3NTJlMWIzNGQ5Nzk2ZWM5ZDIxMDc5ZDQ3MjBh
+    ODRmMWIzMGZkM2M4ZGRlNjFkNGM3OTU5ZmZmNmJmMDM4ZDg1ZGY=

data/.gitignore

@@ -8,6 +8,7 @@ Gemfile*.lock
 .bundle
 .config
 coverage
+log
 InstalledFiles
 lib/bundler/man
 pkg

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
-gemspec
 
+group :test do
+  gem 'coveralls', require: false
+  gem 'simplecov' #, :require => false
+  gem 'mocha'
+end
 
+gemspec

data/README.md

@@ -2,6 +2,7 @@
 [![Build Status](https://travis-ci.org/staskobzar/opensips-mi.png?branch=master)](https://travis-ci.org/staskobzar/opensips-mi)
 [![Code Climate](https://codeclimate.com/github/staskobzar/opensips-mi.png)](https://codeclimate.com/github/staskobzar/opensips-mi)
 [![Gem Version](https://badge.fury.io/rb/opensips-mi.png)](http://badge.fury.io/rb/opensips-mi)
+[![Coverage Status](https://coveralls.io/repos/staskobzar/opensips-mi/badge.png?branch=master)](https://coveralls.io/r/staskobzar/opensips-mi)
 
 OpenSIPs management interface library. 
 This library supports following management interfaces OpenSIPs modules:
@@ -26,11 +27,11 @@ Or install it yourself as:
 
 ## Connecting management interfaces
 
-### Generic connection interface
+### Generic function to connect mi
 
 Using generic function to connect management interface:
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 Opensips::MI.connect INTERFACE, PARAMS
 ```
 Parameters:
@@ -53,7 +54,7 @@ Function returns instance of one of the following classes:
 ### FIFO
 
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 opensips = Opensips::MI.connect :fifo, 
                                 :fifo_name => '/tmp/opensips_fifo',
                                 :reply_fifo => 'opensips_reply' . $$,
@@ -69,7 +70,7 @@ opensips = Opensips::MI.connect :fifo,
 
 ### Datagram
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 opensips = Opensips::MI.connect :datagram, 
                                 :host => "sipproxy.com", 
                                 :port => 8809
@@ -81,7 +82,7 @@ opensips = Opensips::MI.connect :datagram,
 
 ### XMLRPC
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 opensips = Opensips::MI.connect :xmlrpc, 
                                 :host => "192.168.2.133", 
                                 :port => 8080
@@ -98,7 +99,7 @@ Command parameters' description can be found in module documentation. For exampl
 Usage example:
 
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 opensips = Opensips::MI.connect :fifo, 
                                 :fifo_name => '/tmp/opensips_fifo'
                                 
@@ -110,7 +111,7 @@ opensips.command('get_statistics', 'dialog','tm')
 
 It is also possible to use command names as a method interface:
 ```ruby
-require 'opensips-mi'
+require 'opensips/mi'
 opensips = Opensips::MI.connect :datagram, 
                                 :host => "192.168.122.128", 
                                 :port => 8809

data/lib/opensips/mi.rb

@@ -12,10 +12,9 @@ require "opensips/mi/transport"
 module Opensips
   module MI
     def self.connect(transport, params)
-      class_name = transport.to_s.capitalize
       # send to transport class
-      Transport.const_get(class_name).init params
-    rescue NameError => e
+      Transport.const_get(transport.to_s.capitalize).init params
+    rescue NameError
       raise NameError, "Unknown transport method: " << transport.to_s
     end
   end

data/lib/opensips/mi/response.rb

@@ -114,7 +114,32 @@ module Opensips
         self
       end
 
-    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
+
+      private
+       def dr_gws_hash
+         Hash[
+           @rawdata.map do |gw|
+             if /\AID::\s+(?<id>[^\s]+)\s+IP=(?<ip>[^:]+):(?<port>\d+)\s+Enabled=(?<status>yes|no)/ =~ gw
+               [id, {
+                 enabled: status.eql?('yes'),
+                 ipaddr: ip,
+                 port: port
+               }]
+             end
+           end
+         ]
+       end
+
+    end # END class
 
     class InvalidResponseData < Exception;end
     class EmptyResponseData < Exception;end

data/lib/opensips/mi/version.rb

@@ -1,5 +1,5 @@
 module Opensips
   module MI
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/opensips-mi.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('bundler', '~> 1.3')
   gem.add_development_dependency('rdoc')
   gem.add_development_dependency('rake')
-  gem.add_development_dependency('mocha')
 end

data/test/helper.rb

@@ -1,12 +1,18 @@
+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'
 
-
-
-require 'pp'
-
 class MiniTest::Unit::TestCase
 
   def init_class_fifo
@@ -36,6 +42,36 @@ class MiniTest::Unit::TestCase
     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",

data/test/test_command.rb

@@ -17,6 +17,14 @@ describe Command, "commands for transport classes" do
       }.must_raise NoMethodError
     end
 
+    it "must send command" do
+      mi = init_class_fifo
+      mi.expects(:command).with('which').returns(Opensips::MI::Response.new(response_data_cmd_which))
+      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 {

data/test/test_response.rb

@@ -96,6 +96,29 @@ describe Response, "response class" do
       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

@@ -137,6 +137,21 @@ describe Opensips::MI::Transport, "testing MI transport layers" do
       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
@@ -174,12 +189,19 @@ describe Opensips::MI::Transport, "testing MI transport layers" do
     it "must connect to xmlrpc server" do
       host = "192.168.122.128" 
       port = 8080
-      XMLRPC::Client.stubs(:new_from_uri).
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensips-mi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Stas Kobzar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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
 email:
 - stas@modulis.ca
@@ -114,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: OpenSIPs management interface