dns_adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d8e3fd1654dd5ce7799fa3211d210ba4b633c67
+  data.tar.gz: f72a3cabad09a65366f89b55fc6fca4111aae82c
+SHA512:
+  metadata.gz: 1630678f66915f648dceee32bc418021c3de846954824b03ef3bf0670b720f30d0944b1d9bc66457f706ea285a448418bc605597085e91b43165681993e773c9
+  data.tar.gz: 2420893ee8679b6b13c3c8b21f62d35af148d474ed5f06dcdeb6ab7a8fd03d509f85255a4580213cb262186273e3c0c8530adb77eb79c13671e853de37738af0

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+env:
+  - CODECLIMATE_REPO_TOKEN=9881d1116b64b55a16845046a4a2dc43f12203d7201a33ce92fec4b7732e3c93
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', group: :test, require: false
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Peter M. Goldstein 
+
+   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.md

@@ -0,0 +1,35 @@
+# DNSAdapter
+
+[![Build Status](https://travis-ci.org/petergoldstein/dns_adapter.svg?branch=master)](https://travis-ci.org/petergoldstein/dns_adapter)
+[![Test Coverage](https://codeclimate.com/github/petergoldstein/dns_adapter/badges/coverage.svg)](https://codeclimate.com/github/petergoldstein/dns_adapter)
+[![Code Climate](https://codeclimate.com/github/petergoldstein/dns_adapter/badges/gpa.svg)](https://codeclimate.com/github/petergoldstein/dns_adapter)
+
+An adapter layer for DNS queries that makes it simple to swap in different DNS providers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dns_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dns_adapter
+
+## Usage
+
+DNSAdapter contains a set of useful adapter classes that present a common set of return types and errors for DNS services.  To use the gem, simply instantiate an instance of the desired adapter class.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dns_adapter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color', '--format doc']
+end
+
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/dns_adapter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dns_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dns_adapter'
+  spec.version       = DNSAdapter::VERSION
+  spec.authors       = ['Peter M. Goldstein']
+  spec.email         = ['peter.m.goldstein@gmail.com']
+  spec.summary       = 'An adapter layer for DNS queries.'
+  spec.description   = 'An adapter layer for DNS queries.'
+  spec.homepage      = 'https://github.com/petergoldstein/dns_adapter'
+  spec.license       = 'Apache'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/dns_adapter/error.rb

@@ -0,0 +1,5 @@
+module DNSAdapter
+  class Error < ::StandardError; end
+  class TimeoutError < Error; end
+  class NXDomainError < Error; end
+end

data/lib/dns_adapter/mock_client.rb

@@ -0,0 +1,104 @@
+require 'dns_adapter/error'
+
+module DNSAdapter
+  # A mock client for use in tests.
+  class MockClient
+    def initialize(zone_data)
+      @zone_data = {}
+      zone_data.each do |k, v|
+        @zone_data[k.downcase] = v.dup
+      end
+    end
+
+    def fetch_a_records(domain)
+      fetch_records(domain, 'A')
+    end
+
+    def fetch_aaaa_records(domain)
+      fetch_records(domain, 'AAAA')
+    end
+
+    def fetch_mx_records(domain)
+      fetch_records(domain, 'MX')
+    end
+
+    def fetch_ptr_records(arpa_address)
+      fetch_records(arpa_address, 'PTR')
+    end
+
+    def fetch_txt_records(domain)
+      fetch_records(domain, 'TXT')
+    end
+
+    def fetch_spf_records(domain)
+      fetch_records(domain, 'SPF')
+    end
+
+    def fetch_records(domain, type)
+      record_set = find_records_for_domain(domain)
+      return [] if record_set.empty?
+      records = records_for_type(record_set, type)
+      if records.empty?
+        check_for_timeout(record_set)
+      else
+        formatted_records(records, type)
+      end
+    end
+
+    private
+
+    def normalize_domain(domain)
+      return if domain.blank?
+      domain = domain[0...-1] if domain[domain.length - 1] == '.'
+      domain.downcase
+    end
+
+    def find_records_for_domain(domain)
+      return [] if domain.blank?
+      @zone_data[normalize_domain(domain)] || []
+    end
+
+    def records_for_type(record_set, type)
+      record_set.select do |r|
+        r.is_a?(Hash) && r[type] && r[type] != 'NONE'
+      end
+    end
+
+    TIMEOUT = 'TIMEOUT'
+    def check_for_timeout(record_set)
+      return [] if record_set.select { |r| r == TIMEOUT }.empty?
+      fail DNSAdapter::TimeoutError
+    end
+
+    RECORD_TYPE_TO_ATTR_NAME_MAP = {
+      'A' => :address,
+      'AAAA' => :address,
+      'MX' => :exchange,
+      'PTR' => :name,
+      'SPF' => :text,
+      'TXT' => :text
+    }
+
+    def formatted_records(records, type)
+      records.map do |r|
+        val = r[type]
+        fail DNSAdapter::TimeoutError if val == TIMEOUT
+        val = normalize_value(val, type)
+        {
+          type: type,
+          RECORD_TYPE_TO_ATTR_NAME_MAP[type] => val
+        }
+      end
+    end
+
+    def normalize_value(value, type)
+      if type == 'MX' && value.is_a?(Array)
+        value.last
+      elsif (type == 'TXT' || type == 'SPF') && value.is_a?(Array)
+        value.join('')
+      else
+        value
+      end
+    end
+  end
+end

data/lib/dns_adapter/resolv_client.rb

@@ -0,0 +1,108 @@
+require 'resolv'
+require 'resolv/dns/resource/in/spf'
+
+module DNSAdapter
+  # An adapter client for the internal Resolv DNS client.
+  class ResolvClient
+    def fetch_a_records(domain)
+      fetch_a_type_records(domain, 'A')
+    end
+
+    def fetch_aaaa_records(domain)
+      fetch_a_type_records(domain, 'AAAA')
+    end
+
+    def fetch_mx_records(domain)
+      fetch_records(domain, 'MX') do |record|
+        {
+          type: 'MX',
+          exchange: record.exchange.to_s
+        }
+      end
+    end
+
+    def fetch_ptr_records(arpa_address)
+      fetch_records(arpa_address, 'PTR') do |record|
+        {
+          type: 'PTR',
+          name: record.name.to_s
+        }
+      end
+    end
+
+    def fetch_txt_records(domain)
+      fetch_txt_type_records(domain, 'TXT')
+    end
+
+    def fetch_spf_records(domain)
+      fetch_txt_type_records(domain, 'SPF')
+    end
+
+    private
+
+    def fetch_a_type_records(domain, type)
+      fetch_records(domain, type) do |record|
+        {
+          type: type,
+          address: record.address.to_s
+        }
+      end
+    end
+
+    def fetch_txt_type_records(domain, type)
+      fetch_records(domain, type) do |record|
+        {
+          type: type,
+          # Use strings.join('') to avoid JRuby issue where
+          # data only returns the first string
+          text: record.strings.join('')
+        }
+      end
+    end
+
+    def fetch_records(domain, type, &block)
+      records = dns_lookup(domain, type)
+      records.map(&block)
+    end
+
+    TRAILING_DOT_REGEXP = /\.\z/
+    def normalize_domain(domain)
+      (domain.sub(TRAILING_DOT_REGEXP, '') || domain).downcase
+    end
+
+    def dns_lookup(domain, rr_type)
+      domain = normalize_domain(domain)
+      resources = getresources(domain, rr_type)
+
+      unless resources
+        fail DNSAdapter::Error,
+             "Unknown error on DNS '#{rr_type}' lookup of '#{domain}'"
+      end
+
+      resources
+    end
+
+    def getresources(domain, rr_type)
+      rr_class = self.class.type_class(rr_type)
+      dns_resolver.getresources(domain, rr_class)
+    rescue Resolv::ResolvTimeout
+      raise DNSAdapter::TimeoutError,
+            "Time-out on DNS '#{rr_type}' lookup of '#{domain}'"
+    rescue Resolv::ResolvError
+      raise DNSAdapter::Error, "Error on DNS lookup of '#{domain}'"
+    end
+
+    SUPPORTED_RR_TYPES = %w(A AAAA MX PTR TXT SPF)
+    def self.type_class(rr_type)
+      if SUPPORTED_RR_TYPES.include?(rr_type)
+        Resolv::DNS::Resource::IN.const_get(rr_type)
+      else
+        fail ArgumentError, "Unknown RR type: #{rr_type}"
+      end
+    end
+
+    def dns_resolver
+      @dns_resolver ||= Resolv::DNS.new
+    end
+  end
+end

data/lib/dns_adapter/version.rb

@@ -0,0 +1,3 @@
+module DNSAdapter
+  VERSION = '0.0.1'
+end

data/lib/dns_adapter.rb

@@ -0,0 +1,8 @@
+require 'dns_adapter/version'
+require 'dns_adapter/error'
+require 'dns_adapter/mock_client'
+require 'dns_adapter/resolv_client'
+
+# A useful adapter interface for hiding DNS implementations
+module DNSAdapter
+end

data/lib/resolv/dns/resource/in/spf.rb

@@ -0,0 +1,15 @@
+require 'resolv'
+
+class Resolv
+  class DNS
+    class Resource
+      module IN
+        # DNS record type for SPF records
+        class SPF < Resolv::DNS::Resource::IN::TXT
+          # resolv.rb doesn't define an SPF resource type.
+          TypeValue = 99 # rubocop:disable Style/ConstantName
+        end
+      end
+    end
+  end
+end

data/spec/resolv_client_spec.rb

@@ -0,0 +1,307 @@
+require 'spec_helper'
+
+describe DNSAdapter::ResolvClient do
+  subject { DNSAdapter::ResolvClient.new }
+  let(:mock_resolver) { double(:resolver) }
+
+  context '#fetch_a_records' do
+    let(:first_a_addr) { Resolv::IPv4.new([127, 0, 0, 1].pack('CCCC')) }
+    let(:first_a_record) { Resolv::DNS::Resource::IN::A.new(first_a_addr) }
+    let(:second_a_addr) { Resolv::IPv4.new([192, 168, 8, 14].pack('CCCC')) }
+    let(:second_a_record) { Resolv::DNS::Resource::IN::A.new(second_a_addr) }
+    let(:record_list) { [first_a_record, second_a_record] }
+    let(:domain) { 'example.com' }
+    let(:domain_with_trailing) { "#{domain}." }
+
+    it 'should map the Resolv classes to a set of hashes' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::A).and_return(record_list)
+      results = subject.fetch_a_records(domain)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'A' })
+      expect(results.map { |x| x[:address] })
+        .to eq(record_list.map(&:address).map(&:to_s))
+    end
+
+    it 'should map when the domain has a trailing dot' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::A).and_return(record_list)
+      results = subject.fetch_a_records(domain_with_trailing)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'A' })
+      expect(results.map { |x| x[:address] })
+        .to eq(record_list.map(&:address).map(&:to_s))
+    end
+
+    it 'should map the Resolv errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::A)
+        .and_raise(Resolv::ResolvError)
+      expect do
+        subject.fetch_a_records(domain_with_trailing)
+      end.to raise_error(DNSAdapter::Error)
+    end
+
+    it 'should map the Resolv timeout errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::A)
+        .and_raise(Resolv::ResolvTimeout)
+      expect do
+        subject.fetch_a_records(domain_with_trailing)
+      end.to raise_error(DNSAdapter::TimeoutError)
+    end
+  end
+
+  context '#fetch_aaaa_records' do
+    let(:first_aaaa_addr) do
+      Resolv::IPv6.create('FE80:10:1:1:202:B3FF:FE1E:8329')
+    end
+    let(:first_aaaa_record) do
+      Resolv::DNS::Resource::IN::AAAA.new(first_aaaa_addr)
+    end
+    let(:second_aaaa_addr) do
+      Resolv::IPv6.create('AB61:10:111:891:4202:B3FF:FE1E:7329')
+    end
+    let(:second_aaaa_record) do
+      Resolv::DNS::Resource::IN::AAAA.new(second_aaaa_addr)
+    end
+    let(:record_list) { [first_aaaa_record, second_aaaa_record] }
+    let(:domain) { 'example.com' }
+    let(:domain_with_trailing) { "#{domain}." }
+
+    it 'should map the Resolv classes to a set of hashes' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::AAAA).and_return(record_list)
+      results = subject.fetch_aaaa_records(domain)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'AAAA' })
+      expect(results.map { |x| x[:address] })
+        .to eq(record_list.map(&:address).map(&:to_s))
+    end
+
+    it 'should map when the domain has a trailing dot' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::AAAA).and_return(record_list)
+      results = subject.fetch_aaaa_records(domain_with_trailing)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'AAAA' })
+      expect(results.map { |x| x[:address] })
+        .to eq(record_list.map(&:address).map(&:to_s))
+    end
+
+    it 'should map the Resolv errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::AAAA)
+        .and_raise(Resolv::ResolvError)
+      expect { subject.fetch_aaaa_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::Error)
+    end
+
+    it 'should map the Resolv timeout errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::AAAA)
+        .and_raise(Resolv::ResolvTimeout)
+      expect { subject.fetch_aaaa_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::TimeoutError)
+    end
+  end
+
+  context '#fetch_mx_records' do
+    let(:first_mx_name) do
+      Resolv::DNS::Name.create('alt1.aspmx.l.google.com.')
+    end
+    let(:first_mx_record) do
+      Resolv::DNS::Resource::IN::MX.new(20, first_mx_name)
+    end
+    let(:second_mx_name) do
+      Resolv::DNS::Name.create('aspmx.l.google.com')
+    end
+    let(:second_mx_record) do
+      Resolv::DNS::Resource::IN::MX.new(10, second_mx_name)
+    end
+    let(:record_list) { [first_mx_record, second_mx_record] }
+    let(:domain) { 'example.com' }
+    let(:domain_with_trailing) { "#{domain}." }
+
+    it 'should map the Resolv classes to a set of hashes' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::MX).and_return(record_list)
+      results = subject.fetch_mx_records(domain)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'MX' })
+      expect(results.map { |x| x[:exchange] })
+        .to eq(record_list.map(&:exchange).map(&:to_s))
+    end
+
+    it 'should map when the domain has a trailing dot' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::MX).and_return(record_list)
+      results = subject.fetch_mx_records(domain_with_trailing)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'MX' })
+      expect(results.map { |x| x[:exchange] })
+        .to eq(record_list.map(&:exchange).map(&:to_s))
+    end
+
+    it 'should map the Resolv errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::MX).and_raise(Resolv::ResolvError)
+      expect { subject.fetch_mx_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::Error)
+    end
+
+    it 'should map the Resolv timeout errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::MX)
+        .and_raise(Resolv::ResolvTimeout)
+      expect { subject.fetch_mx_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::TimeoutError)
+    end
+  end
+
+  context '#fetch_txt_records' do
+    let(:first_txt_string) { SecureRandom.hex(10) }
+    let(:first_txt_record) do
+      Resolv::DNS::Resource::IN::TXT.new(first_txt_string)
+    end
+    let(:second_txt_string) { SecureRandom.hex(10) }
+    let(:second_txt_string_array) do
+      [SecureRandom.hex(10), SecureRandom.hex(10)]
+    end
+    let(:second_txt_record) do
+      Resolv::DNS::Resource::IN::TXT.new(second_txt_string,
+                                         second_txt_string_array)
+    end
+    let(:record_list) { [first_txt_record, second_txt_record] }
+    let(:domain) { 'example.com' }
+    let(:domain_with_trailing) { "#{domain}." }
+
+    it 'should map the Resolv classes to a set of hashes' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+                               .with(domain, Resolv::DNS::Resource::IN::TXT)
+                               .and_return(record_list)
+      results = subject.fetch_txt_records(domain)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'TXT' })
+      expect(results.map { |x| x[:text] }).to eq(
+        [first_txt_string,
+         ([second_txt_string] + second_txt_string_array).join('')])
+    end
+
+    it 'should map when the domain has a trailing dot' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+                               .with(domain, Resolv::DNS::Resource::IN::TXT)
+                               .and_return(record_list)
+      results = subject.fetch_txt_records(domain_with_trailing)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'TXT' })
+      expect(results.map { |x| x[:text] }).to eq(
+        [first_txt_string,
+         ([second_txt_string] + second_txt_string_array).join('')])
+    end
+
+    it 'should map the Resolv errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::TXT)
+        .and_raise(Resolv::ResolvError)
+      expect { subject.fetch_txt_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::Error)
+    end
+
+    it 'should map the Resolv timeout errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::TXT)
+        .and_raise(Resolv::ResolvTimeout)
+      expect { subject.fetch_txt_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::TimeoutError)
+    end
+  end
+
+  context '#fetch_spf_records' do
+    let(:first_spf_string) { SecureRandom.hex(10) }
+    let(:first_spf_record) do
+      Resolv::DNS::Resource::IN::TXT.new(first_spf_string)
+    end
+    let(:second_spf_string) { SecureRandom.hex(10) }
+    let(:second_spf_string_array) do
+      [SecureRandom.hex(10), SecureRandom.hex(10)]
+    end
+    let(:second_spf_record) do
+      Resolv::DNS::Resource::IN::SPF.new(second_spf_string,
+                                         second_spf_string_array)
+    end
+    let(:record_list) { [first_spf_record, second_spf_record] }
+    let(:domain) { 'example.com' }
+    let(:domain_with_trailing) { "#{domain}." }
+
+    it 'should map the Resolv classes to a set of hashes' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+                               .with(domain, Resolv::DNS::Resource::IN::SPF)
+                               .and_return(record_list)
+      results = subject.fetch_spf_records(domain)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'SPF' })
+      expect(results.map { |x| x[:text] }).to eq(
+        [first_spf_string,
+         ([second_spf_string] + second_spf_string_array).join('')])
+    end
+
+    it 'should map when the domain has a trailing dot' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+                               .with(domain, Resolv::DNS::Resource::IN::SPF)
+                               .and_return(record_list)
+      results = subject.fetch_spf_records(domain_with_trailing)
+      expect(results.size).to eq(record_list.length)
+      expect(results.map { |x| x[:type] })
+        .to eq(record_list.length.times.map { 'SPF' })
+      expect(results.map { |x| x[:text] }).to eq(
+        [first_spf_string,
+         ([second_spf_string] + second_spf_string_array).join('')])
+    end
+
+    it 'should map the Resolv errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::SPF)
+        .and_raise(Resolv::ResolvError)
+      expect { subject.fetch_spf_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::Error)
+    end
+
+    it 'should map the Resolv timeout errors to Coppertone errors' do
+      expect(Resolv::DNS).to receive(:new).and_return(mock_resolver)
+      expect(mock_resolver).to receive(:getresources)
+        .with(domain, Resolv::DNS::Resource::IN::SPF)
+        .and_raise(Resolv::ResolvTimeout)
+      expect { subject.fetch_spf_records(domain_with_trailing) }
+        .to raise_error(DNSAdapter::TimeoutError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start || SimpleCov.start
+
+require 'dns_adapter'
+
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: dns_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter M. Goldstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An adapter layer for DNS queries.
+email:
+- peter.m.goldstein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dns_adapter.gemspec
+- lib/dns_adapter.rb
+- lib/dns_adapter/error.rb
+- lib/dns_adapter/mock_client.rb
+- lib/dns_adapter/resolv_client.rb
+- lib/dns_adapter/version.rb
+- lib/resolv/dns/resource/in/spf.rb
+- spec/resolv_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/petergoldstein/dns_adapter
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: An adapter layer for DNS queries.
+test_files:
+- spec/resolv_client_spec.rb
+- spec/spec_helper.rb