kandalf-cdmon_updater 0.1.1 → 0.1.5

data/README

@@ -22,17 +22,30 @@ general:
   email:        root@server
   log_level:    DEBUG
   service_url:  https://dinamico.cdmon.org/onlineService.php
+  send_mail_on_error: no
 
 users:
   cdmon_user:
-    hosts: domain1.com domainX.com
+    hosts: kandalf.com.ar blog.kandalf.com.ar
     md5pass: 1278323gfb37875f2749ju6cabd8io89
 
+mailer:
+  address: relay.someserver.com.ar
+  port: 25
+  domain: kandalf.com.ar
+  user_name: someuser #without @domain
+  password: plain_password
+
 You should customize the users section with your personal data. The cdmon_user should be replaced with the user you have associated in your CDMon control panel with your domains.
 As you can have multiple users in CDMon, you can add as many user sections as you need here.
 The md5pass should be the user's password crypted as an MD5 hash, CDMon provides a website to do this ( https://www.cdmon.com/webapps/encriptar.php ) but you can use the method you like as long as it results on the MD5 hash for your passowrd.
 
-From the general section you should customizde the log_level and the email (which is not yet supported but it will be soon).
+For mail notification you must activate the the send_mail_on_error feature on the general section and properly config your mail server.
+Also, you have to define a valid email address for the email feature on the general section.
+
+  When these things are set up, an email will be sent to the email address defined on the general section with the message of the error and the time it was raised and the subject of "CDMon Updater ERROR".
+
+From the general section you should customize the log_level and the email (which is not yet supported but it will be soon).
 
 After you have your settings, you can run the client manually or you can add the following line to your crontab
 

data/cdmon_updater.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cdmon_updater}
-  s.version = "0.1.1"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leonardo Mateo"]
@@ -27,7 +27,10 @@ Gem::Specification.new do |s|
      "config/schedule.rb",
      "lib/cdmon.rb",
      "lib/config.rb",
-     "lib/ip_updater.rb"
+     "lib/ip_updater.rb",
+     "lib/mailer.rb",
+     "spec/mailer_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kandalf/cdmon_updater}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -35,6 +38,11 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{cdmon_updater}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A client updater for CDMon dynamic DNS.}
+  s.test_files = [
+    "spec/ip_updater_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/mailer_spec.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/config/cdmon.yml

@@ -3,9 +3,17 @@ general:
   email:        root@server
   log_level:    DEBUG
   service_url:  https://dinamico.cdmon.org/onlineService.php
+  send_mail_on_error: no
 
 users:
   cdmon_user:
     hosts: kandalf.com.ar blog.kandalf.com.ar
     md5pass: 1278323gfb37875f2749ju6cabd8io89
 
+mailer:
+  address: relay.someserver.com.ar
+  port: 25
+  domain: kandalf.com.ar
+  user_name: someuser #without @domain
+  password: plain_password
+

data/lib/cdmon.rb

@@ -1,4 +1,6 @@
 require 'logger'
+require 'config'
+require 'mailer'
 
 module CDMon
   VERSION = "0.1.0"
@@ -8,12 +10,12 @@ module CDMon
         @@logger = Logger.new("/var/log/cdmon.log", 10, 1024000)
       rescue Errno::EACCES
         @@logger = Logger.new("#{ENV["HOME"]}/.cdmon.log")
-      end
+       end
       @@logger
-  end
+  end 
   
   def self.log_level=(level)
-    case level
+    case  level
       when "WARN"
         logger.level = Logger::WARN
       when "INFO"
@@ -32,5 +34,16 @@ module CDMon
     logger.debug(message)
     logger.warn(message)
     logger.error(message)
+    self.send_error_mail(message) if Config.mail_on_error?
+  end
+
+  protected
+  def self.send_error_mail(message)
+    mailer = Mailer.new({"server" => Config.mailer})
+    mailer.from = "cdmon_updater@#{Mailer.domain}"
+    mailer.to = Config.mail_to
+    mailer.subject = "CDMon Updater ERROR"
+    mailer.message = message
+    self.log_all("Cannot send mail") unless mailer.send_mail
   end
 end

data/lib/config.rb

@@ -11,6 +11,8 @@ module Config
   CDMON_BAD_IP = "badip"
   CDMON_ERROR_LOGIN = "errorlogin"
 
+  @@config = {}
+
   def self.load(config_file)
     @@config = YAML::load_file(config_file)
   end
@@ -23,6 +25,14 @@ module Config
     @@config["users"]
   end
 
+  def self.mailer
+    @@config["mailer"]
+  end
+
+  def self.mail_to
+   @@config["general"]["email"] if @@config 
+  end
+
   def self.md5_password_for(user)
     @@config["users"][user.to_s]["md5pass"] if @@config
   end
@@ -35,6 +45,10 @@ module Config
     @@config["general"]["dns"] if @@config
   end
 
+  def self.mail_on_error?
+    @@config["general"]["send_mail_on_error"]
+  end
+
   def self.hosts
     HOSTS
   end

data/lib/mailer.rb

@@ -0,0 +1,93 @@
+require 'net/smtp'
+require 'cdmon'
+
+module CDMon
+  class Mailer < Net::SMTP
+    attr_accessor :subject, :message, :from, :to
+
+    if Config.mailer
+      @@address = Config.mailer["address"]
+      @@port = Config.mailer["port"]
+      @@domain = Config.mailer["domain"]
+      @@credentials[:user_name] = Config.mailer["user_name"]
+      @@credentials[:password] = Config.mailer["password"]
+    else
+      @@address = nil
+      @@port = nil
+      @@credentials = {:user_name => nil, :password => nil}
+    end
+
+    def initialize(options = {})
+      if options.has_key?("server") && options["server"].is_a?(Hash) && options["server"].keys.any?
+        server_options = options.delete("server")
+
+        @@address = server_options["address"]
+        @@port = server_options["port"]
+        @@domain = server_options["domain"]
+        @@credentials[:user_name] = server_options["user_name"]
+        @@credentials[:password] = server_options["password"]
+      end
+    end
+
+    #class methods
+    def self.address
+      @@address
+    end
+    def self.address=(address)
+      @@address = address
+    end
+    
+    def self.port
+      @@port
+    end
+    def self.port=(port)
+      @@port = port
+    end
+  
+    def self.domain
+      @@domain
+    end
+    def self.domain=(domain)
+      @@domain = domain
+    end
+    def self.credentials
+      @@credentials
+    end
+    def self.credentials=(data = {:user_name => nil, :password => nil})
+      @@credentials = data
+    end
+
+    #instance methods
+    def send_mail
+      body = mail_headers
+      body << "#{Time.now.to_s} - #{@message}"
+
+      begin
+        @to.split(",").each do | to |
+
+            Net::SMTP.start(@@address, @@port, @from, @@credentials[:user_name], @@credentials[:password], :login)  do |smtp|
+              
+              smtp.send_message(body, @from, to.strip)
+
+            end
+         end
+         true
+       rescue
+        CDMon.log_all("Cannot send email")
+        false
+       end
+    end
+
+    private
+    def mail_headers
+      body =  "From: #{@from} <#{@from}>\n" 
+      body << "To: #{@to}<#{@to}>\n"
+      body << "Subject: #{@subject}\n"
+      body << "Date: #{Time.now}\n"
+      body << "Importance:high\n"
+      body << "MIME-Version:1.0\n"
+      body << "\n\n\n"
+      body
+    end
+  end
+end

data/spec/ip_updater_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'ip_updater'
+
+describe CDMon::IPUpdater do
+
+  before(:all) do
+    @updater = CDMon::IPUpdater.new("/etc/cdmon.yml")
+
+  end
+
+  it "should update the IP" do
+    "you should have your settings on /etc/cdmon.yml".should_not be_nil
+    #@updater.update   
+  end
+end

data/spec/mailer_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'mailer'
+
+describe CDMon::Mailer do
+
+  before(:all) do
+    server_options = {"server" => {"address" => "some.smtp.server", "port" => 25, "user_name" => "user", "password" => "smtp_password"}}
+    
+    @mailer = CDMon::Mailer.new(server_options)
+  end
+
+  it "should have class options set" do
+    CDMon::Mailer.address.should == "some.smtp.server"
+    CDMon::Mailer.port.should == 25
+    CDMon::Mailer.credentials[:user_name].should == "user"
+    CDMon::Mailer.credentials[:password].should == "smtp_password"
+  end
+
+  it "should have instance attributes" do
+    @mailer.subject = "Test Mail"
+    @mailer.message = "This is the body of the message"
+    @mailer.from = "someuser@someserver.com"
+    @mailer.to = "someotheruser@someserver.com"
+    @mailer.stub!(:send_mail).and_return(true)
+    @mailer.send_mail.should be_true
+  end
+
+  it "should send mail" do
+    "This is a stub left in blank since I can't publish my smtp access data".should_not be_nil
+    "You should fill your own data on ../config/cdmon.yml".should_not be_nil
+    #Config.load("../config/cdmon.yml")
+
+    #@mailer = CDMon::Mailer.new({"server" => Config.mailer})
+    #@mailer.subject = "Test Mail"
+    #@mailer.message = "This is the body of the message"
+    #@mailer.from = "cdmon_updater@kandalf.com.ar"
+    #@mailer.to = "some_real_address@some_server.com"
+    #@mailer.send_mail.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$: << "../lib" << "lib"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kandalf-cdmon_updater
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors: 
 - Leonardo Mateo
@@ -32,6 +32,9 @@ files:
 - lib/cdmon.rb
 - lib/config.rb
 - lib/ip_updater.rb
+- lib/mailer.rb
+- spec/mailer_spec.rb
+- spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/kandalf/cdmon_updater
 licenses: 
@@ -59,5 +62,7 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A client updater for CDMon dynamic DNS.
-test_files: []
-
+test_files: 
+- spec/ip_updater_spec.rb
+- spec/spec_helper.rb
+- spec/mailer_spec.rb