mtik_directory_2_address_list 1.0.2 → 1.0.3

data/bin/mtik_directory_2_address_list

@@ -3,42 +3,59 @@ require 'optparse'
 require 'syslog'
 require 'mtik_directory_2_address_list'
 
-class Args < OptionParser
-  attr_reader :prefix, :quiet
-  attr_reader :dir, :mtik
+class Args
+  Error = Class.new(StandardError)
+
+  attr_reader :verbose, :prefix, :retry_timeout
 
   def initialize
-    super 'Usage: <dir> <host> <user> <pass>'
-    on('-p', '--prefix PREFIX', "Mikrotik address-list prefix (default: #{@prefix = 'md2al_'})") { |str| @prefix = str }
-    on('-q', '--quiet', "Be quiet (default: #{@quiet = false})") { |bool| @quiet = bool }
-    parse!
-    if ARGV.empty?
-      STDOUT << to_s << <<-EOS.gsub(/^ +/, '')
-
-        Symbolic links in <dir>, named like an IP address, will be
-        sent to the Mikrotik device at <host>. The address-list name
-        will be formed by the PREFIX + whatever the link points to.
-
-        For example, the following symbolic link:
-        \t1.2.3.4 -> 15mbps
-        With --prefix set to "down_speed_", will add the IP 1.2.3.4,
-        to the address-list named down_speed_15mbps.
-
-      EOS
-      exit(2)
-    elsif ARGV.size != 4
-      puts to_s
-      puts "Missing required argument"
-      exit(2)
-    else
-      @dir = ARGV.shift
-      @mtik = Hash[[:host, :user, :pass].zip(ARGV.shift(3))]
-    end
-  rescue OptionParser::ParseError => err
-    puts to_s
-    puts "Error: #{err}"
+    @verbose = STDOUT.tty?
+    @prefix = 'md2al_'
+    @retry_timeout = 15 # seconds
+  end
+
+  def self.parse
+    self.new.tap { |args| args.parse }
+  end
+
+  def parse
+    opts = OptionParser.new
+    opts.banner = 'Usage: <host> <username> <password> <dir> [options]'
+
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-p', '--prefix PREFIX', 'Mikrotik address-list prefix',
+            "(default: #{@prefix})") { |s| @prefix = s }
+    opts.on('-v', '--[no-]verbose', 'Print debug messages to stdout',
+            '(default: true if stdout is a TTY)') { |v| @verbose = v }
+    opts.on('--retry-timeout SECONDS', Integer, 'Wait before restarting after an error',
+            "(default: #{@retry_timeout})") { |i| @retry_timeout = i }
+
+    opts.separator ''
+    opts.separator 'Symbolic links in <dir>, named like an IP address, will be sent to the'
+    opts.separator 'Mikrotik device at <host>. The address-list name will be formed by the'
+    opts.separator 'PREFIX + whatever the link points to.'
+    opts.separator ''
+    opts.separator 'For example, the following symbolic link: 1.2.3.4 -> 15mbps'
+    opts.separator 'With --prefix set to "down_speed_", will add the IP 1.2.3.4,'
+    opts.separator 'to the address-list named down_speed_15mbps.'
+    opts.separator ''
+
+    opts.parse!
+    ARGV.size == 4 || raise(Error, "need 4 arguments, but #{ARGV.size} provided")
+
+  rescue Error, OptionParser::ParseError => err
+    STDERR << opts << 'Error: ' << err << "\n"
     exit(2)
   end
+
+  def directory
+    ARGV[3]
+  end
+
+  def mikrotik
+    Hash[[:host, :user, :pass].zip(ARGV[0, 3])]
+  end
 end
 
 class Main
@@ -48,17 +65,19 @@ class Main
   end
 
   def args
-    @args ||= Args.new.tap do |args|
+    @args ||= Args.parse.tap do |args|
       Syslog.open($PROGRAM_NAME, Syslog::LOG_PID, Syslog::LOG_DAEMON)
-      args.quiet || MtikDirectory2AddressList::Log.output(&method(:info))
+      args.verbose && MtikDirectory2AddressList::Log.output(&method(:info))
     end
   end
 
   def sync
-    MtikDirectory2AddressList.sync(args.dir, args.mtik, args.prefix)
+    MtikDirectory2AddressList.sync(args.directory, args.mikrotik, args.prefix)
   rescue => err
-    err("Error: #{err} [#{err.backtrace.first}]")
-    sleep(30) ; retry
+    err("Error: #{err}")
+    err.backtrace.each { |line| err(" #{line}") }
+    sleep(args.retry_timeout)
+    retry
   end
 
   # Send +message+ to syslog and STDERR.
@@ -73,7 +92,7 @@ class Main
   # @param [String] message
   # @return [void]
   def info(message)
-    STDOUT << message << "\n" if STDOUT.tty?
+    STDOUT << message << "\n"
   end
 end
 

data/lib/mtik_directory_2_address_list.rb

@@ -12,7 +12,7 @@ module MtikDirectory2AddressList
   # @param [String] src The directory where to look for symbolic links
   # @param [Hash] dst The object passed to the +mtik+ gem (keys: +host+, +user+, +pass+)
   # @param [String] prefix The prefix an address list name must have for it to be used
-  # @return [nil]
+  # @return [void]
   def sync(src, dst, prefix = "dir_")
     Log.info { "Synchronizing [#{src}] with router at [#{dst[:host]}]" }
     mtik = Mikrotik.new(dst.dup.merge(prefix:prefix))

data/lib/mtik_directory_2_address_list/directory.rb

@@ -2,9 +2,15 @@
 
 module MtikDirectory2AddressList
   class Directory
+    Error = Class.new(StandardError)
+
+    # The {#list} method will not enumerate symbolic links that do not match this regular expression.
+    # Other methods may raise Error.
+    IP_RE = %r{ \A \d{1,3} \. \d{1,3} \. \d{1,3} \. \d{1,3} \z }x
+
     # Manage a directory of symbolic links.
     #
-    # The IP address is the name of a symlink link in +@path+.
+    # The IP address is the name of the symbolic link.
     # The address list name is what the symbolic link points to.
     #
     # @param [Hash] params
@@ -13,23 +19,21 @@ module MtikDirectory2AddressList
       @path = params[:path]
     end
 
-    # Return the address list associated with the specified IP.
+    # Return the address list associated with +ip+.
     #
-    # @param [String] ip The IP to search for
+    # @param [String] ip
     #
-    # @return [String] The value associated with +ip+
-    # @return [nil] When the +ip+ is not found
+    # @return [String] The address list associated with +ip+
+    # @return [nil] When the +ip+ is not found or is not a symbolic link
     def [](ip)
-      File.readlink(File.join(@path, ip))
-    rescue Errno::EINVAL
-      nil # Not a symlink
+      (ip =~ IP_RE) || raise(Error, "Invalid IP [#{ip}]")
+      file = File.join(@path, ip)
+      File.readlink(file)
+    rescue Errno::ENOENT, Errno::EINVAL
+      nil # symlink deleted, not a symlink
     end
 
-    # The {#list} method will not enumerate symbolic links that do not match this regular expression.
-    # The {#[]} method will read any symbolic link, even if its name does not match this regular expression.
-    IP_RE = %r{ \A \d{1,3} \. \d{1,3} \. \d{1,3} \. \d{1,3} \z }x
-
-    # Enumerates every IP in +@path+.
+    # Enumerate IPs associated with an address list.
     #
     # @return [Enumerator] Arrays with: IP, address list
     def list
@@ -40,11 +44,14 @@ module MtikDirectory2AddressList
       end
     end
 
-    # Yield whenever +@path+ is modified.
+    # Yield whenever an association is modified.
     #
-    # @yield Right after being called
-    # @yield After every update to +@path+
+    # This is based on the mtime of the directory being watched.
+    # If the mtime is not updated when a symbolic link is changed,
+    # the directory must be touched manually.
     #
+    # @yield Right after being called
+    # @yield After every association update
     # @return [void]
     def watch
       before = nil
@@ -54,12 +61,11 @@ module MtikDirectory2AddressList
       end
     end
 
-    # Watch +path+, and yield +list+ as a hash.
+    # Like the instance method {#watch}, but yield a Hash with the associations.
     #
     # @param [String] path The directory to watch for modifications
     #
     # @yieldparam Hash{String=>String} Map IP addresses to address list names
-    #
     # @return [void]
     def self.watch(path)
       dir = self.new(path:path)

data/lib/mtik_directory_2_address_list/mikrotik.rb

@@ -3,9 +3,9 @@ require 'mtik'
 
 module MtikDirectory2AddressList
   class Mikrotik
-    class Error < StandardError ; end
-    class RouterError < StandardError ; end
-    class SyncError < StandardError ; end
+    Error = Class.new(StandardError)
+    RouterError = Class.new(Error)
+    SyncError = Class.new(Error)
 
     def initialize(params)
       @prefix = (params[:prefix] || 'md2al_')

data/lib/mtik_directory_2_address_list/version.rb

@@ -1,3 +1,3 @@
 module MtikDirectory2AddressList
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/mtik_directory_2_address_list.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = MtikDirectory2AddressList::VERSION
   spec.authors       = ['Andre Luiz dos Santos']
   spec.email         = ['andre.netvision.com.br@gmail.com']
-  spec.summary       = %q{Synchronize a directory with a Mikrotik address list}
+  spec.summary       = %q{Synchronize a directory with a Mikrotik address list.}
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtik_directory_2_address_list
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,7 +151,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Synchronize a directory with a Mikrotik address list
+summary: Synchronize a directory with a Mikrotik address list.
 test_files:
 - test/test_directory.rb
 - test/test_mikrotik.rb