kieranj-asterisk-manager 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kieran Johnson
+
+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.rdoc

@@ -0,0 +1,23 @@
+= asterisk-manager
+
+= Overview:
+
+A block based DSL for interacting with the Asterisk Manager through a TCP connection.
+
+== Installation:
+
+  $ gem sources -a http://gems.github.com/ (you only need to do this once)
+  $ gem install kieranj-asterisk-manager
+
+= Usage:
+  
+  require 'rubygems'
+  require 'asterisk-manager'
+  
+  AsteriskManager.start('host', 'user', 'secret') do |asterisk|
+    asterisk.dial('SIP/123testphone', '7275551212')
+  end
+
+== Copyright
+
+Copyright (c) 2009 Kieran Johnson. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/asterisk_manager.rb

@@ -0,0 +1,97 @@
+require "socket"
+
+# = Overview:
+
+# A block based DSL for interacting with the Asterisk Manager through a TCP connection.
+
+# = Usage:
+
+# AsteriskManager.start('host', 'user', 'secret') do |asterisk|
+#   asterisk.dial('SIP/123testphone', '7275551212')
+# end
+
+class AsteriskManager
+  
+  # <tt>:host</tt>:: Asterisk host/IP.
+  # <tt>:port</tt>:: Defaults to 5038
+  
+  def initialize(host, port=5038)
+    @host = host
+    @port = port
+  end
+  
+  class << self
+    
+    def start(host, username, secret, &block)
+      new(host).start(host, username, secret, &block)
+    end
+    
+  end
+  
+  # <tt>:host</tt>:: Asterisk host/IP.
+  # <tt>:username</tt>:: Asterisk username.
+  # <tt>:secret</tt>:: Asterisk secret.
+  # <tt>:port</tt>:: Defaults to 5038
+  
+  # TODO: Check authentication response, flag logged in or raise error
+  def start(host, username, secret, port=5038)
+    begin
+      @socket = TCPSocket.new(host, port)
+      login(username, secret)
+      return yield(self)
+    ensure
+      logout
+      @socket.close
+    end
+  end
+  
+  def ping
+    send_action "Ping"
+  end
+  
+  # Dials the extension from the channel.
+  # Required fields are:
+  # <tt>:channel</tt>:: Your Asterisk device.
+  # <tt>:extension</tt>:: The number to dial.
+  # Options
+  # <tt>:context</tt>:: Context
+  # <tt>:priority</tt>:: Priority
+  # <tt>:caller_id</tt>:: Caller ID
+
+  def originate(channel, extension, options={})
+    options = {:context => "phones", :priority => 1, :callerid => "Asterisk Automatic Wardial"}.merge(options)
+    send_action "Originate", {
+      :channel  => channel,
+      :context  => options[:context],
+      :exten    => extension,
+      :priority => options[:priority],
+      :callerid => options[:callerid],
+    }
+  end
+    
+  protected
+  
+    # <tt>:username</tt>:: Asterisk manager username.
+    # <tt>:secret</tt>:: Asterisk manager secret.
+  
+    def login(username, secret)
+      send_action "Login", { 
+        :username => username,
+        :secret   => secret
+      }
+    end
+
+    def logout
+      send_action "Logoff"
+    end
+    
+    # Send the action and options follow by extra new line.
+    
+    def send_action(action, options={})
+      action = "Action: #{action}\r\n"
+      action += options.map { |k,v| "#{k.to_s.capitalize}: #{v}"}.reverse.join("\r\n")
+      action += options.any? ? "\r\n\r\n" : "\r\n"
+      @socket.print(action)
+    end
+  
+end

data/test/asterisk_manager_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AsteriskManagerTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'asterisk_manager'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: kieranj-asterisk-manager
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kieran Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kieran@invisiblelines.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/asterisk_manager.rb
+- test/asterisk_manager_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/kieranj/asterisk-manager
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+