active_mailbox 0.0.1

data/test/mailbox_test.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class MailboxTest < Test::Unit::TestCase
+  context "ActiveMailbox::Mailbox" do
+    should "find Mailbox with extension and context" do
+      ActiveMailbox::Fixtures.execute! do
+        assert ActiveMailbox::Mailbox.find('15183332220')
+      end
+    end
+
+    should "find Mailbox with extension only" do
+      ActiveMailbox::Fixtures.execute! do
+        m1 = ActiveMailbox::Mailbox.find('15183332220', '518')
+        m2 = ActiveMailbox::Mailbox.find('15183332220')
+        assert m1 == m2
+      end
+    end
+
+    should "raise MailboxNotFound with invalid path" do
+      assert_raise ActiveMailbox::Errors::MailboxNotFound do
+        ActiveMailbox::Mailbox.find('i certainly', 'dont exist')
+      end
+    end
+
+    context "instance" do
+      setup do
+        ActiveMailbox::Fixtures.create!
+        @mailbox = ActiveMailbox::Mailbox.find('15183332220', '518')
+      end
+
+      teardown do
+        ActiveMailbox::Fixtures.destroy!
+      end
+
+      should "use method_missing to simulate folder accessors" do
+        @mailbox.folders.keys.each do |folder|
+          assert_nothing_raised do
+            assert @mailbox.send(folder)
+          end
+          assert @mailbox.send(folder) == @mailbox.folders[folder]
+        end
+
+        assert_raise NoMethodError do
+          @mailbox.i_dont_exist
+        end
+      end
+
+      should "yield Folder hash" do
+        assert @mailbox.folders.is_a?(Hash)
+        @mailbox.folders.each do |key, folder|
+          assert folder.is_a?(ActiveMailbox::Folder)
+        end
+      end
+
+      should "purge all messages in all folders" do
+        assert @mailbox.total_messages > 0
+        @mailbox.purge!
+        @mailbox.folders.each do |name, folder|
+          assert folder.messages.empty?
+          assert File.exists?(folder.path)
+        end
+        assert_equal 0, @mailbox.total_messages
+      end
+
+      should "destroy itself" do
+        @mailbox.destroy!
+        assert File.exists?(@mailbox.path) == false
+      end
+
+      should "yield a current greeting" do
+        assert @mailbox.current_greeting
+      end
+
+      should "delete valid greeting" do
+        @mailbox.delete_greeting!(:unavail)
+        assert File.exists?(@mailbox.greeting_path(:unavail)) == false
+        assert_raise ActiveMailbox::Errors::GreetingNotFound do
+          @mailbox.delete_greeting!(:i_am_not_real)
+        end
+
+        assert @mailbox.delete_greeting!(:unavail) == false
+      end
+
+      should "delete temp greeting" do
+        @mailbox.delete_temp_greeting!
+        assert File.exists?(@mailbox.greeting_path(:temp)) == false
+      end
+
+      should "delete unvavail greeting" do
+        @mailbox.delete_unavail_greeting!
+        assert File.exists?(@mailbox.greeting_path(:unavail)) == false
+      end
+
+      should "delete busy greeting" do
+        @mailbox.delete_busy_greeting!
+        assert File.exists?(@mailbox.greeting_path(:busy)) == false
+      end
+
+      should "clean ghost messages in all folders" do
+        @mailbox.folders.each do |key, folder|
+          ActiveMailbox::Fixtures.simulate_ghosts(folder)
+          count = @mailbox.total_messages
+          @mailbox.clean_ghosts!
+          assert count > @mailbox.total_messages
+        end
+      end
+
+      should "clean stale messages in all folders" do
+        count = @mailbox.total_messages
+        @mailbox.clean_stale!
+        assert count > @mailbox.total_messages
+      end
+
+      should "sort and rename all messages in all folders" do
+        @mailbox.folders.each do |key, folder|
+          messages = folder.messages.map(&:name)
+          assert messages.size == folder.size
+
+          ActiveMailbox::Fixtures.simulate_unordered(folder)
+          assert messages.size > folder.size
+
+          names = messages.map { |m| "msg%04d" % m.match(/([0-9]{4})/)[1].to_i }
+          check = (0..messages.size - 1).map { |i| "msg%04d" % i }
+          assert_same_elements names, check
+        end
+      end
+
+      should "be compared to another instance based on mailbox number" do
+        mailbox = ActiveMailbox::Mailbox.find(@mailbox.mailbox)
+        assert mailbox == @mailbox
+      end
+
+    end
+  end
+end

data/test/message_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class MessageTest < Test::Unit::TestCase
+  context "ActiveMailbox::Message" do
+    setup do
+      ActiveMailbox::Fixtures.create!
+      @mailbox = ActiveMailbox::Mailbox.find('15183332220', '518')
+      @message = @mailbox.inbox.messages.first
+    end
+
+    teardown do
+      ActiveMailbox::Fixtures.destroy!
+    end
+
+    should "raise MessageNotFound initializing with invalid info file path" do
+      assert_raise ActiveMailbox::Errors::MessageNotFound do
+        ActiveMailbox::Message.new('i dont exist', @mailbox)
+      end
+    end
+
+    context "instance" do
+      should "destroy itself" do
+        wav = @message.wav
+        txt = @message.txt
+
+        assert @message.destroy!
+        assert File.exists?(wav) == false
+        assert File.exists?(txt) == false
+      end
+
+      should "yield attributes" do
+        [:timestamp, :duration, :callerid_number, :callerid_name, :name, :path].each do |key|
+          assert @message.send(key).nil? == false
+        end
+      end
+
+      should "be stale if older than MaximumAge" do
+        # last fixture message is older than MaximumAge
+        assert @mailbox.inbox.messages.last.stale?
+      end
+
+      should "be compared based on message number" do
+        m1 = @mailbox.inbox.messages[0]
+        m2 = @mailbox.inbox.messages[1]
+        assert m1 < m2
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,97 @@
+# Set Asterisk's voicemail path so tests don't clobber a production system
+ENV['ASTERISK_VOICEMAIL_ROOT'] = "/tmp/active_mailbox_test_#{Time.now.to_i}"
+
+require 'rubygems'
+require 'test/unit'
+require 'turn'
+require 'shoulda'
+require 'fileutils'
+
+require 'active_mailbox'
+
+module ActiveMailbox::Fixtures
+  extend self
+
+  BASE_DIR = ENV['ASTERISK_VOICEMAIL_ROOT']
+
+  def simulate_ghosts(folder)
+    [2, 4, 0, 5].map do |i|
+      message = folder.messages[i]
+      File.unlink(message.wav)
+    end
+  end
+
+  def simulate_unordered(folder)
+    [2, 4, 0, 5].map do |i|
+      folder.messages[i]
+    end.each(&:destroy!)
+  end
+
+  def mailbox
+    File.join(BASE_DIR, '518', '15183332220')
+  end
+
+  def inbox
+    File.join(mailbox, 'INBOX')
+  end
+
+  def old
+    File.join(mailbox, 'Old')
+  end
+
+  def info_template(date)
+    template = %{;
+      ; Message Information file
+      ;
+      [message]
+      origmailbox=15183332220
+      context=incoming
+      macrocontext=
+      exten=15183332220
+      priority=6
+      callerchan=SIP/16.26.15.146-00c811d0
+      callerid="Joshua Priddle" <15183332220>
+      origdate=#{date}
+      origtime=1244496482
+      category=
+      duration=0}.gsub(/^      /, '')
+  end
+
+  def execute!(&block)
+    create!
+    yield
+    destroy!
+  end
+
+  def destroy!
+    if File.exists?(BASE_DIR)
+      FileUtils.rm_rf(BASE_DIR)
+    end
+  end
+
+  def create!
+    FileUtils.mkdir_p(mailbox)
+    FileUtils.touch(File.join(mailbox, 'unavail.wav'))
+    FileUtils.touch(File.join(mailbox, 'temp.wav'))
+
+    [inbox, old].each do |dir|
+      FileUtils.mkdir_p(dir)
+      Dir.chdir(dir) do
+        0.upto(10) do |i|
+          msg = "msg%04d" % i
+          wav = "#{msg}.wav"
+          txt = "#{msg}.txt"
+
+          FileUtils.touch(wav)
+
+          date = Time.now - (60 * 60 * 24 * (4 * (i + 1)))
+
+          File.open(txt, "w") do |f|
+            f.puts info_template(date)
+          end
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: active_mailbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Priddle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  type: :development
+  version_requirements: *id002
+description: "    ActiveMailbox provides a simple API and command line utility to work\n    with voicemail boxes and voicemails generated by Asterisk.\n"
+email: jpriddle@nevercraft.net
+executables: 
+- active_mailbox
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- LICENSE
+files: 
+- Rakefile
+- README.markdown
+- LICENSE
+- bin/active_mailbox
+- lib/active_mailbox/cli.rb
+- lib/active_mailbox/errors.rb
+- lib/active_mailbox/folder.rb
+- lib/active_mailbox/mailbox.rb
+- lib/active_mailbox/message.rb
+- lib/active_mailbox/version.rb
+- lib/active_mailbox.rb
+- test/folder_test.rb
+- test/mailbox_test.rb
+- test/message_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/itspriddle/active_mailbox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "ActiveMailbox: API/CLI for Asterisk Voicemail"
+test_files: []
+