sevenscale-adhearsion 0.7.1003 → 0.8.0

data/app_generators/ahn/templates/dialplan.rb

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

data/app_generators/ahn/templates/events.rb

@@ -1,6 +1,32 @@
-# For a full description of what this file does, view the online
-# documentation at http://adhearsion.com
-
-events.asterisk.before_call.each do |event|
-  
-end
+##
+# In this file you can define callbacks for different aspects of the framework. Below is an example:
+##
+#
+# events.asterisk.before_call.each do |call|
+#   # This simply logs the extension for all calls going through this Adhearsion app.
+#   extension = call.variables[:extension]
+#   ahn_log "Got a new call with extension #{extension}"
+# end
+#
+##
+# Asterisk Manager Interface example:
+#
+# events.asterisk.manager_interface.each do |event|
+#   ahn_log.events event.inspect
+# end
+#
+# This assumes you gave :events => true to the config.asterisk.enable_ami method in config/startup.rb
+#
+##
+# Here is a list of the events included by default:
+#
+# - events.asterisk.manager_interface
+# - events.after_initialized
+# - events.shutdown
+# - events.asterisk.before_call
+# - events.asterisk.failed_call
+# - events.asterisk.call_hangup
+#
+#
+# Note: events are mostly for components to register and expose to you.
+##

data/bin/jahn

@@ -29,4 +29,14 @@ require 'adhearsion/cli'
 # file from an app.
 # require 'adhearsion/jruby'
 
+abort(<<-MESSAGE) unless RUBY_PLATFORM =~ /java/
+You must use jahn with JRuby! Are you running this script after installing Adhearsion with non-JRuby RubyGems?
+
+If you don't want to install Adhearsion with the JRuby version of RubyGems, try running jahn directly with an absolute path:
+
+#{File.expand_path(__FILE__)} start your_app_name
+
+Note: You must have the jruby executable in your $PATH and $JRUBY_HOME set.
+MESSAGE
+
 Adhearsion::CLI::AhnCommand.execute!

data/examples/asterisk_manager_interface/standalone.rb

@@ -0,0 +1,51 @@
+# This is a file which shows you how to use the Asterisk Manager Interface library in a standalone Ruby script.
+
+PATH_TO_ADHEARSION = File.join(File.dirname(__FILE__), "/../..")
+
+MANAGER_CONNECTION_INFORMATION = {
+  :host     => "10.0.1.97",
+  :username => "jicksta",
+  :password => "roflcopter",
+  :events   => true
+}
+
+require 'rubygems'
+begin
+  require 'adhearsion'
+rescue LoadError
+  begin
+    require File.join(PATH_TO_ADHEARSION, "/lib/adhearsion")
+  rescue LoadError
+    abort "Could not find Adhearsion! Please update the PATH_TO_ADHEARSION constant in this file"
+  end
+end
+
+require 'adhearsion/voip/asterisk/manager_interface'
+
+# If you'd like to see the AMI protocol data, change this to :debug
+Adhearsion::Logging.logging_level = :warn
+
+# This makes addressing the ManagerInterface class a little cleaner
+include Adhearsion::VoIP::Asterisk::Manager
+
+# Let's instantiate a new ManagerInterface object and have it automatically connect using the Hash we defined above.
+interface = ManagerInterface.connect MANAGER_CONNECTION_INFORMATION
+
+# Send an AMI action with our new ManagerInterface object. This will return an Array of SIPPeer events.
+sip_peers = interface.send_action "SIPPeers"
+
+# Pretty-print the SIP peers on the server
+
+if sip_peers.any?
+  sip_peers.each do |peer|
+    # Uncomment the following line to view all the headers for each peer.
+    # p peer.headers
+    
+    peer_name   = peer.headers["ObjectName"]
+    peer_status = peer.headers["Status"]
+    
+    puts "#{peer_name}: #{peer_status}"
+  end
+else
+  puts "This Asterisk server has no SIP peers!"
+end

data/lib/adhearsion/cli.rb

@@ -6,16 +6,26 @@ module Adhearsion
       USAGE = <<USAGE
 Usage:
    ahn create /path/to/directory
-   ahn start [daemon] [directory]
+   ahn start [daemon] [/path/to/directory]
    ahn version|-v|--v|-version|--version
    ahn help|-h|--h|--help|-help
-
-Under development:
-   ahn create:projectname /path/to/directory
+   
+   ahn  enable component COMPONENT_NAME
+   ahn disable component COMPONENT_NAME
+   ahn  create component COMPONENT_NAME
 USAGE
     
       def self.execute!
         CommandHandler.send(*parse_arguments)
+      rescue CommandHandler::CLIException => error
+        fail_and_print_usage error
+      end
+      
+      ##
+      # Provides a small abstraction of Kernel::abort().
+      #
+      def self.fail_and_print_usage(error)
+        Kernel.abort "#{error.message}\n\n#{USAGE}"
       end
       
       def self.parse_arguments(args=ARGV.clone)
@@ -23,14 +33,14 @@ USAGE
         case action
           when /^-?-?h(elp)?$/, nil   then [:help]
           when /^-?-?v(ersion)?$/     then [:version]
-          when /^create(:([\w_.]+))?$/
-            [:create, args.shift, $LAST_PAREN_MATCH || :default]
+          when "create"
+            [:create, *args]
           when 'start'
             pid_file_regexp = /^--pid-file=(.+)$/
             if args.size > 3
-              raise CommandHandler::UnknownCommand, "Too many arguments supplied!" if args.size > 3
+              fail_and_print_usage "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
+              fail_and_print_usage "Unrecognized final argument #{args.last}" unless args.last =~ pid_file_regexp
               pid_file = args.pop[pid_file_regexp, 1]
             else
               pid_file = nil
@@ -42,11 +52,19 @@ USAGE
             elsif args.size == 1
               path, daemon = args.first, false
             else
-              raise CommandHandler::UnknownCommand, "Invalid format for the start CLI command!"
+              fail_and_print_usage "Invalid format for the start CLI command!"
             end
             [:start, path, daemon, pid_file]
           when '-'
             [:start, Dir.pwd]
+          when "enable", "disable"
+            if args.size == 1
+              raise CommandHandler::UnknownCommand, "Must supply an argument for what you wish to #{action}"
+            elsif args.size == 2
+              [action, *args]
+            else
+              raise CommandHandler::UnknownCommand, "Too many arguments supplied!"
+            end
           else
             [action, *args]
         end
@@ -54,15 +72,56 @@ USAGE
       
       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')
+          
+          def create(*args)
+            if args.size.zero?
+              raise CommandHandler::UnknownCommand.new("Must specify something to create!")
+            elsif args.size == 1
+              # We're creating a project
+              path = args.first
+              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')
+            elsif args.size == 2
+              # We're creating a feature (e.g. a component)
+              feature_type, component_name = args
+              
+              if feature_type != "component"
+                # At the moment, only components can be created.
+                raise CommandHandler::UnknownCommand.new("Don't know how to create '#{feature_type}'") 
+              end
+              
+              if component_name !~ /^[a-z][\w_]+$/
+                raise CommandHandler::ComponentError.new("Component name must be lowercase alphanumeric characters " +
+                    "and begin with a character")
+              end
+              
+              app_path = PathString.from_application_subdirectory Dir.pwd
+              
+              raise PathInvalid.new(Dir.pwd) if app_path.nil?
+              
+              new_component_dir = app_path + "/components/#{component_name}"
+              raise ComponentError.new("Component #{component_name} already exists!") if File.exists?(new_component_dir)
+              
+              # Everything's good. Let's create the component
+              Dir.mkdir new_component_dir
+              File.open(new_component_dir + "/#{component_name}.rb","w") do |file|
+                file.puts <<-RUBY
+# See http://docs.adhearsion.com for more information on how to write components or
+# look at the examples in newly-created projects.
+                RUBY
+              end
+              File.open(new_component_dir + "/config.yml","w") do |file|
+                file.puts '# You can use this file for component-specific configuration.'
+              end
+              puts "Created blank component '#{component_name}' at components/#{component_name}"
+            else
+              raise CommandHandler::UnknownCommand.new("Provided too many arguments to 'create'")
+            end
           end
         
           def start(path, daemon=false, pid_file=nil)
@@ -78,26 +137,84 @@ USAGE
             puts USAGE
           end
         
+          def enable(type, name)
+            case type
+              when "component"
+                app_path = PathString.from_application_subdirectory Dir.pwd
+                if app_path
+                  disabled_component_path = File.join app_path, "components", "disabled", name
+                  enabled_component_path  = File.join app_path, "components", name
+                  if File.directory? disabled_component_path
+                    FileUtils.mv disabled_component_path, enabled_component_path
+                    puts "Enabled component #{name}"
+                  else
+                    raise ComponentError.new("There is no components/disabled directory!")
+                  end
+                else
+                  raise PathInvalid.new(Dir.pwd)
+                end
+              else
+                raise UnknownCommand.new("enable #{type}")
+            end
+          end
+          
+          def disable(type, name)
+            case type
+              when "component"
+                app_path = PathString.from_application_subdirectory Dir.pwd
+                if app_path
+                  disabled_dir = File.join app_path, "components", "disabled"
+                  
+                  disabled_component_path = File.join disabled_dir, name
+                  enabled_component_path  = File.join app_path, "components", name
+                  
+                  Dir.mkdir disabled_dir unless File.directory?(disabled_dir)
+                  
+                  if File.directory? enabled_component_path
+                    if File.directory?(disabled_component_path)
+                      raise ComponentError.new("There is already a disabled component at #{disabled_component_path}")
+                    else
+                      FileUtils.mv enabled_component_path, disabled_component_path
+                      puts "Disabled component #{name}"
+                    end
+                  else
+                    raise ComponentError.new("Could not find component #{name} at #{enabled_component_path} !")
+                  end
+                else
+                  raise PathInvalid.new(Dir.pwd)
+                end
+              else
+                raise UnknownCommand.new("disable #{type}")
+            end
+          end
+          
           def method_missing(action, *args)
             raise UnknownCommand, [action, *args] * " "
           end
+          
+          private
+          
         end
         
-        class UnknownCommand < Exception
+        class CLIException < Exception; end
+        
+        class UnknownCommand < CLIException
           def initialize(cmd)
-            super "Unknown command: #{cmd}\n#{USAGE}"
+            super "Unknown command: #{cmd}"
           end
         end
         
-        class UnknownProject < Exception
+        class ComponentError < CLIException; end
+        
+        class UnknownProject < CLIException
           def initialize(project)
             super "Application #{project} does not exist! Have you installed it?"
           end
         end
         
-        class PathInvalid < Exception
+        class PathInvalid < CLIException
           def initialize(path)
-            super "Directory #{path} does not contain an Adhearsion project!"
+            super "Directory #{path} does not belong to an Adhearsion project!"
           end
         end
       end

data/lib/adhearsion/component_manager/component_tester.rb

@@ -0,0 +1,55 @@
+module ComponentTester
+  
+  class << self
+    
+    ##
+    #
+    #
+    # @return [Module] an anonymous module which includes the ComponentTester module.
+    #
+    def new(component_name, component_directory)
+      component_directory = File.expand_path component_directory
+      main_file = component_directory + "/#{component_name}/#{component_name}.rb"
+      
+      component_manager = Adhearsion::Components::ComponentManager.new(component_directory)
+      component_module  = Adhearsion::Components::ComponentManager::ComponentDefinitionContainer.load_file main_file
+      
+      Module.new do
+        
+        extend ComponentTester
+        
+        (class << self; self; end).send(:define_method, :component_manager)   { component_manager   }
+        (class << self; self; end).send(:define_method, :component_name)      { component_name      }
+        (class << self; self; end).send(:define_method, :component_module)    { component_module    }
+        (class << self; self; end).send(:define_method, :component_directory) { component_directory }
+        
+        
+        define_method(:component_manager)   { component_manager   }
+        define_method(:component_name)      { component_name      }
+        define_method(:component_module)    { component_module    }
+        define_method(:component_directory) { component_directory }
+        
+        def self.const_missing(name)
+          component_module.const_get name
+        end
+        
+      end
+    end
+  end
+  
+  def helper_method(name)
+    Object.new.extend(component_module).method(name)
+  end
+  
+  def config
+    component_manager.configuration_for_component_named component_name
+  end
+  
+  def initialize!
+    metadata = component_module.metaclass.send(:instance_variable_get, :@metadata)
+    if metadata && metadata[:initialization_block].kind_of?(Proc)
+      metadata[:initialization_block].call
+    end
+  end
+  
+end

data/lib/adhearsion/component_manager/spec_framework.rb

@@ -0,0 +1,24 @@
+require 'adhearsion/component_manager/component_tester'
+begin
+  require 'spec'
+rescue LoadError
+  abort 'You do not have the "rspec" gem installed! You must install it to continue.\n\nsudo gem install rspec\n\n'
+end
+
+begin
+  require 'rr'
+rescue LoadError
+  abort 'You do not have the "rr" gem installed! You must install it to continue.\n\nsudo gem install rr\n\n'  
+end
+
+module ComponentConfigurationSpecHelper
+  def mock_component_config_with(new_config)
+    Object.send(:remove_const, :COMPONENTS) rescue nil
+    Object.send(:const_set, :COMPONENTS, OpenStruct.new(new_config))
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+  config.include ComponentConfigurationSpecHelper
+end