avarteq-email2sms 0.4.0

data/.gitignore

@@ -0,0 +1,13 @@
+.idea
+nbproject/* 
+nbproject/**/*
+log/email2sms_main.rb.output
+log/*.log
+tmp/**/*
+log/*.pid 
+db/schema.rb
+.DS_Store
+*.swp
+*~
+config/database.yml
+

data/README.textile

@@ -0,0 +1,98 @@
+h1. Email2sms
+
+p>. !http://farm3.static.flickr.com/2545/3859077628_55156d5b3e_t.jpg(Avarteq GmbH)!:http://www.avarteq.de
+
+Email2sms has been developed by "www.avarteq.de":http://www.avarteq.de.
+
+Email2sms is a free and pure Ruby E-Mail to sms gateway including an extensible filterchain to filter and manipulate incoming emails before sending them as text messages.
+
+h1. Requirements
+
+In order to run Email2sms you will need the following.
+
+* IMAP Mailbox
+* DeveloperGarden Account with credits. Have a look at "developergarden.com":http://www.developergarden.com
+
+h2. Required gems
+
+* developergarden_sdk
+* tmail
+
+h1. Configuration
+
+The first time you start email2smd it will create the following directory:
+
+bc. ENV["HOME"]/.email2sms
+
+Which basically means that it will create the hidden directory email2sms in your home directory (~/).
+
+In addition to this it will create a configuration file template:
+
+bc. ~/.email2sms/email2sms.yml
+
+Now it's you turn:
+
+Open the config file and adapt it to your needs.
+
+h1. Usage
+
+The basic usage of email2sms is straight forward. It's mainly about starting and stopping the daemon.
+Type
+
+bc. email2smsd -h
+
+to get more information. This help is generated by the daemon gem so this message is not application specific but it will give you to get a short introduction about how to control the daemon.
+
+h2. Start
+
+bc. email2smd start
+
+h2. Stop
+
+bc. email2smsd stop
+
+Watch output in
+
+bc. email2sms_main.rb.output
+
+and
+
+bc.  email2sms_main.rb.log
+
+for detailed application state information and errors.
+
+The files are located in the folder you have configured in your configuration file.
+By default this is the directory from where you have started the daemon.
+
+h2. Send e-mail
+
+**Ok, now you are ready:**
+
+In order to send an sms just send an email to the email adress configured in the email2sms.yml file.
+If you use the subject filter then you will need to have the password in your subject line:
+
+bc. Subject:
+mypass +49177 12344567
+Message body:
+Whatever
+
+**That's it. Have fun!**
+
+h1. Contact
+
+* You would like to have a customized version of email2sms for your project but don't want to do the dirty work? 
+* Do you like email2sms but want to have an hosted solution?
+* Want to argue about the Ruby and the meaning of life?
+
+Feel free to contact us:
+
+Avarteq GmbH
+Julian Fischer
+email2sms@avarteq.de
+"www.avarteq.de":http://www.avarteq.de
+
+Also checkout our hosting services:
+"www.railshoster.de":http://www.railshoster.de
+and
+"www.enterprise-rails.de":http://www.enterprise-rails.de
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "email2sms"
+    gem.summary = "Pure Ruby e-mail to sms gateway"
+    gem.description = "Free and pure Ruby E-Mail to sms gateway including an extensible filterchain to filter and manipulate incoming emails before sending them as text messages."
+    gem.email = "email2sms@avarteq.de"
+    gem.homepage = "http://github.com/avarteq/email2sms"
+    gem.authors = ["Julian Fischer"]
+    # gem.add_development_dependency "developergarden_sdk"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "email2sms #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/bin/email2smsd

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'daemons'
+require 'daemons'
+require File.dirname(__FILE__) + '/../lib/' + 'config.rb'
+
+daemon_options =  {
+  :backtrace  => true,
+  :log_output => true,
+  :dir_mode   => :normal,
+  :dir        => Config.logdir
+}
+
+Daemons.run(File.dirname(__FILE__) + '/../lib/' + 'email2sms_main.rb', daemon_options)

data/config/email2sms.yml

@@ -0,0 +1,21 @@
+general:
+    default_charset: "UTF-8"
+dev_garden:
+    user: "yourdevguser@t-online.de"
+    pass: "yourdevgpass"
+imap:
+    server_host: 'mail.yourmailserver.de'
+    user: 'yourimapuser@yourdomain.de'
+    pass: 'yourimappass'
+    poll_interval: 10
+sms:
+    sender_name: "Email2Sms"
+filter_chain:
+    subject_filter:
+        password: "Aihie4ca6a"
+log:
+    # dir_mode = normal => dir will be interpreted as dir
+    # dir_mode = current => dir will be ignored. Logs will go to the folder from where
+    #   the app has been started.
+    dir_mode: "normal"
+    dir: "default"

data/email2sms.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{email2sms}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julian Fischer"]
+  s.date = %q{2009-08-27}
+  s.default_executable = %q{email2smsd}
+  s.description = %q{Free and pure Ruby E-Mail to sms gateway including an extensible filterchain to filter and manipulate incoming emails before sending them as text messages.}
+  s.email = %q{email2sms@avarteq.de}
+  s.executables = ["email2smsd"]
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/email2smsd",
+     "config/email2sms.yml",
+     "email2sms.gemspec",
+     "lib/config.rb",
+     "lib/email2sms_main.rb",
+     "lib/email_to_sms.rb",
+     "lib/filter/basic_filter.rb",
+     "lib/filter/filter_chain.rb",
+     "lib/filter/subject_filter.rb",
+     "lib/mail/imap_tools.rb",
+     "lib/mail/tmail_tools.rb",
+     "pkg/email2sms-0.2.0.gem"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/avarteq/email2sms}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Pure Ruby e-mail to sms gateway}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/config.rb

@@ -0,0 +1,54 @@
+module Config
+  def self.load
+    config_filename = "email2sms.yml"
+    default_config  = YAML.load_file(File.dirname(__FILE__) + "/../config/" + config_filename)
+    default_config_file_path = File.dirname(__FILE__) + "/../config/email2sms.yml"
+
+    config_dir        = ENV["HOME"] + "/.email2sms"
+    config_file_path  = config_dir + "/" + config_filename
+
+    # Check or create config dir
+    exists_or_create_dir(config_dir)
+    
+    # Check or create config file
+    unless File.exists?(config_file_path) then
+      puts "\n\n-------------------------------------\n"
+      puts "Didn't find a configuration file in #{config_file_path}. First start?"
+      puts "I am going to create a configuration file template for you under #{config_file_path}."
+      puts "Please adapt it to your needs and start the daemon again."
+      puts "-------------------------------------\n\n"
+      config_file = File.new(config_file_path, "w+")
+      config_file.puts File.open(default_config_file_path).read
+    end
+
+    config = YAML.load_file(config_file_path)
+    config 
+  end
+  
+  def self.logdir
+    mylogdir = ""
+    
+    config = self.load
+    
+    # If there is no configuration file, it will be generated but it wouldn't make 
+    # sense to load it. The user has to customize it, first.
+    if config    
+      if config["log"]["dir_mode"] == "current" then
+        mylogdir = Dir.pwd
+      elsif config["log"]["dir_mode"] == "normal" then
+        mylogdir = config["log"]["dir"]      
+        exists_or_create_dir(mylogdir)
+      else
+        raise "Unknown log dir_mode #{config[:log][:dir_mode]}. Possible values are: 'current' and 'normal'."
+      end  
+    end
+    mylogdir || Dir.pwd
+  end
+  
+  protected
+  
+  # Checks whether the given dir exists. Creates it if not.
+  def self.exists_or_create_dir(dir)  
+    FileUtils.mkdir_p(dir) unless File.directory?(dir)
+  end
+end

data/lib/email2sms_main.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'developergarden_sdk'
+require 'sms_service/sms_service'
+require 'quota_service/quota_service'
+require 'tmail'
+
+require File.dirname(__FILE__) + '/../lib/' + 'config.rb'
+require File.dirname(__FILE__) + '/../lib/' + 'mail/tmail_tools'
+require File.dirname(__FILE__) + '/../lib/' + 'mail/imap_tools'
+require File.dirname(__FILE__) + '/../lib/' + 'email_to_sms'
+require File.dirname(__FILE__) + '/../lib/' + 'filter/filter_chain'
+require File.dirname(__FILE__) + '/../lib/' + 'filter/basic_filter'
+require File.dirname(__FILE__) + '/../lib/' + 'filter/subject_filter'
+
+# Catching the exit signal and 
+Signal.trap(0, proc do
+  puts "Stopping email2sms"
+  email2sms.close
+end
+)
+
+Net::IMAP.debug = true if $DEBUG
+
+CONFIG = Config.load
+
+puts "Creating email2sms main class"
+email2sms = EmailToSms.new( EmailToSms.ENVIRONMENT_PRODUCTION )
+
+puts "Entering dispatch loop"
+loop do
+  email2sms.dispatch
+  sleep CONFIG["imap"]["poll_interval"]
+end
+
+

data/lib/email_to_sms.rb

@@ -0,0 +1,144 @@
+require 'net/imap'
+
+class EmailToSms
+
+  include Mail::ImapTools
+  include Mail::TmailTools
+
+  @@SENT_SMS_MAILBOX        = "sent_sms"
+  @@ERROR_SMS_MAILBOX       = "error"  
+  @@FILTERED_MAILBOX        = "filtered"
+  @@ENVIRONMENT_MOCK        = 2
+  @@ENVIRONMENT_PRODUCTION  = 1
+  @@CONFIG = Config.load
+
+  def initialize(environment = @@ENVIRONMENT_MOCK)
+    @charset        = @@CONFIG["general"]["default_charset"]
+    @environment    = environment
+    @filter_chain   = FilterChain.build_simple_filter_chain(@@CONFIG, @charset)
+    dev_garden_user = @@CONFIG["dev_garden"]["user"]
+    dev_garden_pass = @@CONFIG["dev_garden"]["pass"]
+    @sms_service    = SmsService::SmsService.new(dev_garden_user, dev_garden_pass)
+    @imap           = Net::IMAP.new(@@CONFIG["imap"]["server_host"])
+    imap_user       = @@CONFIG["imap"]["user"]
+    imap_pass       = @@CONFIG["imap"]["pass"]
+    
+    @imap.authenticate('LOGIN', imap_user, imap_pass)
+    status_or_create_mailboxes
+  end
+
+  # See which emails to send
+  def dispatch
+    @imap.select('INBOX')
+    puts "Checking mailbox..."
+    @imap.uid_search(["UNSEEN"]).each do |uid_unseen|
+      tmail_unseen = tmail_from_imap(uid_unseen)
+
+      # Only mails passing all filters will be delivered.
+      # Be aware that filters might modify the mail.
+      passed = @filter_chain.passed_filter?(tmail_unseen)
+
+      if not passed then
+        puts "E-mail has been filtered."
+        move_email(uid_unseen, @@FILTERED_MAILBOX)
+      else        
+        puts "Sending E-mail as text message..."
+        send_email_as_sms(uid_unseen, tmail_unseen)
+      end
+    end
+  end
+
+  # Close imap connection
+  def close
+    @imap.close
+    @imap.disconnect
+  end
+ 
+  protected
+
+  def tmail_from_imap(uid)
+    # Get the email in rfc822 format
+    mail_rfc822 = @imap.uid_fetch(uid, 'RFC822')[0].attr['RFC822']
+
+    # A TMail object hides all the quoting and parsing stuff
+    tmail = TMail::Mail.parse( mail_rfc822 )    
+    tmail
+  end
+
+  # Created needed imap folders
+  def status_or_create_mailboxes
+    [@@SENT_SMS_MAILBOX, @@FILTERED_MAILBOX, @@ERROR_SMS_MAILBOX].each do |mailbox|
+      status_or_create_mailbox(mailbox)
+    end
+  end
+
+  def send_email_as_sms(uid, tmail)                
+    final_sms_message   = sms_message_from(tmail)
+    receiver            = get_receiver_from_subject(tmail)
+    sms_sender_name     = @@CONFIG["sms"]["sender_name"]
+
+    if @environment == @@ENVIRONMENT_PRODUCTION then            
+      send_email_as_sms_production(uid, receiver, final_sms_message, sms_sender_name)
+    else
+      send_email_as_sms_mock(uid, tmail, receiver, final_sms_message)
+    end
+  end
+  
+  def send_email_as_sms_production(uid, receiver, final_sms_message, sms_sender_name)
+    rescue_send_sms_exceptions(uid) do |uid|
+      @sms_service.send_sms(receiver, final_sms_message, sms_sender_name, ServiceEnvironment.PRODUCTION)
+      puts "Text message has ben sent."
+      
+      # Copy mail to sent_sms folder
+      move_email(uid, @@SENT_SMS_MAILBOX)            
+    end
+  end
+  
+  def send_email_as_sms_mock(uid, tmail, receiver, final_sms_message)
+    
+    # MOCK environment so we don't send any sms just print it out
+    puts_tmail(tmail)
+    puts_sms(receiver, final_sms_message)                    
+    
+    # Copy mail to sent_sms folder
+    move_email(uid, @@SENT_SMS_MAILBOX)
+  end
+  
+  def rescue_send_sms_exceptions(uid, &block)
+    begin
+      yield(uid)
+    rescue ServiceException => e
+      r = e.response
+      puts "\tError while sending sms.\n\t\tError message: #{r.error_message}\n\t\tError code: #{r.error_code}"
+      
+      # Copy mail to sent_sms folder
+      move_email(uid, @@ERROR_SMS_MAILBOX)
+    end
+  end
+  
+  def sms_message_from(tmail)
+    final_sms_message = tmail_to_plaintext(tmail)
+
+    # Shorten message
+    final_sms_message = final_sms_message.strip![0, 150]
+    final_sms_message
+  end
+  
+  # Print the given sms message to stdout
+  def puts_sms(receiver, final_sms_message)            
+    puts "\n\n-----------------------"
+    puts "Text message to #{receiver}:"
+    puts final_sms_message
+    puts "-----------------------\n\n"    
+  end
+
+  #### Public static methods
+
+  def self.ENVIRONMENT_MOCK
+    return @@ENVIRONMENT_MOCK
+  end
+
+  def self.ENVIRONMENT_PRODUCTION
+    return @@ENVIRONMENT_PRODUCTION
+  end
+end

data/lib/filter/basic_filter.rb

@@ -0,0 +1,10 @@
+class BasicFilter
+
+  def initialize(charset = "UTF-8")
+    @charset = charset
+  end
+
+  def passed_filter?(tmail)
+    raise "unimplemented"
+  end
+end

data/lib/filter/filter_chain.rb

@@ -0,0 +1,42 @@
+# The filter chain is responsible for deciding which mail to forward and which to drop.
+# The filter chain can consist of one ore more filters each analysing and/or modifing the incoming
+# mail.
+class FilterChain
+  
+  def initialize(config)
+    @filters = []
+    @config = config
+  end
+
+  def <<(filter)
+    @filters << filter   
+  end
+
+  def add(filter)
+    @filters << filter
+  end
+
+  def delete(filter)
+    @filters.delete(filter)
+  end
+
+  # Execute each filter, stop of a filter rejects the mail
+  def passed_filter?(tmail)
+    ret = true
+    for filter in @filters do
+      if not filter.passed_filter?(tmail) then
+        ret = false
+        break
+      end
+    end
+    return ret
+  end
+
+  # Factory method to create a simple filter chaing using a SubjectFilter.
+  def self.build_simple_filter_chain(config, charset = "UTF-8")
+    filter_chain            = self.new(config)    
+    subject_filter_password = config["filter_chain"]["subject_filter"]["password"]
+    filter_chain << SubjectFilter.new(subject_filter_password, charset)
+    return filter_chain
+  end
+end

data/lib/filter/subject_filter.rb

@@ -0,0 +1,24 @@
+# Checks the subject of the incomming message for a specific password and rejects the mail if the
+# passwort is not present.
+class SubjectFilter < BasicFilter
+
+  def initialize(password, charset = "UTF-8")
+    super(charset)
+    @password = password
+  end
+
+  # Returns true if password is present.
+  # Password will be removed from the subject.
+  def passed_filter?(tmail)
+    password_is_present = !tmail.subject.match(@password).nil?
+
+    password_matcher = Regexp.new("#{@password}\s+")
+    
+    if password_is_present then
+      # Remove password from the subject
+      tmail.subject = tmail.subject(@charset).gsub(password_matcher, "")
+    end
+    
+    return password_is_present
+  end
+end

data/lib/mail/imap_tools.rb

@@ -0,0 +1,52 @@
+# IMAP related methods
+module Mail
+  module ImapTools
+  
+    # Deletes the email with the given uid
+    def delete_email(uid)
+      @imap.uid_store(uid, "+FLAGS", [:Deleted])
+      @imap.expunge
+    end
+
+    # Move a mail from the current to the given mailbox.
+    def move_email(uid, mailbox)
+
+      # Copy mail to sent_sms folder
+      @imap.uid_copy(uid, mailbox)
+      delete_email(uid)
+    end
+
+    # Checks whether the given mailbox exists and creates it if not.
+    # If it exists it will be selected.
+    #TODO check imap protocoll if there isn't a better way to do this.
+    # === Parameters
+    # <tt>mailbox</tt>:: Name of the mailbox (imap folder)
+    # <tt>raise_on_select</tt>:: Raise an exception if a select is not possible. This also skips creation of the mailbox. Used for internal purposes.
+    def status_or_create_mailbox(mailbox, raise_on_select = false)
+      ret = nil
+      
+      begin
+        ret = @imap.status(mailbox, ["MESSAGES", "RECENT", "UNSEEN"])
+        # Mailbox already exists
+      rescue Net::IMAP::NoResponseError => e
+
+        # The mailbox does not exist (or is non-selectable for some reason)
+        unless raise_on_select
+          
+          # So we create it
+          @imap.create(mailbox)
+          puts "Created mailbox #{mailbox}."
+
+          # And select it
+          status_or_create_mailbox(mailbox, true)
+        else
+          
+          # For some reasons the creation/selection of the mailbox failed.
+          # In order to avoid an infinte loop we give up after trying to create and select the mailbox once.
+          raise e
+        end
+      end
+      return ret
+    end
+  end
+end

data/lib/mail/tmail_tools.rb

@@ -0,0 +1,40 @@
+module Mail
+  module TmailTools
+    
+    # Prints the given tmail object to stdout
+    def puts_tmail(tmail)
+      puts "\n\n-----------------------"
+      puts "E-Mail message:"
+      puts tmail.subject
+      puts tmail_to_plaintext(tmail)
+      puts "-----------------------\n\n"
+    end
+    
+    # Extracts the receiver's number from the email subject
+    def get_receiver_from_subject(tmail)
+      return tmail.subject(@charset).strip
+    end
+    
+    # If it is a multipart email with a plain text part
+    # it searches for the text/plain part of the mail and returns it.
+    def tmail_to_plaintext(tmail)
+      ret = nil    
+      if tmail.multipart? then
+        plain_text_body_from_multipart(tmail)
+      else
+        ret = tmail.body(@charset)
+      end
+      ret
+    end
+
+    # Extraxt the plain text body from a multipart email
+    def plain_text_body_from_multipart(tmail)
+      ret = nil    
+      tmail.parts.each do |part|
+        ret = part.body(@charset) if part.content_type == 'text/plain'
+        break
+      end
+      ret
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: avarteq-email2sms
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+platform: ruby
+authors: 
+- Julian Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-27 00:00:00 -07:00
+default_executable: email2smsd
+dependencies: []
+
+description: Free and pure Ruby E-Mail to sms gateway including an extensible filterchain to filter and manipulate incoming emails before sending them as text messages.
+email: email2sms@avarteq.de
+executables: 
+- email2smsd
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION
+- bin/email2smsd
+- config/email2sms.yml
+- email2sms.gemspec
+- lib/config.rb
+- lib/email2sms_main.rb
+- lib/email_to_sms.rb
+- lib/filter/basic_filter.rb
+- lib/filter/filter_chain.rb
+- lib/filter/subject_filter.rb
+- lib/mail/imap_tools.rb
+- lib/mail/tmail_tools.rb
+- pkg/email2sms-0.2.0.gem
+has_rdoc: true
+homepage: http://github.com/avarteq/email2sms
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Pure Ruby e-mail to sms gateway
+test_files: []
+