akaer 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# RubyMine
+.idea/

data/Gemfile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    akaer (0.1.0)
+      cowtech-extensions (~> 2.1.0)
+      cowtech-lib (~> 1.9.8.0)
+      hashie (~> 1.2.0)
+      rainbow (~> 1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    cowtech-extensions (2.1.0)
+      actionpack (~> 3.0)
+      tzinfo (~> 0.3.33)
+    cowtech-lib (1.9.8.1)
+      jeweler
+      open4
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hashie (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.3)
+    multi_json (1.3.6)
+    open4 (1.3.0)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rainbow (1.1.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  akaer!
+  rspec (~> 2.10.0)

data/README.md

@@ -0,0 +1,56 @@
+# akaer
+
+A small utility to add aliases to network interfaces.
+http://github.com/ShogunPanda/akaer
+
+## Description
+
+Akaer is a small utility that adds and remove aliases to your network interfaces. This is useful in web development.
+
+## Basic usage
+
+1. Install the gem:
+
+	`gem install akaer`
+
+2. Run the application:
+
+	`akaer`
+
+**You're done!**
+
+## Advanced usage
+
+Just type `akaer --help` and you'll see all available options.
+
+## Configuration
+
+By defaults, Akaer uses a configuration file in `~/.akaer_config`, but you can change the path using the `--config` switch.
+
+The file is a plain Ruby file with a single `config` object that supports the following directives.
+
+* `interface`: The network interface to manage. `lo0` by default.
+* `address`: A specific list of aliases to manage.
+* `start-address`: The address to start sequential address. `10.0.0.1` by default. Not used if `addresses` is specified.
+* `aliases`: The number of sequential addresses to add. 5 by default.
+* `log_file`: The default log file. By default it logs to standard output.
+* `log_level`: The default log level. Valid values are from 0 to 5 where 0 means "all messages".
+
+## Remarks
+
+Akaer is tightly coupled with the UNIX tools, so it won't work for Windows.
+
+## Contributing to akaer
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (C) 2012 and above Shogun <[shogun_panda@me.com](mailto:shogun_panda@me.com)>.
+Licensed under the MIT license, which can be found at [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+desc "Run all specs with rcov"
+RSpec::Core::RakeTask.new("spec:coverage") do |t|
+  t.rcov_opts =  %q[--exclude "spec"]
+end

data/akaer.gemspec

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "./lib/akaer/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "akaer"
+  gem.version = Akaer::Version::STRING
+  gem.authors = ["Shogun"]
+  gem.email = ["shogun_panda@me.com"]
+  gem.homepage = "http://github.com/ShogunPanda/akaer"
+  gem.summary = %q{A small utility to add aliases to network interfaces.}
+  gem.description = %q{A small utility to add aliases to network interfaces.}
+
+  gem.rubyforge_project = "akaer"
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("cowtech-extensions", "~> 2.1.0")
+  gem.add_dependency("cowtech-lib", "~> 1.9.8.0")
+  gem.add_dependency("hashie", "~> 1.2.0")
+  gem.add_dependency("rainbow", "~> 1.1.0")
+
+  gem.add_development_dependency("rspec", "~> 2.10.0")
+end
+
+

data/bin/akaer

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+
+require "rubygems"
+require "akaer"
+Akaer::Application.start

data/lib/akaer/application.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "cowtech-lib"
+require "ipaddr"
+
+class Fixnum
+  def i(num = 3)
+    self.to_s.rjust(num, "0")
+  end
+end
+
+module Akaer
+  class Application < Cowtech::Lib::Script
+    def self.start
+      self.new
+    end
+
+    def initialize
+      Akaer::Logger.start_time = Time.now
+      super(:args => {:name => "Interface aliases", :version => 1.0, :description => "A small utility to add aliases to network interfaces.", :usage => "Usage: #{ARGV[0]} [OPTIONS] [add|remove]"})
+    end
+
+    def add_options
+      @options_parser << [
+        {:name => "configuration", :short => "-c", :long => "--configuration", :type => :string, :help => "Configuration file. By default is the standard output", :meta => "FILE", :required => false, :default => "~/.akaer_config"},
+        {:name => "interface", :short => "-i", :long => "--interface", :type => :string, :help => "Interface", :meta => "INTERFACE", :required => false, :default => "lo0"},
+        {:name => "addresses", :short => "-A", :long => "--addresses", :type => :list, :help => "Addresses to add", :required => false, :default => []},
+        {:name => "start-address", :short => "-s", :long => "--start-address", :type => :string, :help => "Starting address (not used if --addresses is specified).", :meta => "ADDRESS", :required => false, :default => "10.0.0.1"},
+        {:name => "aliases", :short => "-S", :long => "--aliases", :type => :int, :help => "Number of aliases to add", :meta => "NUMBER", :required => false, :default => 5},
+        {:name => "log-file", :short => "-l", :long => "--log-file", :type => :string, :help => "Log file. By default is the standard output", :meta => "FILE", :required => false, :default => "STDOUT"},
+        {:name => "log-level", :short => "-L", :long => "--log-level", :type => :int, :help => "The default log level. Valid values are from 0 to 5 where 0 means \"all messages\".", :meta => "NUMBER", :required => false, :default => Logger::INFO},
+        {:name => "dry-run", :short => "-n", :long => "--dry-run", :type => :bool, :help => "Do not really execute actions."},
+        {:name => "quiet", :short => "-q", :long => "--quiet", :type => :bool, :help => "Do not show any message", :required => false, :default => false}
+      ]
+    end
+
+    def create_logger(file, level = Logger::INFO)
+      file = case file
+        when "STDOUT" then $stdout
+        when "STDERR" then $stderr
+        else file
+      end
+
+      rv = Akaer::Logger.new(file)
+      rv.level = level.to_i
+      rv
+    end
+
+    def execute_command(interface, action, ip, prefix = "")
+      prefix += " " if !prefix.blank?
+      @logger.info("#{prefix}#{(action == "add" ? "Adding" : "Removing").bright} alias #{ip.bright} #{action == "add" ? "to" : "from"} interface #{interface.bright}.")
+      system("sudo ifconfig #{interface} #{action == "add" ? "alias" : "-alias"} #{ip}")
+    end
+
+    def run
+      @logger = self.create_logger(@options_parser["log-file"], @options_parser["log-level"])
+
+      command = (@options_parser.args[0] || "add").downcase
+      aliases = []
+      target_address = ""
+
+      # Parse configuration file
+      configuration = Akaer::Configuration.load(@options_parser["configuration"], @logger)
+
+      # Now merge with the options
+      @options_parser[].each_pair do |option, value|
+        key = option.to_s.gsub("-", "_")
+        configuration[key] = value if configuration.has_key?(key) && @options_parser.provided?(option)
+      end
+
+      # Instantiate the logger
+      logger = self.create_logger(configuration.log_file, configuration.log_level)
+
+      # Create address
+      if !["add", "remove"].include?(command) then
+        @logger.fatal("\"Please choose an action between \"add\" or \"remove\".")
+        abort
+      end
+
+      begin
+        if configuration.addresses.blank? then
+          target_address = configuration.start_address
+          temp = IPAddr.new(target_address)
+
+          [configuration.aliases, 1].max.times do
+            aliases << temp.to_s
+            temp = temp.succ
+            target_address = temp.to_s
+          end
+        else
+          configuration.addresses.each do |t|
+            target_address = t
+            aliases << IPAddr.new(target_address)
+          end
+        end
+      rescue ArgumentError => e
+        logger.fatal("\"#{target_address}\" is not a valid IP address.")
+        abort
+      end
+
+      if !@options_parser["dry-run"] then
+        total = aliases.length
+        rj = total.to_s.length
+        aliases.each_with_index do |a, i|
+          prefix = "[#{(i + 1).to_s.rjust(rj, "0")}/#{total}]"
+          if !self.execute_command(configuration.interface, command, a, prefix) then
+            logger.fatal("#{command == "add" ? "Adding" : "Removing"} alias #{a} failed.")
+            abort
+          end
+        end
+      else
+        @logger.info("I will #{command.bright} #{aliases.length == 1 ? "this alias" : "these aliases"} #{command == "add" ? "to" : "from"} interface #{configuration.interface.bright}: #{aliases.collect {|a| a.bright}.join(", ")}.")
+      end
+    end
+  end
+end

data/lib/akaer/configuration.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Akaer
+  class Configuration < Hashie::Dash
+    property :interface, :default => "lo0"
+    property :addresses, :default => []
+    property :start_address, :default => "10.0.0.1"
+    property :aliases, :default => 5
+    property :log_file, :default => "STDOUT"
+    property :log_level, :default => Logger::INFO
+
+    def self.load(file = nil, logger = nil)
+      if logger.blank? then
+        logger ||= Akaer::Logger.new($stderr)
+        logger.level = Logger::INFO
+      end
+
+      rv = self.new
+      if file.present? then
+        begin
+          # Open the file
+          path = Pathname.new(File.expand_path(file)).realpath
+          logger.debug("Using configuration file #{path}.")
+
+          rv.tap do |config|
+            eval(File.read(path))
+          end
+        rescue Errno::ENOENT, LoadError
+        rescue Exception
+          raise Akaer::Errors::InvalidConfiguration.new("Config file #{file.bright} is not valid.")
+        end
+      end
+
+      rv
+    end
+  end
+end

data/lib/akaer/errors.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Akaer
+  module Errors
+    class InvalidConfiguration < ArgumentError
+    end
+  end
+end

data/lib/akaer/logger.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Akaer
+  class Logger < ::Logger
+    mattr_accessor :start_time
+
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      super(logdev, shift_age, shift_size)
+
+      self.formatter = Proc.new {|severity, datetime, progname, msg|
+        color = case severity
+          when "DEBUG" then :cyan
+          when "INFO" then :green
+          when "WARN" then :yellow
+          when "ERROR" then :red
+          when "FATAL" then :magenta
+          else nil
+        end
+
+        header = ("[%s T+%0.5f]" %[datetime.strftime("%Y/%b/%d %H:%M:%S"), datetime.to_f - @@start_time.to_f, msg]).bright
+        header = header.color(color) if color.present?
+        log = "%s %s\n" % [header, msg]
+      }
+    end
+  end
+end

data/lib/akaer/version.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Akaer
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join(".")
+  end
+end

data/lib/akaer.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+# This file is part of the akaer gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "cowtech-extensions"
+require "cowtech-lib"
+require "ipaddr"
+require "hashie"
+require "rainbow"
+require "pathname"
+
+Sickill::Rainbow.enabled = true
+
+require "akaer/version" if !defined?(Akaer::Version)
+require "akaer/errors"
+require "akaer/logger"
+require "akaer/configuration"
+require "akaer/application"
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: akaer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Shogun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cowtech-extensions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: cowtech-lib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.8.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: A small utility to add aliases to network interfaces.
+email:
+- shogun_panda@me.com
+executables:
+- akaer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- akaer.gemspec
+- bin/akaer
+- lib/akaer.rb
+- lib/akaer/application.rb
+- lib/akaer/configuration.rb
+- lib/akaer/errors.rb
+- lib/akaer/logger.rb
+- lib/akaer/version.rb
+homepage: http://github.com/ShogunPanda/akaer
+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'
+      segments:
+      - 0
+      hash: 2748666871543433517
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2748666871543433517
+requirements: []
+rubyforge_project: akaer
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A small utility to add aliases to network interfaces.
+test_files: []