ruby-asterisk 0.0.7 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c6e14b4aa50cd5f5e4742021d1b806c58ee640
+  data.tar.gz: 21d66e82b5e2755110f83c6fcecd235560cd992b
+SHA512:
+  metadata.gz: be06cc29301f21aafa7a9d9d72cdfff8cca8cd1822fa447096e60f3db791f3d3bc6cdae8eb3bf8c506d63c077cb8f433ffb55cc01d3856c5f296e81ce6f47ba4
+  data.tar.gz: ecca78c7fa306058acc211ff90d6d330b0009f3219d3315fd2123190491e678b12103a6e3d3f510edf388a6782efc41f41a3309b1ae4556a8cadd69e51e62ec6

data/README.md

@@ -1,5 +1,7 @@
 # RUBY-ASTERISK
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/emilianodellacasa/ruby-asterisk)
+
 This gem add support to your Ruby or RubyOnRails projects to Asterisk Manager Interface
 
 There was a project with the same name, but it appears to be discontinued so I decided to start a new project
@@ -90,6 +92,58 @@ To get the state of an extension use the following command
 ```ruby
  @ami.extension_state(@exten,@context)
 ```
+### SKINNY DEVICES AND LINES
+
+To get list of skinny devices
+
+```ruby
+ @ami.skinny_devices
+```
+
+To get list of skinny lines
+
+```ruby
+ @ami.skinny_lines
+```
+
+### QUEUE PAUSE
+                                                                                         
+To pause or unpause a member in a call queue
+                                                                                                        
+```ruby
+ @ami.queue_pause("SIP/100", "true", "myqueue", "reason")                                                                            
+```
+
+### PING
+
+To ping asterisk AMI
+
+```ruby
+ @ami.ping
+```
+
+### EVENT MASK                                                            
+
+To enable or disable sending events to this manager connection
+
+```ruby
+ @ami.event_mask("on")
+```
+
+### SIPpeers
+
+To get a list of sip peers (equivalent to "sip show peers" call on the asterisk server).  This can be used to get a buddy list. 
+
+```ruby
+ @ami.sip_peers
+```
+
+### STATUS
+                                                                                                                        
+To get a status of a single channel or for all channels                                                                                                                                  
+```ruby
+ @ami.status 
+```
 
 ### THE RESPONSE OBJECT
 
@@ -100,6 +154,7 @@ The response object contains all information about all data received from Asteri
 - action_id
 - message
 - data
+- raw_response
 
 The data property contains all additional information obtained from Asterisk, like for example the list of active channels after a "core show channels" command.
 

data/lib/ruby-asterisk.rb

@@ -5,113 +5,144 @@ require "ruby-asterisk/response"
 require 'net/telnet'
 
 module RubyAsterisk
-	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
+  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.close if self.connected
-				@session = nil
-				self.connected = false
-				true
+        @session = Net::Telnet::new("Host" => self.host,"Port" => self.port)
+        self.connected = 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
+    def disconnect
+      begin
+        @session.close if self.connected
+        @session = nil
+        self.connected = false
+        true
+      rescue Exception => ex
+        puts ex
+        false
       end
-      Response.new("Command",request.response_data)
-		end
+    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 login(username,password)
+      self.connect unless self.connected
+      execute "Login", {"Username" => username, "Secret" => password, "Event" => "On"}
+    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)
+    def command(command)
+      execute "Command", {"Command" => command}
     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)
+    def core_show_channels
+      execute "CoreShowChannels"
     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)
+    def meet_me_list
+      execute "MeetMeList"
+    end
+
+    def parked_calls
+      execute "ParkedCalls"
+    end
+
+    def extension_state(exten, context, action_id=nil)
+      execute "ExtensionState", {"Exten" => exten, "Context" => context, "ActionID" => action_id}
     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|
+    def skinny_devices
+      execute "SKINNYdevices"
+    end
+    
+    def skinny_lines
+      execute "SKINNYlines"
+    end
+
+    def status(channel=nil,action_id=nil)
+      execute "Status", {"Channel" => channel, "ActionID" => action_id}
+    end
+
+    def originate(caller,context,callee,priority,variable=nil)
+      execute "Originate", {"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000", "Variable" => variable  }
+    end
+
+    def channels
+      execute "Command", { "Command" => "show channels" }
+    end
+
+    def redirect(caller,context,callee,priority,variable=nil)
+      execute "Redirect", {"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000", "Variable" => variable}
+    end
+
+    def queues
+      execute "Queues", {}
+    end
+
+    def queue_add(queue, exten, penalty=2, paused=false, member_name)
+      execute "QueueAdd", {"Queue" => queue, "Interface" => exten, "Penalty" => penalty, "Paused" => paused, "MemberName" => member_name}
+    end
+
+    def queue_pause(queue, exten)
+      execute "QueuePause", {"Interface" => exten, "Paused" => paused}
+    end
+
+    def queue_remove(queue, exten)
+      execute "QueueRemove", {"Queue" => queue, "Interface" => exten}
+    end
+
+    def queue_status
+      execute "QueueStatus"
+    end
+
+    def queue_summary(queue)
+      execute "QueueSummary", {"Queue" => queue}
+    end
+
+    def mailbox_status(exten, context="default")
+      execute "MailboxStatus", {"Mailbox" => "#{exten}@#{context}"}
+    end
+
+    def mailbox_count(exten, context="default")
+      execute "MailboxCount", {"Mailbox" => "#{exten}@#{context}"}
+    end
+
+    def queue_pause(interface,paused,queue,reason='none')
+      execute "QueuePause", {"Interface" => interface, "Paused" => paused, "Queue" => queue, "Reason" => reason}
+    end
+
+    def ping
+      execute "Ping"
+    end
+
+    def event_mask(event_mask="off")
+      execute "Events", {"EventMask" => event_mask}
+    end
+
+    def sip_peers
+      execute "SIPpeers"
+    end
+
+    private
+    def execute(command, options={})
+      request = Request.new(command, options)
+      request.commands.each do |command|
         @session.write(command)
       end
-      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 30) do |data|
+      @session.waitfor("Match" => /ActionID: #{request.action_id}.*?\n\n/m, "Timeout" => 10) do |data|
         request.response_data << data
       end
-      Response.new("Originate",request.response_data)
-		end
-	end
+      Response.new(command,request.response_data)
+    end
+  end
 end

data/lib/ruby-asterisk/request.rb

@@ -1,32 +1,32 @@
 module RubyAsterisk
-	class Request
-		attr_accessor :action, :action_id, :parameters, :response_data
+  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 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 
+    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
+    protected
 
-		def generate_action_id
+    def generate_action_id
       if RUBY_VERSION.start_with?("1.9")
-  			Random.rand(999).to_s
+        Random.rand(999).to_s
       else
         rand(999).to_s
       end
-		end
+    end
 
-	end
+  end
 end

data/lib/ruby-asterisk/response.rb

@@ -1,114 +1,162 @@
 module RubyAsterisk
-	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|
+  class Response
+    attr_accessor :type, :success, :action_id, :message, :data, :raw_response
+
+    def initialize(type,response)
+      self.raw_response = 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)
+      self._parse(response,"ActionID:")
+    end
+
+    def _parse_message(response)
+      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"
+      _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
+        when "Status"
+          self._parse_status(response)
+        when "ExtensionState"
+          self._parse_extension_state(response)
+        when "SKINNYdevices"
+          self._parse_skinny_devices(response)
+        when "SKINNYlines"
+          self._parse_skinny_lines(response)
+        when "Command"
+          response
+        when "QueuePause"
+          self._parse_queue_pause(response)
+        when "Pong"
+          self._parse_pong(response)
+        when "Events"
+          self._parse_event_mask(response)
+        when "SIPpeers"
+          self._parse_sip_peers(response)
+      end
+
+    end
+
+    def _parse_sip_peers(response)
+      self._parse_objects(response, :peers, "Event: PeerEntry")
     end
 
-		def _parse_meet_me_list(response)
+    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_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_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_data_core_show_channels(response)
+      self._parse_objects(response,:channels,"Event: CoreShowChannel","Event: CoreShowChannelsComplete")
+    end
 
-		def _parse_extension_state(response)
+    def _parse_extension_state(response)
       _data = self._parse_objects(response,:hints,"Response:")
-			self._convert_status(_data)
+      self._convert_status(_data)
+    end
+    
+    def _parse_skinny_devices(response)
+      self._parse_objects(response,:skinnydevs,"Event: DeviceEntry")
+    end
+
+    def _parse_skinny_lines(response)
+      self._parse_objects(response,:skinnylines,"Event: LineEntry")
+    end
+    
+    def _parse_queue_pause(response)
+      _data = self._parse_objects(response,:queue_pause,"Response:")
+    end
+    
+    def _parse_pong(response)
+      _data = self._parse_objects(response,:pong, "Response:")
+    end
+    
+    def _parse_event_mask(response)
+      _data = self._parse_objects(response, :event_mask, "Ping:")
+    end
+
+    def _parse_status(response)
+      self._parse_objects(response, :status, "Event: Status")
     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"
+    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"
+          when "2"
             hint["DescriptiveStatus"] = "Busy"
-					when "4"
+          when "4"
             hint["DescriptiveStatus"] = "Unavailable"
-					when "8"
+          when "8"
             hint["DescriptiveStatus"] = "Ringing"
-					when "16"
+          when "16"
             hint["DescriptiveStatus"] = "On Hold"
-				end
-			end
-			_data
-		end
+        end
+      end
+      _data
+    end
 
-		def _parse_objects(response,symbol_name,search_for,stop_with=nil)
-			 _data = { symbol_name => [] }
+    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))
+        line.strip!
+        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?
+          tokens = line.split(':', 2)
+          object[tokens[0].strip]=tokens[1].strip unless tokens[1].nil?
         end
       end
       _data[symbol_name] << object unless object.nil?
       _data
-		end
-	end
+    end
+  end
 end

data/lib/ruby-asterisk/version.rb

@@ -1,3 +1,3 @@
 module Rami
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/spec/ruby-asterisk/response_spec.rb

@@ -2,6 +2,16 @@
 require 'spec_helper'
 describe RubyAsterisk::Response do
 
+  def sip_peers_response
+    "Response: Success
+     Message: Peer status list will follow
+     
+     Event: PeerEntry
+     Channeltype: SIP
+     ObjectName: 9915057
+     IPport: 5060"
+  end
+
 	def empty_core_show_channels_response
 		"Event: CoreShowChannelsComplete
 		EventList: Complete
@@ -127,6 +137,11 @@ describe RubyAsterisk::Response do
         @response = RubyAsterisk::Response.new("Originate",originate_response)
         @response.data[:dial][0]["UniqueID"].should eq("1335457364.68")
       end
+
+      it "should have a field with original raw response" do
+        @response = RubyAsterisk::Response.new("Originate",originate_response)
+        @response.raw_response.should eq(originate_response)
+      end
     end
 		
 		describe "receiving a MeetMeList request" do
@@ -154,4 +169,17 @@ describe RubyAsterisk::Response do
       end
     end
 	end
+
+  describe "receiving a SIPPeers request" do
+    it "should parse correctly data coming from Asterisk abous sip peers" do
+      @response = RubyAsterisk::Response.new("SIPpeers",sip_peers_response)
+      @response.data[:peers].should_not be_empty
+    end
+    
+    it "should correctly fill the fields" do
+      @response = RubyAsterisk::Response.new("SIPpeers",sip_peers_response)
+      @response.data[:peers][0]["ObjectName"].should eq("9915057")
+      @response.data[:peers][0]["IPport"].should eq("5060")
+    end
+  end
 end

data/spec/ruby-asterisk/ruby_asterisk_spec.rb

@@ -139,4 +139,12 @@ describe RubyAsterisk do
       @session.extension_state("9100","HINT").should be_kind_of(RubyAsterisk::Response)
     end
   end
+
+  describe ".sip_peers" do
+    it "should return a response object" do
+      @session.login("mark","mysecret")
+      @session.sip_peers.should be_kind_of(RubyAsterisk::Response)
+    end
+  end
+
 end

metadata

@@ -1,49 +1,51 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-asterisk
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Emiliano Della Casa
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  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
-  version_requirements: *id002
-description: Add support to your ruby or rails projects to Asterisk Manager Interface (AMI)
-email: 
+  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 Asterisk Manager Interface
+  (AMI)
+email:
 - e.dellacasa@engim.eu
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - CHANGELOG
@@ -61,30 +63,25 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/emilianodellacasa/ruby-asterisk
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+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: ruby-asterisk
-rubygems_version: 1.8.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Asterisk Manager Interface in Ruby
 test_files: []
-