asterisk_manager 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28c86c4ef2ed94a4023c9fe1a1c5245c1dd6444d
+  data.tar.gz: 212000fd410995fc4570635b52bcb9170e3adec9
+SHA512:
+  metadata.gz: ed23e41f58af140006c6ad8b4362ba092f7b05f6db56aa096cc63346510637a01dc61134ef741edd40257ef9b6508362ce5b0c25bf8fc0969e5bc3e883e87fea
+  data.tar.gz: de51250b37c273f3bc9778959e2ac5ac44b71f79feb04417254570844ca65e0f208c8f0b14255661e40d410f0953a426ab4382d0bdc246beeac28a96005c9c91

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,26 @@
+# Asterisk Manager
+
+[![Build Status](https://travis-ci.org/kieranj/asterisk_manager.svg?branch=master)](https://travis-ci.org/kieranj/asterisk_manager)
+[![Code Climate](https://codeclimate.com/github/kieranj/asterisk_manager/badges/gpa.svg)](https://codeclimate.com/github/kieranj/asterisk_manager)
+[![Coverage Status](https://coveralls.io/repos/kieranj/asterisk_manager/badge.png)](https://coveralls.io/r/kieranj/asterisk_manager)
+[![Dependency Status](https://gemnasium.com/kieranj/asterisk_manager.svg)](https://gemnasium.com/kieranj/asterisk_manager)
+
+## Overview
+
+A block based DSL for interacting with the Asterisk Manager through a TCP connection.
+
+## Installation
+
+    $ gem install asterisk_manager
+
+## Usage
+
+    require 'asterisk_manager'
+
+    AsteriskManager::Client.start('host', 'user', 'secret') do |asterisk|
+      asterisk.dial('SIP/123testphone', '7275551212')
+    end
+
+## Copyright
+
+Copyright (c) 2009 Kieran Johnson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :spec
+
+task :default => :spec 

data/lib/asterisk_manager.rb

@@ -0,0 +1,2 @@
+require "socket"
+require 'asterisk_manager/client'

data/lib/asterisk_manager/client.rb

@@ -0,0 +1,108 @@
+module AsteriskManager
+
+  # = Overview:
+  #
+  # A block based DSL for interacting with the Asterisk Manager through a TCP connection.
+
+  # = Usage:
+  #
+  # AsteriskManager::Client.start('host', 'user', 'secret') do |asterisk|
+  #   asterisk.originate('SIP/123testphone', '7275551212')
+  # end
+
+  class Client
+
+    # <tt>host</tt>:: Asterisk host/IP.
+    # <tt>port</tt>:: Defaults to 5038
+
+    def initialize(host, port=5038)
+      @host   = host
+      @port   = port
+      @socket = TCPSocket.new(@host, @port)
+    end
+
+    class << self
+
+      # Convience method for new().start()
+      #
+      # <tt>host</tt>:: Asterisk host/IP.
+      # <tt>username</tt>:: Asterisk username.
+      # <tt>secret</tt>:: Asterisk secret.
+      # <tt>port</tt>:: Defaults to 5038
+
+      def start(host, username, secret, port=5038, &block)
+        new(host, port).start(username, secret, &block)
+      end
+
+    end
+
+    # Logs in, yields the block, then logs off and closes the socket
+    # <tt>host</tt>:: Asterisk host/IP.
+    # <tt>username</tt>:: Asterisk username.
+
+    # TODO: Check authentication response, flag logged in or raise error
+    def start(username, secret, &block)
+      return unless block_given?
+      begin
+        login(username, secret)
+        return yield(self)
+      ensure
+        logout
+        @socket.close
+      end
+    end
+
+    # Sends the ping command
+
+    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}"}.join("\r\n")
+        action += options.any? ? "\r\n\r\n" : "\r\n"
+        @socket.print(action)
+      end
+
+  end
+
+end

data/lib/asterisk_manager/version.rb

@@ -0,0 +1,3 @@
+module AsteriskManager
+  VERSION = '0.2.0'
+end

data/spec/asterisk_manager/client_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe AsteriskManager::Client do
+
+  let(:socket) { instance_double('TCPSocket', print: true, close: true) }
+
+  describe "a new session" do
+
+    before do
+      allow(TCPSocket).to receive(:new).and_return(socket)
+    end
+
+    it "creates a new socket" do
+      expect(TCPSocket).to receive(:new).and_return(socket)
+      AsteriskManager::Client.new("127.0.0.1")
+    end
+
+    it "returns if no block is given" do
+      expect(socket).not_to receive(:print)
+      AsteriskManager::Client.start("127.0.0.1", "tester", "secret")
+    end
+
+    it "logs in at the start of a session" do
+      expect(socket).to receive(:print).with("Action: Login\r\nUsername: tester\r\nSecret: secret\r\n\r\n")
+      AsteriskManager::Client.start('127.0.0.1', 'tester', 'secret') { |asterisk| asterisk.ping }
+    end
+
+    it "yields the block" do
+      expect(socket).to receive(:print).with("Action: Ping\r\n\r\n")
+      AsteriskManager::Client.start("127.0.0.1", "tester", "secret") { |asterisk| asterisk.ping }
+    end
+
+    it "logs off at the end of the session" do
+      expect(socket).to receive(:print).with("Action: Logoff\r\n\r\n")
+      AsteriskManager::Client.start("127.0.0.1", "tester", "secret") { |asterisk| asterisk.ping }
+    end
+
+    it "ensures the socket is closed when the session is closed" do
+      expect(socket).to receive(:close)
+      AsteriskManager::Client.start("127.0.0.1", "tester", "secret") { |asterisk| asterisk.ping }
+    end
+
+  end
+
+  describe 'originating a call' do
+    before do
+      allow(TCPSocket).to receive(:new).and_return(socket)
+    end
+
+    let(:channel)   { 'SIP/101test' }
+    let(:extension) { '8135551212' }
+    let(:options) {
+      {
+        context: 'default',
+        priority: 1,
+        callerid: '3125551212'
+      }
+    }
+
+    it 'sends an originate command' do
+      expect(socket).to receive(:print).with("Action: Originate\r\nChannel: #{channel}\r\nContext: #{options[:context]}\r\nExten: #{extension}\r\nPriority: #{options[:priority]}\r\nCallerid: #{options[:callerid]}\r\n\r\n")
+      AsteriskManager::Client.start('127.0.0.1', 'tester', 'secret') { |asterisk| asterisk.originate(channel, extension, options) }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspec'
+require 'asterisk_manager'

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: asterisk_manager
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kieran Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-09 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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: 
+email:
+- hello@invisiblelines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/asterisk_manager.rb
+- lib/asterisk_manager/client.rb
+- lib/asterisk_manager/version.rb
+- spec/asterisk_manager/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kieranj/asterisk_manager
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/asterisk_manager/client_spec.rb
+- spec/spec_helper.rb