ruby-asterisk 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+# 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
+
+## Installation
+
+### Rails3
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+ gem "ruby-asterisk"
+```
+
+### Rails2
+
+Simply run in your terminal
+
+```ruby
+ gem install ruby-asterisk
+```
+
+## Usage
+
+### INITIALIZE
+
+To create a new AMI session, just call the following command
+
+```ruby
+ @ami = RubyAsterisk::AMI.new("192.168.1.1",5038)
+```
+
+### LOGIN
+
+To log in, provide to the created sessions a valid username and password 
+
+```ruby
+ @ami.login("mark","mysecret")
+```
+
+Like all commands, it will return a Response command that could be parsed accordingly
+
+### CORE SHOW CHANNELS
+
+To get a list of all channels currently active on your Asterisk installation, use the following command
+
+```ruby
+ @ami.core_show_channels
+```
+
+### PARKED CALLS
+
+To get a list of all parked calls on your Asterisk PBX, use the following command
+
+```ruby
+ @ami.parked_calls
+```
+
+### ORIGINATE
+
+To start a new call use the following command
+
+```ruby
+ @ami.originate("SIP/9100","OUTGOING","123456","1") # CALLER, CONTEXT, CALLEE, PRIORITY
+```
+
+
+### THE RESPONSE OBJECT
+
+The response object contains all information about all data received from Asterisk. Here follows a list of all object's properties:
+
+- type
+- success
+- action_id
+- message
+- data
+
+The data property contains all additional information obtained from Asterisk, like for example the list of active channels after a "core show channels" command.
+
+## 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`.
+
+This gem is created by Emiliano Della Casa and is under the MIT License and it is distributed by courtesy of [Engim srl](http://www.engim.eu/en).
+

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/ruby-asterisk.rb

@@ -0,0 +1,84 @@
+require "ruby-asterisk/version"
+require "ruby-asterisk/request"
+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
+      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 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 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 originate(caller,context,callee,priority)
+			request = Request.new("Originate",{"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000"  })
+			request.commands.each do |command|
+        @session.write(command)
+      end
+      @session.waitfor("String" => "ActionID: "+request.action_id, "Timeout" => 30) do |data|
+        request.response_data << data
+      end
+      Response.new("Originate",request.response_data)
+		end
+	end
+end

data/lib/ruby-asterisk/request.rb

@@ -0,0 +1,28 @@
+module RubyAsterisk
+	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"
+			end
+			_commands[_commands.length-1]<<"\r\n"
+			_commands
+		end 
+
+		protected
+
+		def generate_action_id
+			Random.rand(999).to_s
+		end
+
+	end
+end

data/lib/ruby-asterisk/response.rb

@@ -0,0 +1,79 @@
+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|
+        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_calls(response)
+			end
+    end
+
+		def _parse_originate_calls(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")
+		end
+
+		def _parse_objects(response,symbol_name,search_for)
+			 _data = { symbol_name => [] }
+      parsing = false
+      object = nil
+      response.each_line do |line|
+        if line.start_with?(search_for)
+          _data[symbol_name] << object unless object.nil?
+          object = {}
+          parsing = true
+        elsif line.strip.empty?
+          parsing = false
+        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/ruby-asterisk/version.rb

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

data/ruby-asterisk.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-asterisk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-asterisk"
+  s.version     = Rami::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Emiliano Della Casa"]
+  s.email       = ["e.dellacasa@engim.eu"]
+  s.homepage    = "http://github.com/emilianodellacasa/ruby-asterisk"
+  s.summary     = %q{Asterisk Manager Interface in Ruby}
+  s.description = %q{Add support to your ruby or rails projects to Asterisk Manager Interface (AMI)}
+
+  s.rubyforge_project = "ruby-asterisk"
+
+  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/ruby-asterisk/response_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require 'spec_helper'
+describe RubyAsterisk::Response do
+
+	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: 3335313510
+		CallerIDname:
+		ConnectedLineNum:
+		ConnectedLineName:
+		Duration: 00:00:05
+		AccountCode:
+		BridgedChannel:
+		BridgedUniqueID:"
+	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: 3335313510
+		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
+
+	describe ".new" do
+		
+		describe "receiving a Core Show Channels request" do
+			it "should parse correctly data coming from Asterisk about channels" do 
+				@response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
+				@response.data[:channels].should_not be_empty
+			end
+
+			it "should correctly fill the fields" do
+        @response = RubyAsterisk::Response.new("CoreShowChannels",core_show_channels_response)
+        @response.data[:channels][0]["CallerIDnum"].should eq("3335313510")
+      end
+		end
+	
+		describe "receiving a Parked Calls request" do
+			it "should parse correctly data coming from Asterisk about calls" do
+				@response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
+				@response.data[:calls].should_not be_empty
+			end
+
+			it "should correctly fill the fields" do
+				@response = RubyAsterisk::Response.new("ParkedCalls",parked_calls_response)
+				@response.data[:calls][0]["Exten"].should eq("701")
+			end
+		end
+
+		describe "resceiving a Originate request" do 
+			it "should parse correctly data coming from Asterisk about the call" do
+        @response = RubyAsterisk::Response.new("Originate",originate_response)
+        @response.data[:dial].should_not be_empty
+      end
+
+      it "should correctly fill the fields" do
+        @response = RubyAsterisk::Response.new("Originate",originate_response)
+        @response.data[:dial][0]["UniqueID"].should eq("1335457364.68")
+      end
+    end
+	end
+end

data/spec/ruby-asterisk/ruby_asterisk_spec.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+require 'spec_helper'
+describe RubyAsterisk do
+
+	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: 3335313510
+		CallerIDname:
+		ConnectedLineNum:
+		ConnectedLineName:
+		Duration: 00:00:05
+		AccountCode:
+		BridgedChannel:
+		BridgedUniqueID:"
+	end
+
+	def mock_request(stubs={})
+    (@mock_request ||= mock_model(RubyAsterisk::Request).as_null_object).tap do |request|
+      request.stub(stubs) unless stubs.empty?
+    end
+  end
+
+	before :each do
+		@session = RubyAsterisk::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(RubyAsterisk::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(RubyAsterisk::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(RubyAsterisk::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").should be_kind_of(RubyAsterisk::Response)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+require 'ruby-asterisk'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-asterisk
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Emiliano Della Casa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-27 00:00:00 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"
+  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"
+  type: :development
+  version_requirements: *id002
+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: 
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
+- lib/ruby-asterisk.rb
+- lib/ruby-asterisk/request.rb
+- lib/ruby-asterisk/response.rb
+- lib/ruby-asterisk/version.rb
+- ruby-asterisk.gemspec
+- spec/ruby-asterisk/response_spec.rb
+- spec/ruby-asterisk/ruby_asterisk_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/emilianodellacasa/ruby-asterisk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: ruby-asterisk
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Asterisk Manager Interface in Ruby
+test_files: []
+