adhearsion 2.0.0.alpha1 → 2.0.0.alpha2

data/lib/adhearsion/cli_commands.rb

@@ -2,6 +2,17 @@ require 'fileutils'
 require 'adhearsion/script_ahn_loader'
 require 'thor'
 
+class Thor
+  class Task
+    protected
+
+    def sans_backtrace(backtrace, caller) #:nodoc:
+      saned  = backtrace.reject { |frame| frame =~ FILE_REGEXP || (frame =~ /\.java:/ && RUBY_PLATFORM =~ /java/) }
+      saned -= caller
+    end
+  end
+end
+
 module Adhearsion
   module CLI
     class AhnCommand < Thor
@@ -42,7 +53,7 @@ module Adhearsion
       desc "stop </path/to/directory>", "Stop a running Adhearsion server"
       method_option :pidfile, :type => :string, :aliases => %w(--pid-file)
       def stop(path = nil)
-        execute_from_app_dir! path, ARGV
+        execute_from_app_dir! path
 
         pid_file = if options[:pidfile]
           File.expand_path File.exists?(File.expand_path(options[:pidfile])) ?
@@ -55,10 +66,10 @@ module Adhearsion
         begin
           pid = File.read(pid_file).to_i
         rescue
-          raise CLIException, "Could not read pid file #{pid_file}"
+          raise PIDReadError, pid_file
         end
 
-        raise CLIException, "Could not read pid" if pid.nil?
+        raise PIDReadError, pid_file if pid.nil?
 
         say "Stopping Adhearsion server at #{path} with pid #{pid}"
         waiting_timeout = Time.now + 15
@@ -73,7 +84,7 @@ module Adhearsion
       desc "restart </path/to/directory>", "Restart the Adhearsion server"
       method_option :pidfile, :type => :string, :aliases => %w(--pid-file)
       def restart(path = nil)
-        execute_from_app_dir! path, ARGV
+        execute_from_app_dir! path
         invoke :stop
         invoke :daemon
       end
@@ -81,12 +92,12 @@ module Adhearsion
       protected
 
       def start_app(path, mode, pid_file = nil)
-        execute_from_app_dir! path, ARGV
-        say "Starting Adhearsion server at #{path}"
+        execute_from_app_dir! path
+        say "Starting Adhearsion server at #{Dir.pwd}"
         Adhearsion::Initializer.start :mode => mode, :pid_file => pid_file
       end
 
-      def execute_from_app_dir!(path, *args)
+      def execute_from_app_dir!(path)
         return if in_app? and running_script_ahn?
 
         path ||= '.' if in_app?
@@ -95,8 +106,8 @@ module Adhearsion
         raise PathInvalid, path unless ScriptAhnLoader.in_ahn_application?(path)
 
         Dir.chdir path do
-          args.flatten!
-          args[1] = '.'
+          args = ARGV.dup
+          args[1] = File.expand_path path
           ScriptAhnLoader.exec_script_ahn! args
         end
       end
@@ -138,5 +149,11 @@ module Adhearsion
         super "Directory #{path} does not belong to an Adhearsion project!"
       end
     end
+
+    class PIDReadError < Thor::Error
+      def initialize(path)
+        super "Could not read pid from the file #{path}"
+      end
+    end
   end
 end

data/lib/adhearsion/configuration.rb

@@ -14,22 +14,38 @@ module Adhearsion
     def initialize(&block)
       initialize_environments
 
+      Loquacious.env_config = true
+      Loquacious.env_prefix = "AHN"
+
       Loquacious::Configuration.for :platform do
         root nil, :desc => "Adhearsion application root folder"
+
         lib "lib", :desc => <<-__
-          Folder to include the own libraries to be used. Adhearsion loads any ruby file located into this folder during the bootstrap
-          process. Set to nil if you do not want these files to be loaded. This folder is relative to the application root folder.
+          Folder to include the own libraries to be used. Adhearsion loads any ruby file 
+          located into this folder during the bootstrap process. Set to nil if you do not 
+          want these files to be loaded. This folder is relative to the application root folder.
         __
-        automatically_accept_incoming_calls true, :desc => "Adhearsion will accept automatically any inbound call"
 
-        environment :development, :desc => "Active environment. Supported values: development, production, staging, test"
+        automatically_accept_incoming_calls true, :transform => Proc.new { |v| v == 'true' }, :desc => <<-__
+          Adhearsion will accept automatically any inbound call
+        __
+
+        environment :development, :transform => Proc.new { |v| v.to_sym }, :desc => <<-__
+          Active environment. Supported values: development, production, staging, test
+        __
+
+        process_name "ahn", :desc => <<-__
+          Adhearsion process name, useful to make it easier to find in the process list
+          Pro tip: set this to your application's name and you can do "killall myapp"
+          Does not work under JRuby.
+        __
 
         desc "Log configuration"
         logging {
-          level :info, :desc => <<-__
+          level :info, :transform => Proc.new { |v| v.to_sym }, :desc => <<-__
             Supported levels (in increasing severity) -- :trace < :debug < :info < :warn < :error < :fatal
           __
-          outputters ["log/adhearsion.log"], :desc => <<-__
+          outputters ["log/adhearsion.log"], :transform => Proc.new { |val| Array(val) }, :desc => <<-__
             An array of log outputters to use. The default is to log to stdout and log/adhearsion.log
           __
           formatter nil, :desc => <<-__
@@ -136,13 +152,26 @@ module Adhearsion
       else
         return "" if Loquacious::Configuration.for(name).nil?
 
+        if args[:show_values]
+          name_leader = "  config.#{name}."
+          desc_leader = "  # "
+          name_value_sep = " = "
+          title_leader = "  "
+        else
+          name_leader = ""
+          desc_leader = "#"
+          name_value_sep = " => "
+          title_leader = ""
+        end
+
         config = Loquacious::Configuration.help_for name,
-                                :name_leader => "",
-                                :desc_leader => "# ",
+                                :name_leader => name_leader,
+                                :desc_leader => desc_leader,
                                 :colorize    => true,
-                                :io          => desc
+                                :io          => desc,
+                                :name_value_sep => name_value_sep
         config.show :values => args[:show_values]
-        "\n# ******* Configuration for #{name} **************\n\n#{desc.string}"
+        "#{title_leader}# ******* Configuration for #{name} **************\n\n#{desc.string}"
       end
     end
   end

data/lib/adhearsion/console.rb

@@ -1,59 +1,78 @@
 require 'pry'
 
 module Adhearsion
-  module Console
+  class Console
     include Adhearsion
+    include Singleton
 
     class << self
       ##
-      # Start the Adhearsion console
-      #
-      def run
-        Pry.prompt = [
-                        proc do |*args|
-                          obj, nest_level, pry_instance = args
-                          "AHN#{'  ' * nest_level}> "
-                        end,
-                        proc do |*args|
-                          obj, nest_level, pry_instance = args
-                          "AHN#{'  ' * nest_level}? "
-                        end
-                      ]
-        Pry.config.command_prefix = "%"
-        if libedit?
-          logger.error "Cannot start. You are running Adhearsion on Ruby with libedit. You must use readline for the console to work."
-        else
-          logger.info "Starting up..."
-          pry
-        end
+      # Include another external functionality into the console
+      def mixin(mod)
+        include mod
       end
 
-      def calls
-        Adhearsion.active_calls
+      def method_missing(method, *args, &block)
+        instance.send method, *args, &block
       end
+    end
+
+    ##
+    # Start the Adhearsion console
+    #
+    def run
+      Pry.prompt = [
+                      proc do |*args|
+                        obj, nest_level, pry_instance = args
+                        "AHN#{'  ' * nest_level}> "
+                      end,
+                      proc do |*args|
+                        obj, nest_level, pry_instance = args
+                        "AHN#{'  ' * nest_level}? "
+                      end
+                    ]
+      Pry.config.command_prefix = "%"
+      if libedit?
+        logger.error "Cannot start. You are running Adhearsion on Ruby with libedit. You must use readline for the console to work."
+      else
+        logger.info "Starting up..."
+        @pry_thread = Thread.current
+        binding.pry
+      end
+    end
+
+    def stop
+      return unless @pry_thread
+      @pry_thread.kill
+      @pry_thread = nil
+      logger.info "Shutting down"
+    end
 
-      def use(call)
-        unless call.is_a? Adhearsion::Call
-          raise ArgumentError unless Adhearsion.active_calls[call]
-          call = Adhearsion.active_calls[call]
-        end
-        Pry.prompt = [ proc { "AHN<#{call.channel}> " },
-                       proc { "AHN<#{call.channel}? " }  ]
+    def calls
+      Adhearsion.active_calls
+    end
 
-        # Pause execution of the thread currently controlling the call
-        call.with_command_lock do
-          CallWrapper.new(call).pry
-        end
+    def use(call)
+      unless call.is_a? Adhearsion::Call
+        raise ArgumentError unless Adhearsion.active_calls[call]
+        call = Adhearsion.active_calls[call]
       end
+      Pry.prompt = [ proc { "AHN<#{call.channel}> " },
+                     proc { "AHN<#{call.channel}? " }  ]
+
+      # Pause execution of the thread currently controlling the call
+      call.with_command_lock do
+        CallWrapper.new(call).pry
+      end
+    end
 
-      def libedit?
-        begin
-          # If NotImplemented then this might be libedit
-          Readline.emacs_editing_mode
-          false
-        rescue NotImplementedError
-          true
-        end
+    def libedit?
+      begin
+        # If NotImplemented then this might be libedit
+        Readline.emacs_editing_mode
+        false
+      rescue NotImplementedError
+        true
       end
     end
 

data/lib/adhearsion/foundation/libc.rb

@@ -0,0 +1,13 @@
+require 'adhearsion/linux_proc_name'
+require 'ffi'
+
+module LibC
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+
+  begin
+    attach_function :prctl, [ :ulong, :ulong, :ulong, :ulong ], :int
+  rescue FFI::NotFoundError => ex
+    Adhearsion::LinuxProcName.error = "Error while attaching libc function prctl: #{ex}"
+  end
+end

data/lib/adhearsion/generators/app/app_generator.rb

@@ -29,9 +29,12 @@ module Adhearsion
       def setup_project
         self.destination_root = @app_path
         BASEDIRS.each { |dir| directory dir }
-        copy_file "Gemfile"
+        template "Gemfile.erb", "Gemfile"
+        copy_file "gitignore", ".gitignore"
+        copy_file "Procfile"
         copy_file "Rakefile"
         copy_file "README.md"
+        chmod "script/ahn", 0755
       end
     end
   end

data/lib/adhearsion/generators/app/templates/{Gemfile → Gemfile.erb}

@@ -1,6 +1,6 @@
 source :rubygems
 
-gem "adhearsion", :git => 'git://github.com/adhearsion/adhearsion.git', :branch => :develop
+gem "adhearsion", ">=<%= Adhearsion::VERSION %>"
 
 #
 # Here are some example plugins you might like to use. Simply

data/lib/adhearsion/generators/app/templates/Rakefile

@@ -1,27 +1,8 @@
-# This file is for the "rake" tool which automates project-related tasks. If you need to automate things, you can create
-# a new Rake task here. See http://rake.rubyforge.org for more info.
+#!/usr/bin/env rake
+
 require 'rubygems'
 require 'bundler'
 Bundler.setup
 Bundler.require
 
-begin
-  require 'adhearsion/tasks'
-rescue LoadError
-  STDERR.puts "\nCannot load Adhearsion! Not all Rake tasks will be loaded!\n\n"
-end
-
-desc "Writes a .gitignore file that ignores certain SCM annoyances such as log files"
-task :gitignore do
-  ignore_file = "#{Dir.pwd}/.gitignore"
-  if File.exists? ignore_file
-    STDERR.puts "File #{ignore_file} already exists!"
-  else
-    File.open ignore_file, 'w' do |file|
-      # Add other files to the Array below
-      %w[ log ].each do |pattern|
-        file.puts pattern
-      end
-    end
-  end
-end
+require 'adhearsion/tasks'

data/lib/adhearsion/generators/app/templates/gitignore

@@ -0,0 +1,7 @@
+.bundle
+.*.swp
+.*.swo
+.DS_STORE
+log/*.log
+tmp
+vendor/ruby

data/lib/adhearsion/generators/app/templates/lib/simon_game.rb

@@ -1,5 +1,6 @@
 class SimonGame < Adhearsion::CallController
   def run
+    answer
     reset
     loop do
       say_number

data/lib/adhearsion/generators/app/templates/script/ahn

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # This command will automatically be run when you run "ahn" with the Adhearsion gem installed from the root of your application.
 
 require File.expand_path('../../config/environment',  __FILE__)

data/lib/adhearsion/initializer.rb

@@ -1,4 +1,5 @@
 require 'adhearsion/punchblock_plugin'
+require 'adhearsion/linux_proc_name'
 
 module Adhearsion
   class Initializer
@@ -38,14 +39,14 @@ module Adhearsion
     def start
       resolve_pid_file_path
       load_lib_folder
-      load_plugins_methods
       load_config
       initialize_log_paths
       daemonize! if should_daemonize?
+      start_logging
       launch_console if need_console?
       catch_termination_signal
       create_pid_file
-      start_logging
+      set_ahn_proc_name
       logger.info "Loaded config in <#{Adhearsion.config.platform.environment}> environment"
       initialize_exception_logger
       update_rails_env_var
@@ -54,7 +55,11 @@ module Adhearsion
       logger.info "Adhearsion v#{Adhearsion::VERSION} initialized!"
       Adhearsion::Process.booted
 
+      run_plugins
       trigger_after_initialized_hooks
+
+      # This method will block until all important threads have finished.
+      # When it does, the process will exit.
       join_important_threads
       self
     end
@@ -62,20 +67,20 @@ module Adhearsion
     def update_rails_env_var
       env = ENV['AHN_ENV']
       if env && Adhearsion.config.valid_environment?(env.to_sym)
-        if ENV['RAILS_ENV'] != env
+        if ENV['RAILS_ENV'] == env
+          logger.info "Using the configured value for RAILS_ENV : <#{env}>"
+        else
           logger.warn "Updating AHN_RAILS variable to <#{env}>"
           ENV['RAILS_ENV'] = env
-        else
-          logger.info "Using the configured value for RAILS_ENV : <#{env}>"
         end
       else
         env = ENV['RAILS_ENV']
-        unless env
+        if env
+          logger.info "Using the configured value for RAILS_ENV : <#{env}>"
+        else
           env = Adhearsion.config.platform.environment.to_s
           logger.info "Defining AHN_RAILS variable to <#{env}>"
           ENV['RAILS_ENV'] = env
-        else
-          logger.info "Using the configured value for RAILS_ENV : <#{env}>"
         end
       end
       env
@@ -107,15 +112,18 @@ module Adhearsion
     def catch_termination_signal
       %w'INT TERM'.each do |process_signal|
         trap process_signal do
+          logger.info "Received #{process_signal} signal. Shutting down."
           Adhearsion::Process.shutdown
         end
       end
 
       trap 'QUIT' do
+        logger.info "Received QUIT signal. Hard shutting down."
         Adhearsion::Process.hard_shutdown
       end
 
       trap 'ABRT' do
+        logger.info "Received ABRT signal. Forcing stop."
         Adhearsion::Process.force_stop
       end
     end
@@ -177,14 +185,14 @@ module Adhearsion
       end
     end
 
-    def load_plugins_methods
-      Plugin.load_methods
-    end
-
     def init_plugins
       Plugin.init_plugins
     end
 
+    def run_plugins
+      Plugin.run_plugins
+    end
+
     def should_daemonize?
       @mode == :daemon
     end
@@ -251,6 +259,10 @@ module Adhearsion
       end
     end
 
+    def set_ahn_proc_name
+      Adhearsion::LinuxProcName.set_proc_name Adhearsion.config.platform.process_name
+    end
+
     def trigger_after_initialized_hooks
       Events.trigger_immediately :after_initialized
     end