adhearsion 2.0.0.beta1 → 2.0.0.rc1

data/lib/adhearsion/call_controller/output.rb

@@ -1,9 +1,14 @@
+# encoding: utf-8
+
 module Adhearsion
   class CallController
     module Output
-      def speak(text, options = {})
+      PlaybackError = Class.new StandardError # Represents failure to play audio, such as when the sound file cannot be found
+
+      def say(text, options = {})
         play_ssml(text, options) || output(:text, text.to_s, options)
       end
+      alias :speak :say
 
       #
       # Plays the specified sound file names. This method will handle Time/DateTime objects (e.g. Time.now),
@@ -50,7 +55,7 @@ module Adhearsion
       # @see play
       #
       def play!(*arguments)
-        play *arguments or raise Adhearsion::PlaybackError, "One of the passed outputs is invalid"
+        play(*arguments) or raise PlaybackError, "One of the passed outputs is invalid"
       end
 
       #
@@ -162,7 +167,7 @@ module Adhearsion
             result = interruptible_play! output
           rescue PlaybackError => e
             # Ignore this exception and play the next output
-            logger.warn e.message
+            logger.warn "Error playing back the prompt: #{e.message}"
           ensure
             break if result
           end
@@ -174,7 +179,7 @@ module Adhearsion
         result = nil
         result = :time if [Date, Time, DateTime].include? output.class
         result = :numeric if output.kind_of?(Numeric) || output =~ /^\d+$/
-        result = :audio if !result && (/\//.match(output.to_s) || URI::regexp(%w(http https)).match(output.to_s))
+        result = :audio if !result && (/^\//.match(output.to_s) || URI::regexp.match(output.to_s))
         result ||= :text
       end
 
@@ -247,13 +252,12 @@ module Adhearsion
             :value => grammar_accept(digits).to_s
           }
         input_stopper_component.register_event_handler ::Punchblock::Event::Complete do |event|
-          logger.warn "#stream_file Handling input complete event."
           output_component.stop! unless output_component.complete?
         end
         write_and_await_response input_stopper_component
         begin
           execute_component_and_await_completion output_component
-        rescue StandardError => e
+        rescue StandardError
           raise Adhearsion::PlaybackError, "Output failed for argument #{argument.inspect}"
         end
         input_stopper_component.stop! if input_stopper_component.executing?

data/lib/adhearsion/call_controller/record.rb

@@ -1,13 +1,16 @@
+# encoding: utf-8
+
 module Adhearsion
   class CallController
     module Record
+      RecordError = Class.new StandardError # Represents failure to record such as when a file cannot be written.
+
       #
       # Start a recording
       #
       # @param [Hash] options
       # @param [Block] &block to process result of the record method
       # @option options [Boolean, Optional] :async Execute asynchronously. Defaults to false
-      # @option options [Proc, Optional] :on_complete Block to be executed on completion when this method is invoked asynchronously
       # @option options [Boolean, Optional] :start_beep Indicates whether subsequent record will be preceded with a beep. Default is true.
       # @option options [Boolean, Optional] :start_paused Whether subsequent record will start in PAUSE mode. Default is false.
       # @option options [String, Optional] :max_duration Indicates the maximum duration (milliseconds) for a recording.
@@ -18,23 +21,18 @@ module Adhearsion
       #
       # @return recording object
 
-      def record(options = {}, &block)
-        async = options.delete(:async) ? true : false
-        on_complete = options.delete :on_complete
+      def record(options = {})
+        async = options.delete :async
 
         component = ::Punchblock::Component::Record.new options
+        component.register_event_handler ::Punchblock::Event::Complete do |event|
+          catching_standard_errors { yield event if block_given? }
+        end
 
         if async
-          execute_component(component).tap do |result|
-            # FIXME: Setting the callback after we begin execution constitutes a race condition. We need to mock the component creation here, since the tests assume we're using whatever is returned by component exection, and that's what we pass the complete event to
-            result.register_event_handler Punchblock::Event::Complete do |event|
-              catching_standard_errors { on_complete.call event }
-            end
-          end
+          write_and_await_response component
         else
-          execute_component_and_await_completion(component).tap do |result|
-            yield result.complete_event if block_given?
-          end
+          execute_component_and_await_completion component
         end
       end
     end

data/lib/adhearsion/call_controller/utility.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   class CallController
     module Utility

data/lib/adhearsion/calls.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'thread'
 
 module Adhearsion
@@ -44,14 +46,14 @@ module Adhearsion
 
     def with_tag(tag)
       atomically do
-        calls.inject([]) do |calls_with_tag,(key,call)|
+        calls.inject([]) do |calls_with_tag,(_,call)|
           call.tagged_with?(tag) ? calls_with_tag << call : calls_with_tag
         end
       end
     end
 
     def each(&block)
-      atomically { calls.values.each &block }
+      atomically { calls.values.each(&block) }
     end
 
     def each_pair

data/lib/adhearsion/cli.rb

@@ -1,7 +1,11 @@
+# encoding: utf-8
+
 require 'adhearsion/script_ahn_loader'
 
 # If we are inside an Adhearsion application this method performs an exec and thus
 # the rest of this script is not run.
 Adhearsion::ScriptAhnLoader.exec_script_ahn!
 
+require 'bundler/setup'
+require 'adhearsion'
 require 'adhearsion/cli_commands'

data/lib/adhearsion/cli_commands.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'fileutils'
 require 'adhearsion/script_ahn_loader'
 require 'thor'
@@ -95,14 +97,18 @@ module Adhearsion
         rescue Errno::ESRCH
         end
 
-        File.delete pid_file
+        File.delete pid_file if File.exists? pid_file
       end
 
       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
-        invoke :stop
+        begin
+          invoke :stop
+        rescue PIDReadError => e
+          puts e.message
+        end
         invoke :daemon
       end
 

data/lib/adhearsion/configuration.rb

@@ -1,7 +1,10 @@
-module Adhearsion
+# encoding: utf-8
 
+module Adhearsion
   class Configuration
 
+    ConfigurationError = Class.new StandardError # Error raised while trying to configure a non existent plugin
+
     ##
     # Initialize the configuration object
     #
@@ -72,9 +75,10 @@ module Adhearsion
     end
 
     def add_environment(env)
+      return if self.class.method_defined? env.to_sym
       self.class.send(:define_method, env.to_sym) do |*args, &block|
         unless block.nil? || env != self.platform.environment.to_sym
-          self.instance_eval &block
+          self.instance_eval(&block)
         end
         self
       end
@@ -96,7 +100,7 @@ module Adhearsion
     # Adhearsion.config.foo => returns the configuration object associated to the foo plugin
     def method_missing(method_name, *args, &block)
       config = Loquacious::Configuration.for method_name, &block
-      raise Adhearsion::ConfigurationError.new "Invalid plugin #{method_name}" if config.nil?
+      raise Adhearsion::Configuration::ConfigurationError.new "Invalid plugin #{method_name}" if config.nil?
       config
     end
 

data/lib/adhearsion/console.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'pry'
 
 module Adhearsion
@@ -33,18 +35,18 @@ module Adhearsion
       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..."
+        logger.info "Launching Adhearsion Console"
         @pry_thread = Thread.current
         pry
-        logger.info "Console exiting"
+        logger.info "Adhearsion Console exiting"
       end
     end
 
     def stop
-      return unless @pry_thread
+      return unless instance_variable_defined?(:@pry_thread)
       @pry_thread.kill
       @pry_thread = nil
-      logger.info "Shutting down"
+      logger.info "Adhearsion Console shutting down"
     end
 
     def log_level(level = nil)
@@ -76,15 +78,17 @@ module Adhearsion
       when nil
         case calls.size
         when 0
-          logger.warn "No calls exist for control"
+          logger.warn "No calls active to take"
         when 1
           interact_with_call calls.values.first
         else
           puts "Please choose a call:"
+          puts "# (inbound/outbound) details"
           current_calls = calls.values
-          current_calls.each_with_index do |call, index|
-            puts "#{index}. (#{call.is_a?(OutboundCall) ? 'o' : 'i' }) #{call.id} from #{call.from} to #{call.to}"
+          current_calls.each_with_index do |active_call, index|
+            puts "#{index}: (#{active_call.is_a?(OutboundCall) ? 'o' : 'i' }) #{active_call.id} from #{active_call.from} to #{active_call.to}"
           end
+          print "#> "
           index = input.gets.chomp.to_i
           call = current_calls[index]
           interact_with_call call
@@ -112,11 +116,11 @@ module Adhearsion
     def set_prompt
       Pry.prompt = [
                 proc do |*args|
-                  obj, nest_level, pry_instance = args
+                  _, nest_level, _ = args
                   "AHN#{'  ' * nest_level}> "
                 end,
                 proc do |*args|
-                  obj, nest_level, pry_instance = args
+                  _, nest_level, _ = args
                   "AHN#{'  ' * nest_level}? "
                 end
               ]
@@ -130,20 +134,16 @@ module Adhearsion
         call.pause_controllers
         CallController.exec InteractiveController.new(call)
       ensure
-        logger.debug "Resuming call's controllers"
+        logger.debug "Restoring control of call to controllers"
         call.resume_controllers
       end
     end
 
     class InteractiveController < CallController
       def run
-        logger.debug "Starting interactive controller."
-        begin
-          pry
-        rescue => e
-          logger.error e
-        end
-        logger.debug "Interactive controller finished."
+        logger.debug "Starting interactive controller"
+        pry
+        logger.debug "Interactive controller finished"
       end
 
       def hangup(*args)

data/lib/adhearsion/events.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   class Events
 
@@ -26,7 +28,7 @@ module Adhearsion
     refresh!
 
     def queue
-      @queue || reinitialize_queue!
+      queue? ? @queue : reinitialize_queue!
     end
 
     def trigger(type, object = nil)
@@ -37,8 +39,12 @@ module Adhearsion
       queue.push_immediately Message.new(type, object)
     end
 
+    def queue?
+      instance_variable_defined? :@queue
+    end
+
     def reinitialize_queue!
-      GirlFriday.shutdown! if @queue
+      GirlFriday.shutdown! if queue?
       # TODO: Extract number of threads to use from Adhearsion.config
       @queue = GirlFriday::WorkQueue.new 'main_queue', :error_handler => ErrorHandler do |message|
         begin
@@ -54,7 +60,7 @@ module Adhearsion
     end
 
     def draw(&block)
-      instance_exec &block
+      instance_exec(&block)
     end
 
     def method_missing(method_name, *args, &block)
@@ -62,7 +68,7 @@ module Adhearsion
     end
 
     def respond_to?(method_name)
-      return true if @handlers && @handlers.has_key?(method_name)
+      return true if instance_variable_defined?(:@handlers) && @handlers.has_key?(method_name)
       super
     end
 

data/lib/adhearsion/foundation.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'English'
+require 'tmpdir'
+require 'tempfile'
+
+Dir.glob File.join(File.dirname(__FILE__), 'foundation', "*rb") do |file|
+  require file
+end

data/lib/adhearsion/foundation/custom_daemonizer.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # This is largely based on the Daemonize library by Travis Whitton and
 # Judson Lester. http://grub.ath.cx/daemonize. I cleaned it up a bit to
 # meet Adhearsion's quality standards.
@@ -28,7 +30,7 @@ module Adhearsion
       # Prevent the possibility of acquiring a controlling terminal
       if oldmode.zero?
         trap 'SIGHUP', 'IGNORE'
-        exit if pid = safefork
+        exit if safefork
       end
 
       Dir.chdir "/"   # Release old working directory

data/lib/adhearsion/foundation/exception_handler.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class Object
   def catching_standard_errors(&block)
     begin

data/lib/adhearsion/foundation/libc.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'adhearsion/linux_proc_name'
 require 'ffi'
 

data/lib/adhearsion/foundation/object.rb

@@ -1,6 +1,9 @@
+# encoding: utf-8
+
 require 'adhearsion/logging'
 
 class Object
+  undef :pb_logger
   def pb_logger
     logger
   end

data/lib/adhearsion/foundation/thread_safety.rb

@@ -1,15 +1,17 @@
+# encoding: utf-8
+
 require 'thread'
 
 class Object
   def synchronize(&block)
     @mutex ||= Mutex.new
-    @mutex.synchronize &block
+    @mutex.synchronize(&block)
   end
 end
 
-class ThreadSafeArray
+class ThreadSafeArray < BasicObject
   def initialize
-    @mutex = Mutex.new
+    @mutex = ::Mutex.new
     @array = []
   end
 
@@ -18,12 +20,4 @@ class ThreadSafeArray
       @array.send method, *args, &block
     end
   end
-
-  def inspect
-    @mutex.synchronize { @array.inspect }
-  end
-
-  def to_s
-    @mutex.synchronize { @array.to_s }
-  end
 end

data/lib/adhearsion/generators.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module Generators
     extend ActiveSupport::Autoload

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module Generators
     class AppGenerator < Generator

data/lib/adhearsion/generators/app/templates/README.md

@@ -25,4 +25,13 @@ In `config/adhearsion.rb` you'll need to set the VoIP platform you're using, alo
 
 Start your new app with "ahn start /path/to/your/app". You'll get a lovely console and should be presented with the SimonGame
 
+### Running your app on heroku
+
+In order to run an adhearsion application on Heroku, you must create the application on the 'cedar' stack (`heroku apps:create --stack cedar`) and re-scale your processes like so:
+
+```
+heroku ps:scale web=0
+heroku ps:scale ahn=1
+```
+
 Check out [the Adhearsion website](http://adhearsion.com) for more details of where to go from here.