ruby-asterisk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c6e14b4aa50cd5f5e4742021d1b806c58ee640
-  data.tar.gz: 21d66e82b5e2755110f83c6fcecd235560cd992b
+  metadata.gz: 95239d89540f2e3507f0b72b8f7e42af3c76f781
+  data.tar.gz: b3d95a77ba65f358d3504d008e5b41d3035399e5
 SHA512:
-  metadata.gz: be06cc29301f21aafa7a9d9d72cdfff8cca8cd1822fa447096e60f3db791f3d3bc6cdae8eb3bf8c506d63c077cb8f433ffb55cc01d3856c5f296e81ce6f47ba4
-  data.tar.gz: ecca78c7fa306058acc211ff90d6d330b0009f3219d3315fd2123190491e678b12103a6e3d3f510edf388a6782efc41f41a3309b1ae4556a8cadd69e51e62ec6
+  metadata.gz: 4fdcf0145516e61659670bce72dd974925b076321180c115fa2d65fd55033faf08d9656d667c6934afbf51238ba42ac535a26a5208c20c79a2a3f17476e74ebf
+  data.tar.gz: 424f729d2eea0516b353f412d7fc4ee6830caf2b847d2931dd4bf78388ea52c4fb38f63ad28b7c73a91fec5975ca04917f3dbe31d1782a40f4ca0e0fe3389e10

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/*
+.cane
+*_high_water_mark

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Emiliano Della Casa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,9 @@
 # RUBY-ASTERISK
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/emilianodellacasa/ruby-asterisk)
+[![Donate via Zerocracy](https://www.0crat.com/contrib-badge/CE8UGB6NP.svg)](https://www.0crat.com/contrib/CE8UGB6NP)
+[![Managed by Zerocracy](https://www.0crat.com/badge/CE8UGB6NP.svg)](https://www.0crat.com/p/CE8UGB6NP)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2861728929db934eb376/maintainability)](https://codeclimate.com/github/emilianodellacasa/ruby-asterisk/maintainability)
 
 This gem add support to your Ruby or RubyOnRails projects to Asterisk Manager Interface
 
@@ -65,7 +68,7 @@ To get a list of all parked calls on your Asterisk PBX, use the following comman
 To start a new call use the following command
 
 ```ruby
- @ami.originate("SIP/9100","OUTGOING","123456","1","var1=12,var2=99") # CALLER, CONTEXT, CALLEE, PRIORITY, VARIABLE
+ @ami.originate("SIP/9100","OUTGOING","123456","1","var1=12,var2=99") # CHANNEL, CONTEXT, CALLEE, PRIORITY, VARIABLES
 ```
 
 
@@ -92,6 +95,15 @@ To get the state of an extension use the following command
 ```ruby
  @ami.extension_state(@exten,@context)
 ```
+
+### DEVICE STATE LIST
+
+To get list of states of devices
+
+```ruby
+ @ami.device_state_list(@exten,@context)
+```
+
 ### SKINNY DEVICES AND LINES
 
 To get list of skinny devices
@@ -138,6 +150,14 @@ To get a list of sip peers (equivalent to "sip show peers" call on the asterisk
  @ami.sip_peers
 ```
 
+### SIP SHOW PEER
+
+To get info of a peer (equivalent to "sip show peer" call on the asterisk server).
+
+```ruby
+ @ami.sip_show_peer(peer)
+```
+
 ### STATUS
                                                                                                                         
 To get a status of a single channel or for all channels                                                                                                                                  
@@ -145,6 +165,62 @@ To get a status of a single channel or for all channels
  @ami.status 
 ```
 
+### ATXFER
+
+Attendand transfer
+
+```ruby
+ @ami.atxfer(channel, exten, context, priority = '1')
+```
+
+### WAIT EVENT
+
+Wait for an event to occur. Timeout in seconds to wait for events, -1 means forever
+
+```ruby
+ wait_event(timeout=-1)
+```
+
+### MONITOR
+
+Monitor a channel
+
+```ruby
+ monitor(channel,mix=false,file=nil,format='wav')
+```
+
+### STOP MONITOR
+
+Stop monitoring a channel
+
+```ruby
+ stop_monitor(channel)
+```
+
+### PAUSE MONITOR
+
+Pause monitoring of a channel
+
+```ruby
+ pause_monitor(channel)
+```
+
+### UNPAUSE MONITOR
+
+Unpause monitoring of a channel
+
+```ruby
+ unpause_monitor(channel)
+```
+
+### CHANGE MONITOR
+
+Change monitoring filename of a channel
+
+```ruby
+ change_monitor(channel,file)
+```
+
 ### THE RESPONSE OBJECT
 
 The response object contains all information about all data received from Asterisk. Here follows a list of all object's properties:
@@ -158,6 +234,12 @@ The response object contains all information about all data received from Asteri
 
 The data property contains all additional information obtained from Asterisk, like for example the list of active channels after a "core show channels" command.
 
+## Todo List
+
+- Adding initialization parameters for Telnet options like Output_log, Waittime, Dump_log, timeout;
+- Adding test cases for better code coverage;
+- Refactoring of ruby-asterisk.rb, adding method_missing for the purpose of supporting as much AMI commands as possible
+
 ## Development
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/emilianodellacasa/ruby-asterisk/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.

data/Rakefile

@@ -5,4 +5,8 @@ require 'rspec'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) 
 
+require 'quality/rake/task'
+
+Quality::Rake::Task.new
+
 task default: :spec

data/lib/ruby-asterisk.rb

@@ -1,23 +1,28 @@
-require "ruby-asterisk/version"
-require "ruby-asterisk/request"
-require "ruby-asterisk/response"
-
+require 'ruby-asterisk/version'
+require 'ruby-asterisk/request'
+require 'ruby-asterisk/response'
 require 'net/telnet'
 
 module RubyAsterisk
+  ##
+  #
+  # Ruby-asterisk main classes
+  #
   class AMI
-    attr_accessor :host, :port, :connected
+    attr_accessor :host, :port, :connected, :timeout, :wait_time
 
-    def initialize(host,port)
+    def initialize(host, port)
       self.host = host.to_s
       self.port = port.to_i
       self.connected = false
+      @timeout = 5
+      @wait_time = 0.1
       @session = nil
     end
 
     def connect
       begin
-        @session = Net::Telnet::new("Host" => self.host,"Port" => self.port)
+        @session = Net::Telnet::new('Host' => self.host, 'Port' => self.port, 'Timeout' => 10)
         self.connected = true
       rescue Exception => ex
         false
@@ -27,7 +32,6 @@ module RubyAsterisk
     def disconnect
       begin
         @session.close if self.connected
-        @session = nil
         self.connected = false
         true
       rescue Exception => ex
@@ -36,113 +40,184 @@ module RubyAsterisk
       end
     end
 
-    def login(username,password)
+    def login(username, password)
       self.connect unless self.connected
-      execute "Login", {"Username" => username, "Secret" => password, "Event" => "On"}
+      execute 'Login', {'Username' => username, 'Secret' => password, 'Event' => 'On'}
+    end
+
+    def logoff
+      execute 'Logoff'
     end
 
     def command(command)
-      execute "Command", {"Command" => command}
+      execute 'Command', {'Command' => command}
     end
 
     def core_show_channels
-      execute "CoreShowChannels"
+      execute 'CoreShowChannels'
     end
 
     def meet_me_list
-      execute "MeetMeList"
+      execute 'MeetMeList'
+    end
+
+    def confbridges
+      execute 'ConfbridgeListRooms'
+    end
+
+    def confbridge(conference)
+      execute 'ConfbridgeList', {'Conference' => conference}
+    end
+
+    def confbridge_mute(conference, channel)
+      execute 'ConfbridgeMute', {'Conference' => conference, 'Channel' => channel}
+    end
+
+    def confbridge_unmute(conference, channel)
+      execute 'ConfbridgeUnmute', {'Conference' => conference, 'Channel' => channel}
+    end
+
+    def confbridge_kick(conference, channel)
+      execute 'ConfbridgeKick', {'Conference' => conference, 'Channel' => channel}
     end
 
     def parked_calls
-      execute "ParkedCalls"
+      execute 'ParkedCalls'
     end
 
-    def extension_state(exten, context, action_id=nil)
-      execute "ExtensionState", {"Exten" => exten, "Context" => context, "ActionID" => action_id}
+    def extension_state(exten, context, action_id = nil)
+      execute 'ExtensionState', {'Exten' => exten, 'Context' => context, 'ActionID' => action_id}
+    end
+    
+    def device_state_list
+      execute 'DeviceStateList'
     end
 
     def skinny_devices
-      execute "SKINNYdevices"
+      execute 'SKINNYdevices'
     end
-    
+
     def skinny_lines
-      execute "SKINNYlines"
+      execute 'SKINNYlines'
+    end
+
+    def status(channel = nil, action_id = nil)
+      execute 'Status', {'Channel' => channel, 'ActionID' => action_id}
     end
 
-    def status(channel=nil,action_id=nil)
-      execute "Status", {"Channel" => channel, "ActionID" => action_id}
+    def originate(channel, context, callee, priority, variable = nil, caller_id = nil, timeout = 30000)
+      @timeout = [@timeout, timeout/1000].max
+      execute 'Originate', {'Channel' => channel, 'Context' => context, 'Exten' => callee, 'Priority' => priority, 'CallerID' => caller_id || channel, 'Timeout' => timeout.to_s, 'Variable' => variable  }
     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  }
+    def originate_app(caller, app, data, async)
+      execute 'Originate', {'Channel' => caller, 'Application' => app, 'Data' => data, 'Timeout' => '30000', 'Async' => async }
     end
 
     def channels
-      execute "Command", { "Command" => "show 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}
+    def redirect(channel, context, callee, priority, variable=nil, caller_id = nil, timeout = 30000)
+      @timeout = [@timeout, timeout/1000].max
+      execute 'Redirect', {'Channel' => channel, 'Context' => context, 'Exten' => callee, 'Priority' => priority, 'CallerID' => caller_id || channel, 'Timeout' => timeout.to_s, 'Variable' => variable}
     end
 
     def queues
-      execute "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}
+    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}
+    def queue_pause(exten, paused)
+      execute 'QueuePause', {'Interface' => exten, 'Paused' => paused}
     end
 
     def queue_remove(queue, exten)
-      execute "QueueRemove", {"Queue" => queue, "Interface" => exten}
+      execute 'QueueRemove', {'Queue' => queue, 'Interface' => exten}
     end
 
     def queue_status
-      execute "QueueStatus"
+      execute 'QueueStatus'
     end
 
     def queue_summary(queue)
-      execute "QueueSummary", {"Queue" => queue}
+      execute 'QueueSummary', {'Queue' => queue}
     end
 
-    def mailbox_status(exten, context="default")
-      execute "MailboxStatus", {"Mailbox" => "#{exten}@#{context}"}
+    def mailbox_status(exten, context='default')
+      execute 'MailboxStatus', {'Mailbox' => "#{exten}@#{context}"}
     end
 
-    def mailbox_count(exten, context="default")
-      execute "MailboxCount", {"Mailbox" => "#{exten}@#{context}"}
+    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}
+      execute 'QueuePause', {'Interface' => interface, 'Paused' => paused, 'Queue' => queue, 'Reason' => reason}
     end
 
     def ping
-      execute "Ping"
+      execute 'Ping'
     end
 
-    def event_mask(event_mask="off")
-      execute "Events", {"EventMask" => event_mask}
+    def event_mask(event_mask='off')
+      execute 'Events', {'EventMask' => event_mask}
     end
 
     def sip_peers
-      execute "SIPpeers"
+      execute 'SIPpeers'
+    end
+    
+    def sip_show_peer(peer)
+      execute 'SIPshowpeer', {'Peer' => peer}
+    end
+    
+    def hangup(channel)
+      execute 'Hangup', {'Channel' => channel}
+    end
+
+    def atxfer(channel, exten, context, priority = '1')
+      execute 'Atxfer', {'Channel' => channel, 'Exten' => exten.to_s, 'Context' => context, 'Priority' => priority}
+    end
+
+    def wait_event(timeout=-1)
+      @timeout = [@timeout, timeout].max
+      execute 'WaitEvent', {'Timeout' => timeout}
+    end
+
+    def monitor(channel,mix=false,file=nil,format='wav')
+      execute 'Monitor', {'Channel' => channel, 'File' => file, 'Mix' => mix}
+    end
+
+    def stop_monitor(channel)
+      execute 'StopMonitor', {'Channel' => channel}
+    end
+
+    def pause_monitor(channel)
+      execute 'PauseMonitor', {'Channel' => channel}
+    end
+
+    def unpause_monitor(channel)
+      execute 'UnpauseMonitor', {'Channel' => channel}
+    end
+
+    def change_monitor(channel,file)
+      execute 'ChangeMonitor', {'Channel' => channel, 'File' => file}
     end
 
     private
-    def execute(command, options={})
+    def execute(command, options = {})
       request = Request.new(command, options)
       request.commands.each do |command|
         @session.write(command)
       end
-      @session.waitfor("Match" => /ActionID: #{request.action_id}.*?\n\n/m, "Timeout" => 10) do |data|
-        request.response_data << data
+      @session.waitfor('Match' => /ActionID: #{request.action_id}.*?\n\n/m, "Timeout" => @timeout, "Waittime" => @wait_time) do |data|
+        request.response_data << data.to_s
       end
-      Response.new(command,request.response_data)
+      Response.new(command, request.response_data)
     end
   end
 end

data/lib/ruby-asterisk/parsing_constants.rb

@@ -0,0 +1,98 @@
+##
+#
+# File containing parsing constants
+#
+module RubyAsterisk
+  DESCRIPTIVE_STATUS = {
+    '-1' => 'Extension not found',
+    '0' => 'Idle',
+    '1' => 'In Use',
+    '2' => 'Busy',
+    '3' => 'Unavailable',
+    '4' => 'Ringing',
+    '5' => 'On Hold'
+  }
+
+  PARSE_DATA = {
+    'CoreShowChannels' => {
+      :symbol => :channels,
+      :search_for => 'Event: CoreShowChannel',
+      :stop_with => 'Event: CoreShowChannelsComplete'
+    },
+    'ParkedCalls' => {
+      :symbol => :calls,
+      :search_for => 'Event: ParkedCall',
+      :stop_with => nil
+    },
+    'Originate'  => {
+      :symbol => :dial,
+      :search_for => 'Event: Dial',
+      :stop_with => nil
+    },
+    'MeetMeList'  => {
+      :symbol => :rooms,
+      :search_for => 'Event: MeetmeList',
+      :stop_with => nil
+    },
+    'ConfbridgeListRooms'  => {
+      :symbol => :rooms,
+      :search_for => 'Event: ConfbridgeListRooms',
+      :stop_with => nil
+    },
+    'ConfbridgeList'  => {
+      :symbol => :channels,
+      :search_for => 'Event: ConfbridgeList',
+      :stop_with => nil
+    },
+    'Status'  => {
+      :symbol => :status,
+      :search_for => 'Event: Status',
+      :stop_with => nil
+    },
+    'ExtensionState'  => {
+      :symbol => :hints,
+      :search_for => 'Response: Success',
+      :stop_with => nil
+    },
+    'DeviceStateList'  => {
+      :symbol => :hints,
+      :search_for => 'Response: Success',
+      :stop_with => nil
+    },
+    'SKINNYdevices'  => {
+      :symbol => :skinnydevs,
+      :search_for => 'Event: DeviceEntry',
+      :stop_with => nil
+    },
+    'SKINNYlines' => {
+      :symbol => :skinnylines,
+      :search_for => 'Event: LineEntry',
+      :stop_with => nil
+    },
+    'QueuePause' => {
+      :symbol => :queue_pause,
+      :search_for => 'Response:',
+      :stop_with => nil
+    },
+    'Pong' => {
+      :symbol => :pong,
+      :search_for => 'Response:',
+      :stop_with => nil
+    },
+    'Events' => {
+      :symbol => :event_mask,
+      :search_for => 'Ping:',
+      :stop_with => nil
+    },
+    'SIPpeers' => {
+      :symbol => :peers,
+      :search_for => 'Event: PeerEntry',
+      :stop_with => nil
+    },
+    'SIPshowpeer'  => {
+      :symbol => :hints,
+      :search_for => 'Response: Success',
+      :stop_with => nil
+    },
+  }
+end