voicemail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85483d596c2b6e25016b05a3ea29885e8c243851
+  data.tar.gz: b06686ed9549ffa75661d4f3065ff0c60e21e2fc
+SHA512:
+  metadata.gz: 21e6b40a6f88258cc4dc9f4324029d5a654da70d4feb1bc7f5513b942e9e0b72852dfb8aabbaef387b9db741c25807822c8c9760a2d04bc8d2e374fcb53f9a53
+  data.tar.gz: 8b7cc4401c5f949e89a4aec9ce381d2ec304efaf7c5278b6a3a4dfe55bced067fb6824fe2b590edf627d75a41d4d595385056c73d2ad3ee316d6a6430282de99

data/.gitignore

@@ -0,0 +1,26 @@
+# Gem related stuff
+*.gem
+/pkg
+/.bundle
+/Gemfile.lock
+/vendor
+
+# Testing stuff
+/coverage
+/spec/reports
+*.log
+/adhearsion.pid
+
+# RBX stuff
+/.rbx/
+
+# Editor temp/backup files
+*~
+.*.sw?
+
+# General
+/nbproject
+.DS_Store
+/.rvmrc
+/.yardoc
+/doc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec/" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2012 Adhearsion Foundation Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+[![Build Status](https://secure.travis-ci.org/adhearsion/voicemail.png?branch=develop)](http://travis-ci.org/adhearsion/voicemail)
+
+# Voicemail
+
+This plugin aims to provide a basic voicemail implementation, complete with a voicemail system that allows user to listen to messages and manage them. It is currently only compatible with Asterisk, and you will need to provide the audio files and their path in the configuration. The configuration also contains many other options.
+
+## Usage
+
+Every mailbox has an id and PIN that can be provisioned using a pry console.
+
+To send a call to a mailbox use:
+```ruby
+  # inside a CallController method
+  invoke Voicemail::VoicemailController, mailbox: mailbox_id
+```
+
+To allow access by users to the mailboxes, `invoke MailboxController`. You will have to provide the mailbox ID to load.
+```ruby
+  # inside a CallController method
+  invoke Voicemail::MailboxController, mailbox: mailbox_id
+```
+
+## Storage
+
+Mailbox metadata is stored in a PStore hash on disk for easy drop-in functionality.
+To implement your owm storage layer, look at the StorageMain class for method signatures.
+
+You can set the storage layer globally in configuration.
+```ruby
+  config.voicemail.storage.storage_class = StorageWidget
+```
+
+Alternatively, you can pass in a storage layer dynamically when invoking the controller.
+```ruby
+  if customer.voicemail_version == VERSION_ONE
+    invoke Voicemail::VoicemailController, mailbox: customer.mailbox_id, storage: VersionOneStorage.new
+  elsif customer.voicemail_version == VERSION_TWO
+    invoke Voicemail::VoicemailController, mailbox: customer.mailbox_id, storage: VersionTwoStorage.new
+  # etc.
+```
+
+## Author
+
+Original author: [Luca Pradovera](https://github.com/polysics)
+
+## Links
+
+* [Source](https://github.com/adhearsion/voicemail)
+* [Bug Tracker](https://github.com/adhearsion/voicemail/issues)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Adhearsion Foundation Inc. MIT license (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+task default: :spec

data/lib/voicemail/application_controller.rb

@@ -0,0 +1,27 @@
+module Voicemail
+  class ApplicationController < ::Adhearsion::CallController
+    def main_menu
+      pass MailboxMainMenuController, mailbox: mailbox[:id]
+    end
+
+    private
+
+    def storage
+      metadata[:storage] || Storage.instance
+    end
+
+    def config
+      Voicemail::Plugin.config
+    end
+
+    def mailbox
+      @mailbox ||= fetch_mailbox
+    end
+
+    def fetch_mailbox
+      mailbox_id = metadata[:mailbox] || nil
+      raise ArgumentError, "Voicemail needs a mailbox specified in metadata" unless mailbox_id
+      storage.get_mailbox mailbox_id
+    end
+  end
+end

data/lib/voicemail/mailbox_controller.rb

@@ -0,0 +1,56 @@
+module Voicemail
+  class MailboxController < ApplicationController
+    def run
+      if mailbox
+        play_greeting
+        fail_auth unless authenticate
+        play_number_of_messages
+        main_menu
+      else
+        mailbox_not_found
+      end
+    end
+
+    def authenticate
+      current_tries = 0
+      auth_ok = false
+      while current_tries < config.mailbox.pin_tries
+        input = ask config.mailbox.please_enter_pin, terminator: "#", timeout: config.prompt_timeout
+        logger.info input.to_s
+        logger.info mailbox[:pin].to_s
+        auth_ok = true if input.to_s == mailbox[:pin].to_s
+        break if auth_ok
+        play config.mailbox.pin_wrong
+        current_tries += 1
+      end
+      auth_ok
+    end
+
+    def play_number_of_messages
+      number = storage.count_new_messages(mailbox[:id])
+      if number > 0
+        play config.mailbox.number_before
+        play_numeric number
+        play config.mailbox.number_after
+      else
+        play config.messages.no_new_messages
+      end
+    end
+
+    private
+
+    def play_greeting
+      play config.mailbox.greeting_message
+    end
+
+    def mailbox_not_found
+      play config.mailbox_not_found
+      hangup
+    end
+
+    def fail_auth
+      play config.mailbox.could_not_auth
+      hangup
+    end
+  end
+end

data/lib/voicemail/mailbox_main_menu_controller.rb

@@ -0,0 +1,41 @@
+module Voicemail
+  class MailboxMainMenuController < ApplicationController
+    def run
+      main_menu
+    end
+
+    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 }
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    end
+
+    def set_greeting
+      invoke MailboxSetGreetingController, mailbox: mailbox[:id]
+    end
+
+    def set_pin
+      invoke MailboxSetPinController, mailbox: mailbox[:id]
+    end
+
+    def listen_to_messages
+      invoke MailboxMessagesController, mailbox: mailbox[:id]
+    end
+  end
+end

data/lib/voicemail/mailbox_messages_controller.rb

@@ -0,0 +1,55 @@
+module Voicemail
+  class MailboxMessagesController < ApplicationController
+    def run
+      message_loop
+    end
+
+    def message_loop
+      number = storage.count_new_messages(mailbox[:id])
+      if number > 0
+        next_message
+      else
+        bail_out
+      end
+    end
+
+    def next_message
+      current_message = storage.next_new_message(mailbox[:id])
+      handle_message current_message
+      message_loop
+    end
+
+    def handle_message(message)
+      invoke MailboxPlayMessageController, message: message, mailbox: mailbox[:id]
+    end
+
+    private
+
+    def bail_out
+      play config.messages.no_new_messages
+      main_menu
+    end
+
+    def section_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 }
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    end
+  end
+end

data/lib/voicemail/mailbox_play_message_controller.rb

@@ -0,0 +1,69 @@
+module Voicemail
+  class MailboxPlayMessageController < ApplicationController
+
+    def run
+      load_message
+      intro_message
+      play_message
+    end
+
+    def play_message
+      menu current_message[:uri].gsub(/\.wav/, ''), config.messages.menu,
+         timeout: config.menu_timeout, tries: config.menu_tries do
+        match 1 do
+          archive_message
+        end
+
+        match 5 do
+          delete_message
+        end
+
+        match(7) { rewind_message }
+        match(9) { main_menu }
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    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
+      execute "SayDigits", from_digits unless from_digits.empty?
+      # say_characters '1234'
+    end
+
+    def rewind_message
+      play_message
+    end
+
+    def archive_message
+      storage.archive_message mailbox[:id], current_message[:id]
+    end
+
+    def delete_message
+      storage.delete_message mailbox[:id], current_message[:id]
+    end
+
+    def current_message
+      @message
+    end
+
+    def load_message
+      @message = metadata[:message] || nil
+      raise ArgumentError, "MailboxPlayMessageController needs a valid message passed to it" unless @message
+    end
+  end
+end

data/lib/voicemail/mailbox_set_greeting_controller.rb

@@ -0,0 +1,75 @@
+module Voicemail
+  class MailboxSetGreetingController < ApplicationController
+    attr_accessor :temp_recording
+
+    def run
+      section_menu
+    end
+
+    def section_menu
+      menu config.set_greeting.prompt,
+         timeout: config.menu_timeout, tries: config.menu_tries do
+        match(1) { listen_to_current_greeting }
+        match(2) { record_greeting }
+        match(9) { main_menu }
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    end
+
+    def listen_to_current_greeting
+      play mailbox[:greeting_message] || config.set_greeting.no_personal_greeting
+      section_menu
+    end
+
+    def record_greeting
+      play config.set_greeting.before_record
+      record_comp = record config.set_greeting.recording.to_hash.merge(interruptible: true, max_duration: 30_000)
+      @temp_recording = record_comp.complete_event.recording.uri.gsub(/file:\/\//, '').gsub(/\.wav/, '')
+      play @temp_recording
+
+      menu config.set_greeting.after_record,
+         timeout: config.menu_timeout, tries: config.menu_tries do
+        match(1) { save_greeting }
+        match 2 do
+          @temp_recording = nil
+          record_greeting
+        end
+
+        match 9 do
+          @temp_recording = nil
+          section_menu
+        end
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    end
+
+    def save_greeting
+      storage.save_greeting_for_mailbox mailbox[:id], temp_recording
+      main_menu
+    end
+  end
+end

data/lib/voicemail/mailbox_set_pin_controller.rb

@@ -0,0 +1,45 @@
+module Voicemail
+  class MailboxSetPinController < ApplicationController
+    def run
+      section_menu
+    end
+
+    def section_menu
+      menu config.set_pin.menu,
+         timeout: config.menu_timeout, tries: config.menu_tries do
+        match(1) { set_pin }
+        match(9) { main_menu }
+
+        timeout do
+          play config.mailbox.menu_timeout_message
+        end
+
+        invalid do
+          play config.mailbox.menu_invalid_message
+        end
+
+        failure do
+          play config.mailbox.menu_failure_message
+          hangup
+        end
+      end
+    end
+
+    def set_pin
+      pin = ask config.set_pin.prompt, terminator: "#"
+      repeat_pin = ask config.set_pin.repeat_prompt, terminator: "#"
+
+      if pin.to_s.size < config.set_pin.pin_minimum_digits
+        play config.set_pin.pin_error
+        set_pin
+      elsif pin.to_s != repeat_pin.to_s
+        play config.set_pin.match_error
+        set_pin
+      else
+        play config.set_pin.change_ok
+        storage.change_pin_for_mailbox mailbox[:id], pin.to_s
+        main_menu
+      end
+    end
+  end
+end

data/lib/voicemail/plugin.rb

@@ -0,0 +1,86 @@
+module Voicemail
+  class Plugin < Adhearsion::Plugin
+
+    init :voicemail do
+      logger.info "Voicemail has been loaded"
+    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"
+      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"
+
+      desc "Voicemail recording options"
+      recording {
+        max_duration 5_000, desc: "Maximum duration for recording in milliseconds"
+        start_beep true, desc: "Play a beep before recording"
+      }
+
+      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_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"
+        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"
+      }
+
+      desc "Set greeting configuration"
+      set_greeting {
+        prompt "Press 1 to listen to your current greeting, 2 to record a new greeting, 9 to return to the main menu", desc: "Main prompt for setting greeting"
+        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"
+      set_pin {
+        menu "Press 1 to change your current PIN, or 9 to go back to the main menu", desc: "Prompt for the change PIN menu"
+        prompt "Enter your new PIN of at least four digits followed by the pound sign", desc: "What the user hears before entering the new PIN"
+        repeat_prompt "Please enter your new PIN again, followed by the pound sign", desc: "Message to ask the user to repeat his PIN"
+        pin_error "Please enter at least four digits followed by the pound sign.", desc: "Message in case the entered PIN is too short"
+        match_error "The two entered PINs don't match, please try again.", desc: "Message telling the user his new PINs don't match."
+        change_ok "Your PIN has been successfully changed", desc: "Message to tell the user his PIN has been changed"
+        pin_minimum_digits 4, desc: "Minimum number of digits for a PIN"
+      }
+
+      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"
+        no_new_messages "There are no new messages", desc: "Message to inform the user he has no new messages"
+        message_received_on "Message received on ", desc: "Prefix to menu intro"
+        from " from ", desc: "Used in message intro"
+      }
+
+      desc "Storage configuration"
+      storage {
+        storage_class Voicemail::StoragePstore, desc: "Class that implements the Storage specification. An instance will be created."
+        pstore_location "voicemail.pstore", desc: "Where to store the voicemail data"
+        file_location "file_dir", desc: "Where to store the voicemail files"
+      }
+    end
+
+    tasks do
+      namespace :voicemail do
+        desc "Prints the Voicemail information"
+        task :info do
+          STDOUT.puts "Voicemail plugin v. #{VERSION}"
+        end
+      end
+    end
+
+  end
+end

data/lib/voicemail/storage.rb

@@ -0,0 +1,7 @@
+module Voicemail
+  class Storage
+    def self.instance
+      @instance ||= Voicemail::Plugin.config.storage.storage_class.new
+    end
+  end
+end