coppertone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bcbc913e28d44152b2f68d954533ec5ece2d454
+  data.tar.gz: f2d0f7ab141c086ceb8476e7e7c091185d3fd67a
+SHA512:
+  metadata.gz: 128de64f9739785af238106d2ed7b8297a3bc98a41e58193833f8c4ec07dcfa402d847de56a4fccc0d4347a437fbbcd1f00f2d276ae93a06fde290dbf4e9746a
+  data.tar.gz: 5e8e211d963dc5f1135a8e870e3b176f9349a220c1d0eac4822c5c0884ed8f91353728b71d8169e17a44352ec7bfb052a11cc8a18b6033402cd247ac42283954

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,7 @@
+language: ruby
+env:
+  - CODECLIMATE_REPO_TOKEN=c860bbaeb7a143f5ab6078e680fa1e210cfe39ab6a0a7a9f21f43162a30911f0
+rvm:
+  - 2.0.0
+  - 2.1.2
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coppertone.gemspec
+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 {yyyy} {name of copyright owner}
+
+   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,58 @@
+# Coppertone
+
+[![Build Status](https://travis-ci.org/petergoldstein/coppertone.svg?branch=master)](https://travis-ci.org/petergoldstein/coppertone)
+[![Test Coverage](https://codeclimate.com/github/petergoldstein/coppertone/badges/coverage.svg)](https://codeclimate.com/github/petergoldstein/coppertone)
+[![Code Climate](https://codeclimate.com/github/petergoldstein/coppertone/badges/gpa.svg)](https://codeclimate.com/github/petergoldstein/coppertone)
+
+A Sender Policy Framework (SPF) toolkit for Ruby.
+
+Coppertone includes tools for parsing SPF DNS records, evaluating the result of SPF checks for received emails, and creating appropriate email headers from the SPF result.  In the future the gem will build on these capabilities to allow deeper analysis of SPF configuration for hosts, senders, and domains.
+
+## Specification Compliance
+
+One of the challenges of writing a gem that is intended to implement a specification - especially one with as long a history as SPF - is determining exactly which version(s) and extensions to the specification the library will support.  Coppertone uses the following guidelines:
+
+1. By default Coppertone follows [RFC 7208](http://tools.ietf.org/html/rfc7208), which is the latest revision of the SPF v1 definition and obsoletes the earlier [RFC 4408](http://tools.ietf.org/html/rfc4408)
+2. The gem explicitly does not support [RFC 4406](http://tools.ietf.org/html/rfc4406), which defines an experimental SPF v2 (Sender ID).  PR requests to add support for this functionality will be rejected.
+3. Coppertone defaults to using the DNS term and lookup limits defined in [RFC 7208](http://tools.ietf.org/html/rfc7208#section-4.6.4), but makes these limits configurable.
+4. Coppertone does not do TLD validation on domains encountered in SPF processing.  Domains are syntactically validated, but the TLD value is not checked against the public access list.
+
+If you'd like to suggest amending these guidelines, please open an issue for discussion.  Suggestions driven by real world behavior - divergences implemented by major mail server vendors or MTAs will be prioritized.
+
+## Requirements
+
+Coppertone supports MRI 2.0 and up - earlier MRI rubies are not supported.  JRuby and Rubinius support is planned, but these VMs are not currently supported.
+
+Coppertone does not require Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coppertone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coppertone
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+We actively seek contributions from the Coppertone community to make this the best possible gem.  Users can contribute by creating a pull request with the requested changes.
+
+Some guidelines:
+
+1. The scope of this gem is limited to the Sender Policy Framework.  New functionality should be restricted to features directly relevant to SPF.
+2. PRs that add functionality or fix bugs must include test coverage for the new functionality or fixed bug.  PRs that don't include such test coverage will not be merged.
+3. PRs should not break existing specs unintentionally.  Only PRs that run green will be merged to master.
+4. Similarly, PRs should not introduce new Rubocop violations.
+5. Please run `bundle exec rake` before submitting your PR and ensure it runs clean.  This will help ensure against inadvertent spec breakage or Rubocop violations.

data/Rakefile

@@ -0,0 +1,140 @@
+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
+
+require 'json'
+require 'yaml'
+require 'fileutils'
+desc 'Parse OpenSPF tests'
+
+def spec_file_name(doc, output_path)
+  description = doc['description']
+  file_name = description.gsub(/[^\w\s_-]+/, '')
+    .gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+    .gsub(/\s+/, '_') + '_spec.rb'
+  File.join(output_path, file_name)
+end
+
+INDENT_STRING = '  '
+def indented_string(num_indents = 1)
+  num_indents.times.map { INDENT_STRING }.join('')
+end
+
+def puts_prefixed_string(f, s, indent = 0)
+  f.write indented_string(indent) unless indent == 0
+  f.puts s
+end
+
+def empty_line(f)
+  puts_prefixed_string(f, '', 0)
+end
+
+def write_zonedata(f, zonedata, indent = 1)
+  puts_prefixed_string(f, 'let(:zonefile) do', indent)
+  puts_prefixed_string(f, zonedata, indent + 1)
+  puts_prefixed_string(f, 'end', indent)
+  empty_line(f)
+  dns_line = 'let(:dns_client) { Coppertone::DNS::MockClient.new(zonefile) }'
+  puts_prefixed_string(f, dns_line, indent)
+  puts_prefixed_string(f, 'let(:options) { { dns_client: dns_client } }',
+                       indent)
+  empty_line(f)
+end
+
+def escape_quote(val)
+  return unless val
+  val.gsub(/'/) { |_s| "\\'" }
+end
+
+def clean_description(description)
+  return unless description
+  description.gsub("\n", ' ').gsub("'", '')
+end
+
+def as_array(val)
+  return [] unless val
+  val.is_a?(Array) ? val : [val]
+end
+
+def write_comment(f, comment, indent)
+  return unless comment
+  comment.lines do |comment_line|
+    puts_prefixed_string(f, "# #{comment_line}", indent)
+  end
+end
+
+def write_result(f, host, mailfrom, helo, indent)
+  spf_result =
+    "Coppertone::SpfService.authenticate_email('#{host}', '#{mailfrom}'," \
+    " '#{helo}', options)"
+  puts_prefixed_string(f, "result = #{spf_result}", indent)
+end
+
+def write_expects(f, results, explanation, indent)
+  results_array = "%i(#{results.join(' ')})"
+  code_expect = "expect(#{results_array}).to include(result.code)"
+  puts_prefixed_string(f, code_expect, indent)
+  return unless explanation
+  exp_expect = "expect(result.explanation).to eq('#{explanation}')"
+  puts_prefixed_string(f, exp_expect, indent)
+end
+
+def normalize_spec_args(spec)
+  helo = escape_quote(spec['helo'])
+  host = escape_quote(spec['host'])
+  mailfrom = escape_quote(spec['mailfrom'])
+  comment = escape_quote(spec['comment'])
+  description = clean_description(spec['description'])
+  results = as_array(spec['result'])
+  explanation = escape_quote(spec['explanation'])
+  [helo, host, mailfrom, comment, description, results, explanation]
+end
+
+def write_spec(f, spec, indent = 1)
+  helo, host, mailfrom, comment, description, results, explanation =
+    normalize_spec_args(spec)
+  puts_prefixed_string(f, "it '#{description}' do", indent)
+  write_comment(f, comment, indent + 1)
+  write_result(f, host, mailfrom, helo, indent + 1)
+  write_expects(f, results, explanation, indent + 1)
+  puts_prefixed_string(f, 'end', indent)
+  empty_line(f)
+end
+
+def write_doc(doc, output_path)
+  open(spec_file_name(doc, output_path), 'w') do |f|
+    puts_prefixed_string(f, "require 'spec_helper'")
+    empty_line(f)
+    description = doc['description']
+    puts_prefixed_string(f, "describe '#{description}' do")
+    write_zonedata(f, doc['zonedata'], 1)
+    doc['tests'].each do |k, spec|
+      spec['description'] ||= k
+      write_spec(f, spec)
+    end
+    puts_prefixed_string(f, 'end')
+  end
+end
+
+task :build_open_spf_test_suite do
+  yml_file_name = 'rfc7208-tests.yml'
+  yml_file_path = File.join(File.dirname(__FILE__), 'spec', yml_file_name)
+  output_path = File.join(File.dirname(__FILE__), 'spec', 'open_spf')
+  FileUtils.mkdir_p(output_path)
+  documents = YAML.load_stream(File.open(yml_file_path).read)
+  documents.each { |doc| write_doc(doc, output_path) }
+end

data/coppertone.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coppertone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coppertone'
+  spec.version       = Coppertone::VERSION
+  spec.authors       = ['Peter M. Goldstein']
+  spec.email         = ['peter.m.goldstein@gmail.com']
+  spec.summary       = 'A Sender Policy Framework (SPF) toolkit'
+  spec.description   = 'Coppertone includes tools for parsing SPF DNS records, evaluating the result of SPF checks for received emails, and creating appropriate email headers from SPF results.'
+  spec.homepage      = 'https://github.com/petergoldstein/coppertone'
+  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_runtime_dependency 'i18n'
+  spec.add_runtime_dependency 'addressable'
+  spec.add_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/coppertone/class_builder.rb

@@ -0,0 +1,20 @@
+module Coppertone
+  # Utility class for building class instances out of a set of
+  # registered types (e.g. mechanisms, modifiers)
+  class ClassBuilder
+    def map
+      @map ||= {}
+    end
+
+    def register(type, klass)
+      map[type] = klass
+    end
+
+    def build(type, attributes)
+      return nil unless type
+      klass = map[type]
+      return nil unless klass
+      klass.create(attributes)
+    end
+  end
+end

data/lib/coppertone/directive.rb

@@ -0,0 +1,38 @@
+require 'coppertone/mechanism'
+require 'coppertone/qualifier'
+
+module Coppertone
+  # Instances of this class represent directive terms, as defined by the
+  # SPF specification (see section 4.6.1).
+  class Directive
+    attr_reader :qualifier, :mechanism
+    def initialize(qualifier, mechanism)
+      @qualifier = qualifier
+      @mechanism = mechanism
+    end
+
+    def evaluate(context, options)
+      code =
+        if mechanism.match?(context, options)
+          qualifier.result_code
+        else
+          Result::NONE
+        end
+      Coppertone::Result.from_directive(self, code)
+    end
+
+    DIRECTIVE_REGEXP = /\A([\+\-\~\?]?)([a-zA-Z0-9]*)((:?)\S*)\z/
+    def self.matching_term(text)
+      return nil if text.include?('=')
+      matches = DIRECTIVE_REGEXP.match(text)
+      return nil unless matches
+      qualifier_txt = matches[1]
+      mechanism_type = matches[2].downcase
+      attributes = matches[3]
+      qualifier = Qualifier.find_by_text(qualifier_txt)
+      mechanism = Mechanism.build(mechanism_type, attributes)
+      return nil unless qualifier && mechanism
+      new(qualifier, mechanism)
+    end
+  end
+end

data/lib/coppertone/dns/error.rb

@@ -0,0 +1,9 @@
+require 'coppertone/error'
+
+module Coppertone
+  module DNS
+    class Error < ::Coppertone::TemperrorError; end
+    class TimeoutError < Error; end
+    class NXDomainError < Error; end
+  end
+end

data/lib/coppertone/dns/mock_client.rb

@@ -0,0 +1,106 @@
+require 'coppertone/error'
+
+module Coppertone
+  module DNS
+    # 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 Coppertone::DNS::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 Coppertone::DNS::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
+end