rhosts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 044fbb1e205d8759c29fa0381afa740ad7352d99
+  data.tar.gz: 2154e8b6d3f7a40365cd381321cf6cc4685e90fc
+SHA512:
+  metadata.gz: b99163fd4aa43d5dd534844858092a7cee61825abff17c87a258014508e247c1b7fec709333ddd5757f645c18269b205641ec7fb695bd650ba37ff76a573ec5d
+  data.tar.gz: 46b2de6da8141d881deab5e82cff345026a8e3ab8ad0c97e1f5a43872f811941efac12937505cb11b0ab0ec08a1813b4d2c82057b9dd6a7c1d13a156d4e5edce

data/License.txt

@@ -0,0 +1,20 @@
+Copyright 2013 Takeshi Takizawa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+RHosts
+====
+
+hosts file manager
+
+# Description
+
+rhosts is a command that facilitates the management of the host file.
+
+# Usage
+## show all hosts
+```
+$ rhosts
+rhosts> all
+### actives
+127.0.0.1
+  localhost
+  dev-www.example.com
+
+127.0.0.2
+  stg-www.example.com
+
+### inactives
+127.0.0.1
+  stg-www.example.com
+
+```
+
+## show active hosts
+```
+rhosts> actives
+### actives
+127.0.0.1
+  localhost
+  dev-www.example.com
+
+127.0.0.2
+  stg-www.example.com
+
+```
+
+## show inactive hosts
+```
+rhosts> inactives
+### inactives
+127.0.0.1
+  stg-www.example.com
+
+```
+
+## map specific host
+```
+$ rhosts
+rhosts> actives
+### actives
+127.0.0.1
+  localhost
+  dev-www.example.com
+
+127.0.0.2
+  stg-www.example.com
+
+rhosts> map "dev-www.example.co.jp" => "127.0.0.1"
+rhosts> actives
+### actives
+127.0.0.1
+  localhost
+  dev-www.example.com
+  dev-www.example.co.jp
+
+127.0.0.2
+  stg-www.example.com
+
+```
+
+## unmap specific host
+```
+$ rhosts
+rhosts> actives
+### actives
+127.0.0.1
+  localhost
+  dev-www.example.com
+
+127.0.0.2
+  stg-www.example.com
+
+rhosts> unmap "dev-www.example.com" => "127.0.0.1"
+rhosts> actives
+### actives
+127.0.0.1
+  localhost
+
+127.0.0.2
+  stg-www.example.com
+
+```

data/bin/rhosts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib_path) unless $:.include?(lib_path)
+
+require "rhosts/cli"

data/lib/rhosts/alias.rb

@@ -0,0 +1,41 @@
+module RHosts
+  module Alias
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def alias_ips
+      self.class.alias_ips
+    end
+
+    def alias_ip(new_name, old_name)
+      self.class.alias_ips[new_name] = old_name
+    end
+
+    def alias_hosts
+      self.class.alias_hosts
+    end
+
+    def alias_host(new_name, old_name)
+      self.class.alias_hosts[new_name] = old_name
+    end
+
+    module ClassMethods
+      def alias_ips
+        @alias_ips ||= {}
+      end
+
+      def alias_ip(new_name, old_name)
+        alias_ips[new_name] = old_name
+      end
+
+      def alias_hosts
+        @alias_hosts ||= {}
+      end
+
+      def alias_host(new_name, old_name)
+        alias_hosts[new_name] = old_name
+      end
+    end
+  end
+end

data/lib/rhosts/cli.rb

@@ -0,0 +1,8 @@
+Signal.trap("INT") { puts; exit(1) }
+
+require 'rhosts'
+
+# TODO: Runnable not only console but also exec from file, string and so on.
+require 'rhosts/commands/console'
+
+RHosts::Console.start

data/lib/rhosts/commands/console.rb

@@ -0,0 +1,57 @@
+require 'readline'
+require 'rhosts/filer'
+require 'rhosts/console/app'
+require 'rhosts/rulable'
+require 'rhosts/alias'
+
+module RHosts
+  class Console
+    include RHosts::ConsoleMethods
+    include RHosts::Rulable
+    include RHosts::Alias
+
+    alias_host 'exp',       'www.example.com'
+    alias_ip   'localhost', '127.0.0.1'
+
+    class << self
+      def start
+        @console = new
+
+        load_default_rules
+        load_run_command
+
+        unless File.writable?(RHosts.config.hosts_file_path)
+          STDERR.puts "Hosts file is not writable. Please check permission"
+          exit 1
+        end
+
+        @console.start
+      end
+
+      private
+      def load_default_rules
+        default_rules = File.read(RHosts.root + '/rhosts/console/default_rules.rb')
+        @console.instance_eval(default_rules)
+      end
+
+      def load_run_command
+        rhostsrc = File.join(File.expand_path("~"), ".rhostsrc")
+        if File.exist?(rhostsrc)
+          puts "load: #{rhostsrc}"
+          @console.instance_eval(File.read(rhostsrc))
+        end
+      end
+    end
+
+    def initialize
+      @actives, @inactives = RHosts::Filer.load
+    end
+
+    def start
+      while command = Readline.readline('rhosts> ', true)
+        # call matched rule with captures
+        rules.each{ |rule, action| action.call($~.captures) if rule.match command.chomp }
+      end
+    end
+  end
+end

data/lib/rhosts/configuration.rb

@@ -0,0 +1,9 @@
+module RHosts
+  class Configuration
+    attr_accessor :hosts_file_path, :backup_dir, :make_backup
+
+    def make_backup?
+      make_backup
+    end
+  end
+end

data/lib/rhosts/console/app.rb

@@ -0,0 +1,74 @@
+require 'ipaddress'
+
+module RHosts
+  module ConsoleMethods
+    def actives
+      @actives ||= Hash.new{ |h, k| h[k] = Set.new }
+    end
+
+    def inactives
+      @inactives ||= Hash.new{ |h, k| h[k] = Set.new }
+    end
+
+    def map(target)
+      process(target) do |host, ip|
+        unless inactives[ip].empty?
+          inactives[ip].delete_if{ |h| h == host }
+          inactives.delete(ip) if inactives[ip].empty?
+        end
+
+        actives[ip] << host
+        puts "map #{host} to #{ip}"
+      end
+    end
+
+    def unmap(target)
+      process(target) do |host, ip|
+        unless actives[ip].empty?
+          actives[ip].delete_if{ |h| h == host }
+          actives.delete(ip) if actives[ip].empty?
+        end
+
+        inactives[ip] << host
+        puts "unmap #{host} from #{ip}"
+      end
+    end
+
+    # print mappings
+    def display(title, mappings)
+      puts "### #{title}"
+      mappings.each do |ip, hosts|
+        puts ip
+        hosts.each{ |host| puts "  #{host}" }
+        puts ''
+      end
+    end
+
+    private
+    def process(target, &block)
+      raise ArgumentsError.new('mapping target must be Hash') unless target.instance_of? Hash
+
+      # TODO
+      # before_actions.each{ |action| action.call }
+
+      target.each do |host, ip|
+        host = alias_hosts[host] || host
+        ip   = alias_ips[ip]     || ip
+
+        ip_without_zone_index = ip.split('%')[0]
+        unless IPAddress.valid?(ip_without_zone_index)
+          STDERR.puts "#{ip} is invalid IP Address!"
+          next
+        end
+
+        block.call(host, ip)
+      end
+
+      RHosts::Filer.backup if RHosts.config.make_backup?
+      RHosts::Filer.save(actives, inactives)
+
+      # TODO
+      # after_actions.each{ |action| action.call }
+    end
+  end
+end

data/lib/rhosts/console/default_rules.rb

@@ -0,0 +1,46 @@
+# print all mappings
+rule /^(A|all)$/ do
+  display 'actives', actives
+  display 'inactives', inactives
+end
+
+# print only active mappings
+rule /^(a|actives)$/ do
+  display 'actives', actives
+end
+
+# print only inactive mappings
+rule /^(i|inactives)$/ do
+  display 'inactives', inactives
+end
+
+# add mapping
+rule /^(m|map) +(.*?) +(.*?)$/ do |command, host, ip|
+  map host => ip
+end
+
+# add unmapping
+rule /^(u|unmap) +(.*?) +(.*?)$/ do |command, host, ip|
+  unmap host => ip
+end
+
+# print command history
+rule /^(hist|history)$/ do
+  puts Readline::HISTORY.to_a.join("\n")
+end
+
+# print registored rules
+rule /^rules$/ do
+  puts rules.keys.join("\n")
+end
+
+# print help
+rule /^(h|help)$/ do
+  # TODO: help message
+  #help
+end
+
+# quit rhosts
+rule /^(q|quit|exit)$/ do
+  exit
+end

data/lib/rhosts/filer.rb

@@ -0,0 +1,91 @@
+require 'ipaddress'
+
+module RHosts
+  module Filer
+    class << self
+      def load
+        actives   = Hash.new{ |h, k| h[k] = Set.new }
+        inactives = Hash.new{ |h, k| h[k] = Set.new }
+
+        File.open(RHosts.config.hosts_file_path, 'r') do |file|
+          file.each do |line|
+            storage = Mapping.active?(line) ? actives : inactives
+
+            Mapping.parse(line) do |ip, hosts|
+              next if ip.nil? or hosts.empty?
+
+              # IPAddress gem can't parse IP with zone index
+              #
+              # for example
+              #   fe80::1%lo0
+              ip_without_zone_index = ip.split('%')[0]
+              next unless IPAddress.valid?(ip_without_zone_index)
+
+              storage[ip] ||= []
+              storage[ip] += hosts
+            end
+          end
+        end
+
+        [actives, inactives]
+      end
+
+      def backup
+        bk_file_path = backup_file_path
+        hosts_file_path = RHosts.config.hosts_file_path
+
+        if File.writable?(RHosts.config.backup_dir)
+          FileUtils.cp(hosts_file_path, bk_file_path)
+          puts "backup: #{bk_file_path}"
+        else
+          STDERR.puts "backup file is not writable. #{bk_file_path}"
+          STDERR.puts 'So we will backup to tmp dir'
+          tmp = tmp_file_path
+          FileUtils.cp(hosts_file_path, tmp)
+          STDERR.puts "backup: #{tmp}"
+        end
+      end
+
+      def save(actives, inactives)
+        # TODO: reload hosts file if chnaged after load
+        hosts_file_path = RHosts.config.hosts_file_path
+        unless File.writable?(hosts_file_path)
+          STDERR.puts "Hosts file is not writable. Please check permission"
+          exit 1
+        end
+
+        File.open(RHosts.config.hosts_file_path, 'w') do |file|
+          actives.each{ |ip, hosts| file.write("#{ip} #{hosts.to_a.join(' ')}\n") }
+          inactives.each{ |ip, hosts| file.write("##{ip} #{hosts.to_a.join(' ')}\n") }
+        end
+        puts "save: #{hosts_file_path}"
+      end
+
+      private
+      def backup_file_path
+        hosts_file_path = RHosts.config.hosts_file_path
+        basename = File.basename(hosts_file_path)
+        File.join(RHosts.config.backup_dir, "#{basename}.#{Time.now.to_i}")
+      end
+
+      def tmp_file_path
+        hosts_file_path = RHosts.config.hosts_file_path
+        basename = File.basename(hosts_file_path)
+        File.join('/tmp', "#{basename}.#{Time.now.to_i}")
+      end
+    end
+
+    class Mapping
+      class << self
+        def active?(line)
+          line !~ /^#/
+        end
+
+        def parse(line, &block)
+          ip, *hosts = line.chomp.sub(/^#+\s*/, '').split(/\s+/)
+          block.call(ip, hosts)
+        end
+      end
+    end
+  end
+end

data/lib/rhosts/rulable.rb

@@ -0,0 +1,11 @@
+module RHosts
+  module Rulable
+    def rules
+      @rules ||= {}
+    end
+
+    def rule(pattern, &block)
+      rules[pattern] = block
+    end
+  end
+end

data/lib/rhosts/version.rb

@@ -0,0 +1,5 @@
+module RHosts # :nodoc:
+  module Version # :nodoc:
+    STRING = '0.0.1'
+  end
+end

data/lib/rhosts.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler/setup'
+
+lib_path = File.dirname(__FILE__)
+$:.unshift(lib_path) unless $:.include?(lib_path)
+
+require 'rhosts/configuration'
+
+module RHosts
+  def self.root
+    @root ||= File.dirname(__FILE__)
+  end
+
+  def self.config
+    @config ||= RHosts::Configuration.new
+  end
+
+  def self.configure
+    yield config if block_given?
+  end
+end
+
+# default setting
+RHosts.configure do |c|
+  c.hosts_file_path = '/etc/hosts'
+  c.backup_dir      = '/etc'
+  c.make_backup     = true
+end

data/spec/console/app_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'rhosts/console/app'
+
+describe 'ConsoleMethods' do
+  include RHosts::ConsoleMethods
+
+  describe '#map' do
+    before do
+      map 'example.com' => '127.0.0.1'
+    end
+
+    after do
+      @actives.clear
+      @inactives.clear
+    end
+
+    it 'map example.com to 127.0.0.1' do
+      expect(actives).to eq('127.0.0.1' => ['example.com'])
+      expect(inactives).to eq({ })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../../lib/rhosts',  __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rhosts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takeshi Takizawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: hosts file manager
+email: TakiTake.create@gmail.com
+executables:
+- rhosts
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/rhosts.rb
+- lib/rhosts/alias.rb
+- lib/rhosts/cli.rb
+- lib/rhosts/commands/console.rb
+- lib/rhosts/configuration.rb
+- lib/rhosts/console/app.rb
+- lib/rhosts/console/default_rules.rb
+- lib/rhosts/filer.rb
+- lib/rhosts/rulable.rb
+- lib/rhosts/version.rb
+- License.txt
+- README.md
+- spec/console/app_spec.rb
+- spec/spec_helper.rb
+- bin/rhosts
+homepage: http://github.com/TakiTake/rhosts
+licenses:
+- MIT
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rhosts
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: rhosts-0.0.1
+test_files:
+- spec/console/app_spec.rb
+- spec/spec_helper.rb