asterisk-mailcmd 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTdkMjFjYTkwZTNlNDUzY2UwYTkxYWEyM2FmYzZjYjlmNzAyMzdhYQ==
+  data.tar.gz: !binary |-
+    YmI2ZGI1YmZiMzhkMDM4NDExNzUzMWYxNWM5ZTc1NTEwNDg4NWIxOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2Q0MWIwZDY5Y2EyOWM1MDBhZmNmNmQ4ZTcyM2YwMTNiODY4NDFjNzM3OGFh
+    MGJmM2I3MDMxOGU5NTU3ZjAwYWQ0ZWVhYzBjNzRlMWEyZWU4NzFjNmRhMDkw
+    OWQ2NzM4Mzg1MTcxYWU5NDExMDcyYjkwMTg3ZTM0MzVmNmM2YTI=
+  data.tar.gz: !binary |-
+    MzY5MjJhNzkzNmE4NmU3ZjRiNzcxNmY5YmNhYzA0MTFmOTJkZTAzZTQ1ODYx
+    ZjNkMWUyM2MyNzRlMDY5Mjc4MDU2MzdkZTdlNmJkNGQ5NWUwYWZjOTg4ZDc4
+    ZTM3ZTg1NWUyYjQzMDBiNGJiMGU4ZjUyYzdlZWYxMTVmN2JjOTA=

data/.gitignore

@@ -0,0 +1,27 @@
+# Ignore temporary files
+.*swp
+*~
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+results.html
+html
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asterisk-mailcmd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    asterisk-mailcmd (0.0.1)
+      mail
+      methadone (~> 1.2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.2.3)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.6)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.1)
+    ffi (1.4.0)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    i18n (0.6.4)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    methadone (1.2.6)
+      bundler
+    mime-types (1.21)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    polyglot (0.3.3)
+    rake (0.9.6)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  asterisk-mailcmd!
+  bundler (~> 1.3)
+  mocha
+  rake (~> 0.9.2)
+  rdoc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stas Kobzar
+
+MIT License
+
+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,111 @@
+# Asterisk::Mailcmd
+
+# Extending Asterisk voicemail message body for emails
+
+Asterisk Voicemail email seems to be quite limited when it comes about 
+configuring email body:
+* Email body is a one line text with backslash escapes and Asterisk variables.
+* It is limited to *512* characters (see voicemail.conf.sample)
+
+Under these circumstances it is impossible to create nice looking, formatted emails,
+to have individual email templates per user or multi-languages emails' templates.
+
+This simple a simple library which is supposed to address these shortcomings.
+
+## HTML Voicemail notification example
+![html email](https://raw.github.com/staskobzar/asterisk-mailcmd/master/sample/html_email.png)
+
+## Installation
+
+### Library for your application
+Add this line to your application's Gemfile:
+
+    gem 'asterisk-mailcmd', :git => git://github.com/staskobzar/asterisk-mailcmd.git
+
+And then execute:
+
+    $ bundle
+
+### Command line application
+Or install it yourself as:
+
+    $ git clone git://github.com/staskobzar/asterisk-mailcmd.git
+    $ cd asterisk-mailcmd
+    $ gem build asterisk-mailcmd.gemspec
+    $ gem install asterisk-mailcmd-X.X.X.gem
+
+## Asterisk configuration
+Asterisk voice mail must be configured to run this library when new voicemail received. There is an option **mailcmd** in voicemail.conf which must link to the executable script with this library: 
+
+    mailcmd=/usr/local/bin/mailcmd
+
+Another option that must be set is the `mailbody` :
+```
+mailbody=VM_NAME:${VM_NAME}\nVM_DUR:${VM_DUR}\nVM_MSGNUM:${VM_MSGNUM}\nVM_MAILBOX:${VM_MAILBOX}\nVM_CALLERID:${VM_CALLERID}\nVM_CIDNUM:${VM_CIDNUM}\nVM_CIDNAME:${VM_CIDNAME}\nVM_DATE:${VM_DATE}\nVM_MESSAGEFILE:${VM_MESSAGEFILE}
+```
+
+This is a list of variables that will be used in ERB templates.
+
+You can not use *asterisk-mailcmd* CLI application installed with this gem directly as a reference in in option **mailcmd** because Asterisk when asterisk run the command, it will not have information about your environment like path to ruby interpreter. 
+For that you must have a wrapper. Example of the wrapper can be found with the source: "sample/mailcmd.rvm.sh". Here is sample code:
+
+
+```bash
+
+#!/bin/sh
+
+# This is as simple wrapper for ruby application asterisk-mailcmd
+# when using RVM (Ruby Version Manager: https://rvm.io/) 
+
+# path to HTML and TEXT templates in ERB format
+# see samples in "sample" directory
+HTML_TMPL=/etc/asterisk/vmtemplate/html.erb
+TEXT_TMPL=/etc/asterisk/vmtemplate/text.erb
+
+# load RVM profile
+source /etc/profile.d/rvm.sh
+# run mail command
+asterisk-mailcmd -t $TEXT_TMPL -m $HTML_TMPL
+
+exit 0
+
+```
+
+Save this to file */usr/local/bin/mailcmd*, just like it is set with **mailcmd** option.
+Make sure that the file is executable.
+
+
+### Ruby gem library
+You can create your own ruby script:
+
+```ruby
+require 'asterisk/mailcmd'
+
+Asterisk::Mailcmd::Email.set_and_send :text_tmpl => '/path/text.erb',
+                                      :html_tmpl => '/path/html.erb'
+```
+
+## `Asterisk::Mailcmd::Email.set_and_send` parameters list:
+
+```
+:html_tmpl  => String: MANDATORY: HTML part ERB template file path
+:text_tmpl  => String: MANDATORY: Text part ERB template file path
+:charset    => String: OPTIONAL: Content type charset
+:date       => Time: OPTIONAL: Email date
+```
+## Templates
+Templates are ERB format with variables that are set with Asterisk (see option *mailbody*):
+
+```
+<h1>There is new mail in mailbox: <%= @astvars[:VM_MAILBOX].to_s %> </h1>
+```
+There are two example files in directory *sample*. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/README.rdoc

@@ -0,0 +1,23 @@
+= asterisk-mailcmd - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2013 YOUR NAME
+
+
+License:: mit, see LICENSE.txt
+
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,62 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/asterisk-mailcmd.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asterisk/mailcmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asterisk-mailcmd"
+  spec.version       = Asterisk::Mailcmd::VERSION
+  spec.authors       = ["Stas Kobzar"]
+  spec.email         = ["stas@modulis.ca"]
+  spec.description   = %q{Asterisk voicemail emails enhancement}
+  spec.summary       = %q{Command to use with Asterisk mailcmp option. See: voicemail.conf}
+  spec.homepage      = "http://www.modulis.ca"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('mocha')
+  spec.add_development_dependency('rake', '~> 0.9.2')
+  spec.add_dependency('mail')
+  spec.add_dependency('methadone', '~> 1.2.6')
+end

data/bin/asterisk-mailcmd

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'asterisk/mailcmd'
+
+require 'pp'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do # main proc
+    Asterisk::Mailcmd::Email.set_and_send options
+  end
+
+  # supplemental methods here
+
+  # Description
+  description %Q{Command to use with Asterisk mailcmp option. See: voicemail.conf.
+Default delivery method is sendmail}
+  
+  # Email text template file
+  on("-t FILE","--text-tmpl","Email TEXT template file (ERB format).") do |file|
+    options[:text_tmpl] = file
+  end
+
+  # Email HTML template file
+  on("-m FILE","--html-tmpl","Email HTML template file (ERB format).") do |file|
+    options[:html_tmpl] = file
+  end
+
+  # Email HTML charset
+  on("-c CHARSET","--charset","Email HTML content-type charset.") do |ch|
+    options[:charset] = ch
+  end
+
+  version Asterisk::Mailcmd::VERSION
+
+  use_log_level_option
+
+  go!
+end

data/features/asterisk-mailcmd.feature

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "asterisk-mailcmd"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/features/step_definitions/asterisk-mailcmd_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/asterisk/mailcmd.rb

@@ -0,0 +1,8 @@
+require "asterisk/mailcmd/settings"
+require "asterisk/mailcmd/email"
+require "asterisk/mailcmd/version"
+
+module Asterisk
+  module Mailcmd
+  end
+end