pabx 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGVmZDE4ZGFhNDBmMzA5ZTUxYTRjODhmNjhjZDUyZTg2ZjZiZmExOQ==
+  data.tar.gz: !binary |-
+    Y2U0ZDcwNWQ2ZmNhMzBiY2NmZDIzODNhMDFiMGVmYmE0NmRlN2QzOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YmIxZjRmNzMwMjVjYjJiMmNlYjJkYjZmOWZmMjM2MzBmNDEwNzJmZWNiNGU1
+    YTQxZDgyZjBhZDgyYjVhNzc1OWI3YTczOGUxNWZmZWU5Yzg1OWY0ZTllMDJk
+    YTk0NjhlMWFmMGEwYTNjYWUzYzU4ZmM0M2FiZTM5ODk1ZWM5OTA=
+  data.tar.gz: !binary |-
+    MWEyNGRjYTVjMmY4MWNmZmVhZmQ1MTM0N2IwNWU4NjIzNWY0ODQyNGFhZjA5
+    ODg3ZTI0NWYxNDU3ZTc5ZWZmYzZmOTcwYzIyOTcyMzNmOTc1YWQxN2RiYmE0
+    OTE4NzZkOTcxMGQ5YzRjYjhiZWZmZmQ3MmE2ZWY1ZjJkMzFiN2Q=

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rami.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) 
+
+task default: :spec

data/lib/pabx.rb

@@ -0,0 +1,117 @@
+require "pabx/version"
+require "pabx/request"
+require "pabx/response"
+
+require 'net/telnet'
+
+module Pabx
+  class AMI
+    attr_accessor :host, :port, :connected
+
+    def initialize(host,port)
+      self.host = host.to_s
+      self.port = port.to_i
+      self.connected = false
+      @session = nil
+    end
+
+    def connect
+      begin
+        @session = Net::Telnet::new("Host" => self.host,"Port" => self.port)
+        self.connected = true
+      rescue Exception => ex
+        false
+      end
+    end
+
+    def disconnect
+      begin
+        @session.close if self.connected
+        @session = nil
+        self.connected = false
+        true
+      rescue Exception => ex
+        puts ex
+        false
+      end
+    end
+
+    def login(username,password)
+      self.connect unless self.connected
+      request = Request.new("Login",{"Username" => username, "Secret" => password})
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("Login",request.response_data)
+    end
+
+    def command(command)
+      request = Request.new("Command",{ "Command" => command })
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("Command",request.response_data)
+    end
+
+    def core_show_channels
+      request = Request.new("CoreShowChannels")
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("CoreShowChannels",request.response_data)
+    end
+
+    def meet_me_list
+      request = Request.new("MeetMeList")
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("MeetMeList",request.response_data)
+    end
+
+    def parked_calls
+      request = Request.new("ParkedCalls")
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("ParkedCalls",request.response_data)
+    end
+
+    def extension_state(exten,context)
+      request = Request.new("ExtensionState",{"Exten" => exten, "Context" => context})
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 3) do |data|
+        request.response_data << data
+      end
+      Response.new("ExtensionState",request.response_data)
+    end
+
+    def originate(caller,context,callee,priority,variable=nil)
+      request = Request.new("Originate",{"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000", "Variable" => variable  })
+      request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 40) do |data|
+        request.response_data << data
+      end
+      Response.new("Originate",request.response_data)
+    end
+  end
+end

data/lib/pabx/request.rb

@@ -0,0 +1,32 @@
+module Pabx
+  class Request
+    attr_accessor :action, :action_id, :parameters, :response_data
+
+    def initialize(action,parameters={})
+      self.action = action
+      self.action_id = self.generate_action_id
+      self.parameters = parameters
+      self.response_data = ""
+    end
+
+    def commands
+      _commands=["Action: "+self.action+"\r\n","ActionID: "+self.action_id+"\r\n"]
+      self.parameters.each do |key,value|
+        _commands<<key+": "+value+"\r\n" unless value.nil?
+      end
+      _commands[_commands.length-1]<<"\r\n"
+      _commands
+    end 
+
+    protected
+
+    def generate_action_id
+      if RUBY_VERSION.start_with?("1.9")
+        Random.rand(999).to_s
+      else
+        rand(999).to_s
+      end
+    end
+
+  end
+end

data/lib/pabx/response.rb

@@ -0,0 +1,114 @@
+module Pabx
+  class Response
+    attr_accessor :type, :success, :action_id, :message, :data
+    
+    def initialize(type,response)
+      self.type = type
+      self.success = self._parse_successfull(response)
+      self.action_id = self._parse_action_id(response)
+      self.message = self._parse_message(response)
+      self.data = self._parse_data(response)
+    end
+
+    protected
+
+    def _parse_successfull(response)
+      response.include?("Response: Success")
+    end
+
+    def _parse_action_id(response)
+      _action_id = self._parse(response,"ActionID:")
+    end
+
+    def _parse_message(response)
+      _message = self._parse(response,"Message:")
+    end
+
+    def _parse(response,field)
+      _value = nil
+      response.each_line do |line|
+        if line.start_with?(field)
+          _value = line[line.rindex(":")+1..line.size].strip
+        end
+      end
+      _value
+    end
+
+    def _parse_data(response)
+      case self.type
+        when "CoreShowChannels"
+          self._parse_data_core_show_channels(response)
+        when "ParkedCalls"
+          self._parse_data_parked_calls(response)
+        when "Originate"
+          self._parse_originate(response)
+        when "MeetMeList"
+          self._parse_meet_me_list(response)
+        when "ExtensionState"
+          self._parse_extension_state(response)
+      end
+    end
+
+    def _parse_meet_me_list(response)
+      self._parse_objects(response,:rooms,"Event: MeetmeList")
+    end
+
+    def _parse_originate(response)
+      self._parse_objects(response,:dial,"Event: Dial")
+    end
+
+    def _parse_data_parked_calls(response)
+      self._parse_objects(response,:calls,"Event: ParkedCall")
+    end
+
+    def _parse_data_core_show_channels(response)
+      self._parse_objects(response,:channels,"Event: CoreShowChannel","Event: CoreShowChannelsComplete")
+    end
+
+    def _parse_extension_state(response)
+      _data = self._parse_objects(response,:hints,"Response:")
+      self._convert_status(_data)
+    end
+
+    def _convert_status(_data)
+      _data[:hints].each do |hint|
+        case hint["Status"]
+          when "-1"
+            hint["DescriptiveStatus"] = "Extension not found"
+          when "0"
+            hint["DescriptiveStatus"] = "Idle"
+          when "1"
+            hint["DescriptiveStatus"] = "In Use"
+          when "2"
+            hint["DescriptiveStatus"] = "Busy"
+          when "4"
+            hint["DescriptiveStatus"] = "Unavailable"
+          when "8"
+            hint["DescriptiveStatus"] = "Ringing"
+          when "16"
+            hint["DescriptiveStatus"] = "On Hold"
+        end
+      end
+      _data
+    end
+
+    def _parse_objects(response,symbol_name,search_for,stop_with=nil)
+       _data = { symbol_name => [] }
+      parsing = false
+      object = nil
+      response.each_line do |line|
+        if line.strip.empty? or (!stop_with.nil? and line.start_with?(stop_with))
+          parsing = false
+        elsif line.start_with?(search_for)
+          _data[symbol_name] << object unless object.nil?
+          object = {}
+          parsing = true
+        elsif parsing
+          object[line.split(':')[0].strip]=line.split(':')[1].strip unless line.split(':')[1].nil?
+        end
+      end
+      _data[symbol_name] << object unless object.nil?
+      _data
+    end
+  end
+end

data/lib/pabx/version.rb

@@ -0,0 +1,3 @@
+module Rami
+  VERSION = "0.0.2"
+end

data/pabx.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pabx/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pabx"
+  s.license     = 'MIT'
+  s.version     = Rami::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Elias Hasnat"]
+  s.email       = ["android.hasnat@gmail.com"]
+  s.homepage    = "http://github.com/claymodel/telephony/pabx"
+  s.summary     = %q{IMS SoftSwitch Manager - Ruby}
+  s.description = %q{Add support to your ruby or rails projects to IMS SoftSwitch Manager}
+
+  s.rubyforge_project = "pabx"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+	s.add_development_dependency "rake"
+	s.add_development_dependency 'rspec'
+end

data/spec/pabx/pabx_spec.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+require 'spec_helper'
+describe Pabx do
+
+	def mock_request(stubs={})
+    (@mock_request ||= mock_model(Pabx::Request).as_null_object).tap do |request|
+      request.stub(stubs) unless stubs.empty?
+    end
+  end
+
+	before :each do
+		@session = Pabx::AMI.new("127.0.0.1",5038)
+  end
+
+	after :each do
+		@session.disconnect
+	end
+
+	describe ".new" do
+		it "initialize session with host" do
+			@session.host.should eq("127.0.0.1")
+		end
+
+		it "initialize session with host" do
+      @session.port.should eq(5038)
+    end
+
+		it "should start the session as disconnected" do
+			@session.connected.should_not be_true
+		end
+	end 
+
+	describe ".connect" do
+		it "should return true if everything is ok" do
+			@session.connect.should be_true
+		end
+
+		it "should return false if everything if something went wrong" do
+			@session.port = 666
+      @session.connect.should_not be_true
+			@session.port = 5038
+    end
+
+		it "should change state to session as connected" do
+			@session.connect
+			@session.connected.should be_true
+		end
+	end
+
+	describe ".disconnect" do
+    it "should return true if everything is ok" do
+      @session.disconnect.should be_true
+    end
+
+		it "should change state to session as disconnected" do
+      @session.disconnect
+      @session.connected.should_not be_true
+    end
+  end
+
+	describe ".login" do
+		it "should return a response object" do
+			@session.login("mark","mysecret").should be_kind_of(Pabx::Response)
+		end
+
+		it "should return a response with type Login" do
+			@session.login("mark","mysecret").type.should eq("Login")
+		end
+
+		describe "if everything is ok" do
+			it "should return a successfull response" do
+				@session.login("mark","mysecret").success.should be_true
+			end
+
+			it "should fill the ActionID" do
+        @session.login("mark","mysecret").action_id.should_not be_nil
+      end
+
+			it "should fill the Message" do
+        @session.login("mark","mysecret").message.should_not be_nil
+      end
+		end
+
+		describe "if credentials are wrong" do
+			it "should not return a successfull response" do
+				@session.login("mark","wrong").success.should be_false
+			end
+		end
+	end
+
+	describe ".core_show_channels" do
+    it "should return a response object" do
+			@session.login("mark","mysecret")
+      @session.core_show_channels.should be_kind_of(Pabx::Response)
+    end
+
+		it "should contain additional data about channels" do
+			@session.login("mark","mysecret")
+			@session.core_show_channels.data[:channels].should_not be_nil
+		end 
+	end
+
+	describe ".parked_calls" do
+    it "should return a response object" do
+      @session.login("mark","mysecret")
+      @session.parked_calls.should be_kind_of(Pabx::Response)
+    end
+
+    it "should contain additional data about parked calls" do
+      @session.login("mark","mysecret")
+      @session.parked_calls.data[:calls].should_not be_nil
+    end
+  end
+
+	describe ".originate" do
+		it "should return a response object" do
+			@session.login("mark","mysecret")
+			@session.originate("SIP/9100","OUTGOING","123456","1","queue=SIP/1000&SIP/1001").should be_kind_of(RubyAsterisk::Response)
+		end
+	end
+
+	describe ".command" do
+    it "should return a response object" do
+      @session.login("mark","mysecret")
+      @session.command("meetme list").should be_kind_of(Pabx::Response)
+    end
+  end
+
+	describe ".meet_me_list" do
+    it "should return a response object" do
+      @session.login("mark","mysecret")
+      @session.meet_me_list.should be_kind_of(Pabx::Response)
+    end
+  end
+
+	describe ".extension_state" do
+    it "should return a response object" do
+      @session.login("mark","mysecret")
+      @session.extension_state("9100","HINT").should be_kind_of(Pabx::Response)
+    end
+  end
+end

data/spec/pabx/request_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'spec_helper'
+describe Pabx::Request do
+
+  describe "of type Originate" do
+    it "should set a Variable option if set" do
+      request = Pabx::Request.new("Originate",{"Channel" => "1234", "Context" => "test", "Exten" => "1", "Priority" => "1", "Callerid" => "1234", "Timeout" => "30000", "Variable" => "var1=15"  })
+      request.commands.include?("Variable: var1=15\r\n").should_not be_nil
+    end
+
+		it "should not set a Variable option if not set" do
+      request = Pabx::Request.new("Originate",{"Channel" => "1234", "Context" => "test", "Exten" => "1", "Priority" => "1", "Callerid" => "1234", "Timeout" => "30000", "Variable" => nil  })
+      request.commands.include?("Variable: var=15").should==false
+    end
+  end
+end
+

data/spec/pabx/response_spec.rb

@@ -0,0 +1,157 @@
+# encoding: utf-8
+require 'spec_helper'
+describe Pabx::Response do
+
+	def empty_core_show_channels_response
+		"Event: CoreShowChannelsComplete
+		EventList: Complete
+    ListItems: 1
+    ActionID: 839"
+	end
+
+	def core_show_channels_response
+		"Event: CoreShowChannel
+		ActionID: 839
+		Channel: SIP/195.62.226.4-00000025
+		UniqueID: 1335448133.61
+		Context: incoming
+		Extension: s
+		Priority: 1
+		ChannelState: 6
+		ChannelStateDesc: Up
+		Application: Parked Call
+		ApplicationData:
+		CallerIDnum: 123456
+		CallerIDname:
+		ConnectedLineNum:
+		ConnectedLineName:
+		Duration: 00:00:05
+		AccountCode:
+		BridgedChannel:
+		BridgedUniqueID:
+
+		Event: CoreShowChannelsComplete
+		EventList: Complete
+		ListItems: 1
+		ActionID: 839"
+	end
+
+	def parked_calls_response
+		"Event: ParkedCall
+		Parkinglot: default
+		Exten: 701
+		Channel: SIP/195.62.226.2-00000026
+		From: SIP/195.62.226.2-00000026
+		Timeout: 3
+		CallerIDNum: 123456
+		CallerIDName:
+		ConnectedLineNum:
+		ConnectedLineName:
+		ActionID: 899"
+	end
+
+	def originate_response
+		"Event: Dial
+		Privilege: call,all
+		SubEvent: End
+		Channel: SIP/9100-0000002b
+		UniqueID: 1335457364.68
+		DialStatus: CHANUNAVAIL"
+	end
+
+	def meet_me_list_response
+		"Event: MeetmeList
+		ActionID: 921
+		Conference: 1234
+		UserNumber: 1
+		CallerIDNum: 123456
+		CallerIDName: <no name>
+		ConnectedLineNum: <unknown>
+		ConnectedLineName: <no name>
+		Channel: SIP/195.62.226.18-0000000e
+		Admin: No
+		Role: Talk and listen
+		MarkedUser: No
+		Muted: No
+		Talking: Not monitored"
+	end
+
+	def extension_state_response
+		"Response: Success
+		ActionID: 180
+		Message: Extension Status
+		Exten: 9100
+		Context: HINT
+		Hint: SIP/9100
+		Status: 0"
+	end
+
+	describe ".new" do
+		
+		describe "receiving a Core Show Channels request" do
+			it "should parse correctly data coming from Soft Switch about channels" do 
+				@response = Pabx::Response.new("CoreShowChannels",core_show_channels_response)
+				@response.data[:channels].should_not be_empty
+			end
+
+			it "should correctly fill the fields" do
+        @response = Pabx::Response.new("CoreShowChannels",core_show_channels_response)
+        @response.data[:channels][0]["CallerIDnum"].should eq("123456")
+      end
+
+			it "should have no channels if answer is empty" do
+				@response = Pabx::Response.new("CoreShowChannels",empty_core_show_channels_response)
+				@response.data[:channels].count.should eq(0)
+			end
+		end
+	
+		describe "receiving a Parked Calls request" do
+			it "should parse correctly data coming from Asterisk about calls" do
+				@response = Pabx::Response.new("ParkedCalls",parked_calls_response)
+				@response.data[:calls].should_not be_empty
+			end
+
+			it "should correctly fill the fields" do
+				@response = Pabx::Response.new("ParkedCalls",parked_calls_response)
+				@response.data[:calls][0]["Exten"].should eq("701")
+			end
+		end
+
+		describe "receiving a Originate request" do 
+			it "should parse correctly data coming from Asterisk about the call" do
+        @response = Pabx::Response.new("Originate",originate_response)
+        @response.data[:dial].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
+        @response = Pabx::Response.new("Originate",originate_response)
+        @response.data[:dial][0]["UniqueID"].should eq("1335457364.68")
+      end
+    end
+		
+		describe "receiving a MeetMeList request" do
+      it "should parse correctly data coming from Asterisk about the conference room" do
+        @response = Pabx::Response.new("MeetMeList",meet_me_list_response)
+        @response.data[:rooms].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
+        @response = Pabx::Response.new("MeetMeList",meet_me_list_response)
+        @response.data[:rooms][0]["Conference"].should eq("1234")
+      end
+    end
+
+		describe "receiving a ExtensionState request" do
+      it "should parse correctly data coming from Asterisk about the state of the extension" do
+        @response = Pabx::Response.new("ExtensionState",extension_state_response)
+        @response.data[:hints].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
+        @response = Pabx::Response.new("ExtensionState",extension_state_response)
+        @response.data[:hints][0]["Status"].should eq("0")
+				@response.data[:hints][0]["DescriptiveStatus"].should eq("Idle")
+      end
+    end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+require 'pabx'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pabx
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Elias Hasnat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !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: Add support to your ruby or rails projects to IMS SoftSwitch Manager
+email:
+- android.hasnat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Rakefile
+- lib/pabx.rb
+- lib/pabx/request.rb
+- lib/pabx/response.rb
+- lib/pabx/version.rb
+- pabx.gemspec
+- spec/pabx/pabx_spec.rb
+- spec/pabx/request_spec.rb
+- spec/pabx/response_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/claymodel/telephony/pabx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: pabx
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: IMS SoftSwitch Manager - Ruby
+test_files:
+- spec/pabx/pabx_spec.rb
+- spec/pabx/request_spec.rb
+- spec/pabx/response_spec.rb
+- spec/spec_helper.rb
+has_rdoc: