lost-socks 0.0.0 → 0.0.1

data/README.md

@@ -0,0 +1,95 @@
+This library is for automating the resolution of DNS records, allowing you to 
+hit arbitrary name servers, and your own local DNS. If you have to migrate
+a boatload of DNS, this library will allow you to verify your migration has
+completed successfully and nothing has been left behind (something that is
+very easy to do in these kinds of jobs).
+
+NOTE: This requires that you have the *nix <code>dig</code> utility installed,
+so it's probably safe to say that this library only work on linux/unix. It 
+hasn't been tested on Windows, so there!
+
+If you're like me and you're fickle about hosting providers, you'd have done
+this a few times. On the last migration I performed this saved me hours of
+manual checking, and saved me from the embarressment of services disappearing
+or whatnot. So let's walk through how you'd use that (full example source is
+in example.rb).
+
+First, you need to require the DNS library:
+
+    require 'lost-socks'
+
+We'll set up some instance variables for the name servers we're going to check
+against:
+
+    @local_dns = [nil]
+    @slicehost_dns = %w(ns1.slicehost.net ns2.slicehost.net)
+
+To prevent name servers from blocking our dig requests, we'll put a delay of
+one second in so that they don't start ignoring us (this happened to me a few
+times, sometimes you can remove it, sometimes you can set it to a lower 
+threshold, experiment would you already!):
+
+    LostSocks.delay = 1
+
+And the rest should be self-explainitory. The API is pretty damn intuitive if
+you ask me after all, I wrote the damn thing). You can check A records, MX
+records, CNAME records and even NS authority! Fwoar!
+
+    (@local_dns + @slicehost_dns).each do |server|
+      
+      LostSocks.verify('yeahnah.org').with_server(server) do |it|
+        # checks A records
+        it.resolves_to('208.78.102.114')
+        # checks MX records
+        it.maps_mail_to('ASPMX.L.GOOGLE.COM', :priority => 10)
+        it.maps_mail_to('ALT1.ASPMX.L.GOOGLE.COM', :priority => 20)
+        it.maps_mail_to('ALT2.ASPMX.L.GOOGLE.COM', :priority => 30)
+      end
+      
+      LostSocks.verify('www.yeahnah.org').with_server(server) do |it|
+        # checks CNAME records
+        it.is_aliased_to('yeahnah.org')
+      end
+      
+      LostSocks.verify('tumble.yeahnah.org').with_server(server) do |it|
+        it.resolves_to('72.32.231.8') # tumblr :)
+      end
+      
+    end
+
+    # shorthand that checks against your local dns
+    LostSocks.verify('yeahnah.org').resolves_to('208.78.102.114')
+    LostSocks.verify('tumble.yeahnah.org').resolves_to('72.32.231.8')
+
+    # oh, and check authorative ns :)
+    LostSocks.verify('yeahnah.org').has_authorative_nameserver_of('ns1.slicehost.net')
+    LostSocks.verify('yeahnah.org').has_authorative_nameserver_of('ns2.slicehost.net')
+
+And this is the output the script will produce if everything works. If it fails
+it'll say FAIL and print the dig output as well (this output is not shown here):
+
+    PASS: yeahnah.org A 208.78.102.114  
+    PASS: yeahnah.org MX ASPMX.L.GOOGLE.COM  {:priority=>10}
+    PASS: yeahnah.org MX ALT1.ASPMX.L.GOOGLE.COM  {:priority=>20}
+    PASS: yeahnah.org MX ALT2.ASPMX.L.GOOGLE.COM  {:priority=>30}
+    PASS: www.yeahnah.org CNAME yeahnah.org  
+    PASS: tumble.yeahnah.org A 72.32.231.8  
+    PASS: yeahnah.org A 208.78.102.114 @ns1.slicehost.net 
+    PASS: yeahnah.org MX ASPMX.L.GOOGLE.COM @ns1.slicehost.net {:priority=>10}
+    PASS: yeahnah.org MX ALT1.ASPMX.L.GOOGLE.COM @ns1.slicehost.net {:priority=>20}
+    PASS: yeahnah.org MX ALT2.ASPMX.L.GOOGLE.COM @ns1.slicehost.net {:priority=>30}
+    PASS: www.yeahnah.org CNAME yeahnah.org @ns1.slicehost.net 
+    PASS: tumble.yeahnah.org A 72.32.231.8 @ns1.slicehost.net 
+    PASS: yeahnah.org A 208.78.102.114 @ns2.slicehost.net 
+    PASS: yeahnah.org MX ASPMX.L.GOOGLE.COM @ns2.slicehost.net {:priority=>10}
+    PASS: yeahnah.org MX ALT1.ASPMX.L.GOOGLE.COM @ns2.slicehost.net {:priority=>20}
+    PASS: yeahnah.org MX ALT2.ASPMX.L.GOOGLE.COM @ns2.slicehost.net {:priority=>30}
+    PASS: www.yeahnah.org CNAME yeahnah.org @ns2.slicehost.net 
+    PASS: tumble.yeahnah.org A 72.32.231.8 @ns2.slicehost.net 
+    PASS: yeahnah.org A 208.78.102.114  
+    PASS: tumble.yeahnah.org A 72.32.231.8  
+    PASS: yeahnah.org NS ns1.slicehost.net
+    PASS: yeahnah.org NS ns2.slicehost.net
+
+And that's about it! If you're using this library and enjoying it, please drop
+me a line and let me know!

data/lib/lost-socks.rb

@@ -1,7 +1,89 @@
-require "lost-socks/version"
+module LostSocks
 
-module Lost
-  module Socks
-    # Your code goes here...
+  VERSION = "0.0.1"
+
+  def self.delay=(seconds)
+    Verifier.delay = seconds
+  end
+  
+  def self.verify(domain)
+    Verifier.new(domain)
   end
+    
+  class Verifier
+    
+    @@delay = nil
+    
+    def self.delay=(seconds)
+      @@delay = seconds
+    end
+    
+    def initialize(domain)
+      @server = nil
+      @domain = domain
+      yield self if block_given?
+      self
+    end
+    
+    def with_server(server)
+      @server = server
+      yield self if block_given?
+      self
+    end
+    
+    def resolves_to(ip)
+      check! 'A', ip
+    end
+    
+    def is_aliased_to(domain)
+      check! 'CNAME', domain
+    end
+    
+    def maps_mail_to(domain, args = {})
+      check! 'MX', domain, args
+    end
+    
+    # or it.answers_to ??
+    def has_authorative_nameserver_of(domain)
+      check! 'NS', domain
+    end
+    
+  private
+  
+    def check!(query, against, args = {})
+      if ['A', 'CNAME', 'NS'].include?(query)
+        pattern = /#{@domain}\.\s+\d+\s+IN\s+#{query}\s+#{against}/
+      elsif query == 'MX'
+        pattern = /#{@domain}\.\s+\d+\s+IN\s+MX\s+#{args[:priority]}\s+#{against}/
+      else
+        raise "Unsupported query (#{query.inspect}): only A, CNAME and MX."
+      end      
+      send(result!(query) =~ pattern ? :pass! : :fail!, query, against, args)
+    end
+    
+    def result!(query)
+      @last_dig_command = if @server
+        "dig @#{@server} #{@domain} #{query}"
+      else
+        "dig #{@domain} #{query}"
+      end
+      sleep(@@delay) if @@delay
+      @last_dig_output = `#{@last_dig_command}`
+    end
+    
+    def pass!(*args)      
+      report! 'PASS', *args
+    end
+    
+    def fail!(*args)
+      report! 'FAIL', *args
+      puts @last_dig_command
+      puts @last_dig_output
+    end
+    
+    def report!(result, query, against, args = {})
+      puts "#{result}: #{@domain} #{query} #{against} #{"@#{@server}" if @server} #{args.inspect if args.any?}"
+    end
+  end
+
 end

data/lost-socks.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "lost-socks/version"
+require "lost-socks"
 
 Gem::Specification.new do |s|
   s.name        = "lost-socks"
-  s.version     = Lost::Socks::VERSION
+  s.version     = LostSocks::VERSION
   s.authors     = ["Ryan Allen"]
   s.email       = ["ryan@yeahnah.org"]
   s.homepage    = "https://github.com/ryan-allen/lost-socks"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lost-socks
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -23,9 +23,9 @@ files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/lost-socks.rb
-- lib/lost-socks/version.rb
 - lost-socks.gemspec
 homepage: https://github.com/ryan-allen/lost-socks
 licenses: []

data/lib/lost-socks/version.rb

@@ -1,5 +0,0 @@
-module Lost
-  module Socks
-    VERSION = "0.0.0"
-  end
-end