asterisk-ami 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eb66f2410e0015663bbbb1a8c4b0b3634bea943
+  data.tar.gz: 2d9c4156b2c46e7bb96207d0442495492b4c116d
+SHA512:
+  metadata.gz: 65aa25c87e102d4db1340e899c712b545f0320fb8b66e774e3b7fc6d3487cd9dca2910fc2d8c3c31b6072bdb0b6c86dfeb841e3660bac19ed060255c8d5bcfd1
+  data.tar.gz: b8b51aa1f3ef5d63e4f3dec088b9b995f68b26603916388379e2b88f79986ec1dea5db1b8a0ecc2298324e3d8af0f9e4dead438bd790ed18eeae622f18baa4fe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+asterisk-ami

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asterisk-ami.gemspec
+gemspec
+
+gem 'em-websocket', :git => "https://github.com/igrigorik/em-websocket.git"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stewart McKee
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# Asterisk::Ami
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'asterisk-ami'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asterisk-ami
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/asterisk-ami.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asterisk/ami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asterisk-ami"
+  spec.version       = Asterisk::Ami::VERSION
+  spec.authors       = ["Stewart McKee"]
+  spec.email         = ["stewart@theizone.co.uk"]
+  spec.description   = %q{Asterisk AMI integration gem}
+  spec.summary       = %q{Asterisk AMI integration gem}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "lib/asterisk"]
+
+  spec.add_dependency "titleize"
+  spec.add_dependency "json"
+  spec.add_dependency "em-websocket", "> 0.5.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/bin/asterisk-ami

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/asterisk/server/socket.rb'

data/lib/ami.rb

@@ -0,0 +1,99 @@
+
+
+Dir[File.dirname(__FILE__) + '/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/asterisk/*.rb'].each {|file| require file }
+require "titleize"
+
+module Asterisk
+  class AMI
+
+    def initialize(username, password, host="localhost", port=5038)
+      @connection = Asterisk::Connection.new(username, password, host, port)
+    end
+
+    def connect
+      begin
+        @connection.connect
+        self.connected = true
+      rescue Exception => ex
+        false
+      end
+    end
+
+    def disconnect
+      begin
+        @connection.disconnect if self.connected
+        self.connected = false
+        true
+      rescue Exception => ex
+        puts ex
+        false
+      end
+    end
+
+    def command(command)
+      Asterisk::Action.new("Command", {"Command" => command}).send(@connection)
+    end
+
+    def core_show_channels
+      Asterisk::Action.new("CoreShowChannels").send(@connection)
+    end
+
+    def meet_me_list
+      Asterisk::Action.new("MeetMeList").send(@connection)
+    end
+
+    def parked_calls
+      Asterisk::Action.new("ParkedCalls").send(@connection)
+    end
+
+    def extension_state(exten,context)
+      Asterisk::Action.new("ExtensionState", {"Exten" => exten, "Context" => context}).send(@connection)
+    end
+
+    def originate(caller,context,callee,priority,variable=nil)
+      Asterisk::Action.new("Originate", {"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000", "Variable" => variable  }).send(@connection)
+    end
+
+    def channels
+      Asterisk::Action.new("Command", { "Command" => "show channels" }).send(@connection)
+    end
+
+    def redirect(caller,context,callee,priority,variable=nil)
+      Asterisk::Action.new("Redirect", {"Channel" => caller, "Context" => context, "Exten" => callee, "Priority" => priority, "Callerid" => caller, "Timeout" => "30000", "Variable" => variable}).send(@connection)
+    end
+
+    def queues
+      Asterisk::Action.new("Queues").send(@connection)
+    end
+
+    def queue_add(queue, exten, penalty=2, paused=false, member_name)
+      Asterisk::Action.new("QueueAdd", {"Queue" => queue, "Interface" => exten, "Penalty" => penalty, "Paused" => paused, "MemberName" => member_name}).send(@connection)
+    end
+
+    def queue_pause(queue, exten)
+      Asterisk::Action.new("QueuePause", {"Interface" => exten, "Paused" => paused}).send(@connection)
+    end
+
+    def queue_remove(queue, exten)
+      Asterisk::Action.new("QueueRemove", {"Queue" => queue, "Interface" => exten}).send(@connection)
+    end
+
+    def queue_status
+      Asterisk::Action.new("QueueStatus").send(@connection)
+    end
+
+    def queue_summary(queue)
+      Asterisk::Action.new("QueueSummary", {"Queue" => queue}).send(@connection)
+    end
+
+    def mailbox_status(exten, context="default")
+      Asterisk::Action.new("MailboxStatus", {"Mailbox" => "#{exten}@#{context}"}).send(@connection)
+    end
+
+    def mailbox_count(exten, context="default")
+      Asterisk::Action.new("MailboxCount", {"Mailbox" => "#{exten}@#{context}"}).send(@connection)
+    end
+
+  end
+end

data/lib/asterisk/action.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__)) + "/message_helper"
+
+module Asterisk
+  class Action
+    include Asterisk::MessageHelper
+
+    def initialize(command, options={})
+      @command = command
+      @options = options
+      @options[:action_id] = Random.rand(9999) unless @options.has_key?(:action_id)
+    end
+
+    def self.parse(str)
+      hash = self.parse_lines(str)
+      Asterisk::Action.new(hash.delete(:action), hash)
+    end
+
+    # send the ami action
+    def send(connection)
+      #puts self.to_ami
+      connection.write(self.to_ami + "\r\n\r\n")
+      #connection.waitfor("Match" => /\r\n\r\n/) do |received_data|
+        #puts received_data
+      #end
+    end
+
+    # convert the action to ami string to send down wire
+    def to_ami
+      ami_lines(@command, @options)
+    end
+
+    def to_hash
+      {:action => @command}.merge(@options)
+    end
+
+  end
+end

data/lib/asterisk/ami/version.rb

@@ -0,0 +1,5 @@
+module Asterisk
+  module Ami
+    VERSION = "0.0.2"
+  end
+end

data/lib/asterisk/connection.rb

@@ -0,0 +1,83 @@
+module Asterisk
+  class Connection
+
+    require "net/telnet"
+    require "json"
+
+    def initialize(username, password, server="localhost", port=5038)
+      @server = server
+      @port = port
+      @username = username
+      @password = password
+
+      @events = []
+    end
+
+    def connect(force = false)
+      if force || @connection.nil?
+        puts "Connecting to #{@server}:#{@port} with user #{@username}"
+        @connection = Net::Telnet::new("Host" => @server, "Port" => @port, "Timeout" => false, "Telnetmode" => false)
+        puts "connected"
+        @connection.waitfor(/Asterisk Call Manager\/\d+\.\d+/) {|response| puts response }
+        puts "Logging in.."
+        Asterisk::Action.new(:login, :username => @username, :secret => @password).send(@connection)
+        puts "Done."
+      end
+    end
+
+    def write(str)
+      @connection.write(str + "\r\n\r\n")
+    end
+
+    def events(&block)
+      force_connection = false
+      if block_given?
+        while true
+          connect(true)
+          t = Thread.new do |thread|
+            while true
+              puts "Waiting for data.."
+              @connection.waitfor("Match" => /\r\n\r\n/) do |received_data|
+                if received_data
+                  received_data.split("\r\n\r\n").each do |message|
+                    begin
+                      if message.include?("Event")
+                        yield Asterisk::Event.parse(message) if block_given?
+                      end
+                    rescue Errno::EPIPE => e
+                      puts "Error in connection to Asterisk: #{e.message}"
+                      puts e.backtrace.join("\n")
+                      sleep(4)
+                      t.kill
+                    rescue => e
+                      puts "Exception in Loop: #{e.message}"
+                    end
+                  end
+                else
+                  @connection.close
+                  puts "Reconnecting..."
+                  force_connection = true
+                  connect(true)
+                  break
+                end
+              end
+              puts "outside waitfor loop"
+            end
+            puts "Exited AMI loop!"
+          end
+          t.join
+          puts "after thread join"
+        end
+      end
+    end
+
+    def disconnect
+      @connection.close()
+    end
+
+    def connection
+      @connection
+    end
+
+  end
+end

data/lib/asterisk/event.rb

@@ -0,0 +1,9 @@
+module Asterisk
+
+  class Event
+    include Asterisk::MessageHelper
+    def self.parse(str)
+      parse_lines(str)
+    end
+  end
+end

data/lib/asterisk/message_helper.rb

@@ -0,0 +1,50 @@
+module Asterisk
+  module MessageHelper
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def parse_lines(str)
+        hash = {}
+        lines = str.gsub("\r", "").split("\n").select{|line| line.include?(":")}
+        lines = lines.map{|line| [line.split(":")[0], line.split(":")[1..-1].join(":")]}
+        lines = lines.map{|element| element.map{|e| e.strip}}
+        lines = lines.flatten
+        if lines.count > 0
+          hash = Hash[*lines]
+          hash.keys.each do |key|
+            hash[(underscore(key).to_sym) || key] = hash.delete(key)
+          end
+        end
+        hash
+      end
+
+      def underscore(str)
+        str.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+
+    def ami_lines(command, options)
+      messages = []
+      messages << add_line("Action", camelize(command, :upcase_ids => true))
+      options.map{|k,v| messages << add_line(camelize(k, :upcase_ids => true),v) }
+      messages.join("\r\n")
+    end
+
+    def add_line(key, value)
+      "#{key}: #{value}"
+    end
+
+    def camelize(term, options={})
+      options[:upcase_ids] = false unless options.has_key?(:upcase_ids)
+
+      string = term.to_s
+      string.split(/[\s|_]/).map{|s| s[0].upcase + s[1..-1].downcase}.join("")
+    end    
+  end
+end

data/lib/asterisk/response.rb

@@ -0,0 +1,9 @@
+module Asterisk
+  class Response
+
+    include Asterisk::MessageHelper
+    def self.parse(str)
+      parse_lines(str)
+    end
+  end
+end

data/lib/asterisk/server/socket.rb

@@ -0,0 +1,96 @@
+# Copyright: Hiroshi Ichikawa <http://gimite.net/en/>
+# Lincense: New BSD Lincense
+
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__)) + "/../lib"
+require File.expand_path(File.dirname(__FILE__)) + "/../../ami"
+
+require 'em-websocket'
+
+Thread.abort_on_exception = true
+# WebSocket.debug = true
+
+if ARGV.size != 5
+  $stderr.puts("Usage: asterisk-ami ACCEPTED_DOMAIN PORT AMI_USERNAME AMI_PASSWORD AMI_HOSTNAME")
+  exit(1)
+end
+
+# server = WebSocketServer.new(
+#   :accepted_domains => [ARGV[0], "localhost"],
+#   :port => ARGV[1].to_i())
+
+port = ARGV[1].to_i
+
+ami_username = ARGV[2]
+ami_password = ARGV[3]
+ami_host = ARGV[4]
+
+puts "Starting Server on port #{port}"
+EM.run {
+  EM::WebSocket.run(:host => "0.0.0.0", :port => port) do |ws|
+    ws.onopen { |handshake|
+
+      puts "Websocket connection request received"
+
+      # Access properties on the EM::WebSocket::Handshake object, e.g.
+      # path, query_string, origin, headers
+
+      # Publish message to the client
+      ws.send "Connected."
+    }
+
+    ws.onclose { puts "Connection closed" }
+
+    ws.onmessage { |msg|
+      puts "Recieved message: #{msg}"
+
+      if msg.is_json?
+        puts "its json"
+        data = JSON.parse(msg)
+        puts data
+        if data["command"]
+          puts "its a command"
+          case data["command"]
+          when "initiate-call"
+            puts "initiate call!"
+            ami_command = Asterisk::Action.new("Originate", :channel => "SIP/#{data["from"]}", :exten => data["to"], :priority => 1, :context => "default")
+            puts ami_command.to_ami
+          end
+          ami_command.send(@connection)
+        else
+          ws.send ("No action found to execute, you must supply a command")
+        end
+      else
+        ws.send "Pong: #{msg}"
+      end
+    }
+
+    @connection = Asterisk::Connection.new(ARGV[2], ARGV[3], ARGV[4])
+    t = Thread.new do
+      @connection.events do |data|
+        puts data.to_json
+        ws.send(data.to_json)
+      end
+    end
+
+  end
+}
+
+# puts("Server is running at port %d" % server.port)
+# server.run() do |ws|
+#   puts("Connection accepted")
+#   puts("Path: #{ws.path}, Origin: #{ws.origin}")
+#   if ws.path == "/"
+#     puts "Received connection from browser"
+#     ws.handshake()
+#     ws.send("Connected.")
+#     connection = Asterisk::Connection.new(ARGV[2], ARGV[3], ARGV[4])
+#     connection.events do |data|
+#       puts data.to_json
+#       ws.send(data.to_json)
+#     end
+#     puts "out of loop, finished thread."
+#   else
+#     ws.handshake("404 Not Found")
+#   end
+#   puts("Connection closed")
+# end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: asterisk-ami
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stewart McKee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Asterisk AMI integration gem
+email:
+- stewart@theizone.co.uk
+executables:
+- asterisk-ami
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asterisk-ami.gemspec
+- bin/asterisk-ami
+- lib/ami.rb
+- lib/asterisk/action.rb
+- lib/asterisk/ami/version.rb
+- lib/asterisk/connection.rb
+- lib/asterisk/event.rb
+- lib/asterisk/message_helper.rb
+- lib/asterisk/response.rb
+- lib/asterisk/server/socket.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/asterisk
+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: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Asterisk AMI integration gem
+test_files: []