voicemail 0.2.0 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ece901d2e7597ad7c46d21892c1c18860366229
-  data.tar.gz: 5179e5142890487aafe759b21d459212f90e8170
+  metadata.gz: fb2e43cb58958f29572591333898ac974619e7b9
+  data.tar.gz: db211cf3e65e54e4863d08d098a64229183630c6
 SHA512:
-  metadata.gz: f741bdf352fb6c34412461e81a1ce85810d01d2ad680248e41d54c3d2dc033dd817edcc0d025a50147b7115c85a9220d77ea46e5171b3e5bf1a6180e84f18d3a
-  data.tar.gz: bbc20bd448644acb1b896835f09f28254f5730d3d1a8579207c981bd83b4cff4ca49120987c079ec7f729e0b415350776ef1f36a6815d0ceda6be4686ebec692
+  metadata.gz: f2167ad8cf793941cb4abfde3a9daaab8d0bbdf84a5da10993980d6cd2e11e2d49d6edb87e7979bb4ccef275834cdce12cac193e3d8264f61156a12bfdf4f42b
+  data.tar.gz: 4020fc20353a8ce76e16e911272113876bd21e3570bd4b036c80ce85bacff270ba9610083cdedc51f7eed800e6070b4c5f7dc172290b83b13e078659f333349d

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+#v1.0.0..
+  * FEATURE - Optional per-mailbox override of default recording hash
+  * FEATURE - Optional rerecording of voicemail messages
+  * FEATURE - I18n numeric methods
+  * FEATURE - I18n support for keys
+  * FEATURE - Seperate pin_checking into seperate matcher class, so that it can be overriden if desired
+  * FEATURE - Allow `pin_tries` to be set to 0 for infinite loop
+  * FEATURE - Pass the complete recording complete object to `#save_recording`, giving the storage more information; `PStore` only uses the uri, but now you have access to more information (such as duration) if desired for your own storage adapter
+  * FEATURE - Seperate weclome/authentication from `MailboxController`, for those that wish to use their own.
+  * FEATURE - Add saved count to `MailboxController`
+  * FEATURE - Allow overriding `MailboxMainMenuController` with your own custom menu class
+  * FEATURE - Ability to listen to new OR saved messages, and archive/unarchive at will.
+  * FEATURE - Improved passing of a storage mechanism between controllers
+  * FEATURE - Customizable method for using TTS/ahn_say for things like "You have #{x} new messages"
+  * CS - Rename config option for when to answer
+  * CS - DRY up duplicated `#mailbox_not_found` method
+  * CS - Move all the call controllers to their own call_controller directory, to avoid clutter
+  * CS - Remove unused `#section_menu` in `MailboxMessagesController`
+  * CS - Remove specs for `#main_menu` in `AuthenticationController` since that controller never calls it
+  * BUGFIX - Calls passed to `VoicemailController` were never formally hungup
+  * BUGFIX - Don't strip extensions or `file://'` - punchblock will do that if needed
+  * BUGFIX - Apply datetime formatting to ahnsaid dates
+  * DOC - Add Justin Aiken to authors
+
+# v0.2.0 - 2012-08-30
+  ## Require adhearsion 2.4 or higher
+  * FEATURE - Put more `#record` options into the config instead of hardcoded
+  * FEATURE - Freeswitch support
+  * FEATURE - Add MIT license to gemspec
+  * FEATURE - Add optional location setting for `#answer`
+  * CS - Refactoring
+
+
+# v0.1.0 - 2013-08-28
+  * BUGFIX - typo in `#load_message`
+  * BUGFIX - `#load_message` not actually called
+  * BUGFIX - Pass mailbox id to `MailboxPlayMessageController`
+  * BUGFIX - Remove calls to nonexistant `#message_loop`
+  * FEATURE - Allow passing in storage adapter
+  * FEATURE - Only record one end of voicemail - save 50% of storage costs!
+  * FEATURE - TravisCI status added to README
+
+# v0.0.1
+  * First release!

data/README.md

@@ -20,6 +20,12 @@ To allow access by users to the mailboxes, `invoke MailboxController`. You will
   invoke Voicemail::MailboxController, mailbox: mailbox_id
 ```
 
+If you want the users to go through pin-based authentication first, pass to the `AuthenticationController` instead:
+```ruby
+  # inside a CallController method
+  invoke Voicemail::AuthenticationController, mailbox: mailbox_id
+```
+
 ## Storage
 
 Mailbox metadata is stored in a PStore hash on disk for easy drop-in functionality.
@@ -39,9 +45,58 @@ Alternatively, you can pass in a storage layer dynamically when invoking the con
   # etc.
 ```
 
-## Author
+## Method Overrides
+
+If you prefer to use your own main menu instead of the [one provided](https://github.com/adhearsion/voicemail/blob/develop/lib/voicemail/call_controllers/mailbox_main_menu_controller.rb#L10-L13), you can set the class to use like so:
+```ruby
+config.voicemail.main_menu_class = MyMenuController
+```
+
+Another override provided is the [pin matcher](https://github.com/adhearsion/voicemail/blob/develop/lib/voicemail/call_controllers/authentication_controller.rb#L43-L45) used to verify authentication - if you want to use your own match-checker (to check against an API or some use), you can also override it:
+```ruby
+config.voicemail.matcher_class = MyMatcher
+```
+
+## Numeric Methods
+
+When you have something like `You have -x- new messages` or `message received on -x-` you can either use the default setting, which will fill the x with TTS, or to use [ahnsay](https://www.github.com/polysics/ahnsay) to use audio files for each digit.
+```ruby
+config.voicemail.numeric_method = :play_numeric #default
+"You have two new messages"
+
+config.voicemail.numeric_method = :ahn_say
+"You have" + "file://...two.ul" + "new messages"
+```
+
+## Internationalization
+
+This plugin also provides support for internationalization:
+
+```ruby
+# Enable I18n support in the plugin
+config.voicemail.use_i18n = true
+
+# Tell your application where your local files are, and set a default
+I18n.load_path += Dir[File.join(config.platform.root, 'config', 'locales', '*.{rb,yml}').to_s]
+I18n.default_locale = :en
+```
+
+Either run `rake voicemail:i18n_init` to copy a starting `en.yml` file from the plugin into your application (default location is `#{ahn_root}/config/locales/en.yml`), or [look at the template](https://github.com/adhearsion/voicemail/blob/develop/templates/en.yml) to get an idea of what translation keys to add to your app's existing localization files.
+
+You can also use I18n to handle the numeric methods:
+
+```ruby
+config.voicemail.numeric_method = :i18n_string
+"You have two new messages"
+"You have one new message"
+```
+
+Using I18n for the numeric method will nicely handle pluralizing message counts and formating the datetime messages were received on.
+
+## Authors
 
-Original author: [Luca Pradovera](https://github.com/polysics)
+* Original author: [Luca Pradovera](https://github.com/polysics)
+* Also contributed: [Justin Aiken](https://github.com/JustinAiken)
 
 ## Links
 

data/lib/voicemail.rb

@@ -1,14 +1,21 @@
+require 'adhearsion'
+
 module Voicemail; end
 require "voicemail/version"
 require "voicemail/storage_pstore"
 require "voicemail/storage"
-require "voicemail/application_controller"
-require "voicemail/voicemail_controller"
-require "voicemail/mailbox_controller"
-require "voicemail/mailbox_main_menu_controller"
-require "voicemail/mailbox_messages_controller"
-require "voicemail/mailbox_play_message_controller"
-require "voicemail/mailbox_set_greeting_controller"
-require "voicemail/mailbox_set_pin_controller"
+require "voicemail/matcher"
+require "voicemail/localization_loader"
+require "voicemail/call_controllers/application_controller"
+require "voicemail/call_controllers/voicemail_controller"
+require "voicemail/call_controllers/mailbox_controller"
+require "voicemail/call_controllers/authentication_controller"
+require "voicemail/call_controllers/mailbox_main_menu_controller"
+require "voicemail/call_controllers/mailbox_messages_controller"
+require "voicemail/call_controllers/mailbox_play_message_intro_controller"
+require "voicemail/call_controllers/mailbox_play_message_controller"
+require "voicemail/call_controllers/mailbox_set_greeting_controller"
+require "voicemail/call_controllers/mailbox_set_pin_controller"
+
 
 require "voicemail/plugin"

data/lib/voicemail/{application_controller.rb → call_controllers/application_controller.rb}

@@ -1,7 +1,7 @@
 module Voicemail
   class ApplicationController < ::Adhearsion::CallController
     def main_menu
-      pass MailboxMainMenuController, mailbox: mailbox[:id]
+      pass config.main_menu_class, mailbox: mailbox[:id], storage: storage
     end
 
     private
@@ -23,5 +23,18 @@ module Voicemail
       raise ArgumentError, "Voicemail needs a mailbox specified in metadata" unless mailbox_id
       storage.get_mailbox mailbox_id
     end
+
+    def record_options
+      if config.use_mailbox_opts_for_recording
+        config.recording.to_hash.merge mailbox[:record_options]
+      else
+        config.recording.to_hash
+      end
+    end
+
+    def mailbox_not_found
+      play config.mailbox_not_found
+      hangup
+    end
   end
 end

data/lib/voicemail/call_controllers/authentication_controller.rb

@@ -0,0 +1,60 @@
+module Voicemail
+  class AuthenticationController < ApplicationController
+
+    attr_accessor :tries, :auth_ok, :input
+
+    def initialize(call, metadata={})
+      @tries   = 0
+      @auth_ok = false
+
+      super call, metadata
+    end
+
+    def run
+      if mailbox
+        play_greeting
+        authenticate
+        fail_auth unless auth_ok
+        pass MailboxController, mailbox: mailbox[:id]
+      else
+        mailbox_not_found
+      end
+    end
+
+    def authenticate
+      while still_going?
+        @tries += 1
+        get_input
+        if matches?
+          @auth_ok = true
+        else
+          play config.mailbox.pin_wrong
+        end
+      end
+    end
+
+    private
+
+    def still_going?
+      return false if auth_ok
+      config.mailbox.pin_tries == 0 || tries < config.mailbox.pin_tries
+    end
+
+    def matches?
+      config.matcher_class.new(input, mailbox[:pin]).matches?
+    end
+
+    def get_input
+      @input = ask config.mailbox.please_enter_pin, terminator: "#", timeout: config.prompt_timeout
+    end
+
+    def play_greeting
+      play config.mailbox.greeting_message
+    end
+
+    def fail_auth
+      play config.mailbox.could_not_auth
+      hangup
+    end
+  end
+end

data/lib/voicemail/call_controllers/mailbox_controller.rb

@@ -0,0 +1,46 @@
+module Voicemail
+  class MailboxController < ApplicationController
+
+    attr_accessor :new_or_saved
+
+    def run
+      if mailbox
+        play_number_of_messages :new
+        play_number_of_messages :saved
+        main_menu
+      else
+        mailbox_not_found
+      end
+    end
+
+    def play_number_of_messages(new_or_saved)
+      @new_or_saved = new_or_saved
+      get_count
+
+      if @number > 0
+        play_message_count
+      else
+        play config.messages["no_#{new_or_saved}_messages".to_sym]
+      end
+    end
+
+    def play_message_count
+      case config.numeric_method
+      when :i18n_string
+        play I18n.t("voicemail.mailbox.x_#{new_or_saved}_messages", count: @number)
+      when :play_numeric
+        play config.mailbox.number_before
+        play_numeric @number
+        play config.mailbox["number_after_#{new_or_saved}".to_sym]
+      when :ahn_say
+        play config.mailbox.number_before
+        play *sounds_for_number(@number)
+        play config.mailbox["number_after_#{new_or_saved}".to_sym]
+      end
+    end
+
+    def get_count
+      @number = storage.send "count_#{new_or_saved}_messages", mailbox[:id]
+    end
+  end
+end

data/lib/voicemail/{mailbox_main_menu_controller.rb → call_controllers/mailbox_main_menu_controller.rb}

@@ -7,9 +7,10 @@ module Voicemail
     def main_menu
       menu config.mailbox.menu_greeting,
          timeout: config.menu_timeout, tries: config.menu_tries do
-        match(1) { listen_to_messages }
-        match(2) { set_greeting }
-        match(3) { set_pin }
+        match(1) { listen_to_new_messages }
+        match(2) { listen_to_saved_messages }
+        match(3) { set_greeting }
+        match(4) { set_pin }
 
         timeout do
           play config.mailbox.menu_timeout_message
@@ -34,8 +35,12 @@ module Voicemail
       invoke MailboxSetPinController, mailbox: mailbox[:id]
     end
 
-    def listen_to_messages
+    def listen_to_new_messages
       invoke MailboxMessagesController, mailbox: mailbox[:id]
     end
+
+    def listen_to_saved_messages
+      invoke MailboxMessagesController, mailbox: mailbox[:id], new_or_saved: :saved
+    end
   end
 end

data/lib/voicemail/call_controllers/mailbox_messages_controller.rb

@@ -0,0 +1,48 @@
+module Voicemail
+  class MailboxMessagesController < ApplicationController
+
+    attr_accessor :new_or_saved
+
+    def initialize(call, metadata={})
+      @new_or_saved = metadata[:new_or_saved] || :new
+
+      super call, metadata
+    end
+
+    def run
+      message_loop
+    end
+
+    def message_loop
+      if messages_remaining > 0
+        next_message
+      else
+        bail_out
+      end
+    end
+
+    def next_message
+      handle_message current_message
+      message_loop
+    end
+
+    def handle_message(message)
+      invoke MailboxPlayMessageController, message: message, mailbox: mailbox[:id], new_or_saved: new_or_saved, storage: storage
+    end
+
+    private
+
+    def messages_remaining
+      storage.send "count_#{new_or_saved}_messages", mailbox[:id]
+    end
+
+    def current_message
+      storage.send "next_#{new_or_saved}_message", mailbox[:id]
+    end
+
+    def bail_out
+      play config.messages["no_#{new_or_saved}_messages"]
+      main_menu
+    end
+  end
+end

data/lib/voicemail/{mailbox_play_message_controller.rb → call_controllers/mailbox_play_message_controller.rb}

@@ -1,6 +1,14 @@
 module Voicemail
   class MailboxPlayMessageController < ApplicationController
 
+    attr_accessor :new_or_saved
+
+    def initialize(call, metadata={})
+      @new_or_saved = metadata[:new_or_saved] || :new
+
+      super call, metadata
+    end
+
     def run
       load_message
       intro_message
@@ -8,9 +16,9 @@ module Voicemail
     end
 
     def play_message
-      menu message_uri, config.messages.menu, timeout: config.menu_timeout, tries: config.menu_tries do
+      menu message_uri, play_message_menu, timeout: config.menu_timeout, tries: config.menu_tries do
         match 1 do
-          archive_message
+          archive_or_unarchive_message
         end
 
         match 5 do
@@ -36,19 +44,27 @@ module Voicemail
     end
 
     def intro_message
-      play config.messages.message_received_on
-      play_time current_message[:received], format: config.datetime_format
-      play config.messages.from
-      from_digits = current_message[:from].scan(/\d/).join
-      say_characters from_digits unless from_digits.empty?
+      invoke MailboxPlayMessageIntroController, message: current_message, mailbox: mailbox[:id], storage: storage
+    end
+
+    def play_message_menu
+      if new_or_saved == :new
+        config.messages.menu_new
+      else
+        config.messages.menu_saved
+      end
     end
 
     def rewind_message
       play_message
     end
 
-    def archive_message
-      storage.archive_message mailbox[:id], current_message[:id]
+    def archive_or_unarchive_message
+      if new_or_saved == :new
+        storage.archive_message mailbox[:id], current_message[:id]
+      else
+        storage.unarchive_message mailbox[:id], current_message[:id]
+      end
     end
 
     def delete_message
@@ -65,7 +81,7 @@ module Voicemail
     end
 
     def message_uri
-      current_message[:uri].gsub(/\.wav/, '')
+      current_message[:uri]
     end
   end
 end

data/lib/voicemail/call_controllers/mailbox_play_message_intro_controller.rb

@@ -0,0 +1,72 @@
+module Voicemail
+  class MailboxPlayMessageIntroController < ApplicationController
+
+    def run
+      load_message
+      intro_message
+    end
+
+    def intro_message
+      play_time_message
+      play_from_message
+    end
+
+    def play_time_message
+      case config.numeric_method
+      when :i18n_string
+        play I18n.t("voicemail.messages.message_received_on_x", received_on: I18n.localize(current_message[:received]))
+      when :play_numeric
+        play config.messages.message_received_on
+        play_time current_message[:received], format: config.datetime_format
+      when :ahn_say
+        play config.messages.message_received_on
+        play *sounds_for_time(current_message[:received], format: config.datetime_format)
+      end
+    end
+
+    def play_from_message
+      case config.numeric_method
+      when :i18n_string
+        play I18n.t("voicemail.messages.message_received_from_x", from: from_string)
+      when :play_numeric
+        play config.messages.from
+        say_characters from_digits unless from_digits.empty?
+      when :ahn_say
+        play config.messages.from
+        play *sounds_for_digits(from_digits)
+      end
+    end
+
+private
+
+    def from_digits
+      current_message[:from].scan(/\d/).join
+    end
+
+    def from_string
+      "".tap do |string|
+        from_digits.each_char do |char|
+          digit_word = I18n.t "numbers.#{char}"
+          if digit_word =~ /missing/
+            string << char
+          else
+            string << digit_word
+          end
+        end
+      end
+    end
+
+    def current_message
+      @message
+    end
+
+    def load_message
+      @message = metadata[:message] || nil
+      raise ArgumentError, "MailboxPlayMessageIntroController needs a valid message passed to it" unless @message
+    end
+
+    def message_uri
+      current_message[:uri]
+    end
+  end
+end