rspec-dns 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@rspec-dns --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2012 Seth Vargo, CustomInk, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.markdown

@@ -0,0 +1,94 @@
+rspec-dns
+=========
+RSpec DNS is an rspec plugin for easy DNS testing. It uses the built-in Ruby 1.9 library Resolv and is customizable.
+
+Installation
+------------
+If you're using bundler, add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rspec-dns'
+```
+
+Don't forget to run the `bundle` command to install.
+
+Or install it manually with:
+
+    $ gem install rspec-dns
+
+Usage
+-----
+RSpec DNS is best described by example. First, require `rspec-dns` in your `spec_helper.rb`:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec'
+require 'rspec-dns'
+```
+
+Then, create a spec like this:
+
+```ruby
+require 'spec_helper'
+
+describe 'www.example.com' do
+  it { should have_dns.with_type('TXT').and_ttl(300).and_data('a=b') }
+end
+```
+
+Or group all your DNS tests into a single file or context:
+
+```ruby
+require 'spec_helper'
+
+describe 'DNS tests' do
+  'www.example.com'.should have_dns.with_type('TXT').and_ttl(300).and_data('a=b')
+  'www.example.com'.should have_dns.with_type('A').and_ttl(300).and_value('1.2.3.4')
+end
+```
+
+### Chain Methods
+All of the method chains are actually [Resolv](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/resolv/rdoc/index.html) attributes on the record. You can prefix them with `and_`, `with_`, `and_with` or whatever your heart desires. The predicate is what is checked. The rest is syntactic sugar.
+
+Depending on the type of record, the following attributes may be available:
+
+- address
+- bitmap
+- cpu
+- data
+- emailbx
+- exchange
+- expire
+- minimum
+- mname
+- name
+- os
+- port
+- preference
+- priority
+- protocol
+- refresh
+- retry
+- rmailbx
+- rname
+- serial
+- target
+- ttl
+- type
+- weight
+
+If you try checking an attribute on a record that is non-existent (like checking the `rmailbx` on an `A` record), you'll get an error like this:
+
+```text
+Failure/Error: it { should have_dns.with_type('TXT').and_ftl(300).and_data('a=b') }
+     NoMethodError:
+       undefined method `rmailbx' for #<Resolv::DNS::Resource::IN::A:0x007fb56302ed90>
+```
+
+For this reason, you should always check the `type` attribute first in your chain.
+
+Contributing
+------------
+1. Fork the project on github
+2. Create your feature branch
+3. Open a Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rspec-dns/have_dns.rb

@@ -0,0 +1,99 @@
+require 'resolv'
+
+RSpec::Matchers.define :have_dns do
+  match do |dns|
+    @dns = dns
+
+    _records.any? do |record|
+      _options.all? do |option, value|
+        # Resolv returns an object instead of just the IP
+        if option == :address
+          record.send(option).to_s == value.to_s
+        else
+          record.send(option) == value
+        end
+      end
+    end
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{actual} to have: #{_pretty_print_options}, but did not. other records were: #{_pretty_print_records}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{actual} not to have #{_pretty_print_options}, but it did"
+  end
+
+  description do
+    'have the correct dns entries'
+  end
+
+  def method_missing(m, *args, &block)
+    if m.to_s =~ /(and\_with|and|with)?\_(.*)$/
+      _options[$2.to_sym] = args.first
+      self
+    else
+      super
+    end
+  end
+
+  def _config
+    @config ||= if File.exists?(_config_file)
+      config = _symbolize_keys(YAML::load(ERB.new(File.read(_config_file) ).result))
+    else
+      nil
+    end
+  end
+
+  def _config_file
+    File.join('config', 'dns.yml')
+  end
+
+  def _symbolize_keys(hash)
+    hash.inject({}){|result, (key, value)|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+      new_value = case value
+                  when Hash then _symbolize_keys(value)
+                  else value
+                  end
+      result[new_key] = new_value
+      result
+    }
+  end
+
+  def _options
+    @_options ||= {}
+  end
+
+  def _pretty_print_options
+    "\n  (#{_options.sort.collect{ |k,v| "#{k}:#{v.inspect}" }.join(', ')})\n"
+  end
+
+  def _records
+    @_records ||= begin
+      Timeout::timeout(1) {
+        if _config.nil?
+          Resolv::DNS.new.getresources(@dns, Resolv::DNS::Resource::IN::ANY)
+        else
+          Resolv::DNS.new(_config).getresources(@dns, Resolv::DNS::Resource::IN::ANY)
+        end
+      }
+    rescue
+      $stderr.puts "Connection timed out for #{@dns}"
+      []
+    end
+  end
+
+  def _pretty_print_records
+    "\n" + _records.collect { |record| _pretty_print_record(record) }.join("\n")
+  end
+
+  def _pretty_print_record(record)
+    '  (' + %w(address bitmap cpu data emailbx exchange expire minimum mname name os port preference priority protocol refresh retry rmailbx rname serial target ttl type weight).collect do |method|
+      "#{method}:#{record.send(method.to_sym).to_s.inspect}" if record.respond_to?(method.to_sym)
+    end.compact.join(', ') + ')'
+  end
+end

data/lib/rspec-dns.rb

@@ -0,0 +1,5 @@
+require 'erb'
+require 'resolv'
+require 'rspec/expectations'
+
+require 'rspec-dns/have_dns'

data/rspec-dns.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.version       = '0.0.1'
+  s.name          = 'rspec-dns'
+  s.author        = 'Seth Vargo'
+  s.email         = 'sethvargo@gmail.com'
+  s.description   = 'Easily test your DNS entries with RSpec'
+  s.summary       = 'rspec-dns provides an easy-to-use DSL for testing your DNS records are responding as they should.'
+  s.homepage      = 'https://github.com/customink/rspec-dns'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rake'
+  s.add_dependency 'rspec', '>= 2.9'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rspec-dns
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Easily test your DNS entries with RSpec
+email: sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/rspec-dns.rb
+- lib/rspec-dns/have_dns.rb
+- rspec-dns.gemspec
+homepage: https://github.com/customink/rspec-dns
+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: -1474966448062495488
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1474966448062495488
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: rspec-dns provides an easy-to-use DSL for testing your DNS records are responding
+  as they should.
+test_files: []