blocklist 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wes Oldenbeuving
+
+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.rdoc

@@ -0,0 +1,58 @@
+= Blocklist
+Blocklist manages /etc/hosts with the goal of routing distracting websites to localhost. It also works well as an ad blocker.
+
+== Usage
+
+You'll need read/write access to /etc/hosts to make this work. It might also be a good idea to keep a backup of /etc/hosts, just in case. Keeping it in a git repo works for me. YMMV.
+
+Blocklist makes a couple of assumtions about how /etc/hosts is set up. Here's a typical dummy file:
+  # localhost
+  127.0.0.1       localhost
+  255.255.255.255 broadcasthost
+  ::1             localhost
+  
+  # disabled
+  # 127.0.0.1       example.org
+
+The above shows that there are blocks of lines, separated by one or more blank lines. Each of these blocks starts with a single comment that names it. Commented-out blocks are prefixed with "# "; hash-space.
+
+=== List all blocks
+  $ blocklist list
+  localhost
+  ads
+  disabled
+
+=== Toggle a block to be commented-out or not
+  $ blocklist toggle disabled
+  # localhost
+  127.0.0.1       localhost
+  255.255.255.255 broadcasthost
+  ::1             localhost
+  
+  # disabled
+  127.0.0.1       example.org
+
+=== Add a domain
+Add a domain to a new or existing block. It automatically adds the subdomain you specified, but it also adds the full domain and the www. subdomain.
+There is support for domains on a TLD that always have a subdomain. The only one that is added out of the box is .co.uk. When you need more, please submit a patch.
+
+  $ blocklist add someblock news.example.org
+  # localhost
+  127.0.0.1       localhost
+  255.255.255.255 broadcasthost
+  ::1             localhost
+
+  # disabled
+  127.0.0.1       example.org
+  
+  # someblock
+  127.0.0.1       news.example.org example.org www.example.org
+
+== Development
+
+You'll need rspec and fakefs to get the specs running.
+
+Patches are always welcome. Please add tests or specs and create a github issue or send a pull request.
+
+== Authors
+* Wes 'Narnach' Oldenbeuving <http://github.com/Narnach>

data/Rakefile

@@ -0,0 +1,49 @@
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require 'rubygems'
+
+################################################################################
+### Gem
+################################################################################
+
+begin
+  # Parse gemspec using the github safety level.
+  file = Dir['*.gemspec'].first
+  data = File.read(file)
+  spec = nil
+  # FIXME: Lowered SAFE from 3 to 2 to work with Ruby 1.9 due to rubygems
+  # performing a require internally
+  Thread.new { spec = eval("$SAFE = 2\n%s" % data)}.join
+
+  # Create the gem tasks
+  Rake::GemPackageTask.new(spec) do |package|
+    package.gem_spec = spec
+  end
+rescue Exception => e
+  printf "WARNING: Error caught (%s): %s\n%s", e.class.name, e.message, e.backtrace[0...5].map {|l| '  %s' % l}.join("\n")
+end
+
+desc 'Package and install the gem for the current version'
+task :install => :gem do
+  system "sudo gem install -l pkg/%s-%s.gem" % [spec.name, spec.version]
+end
+
+desc 'Show files missing from gemspec'
+task :diff do
+  files = %w[
+    Rakefile
+    *README*
+    *LICENSE*
+    *.gemspec
+    bin/*
+    lib/**/*
+    spec/**/*
+  ].map {|pattern| Dir.glob(pattern)}.flatten.select{|f| File.file?(f)}
+  missing_files = files - spec.files
+  extra_files = spec.files - files
+  puts "Missing files:"
+  puts missing_files.join(" ")
+  puts "Extra files:"
+  puts extra_files.join(" ")
+end

data/bin/blocklist

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'blocklist/cli'
+Blocklist::Cli.new(ARGV.dup).run

data/blocklist.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  # Project
+  s.name         = 'blocklist'
+  s.summary      = "Blocklist manages /etc/hosts"
+  s.description  = "Blocklist manages /etc/hosts with the goal of routing distracting websites to localhost. It also works well as an ad blocker."
+  s.version      = '0.1.0'
+  s.date         = '2009-09-15'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Wes Oldenbeuving"]
+  s.email        = "narnach@gmail.com"
+  s.homepage     = "http://www.github.com/Narnach/blocklist"
+
+  # Files
+  root_files     = %w[MIT-LICENSE README.rdoc Rakefile blocklist.gemspec]
+  bin_files      = %w[blocklist]
+  lib_files      = %w[blocklist blocklist/cli]
+  spec_files     = %w[blocklist blocklist/cli]
+  other_files    = %w[spec/spec.opts spec/spec_helper.rb]
+  s.bindir       = "bin"
+  s.require_path = "lib"
+  s.executables  = bin_files
+  s.test_files   = spec_files.map {|f| 'spec/%s_spec.rb' % f}
+  s.files        = root_files + s.test_files + other_files + bin_files.map {|f| 'bin/%s' % f} + lib_files.map {|f| 'lib/%s.rb' % f}
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README.rdoc MIT-LICENSE]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'README.rdoc'
+
+  # Requirements
+  s.required_ruby_version = ">= 1.8.0"
+end

data/lib/blocklist/cli.rb

@@ -0,0 +1,102 @@
+require 'blocklist'
+
+class Blocklist
+  class Cli
+    COMMANDS = %w[add list toggle help]
+    def initialize(argv)
+      @argv = argv
+      @bl = Blocklist.new
+      @bl.parse(File.read('/etc/hosts'))
+      @dry_run = !@argv.delete('-d').nil?
+      @quiet = !@argv.delete('-q').nil?
+      @command = @argv.shift || 'help'
+    end
+
+    def run
+      if COMMANDS.include? @command
+        self.send(@command)
+      else
+        help "Command unknown: '#{@command}'"
+      end
+    end
+
+    protected
+
+    def list
+      puts @bl.blocks.map {|block| block.name}.join("\n")
+    end
+
+    def add
+      block_name = @argv.shift
+      block = @bl.block(block_name) || Blocklist::Block.new(block_name)
+
+      domains = block.lines.map {|line| line.domains}.flatten
+      saved_domains = @argv.map do |domain|
+        dom_segments = domain.split(".")
+        tld_size = 1
+        tld_size = 2 if %w[uk].include? dom_segments.last
+        tld = dom_segments[-tld_size..-1].join(".")
+        dom_no_tld = dom_segments[0...-tld_size]
+        domain_base = dom_no_tld.last
+        subdomain = dom_no_tld.size == 1 ? nil : dom_no_tld[0...-1].join(".")
+        new_domains = [nil, 'www', subdomain].uniq.map {|sub| [sub, domain_base, tld].compact.join(".")} - domains
+        if new_domains.size > 0
+          block.lines << Blocklist::Line.new('127.0.0.1', *new_domains)
+          domains.concat(new_domains)
+        end
+        new_domains
+      end
+      display_result
+      save if saved_domains.flatten.size > 0
+    end
+
+    def toggle
+      block_name = @argv.shift
+      unless block = @bl.block(block_name)
+        help "Could not toggle non-existing block '#{block_name}'"
+        return
+      end
+      block.toggle_comments
+      display_result
+      save
+    end
+
+    def help(msg=nil)
+      if msg
+        $stderr.puts(msg)
+        $stderr.puts('')
+      end
+      $stderr.puts <<-STR
+Syntax: #{$0} [flags] <command>
+
+Flags:
+  -d
+    Perform a dry-run. Does not modify /etc/hosts
+  -q
+    Quiet mode. Minimizes the output to STDOUT
+
+Commands:
+  add <block name> [domain1] .. [domainN]
+    Add a number of domains to the specified block.
+    Each domain will automatically be added with the www subdomain and without subdomain.
+    Duplicate domains are skipped.
+  list
+    Shows a list of all blocks currently defined
+  toggle <block name>
+    Toggle the comment status of all lines in this block.
+  help
+    Show this page
+  STR
+    end
+
+    private
+
+    def display_result
+      puts @bl unless @quiet
+    end
+
+    def save
+      File.open('/etc/hosts','w') {|f| f.puts(@bl.to_s)} unless @dry_run
+    end
+  end
+end

data/lib/blocklist.rb

@@ -0,0 +1,111 @@
+class Blocklist
+  attr_accessor :blocks
+
+  def initialize
+    self.blocks = []
+  end
+
+  def parse(content)
+    block = Block.new
+    content.each_line do |line|
+      parsed_line = Line.parse(line)
+      case parsed_line
+      when nil
+        self.blocks << block
+        block = Block.new
+      when String
+        block.name ||= parsed_line
+      when Line
+        block.lines << parsed_line
+      else
+        raise "Unexpected line: #{line}"
+      end
+    end
+    if block.name or block.lines.size > 0
+      self.blocks << block
+    end
+    nil
+  end
+
+  def block(name)
+    blocks.find {|block| block.name == name}
+  end
+
+  def to_s
+    blocks.join("\n\n")
+  end
+
+  class Block
+    attr_accessor :name, :lines
+
+    def initialize(name=nil, *lines)
+      self.name = name
+      self.lines = lines
+    end
+
+    def ==(other)
+      return false unless other.class == self.class
+      return false unless other.name == self.name
+      return false unless other.lines == self.lines
+      true
+    end
+
+    def toggle_comments
+      lines.each {|line| line.toggle_comment}
+    end
+
+    def to_s
+      "# #{name}\n" + lines.join("\n")
+    end
+  end
+
+  class Line
+    COMMENT_PREFIX = /\A#+\s+/
+    IPV4 = /\A\d{1,3}(\.\d{1,3}){3}/
+    # Took this huge regexp from http://vernon.mauery.com/content/projects/linux/ipv6_regex
+    IPV6 = /(\A([0-9a-f]{1,4}:){1,1}(:[0-9a-f]{1,4}){1,6}\Z)|(\A([0-9a-f]{1,4}:){1,2}(:[0-9a-f]{1,4}){1,5}\Z)|(\A([0-9a-f]{1,4}:){1,3}(:[0-9a-f]{1,4}){1,4}\Z)|(\A([0-9a-f]{1,4}:){1,4}(:[0-9a-f]{1,4}){1,3}\Z)|(\A([0-9a-f]{1,4}:){1,5}(:[0-9a-f]{1,4}){1,2}\Z)|(\A([0-9a-f]{1,4}:){1,6}(:[0-9a-f]{1,4}){1,1}\Z)|(\A(([0-9a-f]{1,4}:){1,7}|:):\Z)|(\A:(:[0-9a-f]{1,4}){1,7}\Z)|(\A((([0-9a-f]{1,4}:){6})(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3})\Z)|(\A(([0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3})\Z)|(\A([0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A([0-9a-f]{1,4}:){1,1}(:[0-9a-f]{1,4}){1,4}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A([0-9a-f]{1,4}:){1,2}(:[0-9a-f]{1,4}){1,3}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A([0-9a-f]{1,4}:){1,3}(:[0-9a-f]{1,4}){1,2}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A([0-9a-f]{1,4}:){1,4}(:[0-9a-f]{1,4}){1,1}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A(([0-9a-f]{1,4}:){1,5}|:):(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)|(\A:(:[0-9a-f]{1,4}){1,5}:(25[0-5]|2[0-4]d|[0-1]?d?d)(.(25[0-5]|2[0-4]d|[0-1]?d?d)){3}\Z)/
+
+    attr_accessor :ip, :domains, :commented
+
+    def initialize(ip, *domains)
+      self.ip = ip
+      self.domains = domains
+      self.commented = false
+    end
+
+    def ==(other)
+      return false unless other.class == self.class
+      return false unless other.ip == self.ip
+      return false unless other.domains == self.domains
+      true
+    end
+
+    def toggle_comment
+      self.commented = !commented
+    end
+
+    def to_s
+      prefix = commented ? "# " : ""
+      "%s%s%s%s" % [prefix, ip, " " * (16 - ip.size), domains.join(" ")]
+    end
+
+    def self.parse(line)
+      stripped_line = line.strip
+      return nil if stripped_line == ''
+      return Line.new(*stripped_line.split(" ")) unless stripped_line =~ COMMENT_PREFIX
+      uncommented_line = stripped_line.gsub(COMMENT_PREFIX, '')
+      split_line = uncommented_line.split(" ")
+      if split_line.first =~ IPV4
+        parsed_line = Line.new(*split_line)
+        parsed_line.commented = true
+        parsed_line
+      elsif split_line.first =~ IPV6
+        parsed_line = Line.new(*split_line)
+        parsed_line.commented = true
+        parsed_line
+      else # comment or title
+        uncommented_line
+      end
+    end
+  end
+end

data/spec/blocklist/cli_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+require 'blocklist/cli'
+begin
+  require 'fakefs/safe'
+rescue LoadError
+  $stderr.puts "!! You need to install fakefs to run the CLI specs.\n!! Look on http://github/defunkt/fakefs or use gemcutter.org."
+  exit 1
+end
+
+describe Blocklist::Cli do
+  before(:each) do
+    FakeFS.activate!
+  end
+  
+  after(:each) do
+    FakeFS.deactivate!
+  end
+
+  def fake_hosts(content='')
+    File.open('/etc/hosts','w') {|f| f.puts content}
+  end
+
+  it 'should display help when no command is given' do
+    fake_hosts
+    cli = Blocklist::Cli.new([])
+    cli.should_receive(:help)
+    cli.run
+  end
+
+  describe 'list' do
+    it 'should show all blocks in /etc/hosts' do
+      fake_hosts <<-STR
+# localhost
+
+# blocked
+      STR
+      cli = Blocklist::Cli.new(%w[list])
+      cli.should_receive(:puts).with("localhost\nblocked")
+      cli.run
+    end
+  end
+
+  describe 'add' do
+    it "should add a domain and its www-subdomain to a block's lines" do
+      fake_hosts <<-STR
+# localhost
+      STR
+      cli = Blocklist::Cli.new(%w[add localhost example.org])
+      cli.run
+      File.read('/etc/hosts').should == <<-STR
+# localhost
+127.0.0.1       example.org www.example.org
+      STR
+    end
+  end
+end

data/spec/blocklist_spec.rb

@@ -0,0 +1,100 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+require 'blocklist'
+
+describe Blocklist do
+  describe '#parse' do
+    it 'should parse all blocks' do
+      hosts = <<-STR
+# localhost
+127.0.0.1 localhost
+255.255.255.255 broadcasthost
+
+# blocked
+127.0.0.1 news.ycombinator.com
+      STR
+      bl = Blocklist.new
+      bl.parse(hosts)
+      bl.blocks.map {|block| block.name}.should == %w[localhost blocked]
+    end
+
+    it 'should parse all domains on a line' do
+      hosts = <<-STR
+# blocked
+127.0.0.1 news.ycombinator.com ycombinator.com
+      STR
+      bl = Blocklist.new
+      bl.parse(hosts)
+      bl.blocks.first.should == Blocklist::Block.new('blocked',
+        Blocklist::Line.new('127.0.0.1', *%w[news.ycombinator.com ycombinator.com]))
+    end
+
+    it 'should handle ipv6 addresses' do
+      hosts = <<-STR.strip
+# localhost
+127.0.0.1       localhost
+::1             localhost
+      STR
+      bl = Blocklist.new
+      bl.parse(hosts)
+      bl.blocks.first.should == Blocklist::Block.new('localhost',
+        Blocklist::Line.new('127.0.0.1', 'localhost'),
+        Blocklist::Line.new('::1', 'localhost'))
+    end
+  end
+
+  describe '#to_s' do
+    it 'should display a Blocklist in the /etc/hosts format' do
+      block1 = Blocklist::Block.new('localhost')
+      block1.lines << Blocklist::Line.new('127.0.0.1', 'localhost')
+      block2 = Blocklist::Block.new('blocked')
+      block2.lines << Blocklist::Line.new('127.0.0.1', 'news.ycombinator.com', 'ycombinator.com')
+      bl = Blocklist.new
+      bl.blocks << block1
+      bl.blocks << block2
+      bl.to_s.should == <<-STR.strip
+# localhost
+127.0.0.1       localhost
+
+# blocked
+127.0.0.1       news.ycombinator.com ycombinator.com
+      STR
+    end
+  end
+
+  describe '#block' do
+    it 'should find the first block by name' do
+      bl = Blocklist.new
+      bl.parse(<<-STR.strip)
+# localhost
+127.0.0.1       localhost
+
+# blocked
+127.0.0.1       news.ycombinator.com ycombinator.com
+      STR
+      bl.block('blocked').lines.first.domains.should == %w[news.ycombinator.com ycombinator.com]
+    end
+
+    it 'should return nil if no block can be found' do
+      Blocklist.new.block('nothing').should be_nil
+    end
+  end
+end
+
+describe Blocklist::Block do
+  describe '#toggle_comments' do
+    it 'should toggle lines between commented-out and not commented' do
+      hosts = <<-STR.strip
+# blocked
+127.0.0.1       news.ycombinator.com ycombinator.com
+      STR
+      bl = Blocklist.new
+      bl.parse(hosts)
+      bl.blocks.first.toggle_comments
+      bl.to_s.should_not == hosts
+      bl2 = Blocklist.new
+      bl2.parse(bl.to_s)
+      bl2.blocks.first.toggle_comments
+      bl2.to_s.should == hosts
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--diff unified
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  $stderr.puts "!! You need to install rspec to run the specs.\n!!   sudo gem install rspec"
+  exit 1
+end
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir)

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: blocklist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Blocklist manages /etc/hosts with the goal of routing distracting websites to localhost. It also works well as an ad blocker.
+email: narnach@gmail.com
+executables: 
+- blocklist
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- blocklist.gemspec
+- spec/blocklist_spec.rb
+- spec/blocklist/cli_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- bin/blocklist
+- lib/blocklist.rb
+- lib/blocklist/cli.rb
+has_rdoc: true
+homepage: http://www.github.com/Narnach/blocklist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Blocklist manages /etc/hosts
+test_files: 
+- spec/blocklist_spec.rb
+- spec/blocklist/cli_spec.rb