asterisk-mailcmd 0.0.1

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'stringio'
+require 'methadone'
+require 'asterisk/mailcmd'
+
+require 'pp'
+
+class MiniTest::Unit::TestCase
+  def mock_ast_stdin
+    # get raw email from fixture file
+    file = File.expand_path('fixtures/email.text',File.dirname(__FILE__))
+    # return mocked IO
+    StringIO.new(File.read file)
+  end
+
+  def html_tmpl_file_path
+    File.expand_path('fixtures/html_tmpl.erb',File.dirname(__FILE__))
+  end
+
+  def text_tmpl_file_path
+    File.expand_path('fixtures/text_tmpl.erb',File.dirname(__FILE__))
+  end
+
+end

data/test/test_read_stdin.rb

@@ -0,0 +1,42 @@
+require 'helper'
+include Asterisk::Mailcmd
+
+describe Email, "reading email data from Asterisk" do
+
+  before do # setup
+    $stdin = mock_ast_stdin
+  end
+
+  after do #teardown
+    $stdin = STDIN
+  end
+
+  describe "Reading from Asterisk" do
+
+    it "must read valid raw email from STDIO" do
+      email = Email.read
+      email.rawdata.size.must_be :>, 0
+    end
+
+    it "must return false if invalid raw email message" do
+      # Valid raw email must endin
+      # with full stop (period) on new line
+      # RFC772: The last line must consist of only a single period.
+      $stdin.stubs(:read).once.returns("This is invalid \n.\nraw email")
+      email = Email.read
+      email.raw_valid?.must_equal false
+    end
+
+    it "must return true if valid raw email" do
+      email = Email.read
+      email.raw_valid?.must_equal true
+    end
+
+    it "must read mail to Mail class instance" do
+      Email.read.
+        mail.from.first.
+        must_equal "asterisk@localhost.localdomain"
+    end
+
+  end
+end

data/test/test_set_mail_send.rb

@@ -0,0 +1,100 @@
+require 'helper'
+include Asterisk::Mailcmd
+include Mail::Matchers
+
+describe Email, "setting up and delivering email" do
+
+  before do # setup
+    @html_tmpl_path = html_tmpl_file_path # helper method
+    @text_tmpl_path = text_tmpl_file_path
+    $stdin = mock_ast_stdin
+  end
+
+  after do #teardown
+    $stdin = STDIN
+  end
+
+  describe "Setting up email" do
+
+    it "must set email date to now" do
+      email = Email.read
+      # stub date
+      time = Time.new
+      Time.stubs(:now).returns(time)
+      email.set_date
+      email.mail.date.to_time. # Mail.date is DateTime class
+        to_s.must_equal time.to_s
+    end
+
+    it "must set default date" do
+      email = Email.read
+      time = Time.now
+      email.set_date time
+      email.mail.date.to_time.
+        to_s.must_equal time.to_s
+    end
+
+    it "must raise when invalid Time object" do
+      email = Email.read
+      proc {
+        email.set_date "some time"
+      }.must_raise ArgumentError
+    end
+    
+    it "must return charset UTF-8 by default" do
+      email = Email.read
+      email.get_charset.must_equal 'UTF-8'
+    end
+
+    it "must set charset" do
+      email = Email.read
+      email.charset = 'ASCII'
+      email.get_charset.must_equal 'ASCII'
+    end
+
+    it "must set html template with charset ISO-8859-1" do
+      email = Email.read
+      email.extract_vars
+      email.set_date
+      chrst = 'ISO-8859-1'
+      email.charset = chrst
+      Settings.read @text_tmpl_path, :text
+      email.text_tmpl Settings.text_tmpl
+      Settings.read @html_tmpl_path
+      email.html_tmpl Settings.html_tmpl
+      email.mail.html_part.content_type.must_match(/charset=#{chrst}/)
+    end
+
+    it "must set default deliver method and params" do
+      email = Email.read
+      email.delivery_method.must_equal :sendmail
+      email.delivery_params.class.must_equal Hash
+      email.delivery_params.size.must_equal 0
+    end
+
+    it "must raise if set_and_send has no text templates set" do
+      proc {
+        Email.set_and_send :charset     => 'UTF-8'
+      }.must_raise InvalidTxtTmpl
+    end
+
+    it "must raise if set_and_send has no HTML templates set" do
+      proc {
+        Email.set_and_send :text_tmpl => @text_tmpl_path
+      }.must_raise InvalidHtmlTmpl
+    end
+
+    it "must send email with set_and_send" do
+      Email.set_and_send  :text_tmpl => @text_tmpl_path,
+                          :html_tmpl => @html_tmpl_path,
+                          :charset => 'ISO-8859-1',
+                          :delivery_method => :test
+      # should send one email
+      Mail::TestMailer.deliveries.length.must_equal 1
+      Mail::TestMailer.deliveries.first.from.first.must_equal "asterisk@localhost.localdomain"
+      Mail::TestMailer.deliveries.first.html_part.content_type.must_match(/charset=ISO-8859-1/)
+      Mail::TestMailer.deliveries.first.html_part.body.decoded.must_match(/2275550168/)
+    end
+
+  end
+end

data/test/test_set_tmpl.rb

@@ -0,0 +1,61 @@
+require 'helper'
+include Asterisk::Mailcmd
+
+describe Email, "Body templates" do
+
+  before do # setup
+    @html_tmpl_path = html_tmpl_file_path # helper method
+    @text_tmpl_path = text_tmpl_file_path
+    $stdin = mock_ast_stdin
+  end
+
+  after do #teardown
+    $stdin = STDIN
+  end
+
+  describe "Setting up email variables and templates" do
+
+    it "must extract Asterisk variables from email" do
+      email = Email.read
+      email.extract_vars
+      # see fixtures for expected values
+      email.astvars[:VM_CIDNUM].must_equal "2275550168"
+    end
+
+    it "must set email HTML tamplate and inline variables" do
+      email = Email.read
+      email.extract_vars
+      Settings.read @html_tmpl_path
+      email.html_tmpl Settings.html_tmpl
+      email.htmlpart.must_match(email.astvars[:VM_CIDNUM])
+      email.mail.html_part.body.decoded.
+        must_match(email.astvars[:VM_CIDNUM])
+    end
+
+    it "must raise if variables were not extracted" do
+      proc {
+        email = Email.read
+        Settings.read @html_tmpl_path
+        email.html_tmpl Settings.html_tmpl
+      }.must_raise ArgumentError
+    end
+
+    it "must raise if invalid template type" do
+      proc {
+        email = Email.read
+        email.tmpl "template text", :unknown_type
+      }.must_raise ArgumentError
+    end
+
+    it "must set email TEXT tamplate and inline variables" do
+      email = Email.read
+      email.extract_vars
+      Settings.read @text_tmpl_path, :text
+      email.text_tmpl Settings.text_tmpl
+      email.textpart.must_match(email.astvars[:VM_CIDNUM])
+      email.mail.text_part.body.decoded.
+        must_match(email.astvars[:VM_CIDNUM])
+    end
+
+  end
+end

data/test/test_settings.rb

@@ -0,0 +1,51 @@
+require 'helper'
+include Asterisk::Mailcmd
+
+describe Settings, "Application settings" do
+
+  before do # setup
+    # helper methods
+    @html_tmpl_path = html_tmpl_file_path 
+    @text_tmpl_path = text_tmpl_file_path
+  end
+
+  after do #teardown
+  end
+
+  describe "Settings processing" do
+
+    it "must raise ArgumentError if template file does not exist" do
+      File.stubs(:exists?).once.returns(false)
+      proc {
+        Settings.read('/not/existing/file.tmpl')
+      }.must_raise ArgumentError
+    end
+
+    it "must raise ArgumentError if template file is not readable" do
+      File.stubs(:exists?).once.returns(true)
+      File.stubs(:readable?).once.returns(false)
+      proc {
+        Settings.read('/not/readable/file.tmpl')
+      }.must_raise ArgumentError
+    end
+
+    it "must set instance variable after reading html template file" do
+      Settings.read(@html_tmpl_path, :html).must_equal Settings.html_tmpl
+    end
+
+    it "must set instance variable after reading text template file" do
+      Settings.read(@text_tmpl_path, :text).must_equal Settings.text_tmpl
+    end
+
+    it "must set default template as html" do
+      Settings.read(@html_tmpl_path, :html).must_equal Settings.read(@html_tmpl_path)
+    end
+
+    it "must raise ArgumentError when template type is invalid" do
+      proc {
+        Settings.read(@html_tmpl_path, :unknown_template_type)
+      }.must_raise ArgumentError
+    end
+
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: asterisk-mailcmd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stas Kobzar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+description: Asterisk voicemail emails enhancement
+email:
+- stas@modulis.ca
+executables:
+- asterisk-mailcmd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- asterisk-mailcmd.gemspec
+- bin/asterisk-mailcmd
+- features/asterisk-mailcmd.feature
+- features/step_definitions/asterisk-mailcmd_steps.rb
+- features/support/env.rb
+- lib/asterisk/mailcmd.rb
+- lib/asterisk/mailcmd/email.rb
+- lib/asterisk/mailcmd/settings.rb
+- lib/asterisk/mailcmd/version.rb
+- sample/html_email.png
+- sample/html_tmpl.erb
+- sample/mailcmd.rvm.sh
+- sample/text_tmpl.erb
+- test/fixtures/email.text
+- test/fixtures/html_tmpl.erb
+- test/fixtures/text_tmpl.erb
+- test/helper.rb
+- test/test_read_stdin.rb
+- test/test_set_mail_send.rb
+- test/test_set_tmpl.rb
+- test/test_settings.rb
+homepage: http://www.modulis.ca
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: ! 'Command to use with Asterisk mailcmp option. See: voicemail.conf'
+test_files:
+- features/asterisk-mailcmd.feature
+- features/step_definitions/asterisk-mailcmd_steps.rb
+- features/support/env.rb
+- test/fixtures/email.text
+- test/fixtures/html_tmpl.erb
+- test/fixtures/text_tmpl.erb
+- test/helper.rb
+- test/test_read_stdin.rb
+- test/test_set_mail_send.rb
+- test/test_set_tmpl.rb
+- test/test_settings.rb