adhearsion 2.4.0 → 2.5.0

data/lib/adhearsion/generators.rb

@@ -28,7 +28,7 @@ module Adhearsion
         klass.start args
       end
 
-      ##
+      #
       # Return a ordered list of task with their class
       #
       def mappings
@@ -38,20 +38,18 @@ module Adhearsion
       ##
       # Globally add a new generator class to +ahn generate+
       #
-      # @param [Symbol] name
-      # key name for generator mapping
-      # @param [Class] klass
-      # class of generator
+      # @param [Symbol] name key name for generator mapping
+      # @param [Class] klass class of generator
       #
       # @return [Hash] generator mappings
       #
       # @example
-      # Adhearsion::Generators.add_generator :myplugin, MyPluginGenerator
+      #   Adhearsion::Generators.add_generator :myplugin, MyPluginGenerator
       #
       def add_generator(name, klass)
         mappings[name] = klass
       end
 
-    end#class << self
-  end#module
-end#module
+    end
+  end
+end

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

@@ -4,19 +4,29 @@ module Adhearsion
   module Generators
     class AppGenerator < Generator
 
-      BASEDIRS  = %w( config lib script spec )
-      EMPTYDIRS = %w( spec/support )
+      BASEDIRS  = %w( config script spec )
+      EMPTYDIRS = %w( app/call_controllers lib spec/support spec/call_controllers )
+
+      class_option :empty, type: :boolean
 
       def setup_project
         self.destination_root = @generator_name
         BASEDIRS.each { |dir| directory dir }
         EMPTYDIRS.each { |dir| empty_directory dir }
+
         template "Gemfile.erb", "Gemfile"
+        template "adhearsion.erb", "config/adhearsion.rb"
+        template "events.erb", "config/events.rb"
+        template "routes.erb", "config/routes.rb"
         copy_file "gitignore", ".gitignore"
         copy_file "rspec", ".rspec"
         copy_file "Procfile"
         copy_file "Rakefile"
         copy_file "README.md"
+        unless options[:empty]
+          copy_file "simon_game.rb", "app/call_controllers/simon_game.rb"
+          copy_file "simon_game_spec.rb", "spec/call_controllers/simon_game_spec.rb"
+        end
         chmod "script/ahn", 0755
       end
     end

data/lib/adhearsion/generators/app/templates/Gemfile.erb

@@ -2,22 +2,20 @@ source 'https://rubygems.org'
 
 gem 'adhearsion', '~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>'
 
+# Adhearsion depends on the Punchblock library, but here you can specify the major version your application depends on.
+# Exercise care when updating the major version, since you might encounter API compatability in parts of your Adhearsion application that rely on the Punchblock API.
+# On occasion, an update of Adhearsion might necessitate an update to Punchblock. You will have to manually allow that here, and take care in the upgrade.
+gem 'punchblock', '~> <%= require "punchblock/version"; Punchblock::VERSION.split('.')[0,2].join('.') %>'
+
 # This is here by default due to deprecation of #ask and #menu.
 # See http://adhearsion.com/docs/common_problems#toc_3 for details
 gem 'adhearsion-asr'
 
 #
-# Here are some example plugins you might like to use. Simply
-# uncomment them and run `bundle install`.
+# Check http://ahnhub.com for a list of plugins you can use in your app.
+# To use them, simply add them here and run `bundle install`.
 #
 
-# gem 'adhearsion-asterisk'
-# gem 'adhearsion-rails'
-# gem 'adhearsion-activerecord'
-# gem 'adhearsion-ldap'
-# gem 'adhearsion-xmpp'
-# gem 'adhearsion-drb'
-
 group :development, :test do
   gem 'rspec'
 end

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

@@ -17,8 +17,6 @@ If you are using Asterisk 1.8, you will need to add an additional context with t
 
 ## FreeSWITCH
 
-### With mod_rayo (recommended)
-
 * Ensure that mod_rayo is installed and configured according to its' documentation.
 * Add an extension to your dialplan like so:
 
@@ -32,23 +30,6 @@ If you are using Asterisk 1.8, you will need to add an additional context with t
 
 * Connect Adhearsion via XMPP using the Rayo protocol, as per the sample config.
 
-### With Punchblock's FreeSWITCH mode (deprecated)
-
-* Ensure that mod_event_socket is installed, and configure it in autoload_configs/event_socket.conf.xml to taste
-* Add an extension to your dialplan like so:
-
-```xml
-<extension name='Adhearsion'>
-  <condition field="destination_number" expression="^10$">
-    <action application="set" data="hangup_after_bridge=false"/>
-    <action application="set" data="park_after_bridge=true"/>
-    <action application='rayo'/>
-  </condition>
-</extension>
-```
-
-* Connect Adhearsion via EventSocket, as per the sample config.
-
 ## Voxeo PRISM
 
 Install the [rayo-server](https://github.com/rayo/rayo-server) app into PRISM 11 and follow the [configuration guide](https://github.com/rayo/rayo-server/wiki/Single-node-and-cluster-configuration-reference).

data/lib/adhearsion/generators/app/templates/adhearsion.erb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+Adhearsion.config do |config|
+<% unless options[:empty] %>
+  # Centralized way to specify any Adhearsion platform or plugin configuration
+  # - Execute rake config:show to view the active configuration values
+  #
+  # To update a plugin configuration you can write either:
+  #
+  #    * Option 1
+  #        Adhearsion.config.<plugin-name> do |config|
+  #          config.<key> = <value>
+  #        end
+  #
+  #    * Option 2
+  #        Adhearsion.config do |config|
+  #          config.<plugin-name>.<key> = <value>
+  #        end
+<% end %>
+  config.development do |dev|
+    dev.platform.logging.level = :debug
+  end
+
+  ##
+  # Use with Rayo (eg Voxeo PRISM or FreeSWITCH mod_rayo)
+  #
+  # config.punchblock.username = "usera@freeswitch.local-dev.mojolingo.com" # Your XMPP JID for use with Rayo
+  # config.punchblock.password = "1" # Your XMPP password
+
+  ##
+  # Use with Asterisk
+  #
+  # config.punchblock.platform = :asterisk # Use Asterisk
+  # config.punchblock.username = "manager" # Your AMI username
+  # config.punchblock.password = "password" # Your AMI password
+  # config.punchblock.host = "asterisk.local-dev.mojolingo.com" # Your AMI host
+end

data/lib/adhearsion/generators/app/templates/config/environment.rb

@@ -2,4 +2,9 @@
 
 require 'bundler'
 Bundler.setup
-Bundler.require
+
+require 'adhearsion'
+
+Bundler.require(:default, Adhearsion.environment)
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../app/')))

data/lib/adhearsion/generators/app/templates/events.erb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+Adhearsion::Events.draw do
+<% unless options[:empty] %>
+  # Register global handlers for events
+  #
+  # eg. Handling Punchblock events
+  # punchblock do |event|
+  #   ...
+  # end
+  #
+  # eg Handling PeerStatus AMI events
+  # ami :name => 'PeerStatus' do |event|
+  #   ...
+  # end
+  #
+<% end %>
+end

data/lib/adhearsion/generators/app/templates/routes.erb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+<% unless options[:empty] %>
+require 'call_controllers/simon_game'
+<% end %>
+
+Adhearsion.router do
+<% if options[:empty] %>
+  route 'default' do
+
+  end
+<% else %>
+  #
+  # Specify your call routes, directing calls with particular attributes to a controller
+  #
+
+  route 'default', SimonGame
+<% end %>
+end

data/lib/adhearsion/generators/controller/controller_generator.rb

@@ -15,8 +15,8 @@ module Adhearsion
         self.destination_root = '.'
         empty_directory 'lib'
         empty_directory 'spec'
-        template 'lib/controller.rb', "lib/#{@controller_name.underscore}.rb"
-        template 'spec/controller_spec.rb', "spec/#{@controller_name.underscore}_spec.rb"
+        template 'lib/controller.rb.erb', "lib/#{@controller_name.underscore}.rb"
+        template 'spec/controller_spec.rb.erb', "spec/#{@controller_name.underscore}_spec.rb"
       end
 
     end

data/lib/adhearsion/generators/plugin/plugin_generator.rb

@@ -13,25 +13,26 @@ module Adhearsion
       def create_plugin
         @plugin_file = @plugin_name.underscore
         @plugin_name = @plugin_name.camelize
-        self.destination_root = '.'
+        self.destination_root = @plugin_file
 
-        empty_directory @plugin_file
-        empty_directory "#{@plugin_file}/lib"
-        empty_directory "#{@plugin_file}/lib/#{@plugin_file}"
-        empty_directory "#{@plugin_file}/spec"
+        empty_directory "lib"
+        empty_directory "lib/#{@plugin_file}"
+        empty_directory "spec"
 
-        template 'plugin-template.gemspec.tt', "#{@plugin_file}/#{@plugin_file}.gemspec"
-        template 'Rakefile.tt', "#{@plugin_file}/Rakefile"
-        template 'README.md.tt', "#{@plugin_file}/README.md"
-        template 'Gemfile.tt', "#{@plugin_file}/Gemfile"
+        copy_file "gitignore", ".gitignore"
 
-        template 'lib/plugin-template.rb.tt', "#{@plugin_file}/lib/#{@plugin_file}.rb"
-        template 'lib/plugin-template/version.rb.tt', "#{@plugin_file}/lib/#{@plugin_file}/version.rb"
-        template 'lib/plugin-template/plugin.rb.tt', "#{@plugin_file}/lib/#{@plugin_file}/plugin.rb"
-        template 'lib/plugin-template/controller_methods.rb.tt', "#{@plugin_file}/lib/#{@plugin_file}/controller_methods.rb"
+        template 'plugin-template.gemspec.tt', "#{@plugin_file}.gemspec"
+        template 'Rakefile.tt', "Rakefile"
+        template 'README.md.tt', "README.md"
+        template 'Gemfile.tt', "Gemfile"
 
-        template 'spec/spec_helper.rb.tt', "#{@plugin_file}/spec/spec_helper.rb"
-        template 'spec/plugin-template/controller_methods_spec.rb.tt', "#{@plugin_file}/spec/#{@plugin_file}/controller_methods_spec.rb"
+        template 'lib/plugin-template.rb.tt', "lib/#{@plugin_file}.rb"
+        template 'lib/plugin-template/version.rb.tt', "lib/#{@plugin_file}/version.rb"
+        template 'lib/plugin-template/plugin.rb.tt', "lib/#{@plugin_file}/plugin.rb"
+        template 'lib/plugin-template/controller_methods.rb.tt', "lib/#{@plugin_file}/controller_methods.rb"
+
+        template 'spec/spec_helper.rb.tt', "spec/spec_helper.rb"
+        template 'spec/plugin-template/controller_methods_spec.rb.tt', "spec/#{@plugin_file}/controller_methods_spec.rb"
       end
 
     end

data/lib/adhearsion/generators/plugin/templates/gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/lib/adhearsion/generators/plugin/templates/spec/plugin-template/controller_methods_spec.rb.tt

@@ -16,7 +16,7 @@ module <%= @plugin_name %>
 
       describe "#greet" do
         it "greets with the correct parameter" do
-          subject.expects(:play).once.with("Hello, Luca")
+          subject.should_receive(:play).once.with("Hello, Luca")
           subject.greet "Luca"
         end
       end

data/lib/adhearsion/initializer.rb

@@ -34,7 +34,7 @@ module Adhearsion
       @mode     = options[:mode]
       @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
       @loaded_init_files  = options[:loaded_init_files]
-      Adhearsion.ahn_root = '.'
+      Adhearsion.root = '.'
     end
 
     def start
@@ -42,6 +42,8 @@ module Adhearsion
         resolve_pid_file_path
         load_lib_folder
         load_config_file
+        load_events_file
+        load_routes_file
         initialize_log_paths
 
         if should_daemonize?
@@ -195,6 +197,16 @@ module Adhearsion
       require "#{Adhearsion.config.root}/config/adhearsion.rb"
     end
 
+    def load_events_file
+      path = "#{Adhearsion.config.root}/config/events.rb"
+      require path if File.exists?(path)
+    end
+
+    def load_routes_file
+      path = "#{Adhearsion.config.root}/config/routes.rb"
+      require path if File.exists?(path)
+    end
+
     def init_get_logging_appenders
       @file_loggers ||= memoize_logging_appenders
     end
@@ -249,7 +261,7 @@ module Adhearsion
     end
 
     def launch_console
-      Adhearsion::Process.important_threads << Thread.new do
+      Thread.new do
         catching_standard_errors do
           Adhearsion::Console.run
         end

data/lib/adhearsion/logging.rb

@@ -88,6 +88,7 @@ module Adhearsion
            'stdout',
            :layout => ::Logging.layouts.pattern(
              :pattern => adhearsion_pattern,
+             :date_pattern => "%Y-%m-%d %H:%M:%S.%L",
              :color_scheme => 'bright'
            ),
            :auto_flushing => 2,

data/lib/adhearsion/outbound_call.rb

@@ -2,7 +2,7 @@
 
 module Adhearsion
   class OutboundCall < Call
-    execute_block_on_receiver :register_handler, :register_tmp_handler, :register_handler_with_priority, :register_event_handler, :on_joined, :on_unjoined, :on_end, :execute_controller, :on_answer, :execute_controller_or_router_on_answer
+    execute_block_on_receiver :on_answer, :execute_controller_or_router_on_answer, *execute_block_on_receiver
 
     attr_reader :dial_command
 
@@ -73,7 +73,7 @@ module Adhearsion
         wait_timeout = 60
       end
 
-      write_and_await_response(Punchblock::Command::Dial.new(options), wait_timeout).tap do |dial_command|
+      write_and_await_response(Punchblock::Command::Dial.new(options), wait_timeout, true).tap do |dial_command|
         @dial_command = dial_command
         Adhearsion.active_calls << current_actor
         Adhearsion::Events.trigger_immediately :call_dialed, current_actor
@@ -95,15 +95,11 @@ module Adhearsion
     def run_router_on_answer
       register_event_handler Punchblock::Event::Answered do |event|
         run_router
-        throw :pass
       end
     end
 
     def on_answer(&block)
-      register_event_handler Punchblock::Event::Answered do |event|
-        block.call event
-        throw :pass
-      end
+      register_event_handler Punchblock::Event::Answered, &block
     end
 
     def execute_controller_or_router_on_answer(controller, metadata = {}, &controller_block)

data/lib/adhearsion/punchblock_plugin/initializer.rb

@@ -127,7 +127,8 @@ module Adhearsion
 
         def dispatch_offer(offer)
           catching_standard_errors do
-            call = Adhearsion.active_calls.from_offer offer
+            call = Call.new(offer)
+            Adhearsion.active_calls << call
             case Adhearsion::Process.state_name
             when :booting, :rejecting
               logger.info "Declining call because the process is not yet running."
@@ -144,7 +145,7 @@ module Adhearsion
           if call = Adhearsion.active_calls[event.target_call_id]
             call.async.deliver_message event
           else
-            logger.error "Event received for inactive call #{event.target_call_id}: #{event.inspect}"
+            logger.warn "Event received for inactive call #{event.target_call_id}: #{event.inspect}"
           end
         end
 

data/lib/adhearsion/router/openended_route.rb

@@ -8,7 +8,7 @@ module Adhearsion
       end
 
       def dispatch(call, callback = nil)
-        call[:ahn_prevent_hangup] = true
+        call.auto_hangup = false
         super
       end
     end

data/lib/adhearsion/router/route.rb

@@ -38,10 +38,11 @@ module Adhearsion
 
         call.execute_controller controller, lambda { |call_actor|
           begin
-            if call_actor[:ahn_prevent_hangup]
-              logger.info "Call routing completed, keeping the call alive at controller/router request."
-            else
+            if call_actor.auto_hangup
+              logger.info "Call routing completed. Hanging up now..."
               call_actor.hangup
+            else
+              logger.info "Call routing completed, keeping the call alive at controller/router request."
             end
           rescue Call::Hangup, Call::ExpiredError
           end

data/lib/adhearsion/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Adhearsion
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end