eric-adhearsion 0.7.999

data/ahn_generators/component/component_generator.rb

@@ -0,0 +1,57 @@
+class ComponentGenerator < RubiGen::Base
+  
+  default_options :author => nil
+  
+  attr_reader :name, :class_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    @name       = @name.underscore
+    @class_name = @name.camelize
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "components/#{name}/lib"
+      m.directory "components/#{name}/test"
+
+      # Create stubs
+      m.file     "configuration.rb",    "components/#{name}/configuration.rb"
+      m.template "lib/lib.rb.erb",      "components/#{name}/lib/#{name}.rb"
+      m.template "test/test.rb.erb",    "components/#{name}/test/test_#{name}.rb"
+      m.file     "test/test_helper.rb", "components/#{name}/test/test_helper.rb"
+      
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/ahn_generators/component/templates/lib/lib.rb.erb

@@ -0,0 +1,3 @@
+class <%= class_name %>
+
+end

data/ahn_generators/component/templates/test/test.rb.erb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class Test<%= class_name %> < Test::Unit::TestCase
+
+  def setup
+    @<%= name %> = <%= class_name %>.new
+  end
+  
+  def test_truth
+    
+  end
+end

data/ahn_generators/component/templates/test/test_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__) + '/../../../../../lib'
+require 'adhearsion'
+require 'test/unit'
+require 'flexmock/test_unit'
+AHN_ROOT = Adhearsion::PathString.new(File.dirname(__FILE__) + '/../../..')
+Adhearsion::ComponentManager.load
+Adhearsion::ComponentManager.start
+
+class Test::Unit::TestCase
+  Adhearsion::ComponentManager.components_with_call_context.each_pair do |component_class_name, component_configuration|
+    const_set(component_class_name, component_configuration.component_class)
+    const_get(component_class_name).send(:attr_accessor, :call_context)
+  end
+end

data/app_generators/ahn/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/app_generators/ahn/ahn_generator.rb

@@ -0,0 +1,76 @@
+class AhnGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :author => nil
+  
+  attr_reader :name, :component
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    @component = 'simon_game'
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      m.file  *[".ahnrc"]*2
+      
+      m.file  *["components/simon_game/configuration.rb"]*2
+      m.file  *["components/simon_game/lib/simon_game.rb"]*2
+      m.file  *["components/simon_game/test/test_helper.rb"]*2
+      m.file  *["components/simon_game/test/test_simon_game.rb"]*2
+      
+      m.file  *["config/startup.rb"]*2
+      m.file  *["dialplan.rb"]*2
+      m.file  *["README"]*2
+      m.file  *["Rakefile"]*2
+      
+      m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'], 
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      components/simon_game/lib
+      components/simon_game/test
+      config
+    )
+end

data/app_generators/ahn/templates/.ahnrc

@@ -0,0 +1,12 @@
+# Adhearsion Runtime Configuration.
+
+paths:
+
+  # All paths are relative to this file's directory
+  init: config/startup.rb
+
+  dialplan: dialplan.rb
+
+  models:
+    directory: models
+    pattern: "*.rb"

data/app_generators/ahn/templates/README

@@ -0,0 +1,8 @@
+Start your new app with "ahn start /path/to/your/app"
+
+If you wish to use Adhearsion to control Asterisk's dialplan,
+change the contexts you wish to be affected in your
+/etc/asterisk/extensions.conf file to the following:
+
+[your_context_name]
+exten => _X.,1,AGI(agi://1.2.3.4) ; This IP here

data/app_generators/ahn/templates/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'adhearsion'
+require 'adhearsion/tasks'

data/app_generators/ahn/templates/components/simon_game/lib/simon_game.rb

@@ -0,0 +1,61 @@
+class SimonGame
+  add_call_context :as => :call_context
+
+  attr_accessor :number, :attempt
+  def initialize
+    initialize_number
+    initialize_attempt
+  end
+  
+  def start
+    loop do
+      say_number
+      collect_attempt
+      verify_attempt
+    end
+  end
+
+  def random_number
+    rand(10).to_s
+  end
+
+  def update_number
+    initialize_attempt
+    @number << random_number
+  end
+
+  def say_number
+    update_number
+    call_context.say_digits number
+  end
+
+  def collect_attempt
+    @attempt = call_context.input(number.size)
+  end
+
+  def verify_attempt
+    if attempt_correct? 
+      call_context.play 'good'
+    else
+      call_context.play %W(#{number.size - 1} times wrong-try-again-smarty)
+      reset
+    end
+  end
+
+  def attempt_correct?
+    attempt == number
+  end
+  
+  def initialize_attempt
+    @attempt ||= ''
+  end
+  
+  def initialize_number
+    @number ||= ''
+  end
+  
+  def reset
+    @attempt, @number = '', ''
+  end
+  
+end

data/app_generators/ahn/templates/components/simon_game/test/test_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__) + '/../../../../../lib'
+require 'adhearsion'
+require 'test/unit'
+require 'flexmock/test_unit'
+AHN_ROOT = Adhearsion::PathString.new(File.dirname(__FILE__) + '/../../..')
+Adhearsion::ComponentManager.load
+Adhearsion::ComponentManager.start
+
+class Test::Unit::TestCase
+  Adhearsion::ComponentManager.components_with_call_context.each_pair do |component_class_name, component_configuration|
+    const_set(component_class_name, component_configuration.component_class)
+    const_get(component_class_name).send(:attr_accessor, :call_context)
+  end
+end

data/app_generators/ahn/templates/components/simon_game/test/test_simon_game.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class TestSimonGame < Test::Unit::TestCase
+  attr_reader :game
+  def setup
+    @game = SimonGame.new
+    @game.call_context = mock_call_context
+  end
+  
+  def test_game_executes_say_digits_when_asked_to_say_number
+    flexmock(game).should_receive(:random_number).and_return("2")
+    mock_call_context.should_receive(:say_digits).once.with('2')
+    @game.say_number
+  end
+  
+  
+  # Didn't get very far on this
+  def xtest_can_play_one_round_and_receive_the_players_score
+    flexmock(game).should_receive(:random_number).and_return("2")
+    assert_equal(3, 'x')
+  end
+  
+    private
+    def mock_call_context
+      @mock_call_context ||= flexmock("Mock Call Context")
+    end
+    
+    def stub_random_number
+      
+    end
+end

data/app_generators/ahn/templates/config/startup.rb

@@ -0,0 +1,53 @@
+unless defined? Adhearsion
+  if File.exists? File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
+    # If you wish to freeze a copy of Adhearsion to this app, simply place a copy of Adhearsion
+    # into a folder named "adhearsion" within this app's main directory.
+    require File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
+  else  
+    require 'rubygems'
+    gem 'adhearsion', '>= 0.7.999'
+    require 'adhearsion'
+  end
+end
+
+Adhearsion::Configuration.configure do |config|
+  
+  # Supported levels (in increasing severity) -- :debug < :info < :warn < :error < :fatal
+  config.logging :level => :info
+  
+  # Whether incoming calls be automatically answered. Defaults to true.
+  # config.automatically_answer_incoming_calls = false
+  
+  # Whether the other end hanging up should end the call immediately. Defaults to true.
+  # config.end_call_on_hangup = false
+  
+  # Whether to end the call immediately if an unrescued exception is caught. Defaults to true.
+  # config.end_call_on_error = false
+  
+  # By default Asterisk is enabled with the default settings
+  config.enable_asterisk
+  # config.asterisk.enable_ami :host => "127.0.0.1", :username => "admin", :password => "password"
+  
+  # To change the host IP or port on which the AGI server listens, use this:
+  # config.enable_asterisk :listening_port => 4574, :listening_host => "127.0.0.1"
+  
+  # config.enable_drb 
+  
+  # Streamlined Rails integration! The first argument should be a relative or absolute path to 
+  # the Rails app folder with which you're integrating. The second argument must be one of the 
+  # the following: :development, :production, or :test.
+  
+  # config.enable_rails :path => 'gui', :env => :development
+  
+  # Note: You CANNOT do enable_rails and enable_database at the same time. When you enable Rails,
+  # it will automatically connect to same database Rails does and load the Rails app's models.
+  
+  # Configure a database to use ActiveRecord-backed models. See ActiveRecord::Base.establish_connection
+  # for the appropriate settings here.
+  # config.enable_database :adapter  => 'mysql',
+  #                        :username => 'joe', 
+  #                        :password => 'secret',
+  #                        :host     => 'db.example.org'
+end
+
+Adhearsion::Initializer.start_from_init_file(__FILE__, File.dirname(__FILE__) + "/..")

data/app_generators/ahn/templates/dialplan.rb

@@ -0,0 +1,4 @@
+adhearsion {
+  simon = new_simon_game
+  simon.start
+}

data/bin/ahn

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# This is the main executable file.
+
+# Adhearsion, open source collaboration framework
+# Copyright (C) 2006,2007,2008 Jay Phillips
+# 
+# This library is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
+# any later version.
+# 
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU Lesser General Public License along
+# with this library; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'adhearsion'
+require 'adhearsion/cli'
+
+Adhearsion::CLI::AhnCommand.execute!

data/bin/ahnctl

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# 
+#  ahnctl - Adhearsion daemon controller
+#
+# Adhearsion, open source collaboration framework
+# Copyright (C) 2006,2007,2008 Jay Phillips
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+USAGE = "Usage: ahnctl start|stop|restart /path/to/adhearsion/app [--pid-file=/path/to/pid_file.pid]" 
+
+# Blow up if the CLI arguments are invalid
+abort USAGE unless (2..3).include?(ARGV.size) && %w[start stop restart].include?(ARGV.first)
+
+# By default, ahnctl will use the version of Adhearsion it was installed with.
+
+pid_file    = ARGV.pop if ARGV.size == 3
+ahn_command = File.expand_path File.dirname(__FILE__) + "/ahn"
+app_dir     = File.expand_path ARGV.last
+
+pid_file_path_regexp = /^--pid-file=(.+)$/
+abort USAGE if pid_file && pid_file !~ pid_file_path_regexp
+
+# If pid_file is not nil, let's extract the path specified.
+pid_file &&= File.expand_path pid_file[pid_file_path_regexp,1]
+
+# If there was no third argument and pid_file is still nil, let's use the default.
+pid_file ||= app_dir + '/adhearsion.pid'
+
+abort "Directory is not an Adhearsion application!" unless File.exists?(app_dir + "/.ahnrc")
+
+def terminate(pid) `kill -s TERM #{pid} 2> /dev/null` end
+def      kill(pid) `kill -s KILL #{pid} 2> /dev/null` end
+
+# Even if we're starting Adhearsion, we need to make sure to clean up after any stale
+# pid files. In effect, start is the same as restart.
+puts "Stopping Adhearsion app at #{app_dir}" if %w[stop restart].include? ARGV.first
+
+if File.exists?(pid_file)
+  # An Adhearsion process may still be running. Let's kill the other one as cleanly as possible
+  pid = File.read(pid_file).to_i
+  
+  # Time to spend waiting for Adhearsion to exit
+  waiting_timeout = Time.now + 15
+  
+  terminate pid
+  sleep 0.25 until `ps -p #{pid} | sed -e '1d'`.strip.empty? || Time.now > waiting_timeout
+  kill pid
+  
+  `rm -f #{pid_file}`
+end
+
+if ['start', 'restart'].include? ARGV.first
+  puts "Starting Adhearsion app at #{app_dir}"
+  `#{ahn_command} start daemon #{app_dir} --pid-file=#{pid_file}`
+end

data/bin/jahn

@@ -0,0 +1,32 @@
+#!/usr/bin/env jruby
+
+# This "jahn" script is "ahn" for JRUBY!
+
+# Adhearsion, open source collaboration framework
+# Copyright (C) 2006,2007,2008 Jay Phillips
+# 
+# This library is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
+# any later version.
+# 
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+# 
+# You should have received a copy of the GNU Lesser General Public License along
+# with this library; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'adhearsion'
+require 'adhearsion/cli'
+
+# jahn will soon have JRuby-specific behavior such as creating a compiled .jar
+# file from an app.
+# require 'adhearsion/jruby'
+
+Adhearsion::CLI::AhnCommand.execute!

data/lib/adhearsion/blank_slate.rb

@@ -0,0 +1,5 @@
+class BlankSlate
+  instance_methods.each do |method| 
+    undef_method method unless method =~ /^__/ || method == 'instance_eval'
+  end
+end

data/lib/adhearsion/cli.rb

@@ -0,0 +1,106 @@
+require 'fileutils'
+
+module Adhearsion
+  module CLI
+    module AhnCommand
+      USAGE = <<USAGE
+Usage:
+   ahn create /path/to/directory
+   ahn start [daemon] [directory]
+   ahn version|-v|--v|-version|--version
+   ahn help|-h|--h|--help|-help
+
+Under development:
+   ahn create:projectname /path/to/directory
+USAGE
+    
+      def self.execute!
+        CommandHandler.send(*parse_arguments)
+      end
+      
+      def self.parse_arguments(args=ARGV.clone)
+        action = args.shift
+        case action
+          when /^-?-?h(elp)?$/, nil   then [:help]
+          when /^-?-?v(ersion)?$/     then [:version]
+          when /^create(:([\w_.]+))?$/
+            [:create, args.shift, $LAST_PAREN_MATCH || :default]
+          when 'start'
+            pid_file_regexp = /^--pid-file=(.+)$/
+            if args.size > 3
+              raise CommandHandler::UnknownCommand, "Too many arguments supplied!" if args.size > 3
+            elsif args.size == 3
+              raise CommandHandler::UnknownCommand, "Unrecognized final argument #{args.last}" unless args.last =~ pid_file_regexp
+              pid_file = args.pop[pid_file_regexp, 1]
+            else
+              pid_file = nil
+            end
+            
+            if args.first == 'daemon' && args.size == 2
+              path   = args.last
+              daemon = true
+            elsif args.size == 1
+              path, daemon = args.first, false
+            else
+              raise CommandHandler::UnknownCommand, "Invalid format for the start CLI command!"
+            end
+            [:start, path, daemon, pid_file]
+          when '-'
+            [:start, Dir.pwd]
+          else
+            [action, *args]
+        end
+      end
+      
+      module CommandHandler
+        class << self
+          def create(path, project=:default)
+            raise UnknownProject.new(project) if project != :default # TODO: Support other projects
+            require 'rubigen'
+            require 'rubigen/scripts/generate'
+            source = RubiGen::PathSource.new(:application, 
+              File.join(File.dirname(__FILE__), "../../app_generators"))
+            RubiGen::Base.reset_sources
+            RubiGen::Base.append_sources source
+            RubiGen::Scripts::Generate.new.run([path], :generator => 'ahn')
+          end
+        
+          def start(path, daemon=false, pid_file=nil)
+            raise PathInvalid, path unless File.exists? path + "/.ahnrc"
+            Adhearsion::Initializer.new path, :daemon => daemon, :pid_file => pid_file
+          end
+        
+          def version
+            puts "Adhearsion v#{Adhearsion::VERSION::STRING}"
+          end
+        
+          def help
+            puts USAGE
+          end
+        
+          def method_missing(action, *args)
+            raise UnknownCommand, [action, *args] * " "
+          end
+        end
+        
+        class UnknownCommand < Exception
+          def initialize(cmd)
+            super "Unknown command: #{cmd}\n#{USAGE}"
+          end
+        end
+        
+        class UnknownProject < Exception
+          def initialize(project)
+            super "Application #{project} does not exist! Have you installed it?"
+          end
+        end
+        
+        class PathInvalid < Exception
+          def initialize(path)
+            super "Directory #{path} does not contain an Adhearsion project!"
+          end
+        end
+      end
+    end
+  end
+end