voicemail 0.2.0 → 1.0.0.beta

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

@@ -35,8 +35,8 @@ module Voicemail
 
     def record_greeting
       play config.set_greeting.before_record
-      record_comp = record config.set_greeting.recording.to_hash.merge(interruptible: true)
-      @temp_recording = record_comp.complete_event.recording.uri.gsub(/file:\/\//, '').gsub(/\.wav/, '')
+      record_comp = record record_options
+      @temp_recording = record_comp.complete_event.recording.uri
       play_audio @temp_recording
 
       menu config.set_greeting.after_record,

data/lib/voicemail/call_controllers/voicemail_controller.rb

@@ -0,0 +1,57 @@
+module Voicemail
+  class VoicemailController < ApplicationController
+
+    attr_accessor :recording
+
+    def run
+      answer if config.when_to_answer == :before_greeting
+      if mailbox
+        play_greeting
+        answer if config.when_to_answer == :after_greeting
+        record_message
+        hangup
+      else
+        mailbox_not_found
+      end
+    end
+
+    def play_greeting
+      play mailbox[:greeting_message] || config.default_greeting
+    end
+
+    def record_message
+      @recording = record record_options
+
+      config.allow_rerecording ? recording_menu : save_recording
+    end
+
+    def recording_menu
+      ensure_message_saved_if_hangup
+      menu recording_url, config.after_record, tries: 3, timeout: 10 do
+        match('1') { save_recording }
+        match('2') { record_message }
+
+        invalid {  }
+        timeout { save_recording }
+        failure { save_recording }
+      end
+    end
+
+  private
+
+    def ensure_message_saved_if_hangup
+      call.on_end do
+        save_recording unless @saved
+      end
+    end
+
+    def save_recording
+      storage.save_recording mailbox[:id], call.from, recording.complete_event.recording
+      @saved = true
+    end
+
+    def recording_url
+      recording.complete_event.recording.uri
+    end
+  end
+end

data/lib/voicemail/localization_loader.rb

@@ -0,0 +1,28 @@
+module Voicemail::LocalizationLoader
+
+  def self.replace_config
+    translation_keys.each { |key, value| override_config key, value }
+  end
+
+  #
+  #This method scans the keys in the template en.yml - it doesn't use any values,
+  #it just sets up methods to call i18n.translate later
+  #
+  def self.override_config(key, value)
+    if value.class == String
+      Voicemail::Plugin.config[key.to_sym] = Proc.new { I18n.t "voicemail.#{key}" }
+    else
+      value.keys.each do |k, v|
+        Voicemail::Plugin.config[key.to_sym][k.to_sym] = Proc.new { I18n.t("voicemail.#{key}.#{k}") }
+      end
+    end
+  end
+
+  def self.translation_keys
+    YAML.load(File.open("#{current_path}/../../templates/en.yml"))['en']['voicemail']
+  end
+
+  def self.current_path
+    File.expand_path File.dirname(__FILE__)
+  end
+end

data/lib/voicemail/matcher.rb

@@ -0,0 +1,14 @@
+module Voicemail
+  class Matcher
+    def initialize(entered, actual)
+      @entered = entered.try :to_s
+      @actual  = actual.try :to_s
+    end
+
+    def matches?
+      logger.info "input : #{@entered}"
+      logger.info "actual: #{@actual}"
+      @entered == @actual
+    end
+  end
+end

data/lib/voicemail/plugin.rb

@@ -2,37 +2,55 @@ module Voicemail
   class Plugin < Adhearsion::Plugin
 
     init :voicemail do
-      logger.info "Voicemail has been loaded"
+      if config.use_i18n
+        LocalizationLoader.replace_config
+        logger.info "Voicemail has been loaded with i18n support"
+      else
+        logger.info "Voicemail has been loaded"
+      end
     end
 
     config :voicemail do
-      default_greeting "You have reached voicemail", desc: "What to use to greet users"
-      mailbox_not_found "Mailbox not found", desc: "Message to use for a missing mailbox"
+      use_i18n false, desc: "Whether to use i18n for voice prompts"
       prompt_timeout 5, desc: "Timeout for the various prompts, in seconds"
       menu_timeout 15.seconds, desc: "Timeout for all menus"
       menu_tries 3, desc: "Tries to get matching input for all menus"
-      datetime_format "Q 'digits/at' IMp", desc: "Fromat to use for message date and time TTS"
+      datetime_format "Q 'digits/at' IMp", desc: "Format to use for message date and time formatting"
+
+      when_to_answer :before_greeting, desc: "#answer :before_greeting or :after_greeting"
+      numeric_method :play_numeric, desc: "Whether to use #play_numeric type methods, AhnSay, or a single I18n string"
+
+      matcher_class   Voicemail::Matcher, desc: "Class that checks for a match in pin authentication"
+      main_menu_class Voicemail::MailboxMainMenuController, desc: "Class runs the main menu prompts"
+
+      default_greeting "You have reached voicemail", desc: "What to use to greet users"
+      mailbox_not_found "Mailbox not found", desc: "Message to use for a missing mailbox"
 
-      force_183 false, desc: "Only #answer if the mailbox is found"
+      allow_rerecording true, desc: "Allow caller to rerecord their voicemail"
+      after_record "Press 1 to save your voicemail.  Press 2 to rerecord.", desc: "Message to play if allow_rerecording is set"
 
-      desc "Voicemail recording options"
+      desc "Default recording options"
       recording {
+        interruptible true, desc: "Whether you can stop the recording with a DTMF input"
+        direction :send, desc: "The direction to record; you probably want :send"
         final_timeout 2, desc: "Maximum duration to run after recording in seconds"
         max_duration 30, desc: "Maximum duration for recording in seconds"
         start_beep true, desc: "Play a beep before recording"
         stop_beep false, desc: "Play a beep after recording"
       }
+      use_mailbox_opts_for_recording false, desc: "Whether per-mailbox settings can override defaults"
 
       desc "Configuration for registered users"
       mailbox {
         greeting_message "Welcome to the mailbox system.", desc: "Message to greet voicemail users"
         please_enter_pin "Please enter your PIN.", desc: "Message asking to enter PIN."
-        pin_tries 3, desc: "Number of tries to authenticate before failure"
+        pin_tries 3, desc: "Number of tries to authenticate before failure - set to 0 for infinite"
         pin_wrong "The PIN you entered does not match. Please try again.", desc: "Message for an user that enters the wrong PIN"
         could_not_auth "We are sorry, the system could not authenticate you", desc: "Message for authentication final failure."
         number_before "You have ", desc: "What to play before the number of new messages"
-        number_after " new messages", desc: "What to play after the number of new messages"
-        menu_greeting "Press 1 to listen to new messages, 2 to change your greeting, 3 to change your PIN", desc: "What to say before the main menu"
+        number_after_new " new messages", desc: "What to play after the number of new messages"
+        number_after_saved " saved messages", desc: "What to play after the number of saved messages"
+        menu_greeting "Press 1 to listen to new messages, 2 to listen to saved messages, 3 to change your greeting, 4 to change your PIN", desc: "What to say before the main menu"
         menu_timeout_message "Please enter a digit for the menu", desc: "Message to play on main menu timeout"
         menu_invalid_message "Please enter valid input", desc: "Message to play on main menu invalid"
         menu_failure_message "Sorry, unable to understand your input.", desc: "Message to play on main menu failure"
@@ -44,10 +62,6 @@ module Voicemail
         before_record "Please speak after the beep. The prompt will be played back after.", desc: "Recording instructions"
         after_record "Press 1 to save your new greeting, 2 to discard it, 9 to go back to the menu", desc: "Menu to use after recording"
         no_personal_greeting "You do not currently have a personalized greeting.", desc: "What to play if there is no specific greeting"
-        recording {
-          max_duration 5_000, desc: "Maximum duration for recording in milliseconds"
-          start_beep true, desc: "Play a beep before recording"
-        }
       }
 
       desc "Set PIN configuration"
@@ -63,8 +77,10 @@ module Voicemail
 
       desc "Listen to messages menu configuration"
       messages {
-        menu "Press 1 to archive the message and go to the next, press 5 to delete the message and go to the next, press 7 to hear the message again, press 9 for the main menu", desc: "Menu to use inside messages"
+        menu_new "Press 1 to archive the message and go to the next, press 5 to delete the message and go to the next, press 7 to hear the message again, press 9 for the main menu", desc: "Menu to use inside new messages"
+        menu_saved "Press 1 to unarchive the message and go to the next, press 5 to delete the message and go to the next, press 7 to hear the message again, press 9 for the main menu", desc: "Menu to use inside saved messages"
         no_new_messages "There are no new messages", desc: "Message to inform the user he has no new messages"
+        no_saved_messages "There are no saved messages", desc: "Message to inform the user he has no saved messages"
         message_received_on "Message received on ", desc: "Prefix to menu intro"
         from " from ", desc: "Used in message intro"
       }
@@ -83,8 +99,17 @@ module Voicemail
         task :info do
           STDOUT.puts "Voicemail plugin v. #{VERSION}"
         end
+
+        desc "Copy an initial translation file (en) to your adhearsion project (ahn_root/config/locales/en.yml)"
+        task :i18n_init do
+          current_path  = File.expand_path(File.dirname(__FILE__))
+          template_file = "#{current_path}/../../templates/en.yml"
+          new_location  = "#{Dir.pwd}/config/locales/"
+
+          FileUtils.mkdir_p(new_location) unless File.directory?(new_location)
+          FileUtils.copy template_file, "#{new_location}en.yml"
+        end
       end
     end
-
   end
 end

data/lib/voicemail/storage_pstore.rb

@@ -5,6 +5,7 @@ module Voicemail
     attr_accessor :store
 
     def initialize
+      logger.fatal "#new storage pstore!"
       @store = PStore.new config.storage.pstore_location
       setup_schema
     end
@@ -21,12 +22,24 @@ module Voicemail
       end
     end
 
+    def count_saved_messages(mailbox_id)
+      store.transaction true do
+        store[:archived][mailbox_id].size
+      end
+    end
+
     def next_new_message(mailbox_id)
       store.transaction true do
         store[:recordings][mailbox_id].first
       end
     end
 
+    def next_saved_message(mailbox_id)
+      store.transaction true do
+        store[:archived][mailbox_id].first
+      end
+    end
+
     def archive_message(mailbox_id, message_id)
       store.transaction do
         item = store[:recordings][mailbox_id].select { |i| i[:id] == message_id }
@@ -38,6 +51,17 @@ module Voicemail
       end
     end
 
+    def unarchive_message(mailbox_id, message_id)
+      store.transaction do
+        item = store[:archived][mailbox_id].select { |i| i[:id] == message_id }
+        rec  = item.first
+        if rec
+          store[:recordings][mailbox_id] << rec
+          store[:archived][mailbox_id].delete(rec)
+        end
+      end
+    end
+
     def delete_message(mailbox_id, message_id)
       File.unlink(rec[:uri]) if File.exists?(rec[:uri])
       store[:recordings][mailbox_id].delete(rec)
@@ -55,13 +79,13 @@ module Voicemail
       end
     end
 
-    def save_recording(mailbox_id, from, recording_uri)
+    def save_recording(mailbox_id, from, recording_object)
       store.transaction do
         recording = {
           id:       SecureRandom.uuid,
           from:     from,
           received: Time.now,
-          uri:      recording_uri.gsub(/file:\/\//, '')
+          uri:      recording_object.uri
         }
         store[:recordings][mailbox_id] << recording
         logger.info "Saving recording: #{recording.inspect}"
@@ -78,6 +102,29 @@ module Voicemail
         store[:mailboxes]   ||= {}
         store[:recordings]  ||= {}
         store[:archived]    ||= {}
+
+        store[:mailboxes][1]  = {greeting_message: "Hello.", id: 1, pin: '1234', record_options: {max_duration: 10}}
+        store[:recordings][1] ||= []
+        store[:archived][1]   ||= []
+      end
+
+      store.transaction do
+        foo_recording = {
+          id:       "e31823a5-1e2e-4038-a03b-2b5795190142",
+          from:     "123456",
+          received: DateTime.new(2013,8,29,14,10,12),
+          uri:      "https://gh-audio-development.s3.amazonaws.com/voicemails/f911f9c4-10e6-11e3-a9cb-5dc153dadb7c-3.mp3"
+        }
+
+        foo_archived = {
+          id:       "7a88a931-fd9f-4816-8a92-d055050387a8",
+          from:     "123456",
+          received: DateTime.new(2013,8,29,14,10,12),
+          uri:      "https://gh-audio-development.s3.amazonaws.com/voicemails/9a1ca46c-0f53-11e3-a1f7-2b3c646a58f5-3.mp3"
+        }
+
+        store[:recordings][1] = [foo_recording]
+        store[:archived][1]   = [foo_archived]
       end
     end
 

data/lib/voicemail/version.rb

@@ -1,3 +1,3 @@
 module Voicemail
-  VERSION = "0.2.0"
+  VERSION = "1.0.0.beta"
 end

data/spec/voicemail/call_controllers/application_controller_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Voicemail::ApplicationController do
+  include VoicemailControllerSpecHelper
+
+  describe "#main_menu" do
+    context "with the defaults" do
+      it "passes to MainMenuController" do
+        subject.should_receive(:pass).once.with Voicemail::MailboxMainMenuController, mailbox: mailbox[:id], storage: storage_instance
+        controller.main_menu
+      end
+    end
+
+    context "with a custom class" do
+
+      class Foo; end
+
+      before do
+        @saved_option = config.main_menu_class
+        config.main_menu_class = Foo
+      end
+
+      after { config.main_menu_class = @saved_option }
+
+      it "passes to custom controller class" do
+        subject.should_receive(:pass).once.with Foo, mailbox: mailbox[:id], storage: storage_instance
+        controller.main_menu
+      end
+    end
+  end
+end

data/spec/voicemail/call_controllers/authentication_controller_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Voicemail::AuthenticationController do
+  include VoicemailControllerSpecHelper
+
+  describe "#run" do
+    context "with a missing mailbox parameter in metadata" do
+      let(:metadata) { Hash.new }
+
+      it "should raise an error if there is no mailbox in the metadata" do
+        expect { controller.run }.to raise_error ArgumentError
+      end
+    end
+
+    context "with a present mailbox parameter in metadata" do
+      context "with an invalid mailbox" do
+        let(:mailbox) { nil }
+
+        it "plays the mailbox not found message and hangs up" do
+          should_play config.mailbox_not_found
+          subject.should_receive(:hangup).once
+          controller.run
+        end
+      end
+
+      context "with an existing mailbox" do
+        it "plays the mailbox greeting message" do
+          should_play config.mailbox.greeting_message
+          subject.should_receive(:authenticate)
+          subject.should_receive(:auth_ok).and_return true
+          subject.should_receive(:pass).with Voicemail::MailboxController, mailbox: 100
+          controller.run
+        end
+      end
+    end
+  end
+
+  describe "#authenticate" do
+    it "authenticates an user that enters the correct pin" do
+      should_ask(config.mailbox.please_enter_pin, terminator: "#", timeout: config.prompt_timeout).once.and_return(1234)
+      controller.authenticate
+      controller.auth_ok.should == true
+    end
+
+    it "tell a user his pin is wrong and retries" do
+      subject.should_receive(:ask).times(2).and_return(1111, 1234)
+      should_play config.mailbox.pin_wrong
+      controller.authenticate
+      controller.auth_ok.should == true
+    end
+
+    it "fails with a message if the user enters a wrong PIN the set number of times" do
+      subject.should_receive(:ask).times(3).and_return(1111, 2222, 3333)
+      subject.should_receive(:play).with(config.mailbox.pin_wrong).times(3)
+      controller.authenticate
+      controller.auth_ok.should == false
+    end
+  end
+end

data/spec/voicemail/call_controllers/mailbox_controller_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Voicemail::MailboxController do
+  include VoicemailControllerSpecHelper
+
+  describe "#run" do
+    context "with a missing mailbox parameter in metadata" do
+      let(:metadata) { Hash.new }
+
+      it "should raise an error if there is no mailbox in the metadata" do
+        expect { controller.run }.to raise_error ArgumentError
+      end
+    end
+
+    context "with a present mailbox parameter in metadata" do
+      context "with an invalid mailbox" do
+        let(:mailbox) { nil }
+
+        it "plays the mailbox not found message and hangs up" do
+          should_play config.mailbox_not_found
+          subject.should_receive(:hangup).once
+          controller.run
+        end
+      end
+
+      context "with an existing mailbox" do
+        it "plays the mailbox greeting message" do
+          subject.should_receive(:play_number_of_messages).and_return(true)
+          subject.should_receive(:main_menu).and_return(true)
+          controller.run
+        end
+      end
+    end
+  end
+
+  describe "#play_number_of_messages" do
+    before { config.numeric_method = :play_numeric }
+    after do
+      controller.play_number_of_messages type
+    end
+
+    context ":new" do
+      let(:type) { :new }
+
+      context "with at least one new message" do
+        before { storage_instance.should_receive(:count_new_messages).once.with(mailbox[:id]).and_return 3 }
+
+        it "plays the number of new messages" do
+          should_play(config.mailbox.number_before).ordered
+          subject.should_receive(:play_numeric).ordered.with(3)
+          should_play(config.mailbox.number_after_new).ordered
+        end
+
+        context "when it's set to use ahnsay" do
+          before { config.numeric_method = :ahn_say }
+
+          it "plays the number of messages using ahn say" do
+            should_play(config.mailbox.number_before).ordered
+            subject.should_receive(:sounds_for_number).with(3).and_return "3.ul"
+            subject.should_receive(:play).ordered.with "3.ul"
+            should_play(config.mailbox.number_after_new).ordered
+          end
+        end
+
+        context "when it's set to use I18n" do
+          before { config.numeric_method = :i18n_string }
+
+          it "plays the number of messages using i18n's pluralization" do
+            flexmock(I18n).should_receive(:t).with("voicemail.mailbox.x_new_messages", count: 3).and_return "You have 3 new messages"
+            should_play "You have 3 new messages"
+          end
+        end
+      end
+
+      context "with no new message" do
+        before { storage_instance.should_receive(:count_new_messages).once.with(mailbox[:id]).and_return 0 }
+
+        it "plays the no new messages audio" do
+          should_play(config.messages.no_new_messages).ordered
+        end
+      end
+    end
+
+    context ":saved" do
+      let(:type) { :saved }
+
+      it "plays the number of saved messages if there is at least one" do
+        storage_instance.should_receive(:count_saved_messages).once.with(mailbox[:id]).and_return(3)
+        should_play(config.mailbox.number_before).ordered
+        subject.should_receive(:play_numeric).ordered.with(3)
+        should_play(config.mailbox.number_after_saved).ordered
+      end
+
+      it "does play the no saved messages audio if there are none" do
+        storage_instance.should_receive(:count_saved_messages).once.with(mailbox[:id]).and_return(0)
+        should_play(config.messages.no_saved_messages).ordered
+      end
+    end
+  end
+
+  describe "#main_menu" do
+    it "passes to MainMenuController" do
+      subject.should_receive(:pass).once.with Voicemail::MailboxMainMenuController, mailbox: mailbox[:id], storage: storage_instance
+      controller.main_menu
+    end
+  end
+end