mtik_directory_2_address_list 1.0.0

data/.simplecov

@@ -0,0 +1,3 @@
+if ENV['COVERAGE']
+    SimpleCov.start
+end

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests with simplecov enabled'
+task :coverage do
+  ENV['COVERAGE'] = 'yes'
+  Rake::Task['test'].execute
+end
+
+desc 'Run tests'
+task :default => [:test]

data/bin/mtik_directory_2_address_list

@@ -0,0 +1,68 @@
+# coding: utf-8
+require 'optparse'
+require 'syslog'
+require 'mtik_directory_2_address_list'
+
+class Args < OptionParser
+  attr_reader :prefix, :quiet
+  attr_reader :dir, :mtik
+
+  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.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}"
+    exit(2)
+  end
+end
+
+class Main
+  def initialize
+    args
+    sync
+  end
+
+  def args
+    @args ||= Args.new.tap do |args|
+      Syslog.open($PROGRAM_NAME, Syslog::LOG_PID, Syslog::LOG_DAEMON)
+      args.quiet || MtikDirectory2AddressList::Log.output(&method(:info))
+    end
+  end
+
+  def sync
+    MtikDirectory2AddressList.sync(args.dir, args.mtik, args.prefix)
+  rescue => err
+    err("Error: #{err} [#{err.backtrace.first}]")
+    sleep(30) ; retry
+  end
+
+  # Send +message+ to syslog and STDERR.
+  # @param [String] message
+  # @return [void]
+  def err(message)
+    Syslog.err('%s', message)
+    STDERR << message << "\n" if STDERR.tty?
+  end
+
+  # Send +message+ to STDOUT.
+  # @param [String] message
+  # @return [void]
+  def info(message)
+    STDOUT << message << "\n" if STDOUT.tty?
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Main.new
+end

data/lib/mtik_directory_2_address_list/directory.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+module MtikDirectory2AddressList
+  class Directory
+    # Manage a directory of symbolic links.
+    #
+    # The IP address is the name of a symlink link in +@path+.
+    # The address list name is what the symbolic link points to.
+    #
+    # @param [Hash] params
+    # @option params [String] :path The path to the directory containing symbolic links
+    def initialize(params)
+      @path = params[:path]
+    end
+
+    # Return the address list associated with the specified IP.
+    #
+    # @param [String] ip The IP to search for
+    #
+    # @return [String] The value associated with +ip+
+    # @return [nil] When the +ip+ is not found
+    def [](ip)
+      File.readlink(File.join(@path, ip))
+    rescue Errno::EINVAL
+      nil # 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+.
+    #
+    # @return [Enumerator] Arrays with: IP, address list
+    def list
+      Enumerator.new do |y|
+        Dir.foreach(@path) do |de| file = File.basename(de)
+          (file =~ IP_RE) && (value = self[file]) && (y << [file, value])
+        end
+      end
+    end
+
+    # Yield whenever +@path+ is modified.
+    #
+    # @yield Right after being called
+    # @yield After every update to +@path+
+    #
+    # @return [void]
+    def watch
+      before = nil
+      loop do sleep(1)
+        next if before == (after = mtime)
+        yield ; before = after
+      end
+    end
+
+    # Watch +path+, and yield +list+ as a hash.
+    #
+    # @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)
+      dir.watch do
+        yield(Hash[dir.list.to_a])
+      end
+    end
+
+    private
+
+    def mtime
+      File.mtime(@path)
+    end
+  end
+end

data/lib/mtik_directory_2_address_list/log.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+module MtikDirectory2AddressList
+  module Log
+    module_function
+
+    # Call #output to replace this method.
+    def info
+    end
+
+    # Set the logging method.
+    def output(&block)
+      define_singleton_method(:info) do |&message|
+        block.call(message.call)
+      end
+    end
+  end
+end

data/lib/mtik_directory_2_address_list/mikrotik.rb

@@ -0,0 +1,149 @@
+# coding: utf-8
+require 'mtik'
+
+module MtikDirectory2AddressList
+  class Mikrotik
+    class Error < StandardError ; end
+    class RouterError < StandardError ; end
+    class SyncError < StandardError ; end
+
+    def initialize(params)
+      @prefix = (params[:prefix] || 'md2al_')
+      @mtik_params = params.select { |k,_| %w(host user pass).include? k.to_s }
+      fetch
+    end
+
+    # Enumerates every IP in address lists prefixed with +@prefix+.
+    #
+    # @return [Enumerator] Arrays with: IP, address list
+    def list
+      Enumerator.new do |y|
+        @cache.each_value do |re|
+          y << [re['address'], re['list']]
+        end
+      end
+    end
+
+    # Add IP to address list.
+    #
+    # @param [String] ip The IP address to add
+    # @param [String] address_list The address list to add the IP into
+    #
+    # @raise [SyncError] When the IP already exists in the local cache
+    # @raise [RouterError] When the IP already exists in the Mikrotik router
+    #
+    # @return [self]
+    def add(ip, address_list)
+      if @cache.key?(ip)
+        raise(SyncError, "IP #{ip} already in cache")
+      end
+      id = address_list_add(ip, @prefix + address_list)
+      @cache[ip] = {".id"=>id, "address"=>ip, "list"=>address_list}
+      return self
+    end
+
+    # Move IP to a different address list.
+    #
+    # @param [String] ip The IP address to move
+    # @param [String] address_list The address list to move the IP into
+    #
+    # @raise [SyncError] When the IP is not found in the local cache
+    # @raise [RouterError] When the IP is not found in the Mikrotik router
+    #
+    # @return [self]
+    def update(ip, address_list)
+      unless (re = @cache[ip])
+        raise(SyncError, "IP #{ip} not in cache")
+      end
+      address_list_set(re['.id'], @prefix + address_list)
+      re['list'] = address_list
+      return self
+    end
+
+    # Remove IP from its current address list.
+    #
+    # @param [String] ip The IP address to remove
+    #
+    # @raise [SyncError] When the IP is not found in the local cache
+    # @raise [RouterError] When the IP is not found in the Mikrotik router
+    #
+    # @return [self]
+    def delete(ip)
+      unless (re = @cache.delete(ip))
+        raise(SyncError, "IP #{ip} not in cache")
+      end
+      address_list_remove(re['.id'])
+      return self
+    end
+
+    # Delete all IPs from address lists prefixed with +@prefix+.
+    #
+    # @return [self]
+    def clear
+      @cache.each_value do |re|
+        address_list_remove(re['.id'])
+      end
+      @cache.clear
+      return self
+    end
+
+    private
+
+    # @return [MTik::Connection]
+    def connection
+      @connection ||= MTik::Connection.new(@mtik_params).tap do
+        Log.info { "Connecting to Mikrotik at #{@mtik_params.inspect}" }
+      end
+    end
+
+    # @return [String, nil]
+    def request(*args)
+      Log.info { "Mikrotik request: #{args.inspect}" }
+      connection.get_reply_each(*args) do |request|
+        while (re = request.reply.shift)
+          Log.info { "Mikrotik reply: #{re.inspect}" }
+          if re.key?('!re') ; yield(re)
+          elsif re.key?('!done') ; return re['ret']
+          elsif re.key?('!trap') ; raise(RouterError, re['message'])
+          else raise(Error, "Unrecognized Mikrotik reply: #{re.inspect}")
+          end
+        end
+      end
+      raise(Error, "Missing reply: no !re, !done, !trap received")
+    end
+
+    # @return [void]
+    def fetch
+      @cache = {}
+      request('/ip/firewall/address-list/print', '=.proplist=.id,address,list') do |re|
+        re['list'].sub!(/\A#{Regexp.quote(@prefix)}/) do
+          @cache[re['address']] = re
+          next '' # replaces @prefix on re['list']
+        end
+      end
+    rescue
+      @cache = nil
+      raise
+    end
+
+    # @param [String] ip
+    # @param [String] address_list
+    # @return [String] The ID of the added item
+    def address_list_add(ip, address_list)
+      request('/ip/firewall/address-list/add', "=address=#{ip}", "=list=#{address_list}")
+    end
+
+    # @param [String] id
+    # @param [String] address_list
+    # @return [void]
+    def address_list_set(id, address_list)
+      request('/ip/firewall/address-list/set', "=.id=#{id}", "=list=#{address_list}")
+    end
+
+    # @param [String] id
+    # @return [void]
+    def address_list_remove(id)
+      request('/ip/firewall/address-list/remove', "=.id=#{id}")
+    end
+  end
+end

data/lib/mtik_directory_2_address_list/version.rb

@@ -0,0 +1,3 @@
+module MtikDirectory2AddressList
+  VERSION = '1.0.0'
+end

data/lib/mtik_directory_2_address_list.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+require 'mtik_directory_2_address_list/version'
+require 'mtik_directory_2_address_list/log'
+require 'mtik_directory_2_address_list/directory'
+require 'mtik_directory_2_address_list/mikrotik'
+
+module MtikDirectory2AddressList
+  module_function
+
+  # Synchronize a directory containing symbolic links with a Mikrotik address list.
+  #
+  # @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]
+  def sync(src, dst, prefix = "dir_")
+    Log.info { "Synchronizing [#{src}] with router at [#{dst[:host]}]" }
+    mtik = Mikrotik.new(dst.dup.merge(prefix:prefix))
+    Directory.watch(src) do |dm| # Directory Map {ip => address_list}
+      mm = Hash[mtik.list.to_a] # Mikrotik Map {ip => address_list}
+      dm.each_pair do |d_ip, d_address_list|
+        if mm.key? d_ip
+          if d_address_list != mm[d_ip]
+            Log.info { "Updating IP [#{d_ip}] to list [#{d_address_list}]" }
+            mtik.update(d_ip, d_address_list)
+          end
+        else
+          Log.info { "Adding IP [#{d_ip}] to list [#{d_address_list}]" }
+          mtik.add(d_ip, d_address_list)
+        end
+      end
+      mm.each_key do |m_ip|
+        unless dm.key? m_ip
+          Log.info { "Deleting IP [#{m_ip}]" }
+          mtik.delete(m_ip)
+        end
+      end
+    end
+  end
+end

data/mtik_directory_2_address_list.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mtik_directory_2_address_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mtik_directory_2_address_list'
+  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.files         = `git ls-files -z`.split("\x0")
+  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.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.5'
+  spec.add_development_dependency 'mocha', '~> 1.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+
+  spec.add_runtime_dependency 'mtik', '~> 4.0'
+end

data/test/test_directory.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'simplecov'
+gem 'minitest'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'mtik_directory_2_address_list'
+
+describe "OS" do
+  # man READLINK(2) says:
+  #  EINVAL The named file is not a symbolic link.
+  it "readlink should yield EINVAL on non-symlinks" do
+    begin
+      File.readlink("/") # "/" is always a directory
+    rescue => err
+      assert_instance_of(Errno::EINVAL, err)
+    end
+  end
+end
+
+module MtikDirectory2AddressList
+  describe "Directory" do
+    describe "sample-1" do
+      let :path do
+        "/tmp/sample-1"
+      end
+
+      before do
+        FileUtils.mkdir(path)
+        Dir.chdir(path) do
+          FileUtils.touch(%w(ignored 9.8.7.6))
+          File.symlink("account-name-1", "1.2.3.4")
+          File.symlink("account-name-2", "1.2.3.5")
+        end
+      end
+
+      after do
+        FileUtils.rm_rf(path)
+      end
+
+      it "should list two links" do
+        res = Directory.new(path:path).list
+        assert_equal([%w(1.2.3.4 account-name-1), %w(1.2.3.5 account-name-2)], res.to_a)
+      end
+
+      it "should yield on different mtime" do
+        dir = Directory.new(path:path)
+        dir.stubs(:sleep)
+        dir.stubs(:loop).multiple_yields(*4.times)
+        File.stubs(:mtime).with(path).returns(10, 10, 20, 20)
+        Directory.expects(:new).with(path:path).returns(dir)
+        times = 0
+        Directory.watch(path) do |dem| # Directory Entries Map
+          assert_equal({'1.2.3.4' => 'account-name-1', '1.2.3.5' => 'account-name-2'}, dem)
+          times += 1
+        end
+        # 'watch' should yield first right after starting,
+        # and then a second time when the 'mtime' changes.
+        assert_equal(2, times)
+      end
+    end
+  end
+end

data/test/test_mikrotik.rb

@@ -0,0 +1,113 @@
+# coding: utf-8
+require 'simplecov'
+gem 'minitest'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'mtik_directory_2_address_list'
+
+begin
+  file = File.join(File.dirname(__FILE__), 'mikrotik.eval')
+  $mtik_params = eval(IO.read(file))
+rescue => err
+  puts '*' * 79
+  puts "Cannot read Mikrotik configuration file: #{err}"
+  puts ''
+  puts "Create a file named mikrotik.eval for testing the Mikrotik code."
+  puts "Example: {host:'10.9.8.7', user:'login', pass:'123', prefix:'download_speed_'}"
+  puts '*' * 79
+else
+  module MtikDirectory2AddressList
+    describe "Mikrotik" do
+      subject do
+        Mikrotik.new($mtik_params)
+      end
+
+      before do
+        subject.clear
+      end
+
+      it "#add" do
+        subject.add('1.2.3.4', 'address-list-name')
+        assert_equal([%w(1.2.3.4 address-list-name)], subject.list.to_a)
+      end
+
+      it "raises SyncError on duplicated IP on #add" do
+        subject.add('1.2.3.4', 'address-list-name')
+        assert_raises(Mikrotik::SyncError) { subject.add('1.2.3.4', 'address-list-name') }
+      end
+
+      it "#list" do
+        subject.add('1.2.3.4', 'address-list-name')
+        subject.send(:fetch)
+        assert_equal([%w(1.2.3.4 address-list-name)], subject.list.to_a)
+      end
+
+      it "#delete" do
+        subject.add('1.2.3.4', 'address-list-name')
+        subject.send(:fetch)
+        subject.delete('1.2.3.4')
+        assert_equal([], subject.list.to_a)
+      end
+
+      it "#delete after #add" do
+        subject.add('1.2.3.4', 'address-list-name')
+        subject.delete('1.2.3.4')
+        assert_equal([], subject.list.to_a)
+        subject.send(:fetch)
+        assert_equal([], subject.list.to_a)
+      end
+
+      it "raises SyncError on missing IP on #delete" do
+        assert_raises(Mikrotik::SyncError) { subject.delete('1.2.3.4') }
+      end
+
+      it "#update" do
+        subject.add('1.2.3.4', 'address-list-name')
+        subject.send(:fetch)
+        subject.update('1.2.3.4', 'brand-new-name')
+        assert_equal([%w(1.2.3.4 brand-new-name)], subject.list.to_a)
+        subject.send(:fetch)
+        assert_equal([%w(1.2.3.4 brand-new-name)], subject.list.to_a)
+      end
+
+      it "#update after #add" do
+        subject.add('1.2.3.4', 'address-list-name')
+        subject.update('1.2.3.4', 'brand-new-name')
+        assert_equal([%w(1.2.3.4 brand-new-name)], subject.list.to_a)
+        subject.send(:fetch)
+        assert_equal([%w(1.2.3.4 brand-new-name)], subject.list.to_a)
+      end
+
+      it "raises SyncError on missing IP on #update" do
+        assert_raises(Mikrotik::SyncError) { subject.update('1.2.3.4', 'address-list-name') }
+      end
+
+      it "raises RouterError on !trap" do
+        mtik_api = %w(/ip/firewall/address-list/remove =.id=XXX)
+        err = assert_raises(Mikrotik::RouterError) { subject.send(:request, *mtik_api) }
+        assert_equal('no such item', err.to_s) # ID XXX is impossible/invalid
+      end
+
+      it "raises Error on unrecognized Mikrotik reply" do
+        re = {'unexpected'=>nil}
+        request = mock(:reply => [re])
+        subject.send(:connection).stubs(:get_reply_each).yields(request)
+        err = assert_raises(Mikrotik::Error) { subject.send(:request, '/xxx') }
+        assert_equal('Unrecognized Mikrotik reply: {"unexpected"=>nil}', err.to_s)
+      end
+
+      it "raises Error on incomplete Mikrotik reply" do
+        subject.send(:connection).stubs(:get_reply_each)
+        err = assert_raises(Mikrotik::Error) { subject.send(:request, '/xxx') }
+        assert_equal('Missing reply: no !re, !done, !trap received', err.to_s)
+      end
+
+      it "nil @cache on fetch error" do
+        class MyError < StandardError ; end
+        subject.stubs(:request).raises(MyError)
+        assert_raises(MyError) { subject.send(:fetch) }
+        assert_equal(nil, subject.instance_variable_get(:@cache))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: mtik_directory_2_address_list
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andre Luiz dos Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mtik
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- andre.netvision.com.br@gmail.com
+executables:
+- mtik_directory_2_address_list
+extensions: []
+extra_rdoc_files: []
+files:
+- .simplecov
+- Gemfile
+- Rakefile
+- bin/mtik_directory_2_address_list
+- lib/mtik_directory_2_address_list.rb
+- lib/mtik_directory_2_address_list/directory.rb
+- lib/mtik_directory_2_address_list/log.rb
+- lib/mtik_directory_2_address_list/mikrotik.rb
+- lib/mtik_directory_2_address_list/version.rb
+- mtik_directory_2_address_list.gemspec
+- test/test_directory.rb
+- test/test_mikrotik.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Synchronize a directory with a Mikrotik address list
+test_files:
+- test/test_directory.rb
+- test/test_mikrotik.rb