adhearsion-asterisk 0.1.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor/ruby
+coverage
+.*.swp
+vendor/bundle
+tags
+.rbenv-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# develop
+
+# v0.1.0 - 2012-01-17
+  * A whole bunch of new stuff
+
+## Config Generators
+  * Asterisk config generators moved from Adhearsion
+  * Namespace cleanup
+
+## Plugin Rename
+  * ahn-asterisk to adhearsion-asterisk
+
+# v0.0.1
+  * First release!

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'adhearsion', :git => 'git://github.com/adhearsion/adhearsion.git', :branch => :develop
+
+# Specify your gem's dependencies in ahn-asterisk.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011 Ben Langfeld
+
+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,143 @@
+adhearsion-asterisk
+===========
+
+adhearsion-asterisk is an Adhearsion Plugin providing Asterisk-specific dialplan methods, AMI access, and access to Asterisk configuration.
+
+Features
+--------
+
+Dialplan methods
+
+  * agi
+  * execute
+  * verbose
+  * get_variable
+  * set_variable
+  * sip_add_header
+  * sip_get_header
+  * variable
+  * meetme
+  * voicemail
+  * voicemail_main
+  * queue
+  * play
+  * play!
+  * play_time
+  * play_numeric
+  * play_soundfile
+  * enable_feature
+  * disable_feature
+
+Asterisk configuration generators
+
+  * agents.conf
+  * queues.conf
+  * voicemail.conf
+
+Requirements
+------------
+
+* Adhearsion 2.0+
+* Asterisk 1.8+
+
+Install
+-------
+
+Add `adhearsion-asterisk` to your Adhearsion app's Gemfile.
+
+Examples
+--------
+
+### Dialplan
+
+
+```ruby
+vm {
+  voicemail "8000"
+}
+
+echotest {
+  play 'demo-echotest'
+  execute 'Echo'
+  play 'demo-echodone'
+}
+
+saytime {
+  t = Time.now
+  date = t.to_date
+  date_format = 'ABdY'
+  execute "SayUnixTime", t.to_i, date_format
+  play_time date, :format => date_format
+}
+
+callqueue {
+  case extension
+  when 5001
+    queue 'sales'
+  when 5002
+    queue 'support'
+  end
+}
+
+salesagent {
+  queue('sales').join!
+}
+
+supportagent {
+  queue('support').join!
+}
+
+operator {
+  enable_feature :blind_transfer
+  dial extension, :options => "Tt"
+}
+
+
+```
+
+### Config generation
+
+Stand-alone example
+
+```ruby
+require 'adhearsion/asterisk'
+require 'adhearsion/asterisk/config_generator/voicemail'
+
+config_generator = Adhearsion::Asterisk::ConfigGenerator::Voicemail.new
+asterisk_config_file = "voicemail.conf"
+
+File.open(asterisk_config_file, "w") do |file|
+  file.write config_generator
+end
+```
+
+agents.conf, and queue.conf can be done similarly.
+
+Author
+------
+
+Original author: [Ben Langfeld](https://github.com/benlangfeld)
+
+Contributors:
+  * [Taylor Carpenter](https://github.com/taylor)
+
+Links
+-----
+* [Source](https://github.com/adhearsion/adhearsion-asterisk)
+* [Documentation](http://rdoc.info/github/adhearsion/adhearsion-asterisk/master/frames)
+* [Bug Tracker](https://github.com/adhearsion/adhearsion-asterisk/issues)
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2011 Ben Langfeld. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+task :default => :spec
+task :ci => ['ci:setup:rspec', :spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/adhearsion-asterisk.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "adhearsion/asterisk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "adhearsion-asterisk"
+  s.version     = Adhearsion::Asterisk::VERSION
+  s.authors     = ["Ben Langfeld", "Taylor Carpenter"]
+  s.email       = ["blangfeld@adhearsion.com", "taylor@codecafe.com"]
+  s.homepage    = "http://adhearsion.com"
+  s.summary     = %q{Asterisk specific features for Adhearsion}
+  s.description = %q{An Adhearsion Plugin providing Asterisk-specific dialplan methods, AMI access, and access to Asterisk configuration}
+
+  s.rubyforge_project = "adhearsion-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_runtime_dependency %q<adhearsion>, [">= 2.0.0"]
+  s.add_runtime_dependency %q<activesupport>, [">= 3.0.10"]
+
+  s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
+  s.add_development_dependency %q<rspec>, [">= 2.5.0"]
+  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
+  s.add_development_dependency %q<simplecov>, [">= 0"]
+  s.add_development_dependency %q<simplecov-rcov>, [">= 0"]
+  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<mocha>, [">= 0"]
+  s.add_development_dependency %q<bones>
+  s.add_development_dependency %q<guard-rspec>
+  s.add_development_dependency 'ruby_gntp'
+end

data/lib/adhearsion-asterisk.rb

@@ -0,0 +1 @@
+require 'adhearsion/asterisk'

data/lib/adhearsion/asterisk.rb

@@ -0,0 +1,12 @@
+require 'adhearsion'
+require 'active_support/dependencies/autoload'
+require 'adhearsion/asterisk/version'
+require 'adhearsion/asterisk/plugin'
+
+module Adhearsion
+  module Asterisk
+    extend ActiveSupport::Autoload
+
+    autoload :QueueProxy
+  end
+end

data/lib/adhearsion/asterisk/config_generator.rb

@@ -0,0 +1,103 @@
+module Adhearsion
+  module Asterisk
+    class ConfigGenerator
+      extend ActiveSupport::Autoload
+
+      autoload :Agents
+      autoload :Queues
+      autoload :Voicemail
+
+      SECTION_TITLE = /(\[[\w_-]+\])/
+
+      class << self
+
+        # Converts a config file into a Hash of contexts mapping to two dimensional array of pairs
+        def create_sanitary_hash_from(config_file_content)
+          almost_sanitized = Hash[*config_file_content.
+            split("\n").          # Split the lines into an Array
+            grep(/^\s*[^;\s]/).   # Grep lines that aren't commented out
+            join("\n").           # Convert them into one String again
+            split(SECTION_TITLE). # Separate them into sections
+            map(&:strip).         # Remove all whitespace
+            reject(&:empty?).     # Get rid of indices that were only whitespace
+                                  # Lastly, separate the keys/value pairs for the Hash
+            map { |token| token =~ /^#{SECTION_TITLE}$/ ? token : token.split(/\n+/).sort }
+          ]
+        end
+
+        def warning_message
+          %{;; THIS FILE WAS GENERATED BY ADHEARSION ON #{Time.now.ctime}!\n} +
+          %{;; ANY CHANGES MADE BELOW WILL BE BLOWN AWAY WHEN THE FILE IS REGENERATED!\n\n}
+        end
+
+      end
+
+      def initialize
+        yield self if block_given?
+      end
+
+      def to_sanitary_hash
+        self.class.create_sanitary_hash_from to_s
+      end
+
+      protected
+
+      def boolean(options)
+        cache = options.delete(:with) || properties
+        options.each_pair do |key, value|
+          cache[key] = boolean_to_yes_no value
+        end
+      end
+
+      def string(options)
+        cache = options.delete(:with) || properties
+        options.each_pair do |key, value|
+          cache[key] = value
+        end
+      end
+
+      def int(options)
+        cache = options.delete(:with) || properties
+        options.each_pair do |property,number|
+          number = number.to_i if (number.kind_of?(String) && number =~ /^\d+$/) || number.kind_of?(Numeric)
+          raise ArgumentError, "#{number.inspect} must be an integer" unless number.kind_of?(Fixnum)
+          cache[property] = number.to_i
+        end
+      end
+
+      def one_of(criteria, options)
+        cache = options.delete(:with) || properties
+        options.each_pair do |key, value|
+          search = !criteria.find { |criterion| criterion === value }.nil?
+          unless search
+            msg = "Didn't recognize #{value.inspect}! Must be one of " + criteria.map(&:inspect).to_sentence
+            raise ArgumentError, msg
+          end
+          cache[key] = [true, false].include?(value) ? boolean_to_yes_no(value) : value
+        end
+      end
+
+      def one_of_and_translate(criteria, options)
+        cache = options.delete(:with) || properties
+        options.each_pair do |key, value|
+          search = criteria.keys.find { |criterion| criterion === value }
+          unless search
+            msg = "Didn't recognize #{value.inspect}! Must be one of " + criteria.keys.map(&:inspect).to_sentence
+            raise ArgumentError, msg
+          end
+          cache[key] = criteria[value]
+        end
+      end
+
+      private
+
+      def boolean_to_yes_no(boolean)
+        unless boolean.equal?(boolean) || boolean.equal?(boolean)
+          raise "#{boolean.inspect} is not true/false!"
+        end
+        boolean ? 'yes' : 'no'
+      end
+
+    end
+  end
+end

data/lib/adhearsion/asterisk/config_generator/agents.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), '../config_generator')
+
+module Adhearsion
+  module Asterisk
+    class ConfigGenerator
+      class Agents < ConfigGenerator
+
+        attr_accessor :general_section, :agent_section, :agent_definitions, :agent_section_special
+        def initialize
+          @general_section       = {}
+          @agent_section         = {}
+          @agent_section_special = {} # Uses => separator
+          @agent_definitions     = []
+
+          super
+        end
+
+        def to_s
+          ConfigGenerator.warning_message +
+          general_section.inject("[general]") { |section,(key,value)| section + "\n#{key}=#{value}" } +
+          agent_section.inject("\n[agents]")  { |section,(key,value)| section + "\n#{key}=#{value}" } +
+          agent_section_special.inject("")    { |section,(key,value)| section + "\n#{key} => #{value}" } +
+          agent_definitions.inject("\n") do |section,properties|
+            section + "\nagent => #{properties[:id]},#{properties[:password]},#{properties[:name]}"
+          end
+        end
+        alias conf to_s # Allows "agents.conf" if agents.kind_of?(Agents)
+
+        def agent(id, properties)
+          agent_definitions << {:id => id}.merge(properties)
+        end
+
+        # Group memberships for agents (may change in mid-file)
+        # WHAT DOES GROUPING ACCOMPLISH?
+        def groups(*args)
+          agent_section[:group] = args.join(",")
+        end
+
+        # Define whether callbacklogins should be stored in astdb for
+        # persistence. Persistent logins will be reloaded after
+        # Asterisk restarts.
+        def persistent_agents(yes_or_no)
+          general_section[:persistentagents] = boolean_to_yes_no yes_or_no
+        end
+
+        # enable or disable a single extension from longing in as multiple
+        # agents, defaults to enabled
+        def allow_multiple_logins_per_extension(yes_or_no)
+          general_section[:multiplelogin] = boolean_to_yes_no yes_or_no
+        end
+
+        # Define maxlogintries to allow agent to try max logins before
+        # failed. Default to 3
+        def max_login_tries(number_of_tries)
+          agent_section[:maxlogintries] = number_of_tries
+        end
+
+        # Define autologoff times if appropriate.  This is how long
+        # the phone has to ring with no answer before the agent is
+        # automatically logged off (in seconds)
+        def log_off_after_duration(time_in_seconds)
+          agent_section[:autologoff] = time_in_seconds
+        end
+
+        # Define autologoffunavail to have agents automatically logged
+        # out when the extension that they are at returns a CHANUNAVAIL
+        # status when a call is attempted to be sent there.
+        # Default is "no".
+        def log_off_if_unavailable(yes_or_no)
+          agent_section[:autologoffunavail] = boolean_to_yes_no yes_or_no
+        end
+
+        # Define ackcall to require an acknowledgement by '#' when
+        # an agent logs in using agentcallbacklogin.  Default is "no".
+        def require_hash_to_acknowledge(yes_or_no)
+          agent_section[:ackcall] = boolean_to_yes_no yes_or_no
+        end
+
+        # Define endcall to allow an agent to hangup a call by '*'.
+        # Default is "yes". Set this to "no" to ignore '*'.
+        def allow_star_to_hangup(yes_or_no)
+          agent_section[:endcall] = boolean_to_yes_no yes_or_no
+        end
+
+        # Define wrapuptime.  This is the minimum amount of time when
+        # after disconnecting before the caller can receive a new call
+        # note this is in milliseconds.
+        def time_between_calls(time_in_seconds)
+          agent_section[:wrapuptime] = (time_in_seconds * 1000).to_i
+        end
+
+        # Define the default musiconhold for agents
+        # musiconhold => music_class
+        def hold_music_class(music_class)
+          agent_section_special[:musiconhold] = music_class.to_s
+        end
+
+        # TODO: I'm not exactly sure what this even does....
+
+        # Define the default good bye sound file for agents
+        # default to vm-goodbye
+        def play_on_agent_goodbye(sound_file_name)
+          agent_section_special[:agentgoodbye] = sound_file_name
+        end
+
+        # Define updatecdr. This is whether or not to change the source
+        # channel in the CDR record for this call to agent/agent_id so
+        # that we know which agent generates the call
+        def change_cdr_source(yes_or_no)
+          agent_section[:updatecdr] =  boolean_to_yes_no yes_or_no
+        end
+
+        # An optional custom beep sound file to play to always-connected agents.
+        def play_for_waiting_keep_alive(sound_file)
+          agent_section[:custom_beep] = sound_file
+        end
+
+        def record_agent_calls(yes_or_no)
+          agent_section[:recordagentcalls] = boolean_to_yes_no yes_or_no
+        end
+
+        def recording_format(symbol)
+          raise ArgumentError, "Unrecognized format #{symbol}" unless [:wav, :wav49, :gsm].include? symbol
+          agent_section[:recordformat] = symbol
+        end
+
+        def recording_prefix(string)
+          agent_section[:urlprefix] = string
+        end
+
+        def save_recordings_in(path_to_directory)
+          agent_section[:savecallsin] = path_to_directory
+        end
+
+      end
+    end
+  end
+end