coppertone 0.0.1

data/spec/sender_identity_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Coppertone::SenderIdentity do
+  it 'should parse an email address into localpart and domain' do
+    si = Coppertone::SenderIdentity.new('user@gmail.com')
+    expect(si.sender).to eq('user@gmail.com')
+    expect(si.localpart).to eq('user')
+    expect(si.domain).to eq('gmail.com')
+  end
+
+  it 'should default localpart to postmaster' do
+    si = Coppertone::SenderIdentity.new('yahoo.com')
+    expect(si.sender).to eq('yahoo.com')
+    expect(si.localpart).to eq('postmaster')
+    expect(si.domain).to eq('yahoo.com')
+  end
+
+  it 'should parse an email address into localpart and domain' do
+    si = Coppertone::SenderIdentity.new('user@gmail.com')
+    expect(si.sender).to eq('user@gmail.com')
+    expect(si.localpart).to eq('user')
+    expect(si.domain).to eq('gmail.com')
+  end
+
+  it 'should not raise an error if the sender is nil' do
+    si = Coppertone::SenderIdentity.new(nil)
+    expect(si.sender).to be_nil
+    expect(si.localpart).to eq('postmaster')
+    expect(si.domain).to be_nil
+  end
+
+  it 'should not raise an error if the sender is blank' do
+    si = Coppertone::SenderIdentity.new('')
+    expect(si.sender).to eq('')
+    expect(si.localpart).to eq('postmaster')
+    expect(si.domain).to eq('')
+  end
+
+  it 'should not raise an error if the sender has a too-long domain' do
+    localpart = 'lymeeater'
+    domain = 'A123456789012345678901234567890123456789'\
+             '012345678901234567890123.example.com'
+    sender = "#{localpart}@#{domain}"
+    si = Coppertone::SenderIdentity.new(sender)
+    expect(si.sender).to eq(sender)
+    expect(si.localpart).to eq(localpart)
+    expect(si.domain).to eq(domain)
+  end
+
+  it 'should not raise an error if the sender has a domain missing labels' do
+    localpart = 'lymeeater'
+    domain = 'A...example.com'
+    sender = "#{localpart}@#{domain}"
+    si = Coppertone::SenderIdentity.new(sender)
+    expect(si.sender).to eq(sender)
+    expect(si.localpart).to eq(localpart)
+    expect(si.domain).to eq(domain)
+  end
+
+  it 'should not raise an error if the sender has a domain literal' do
+    localpart = 'foo'
+    domain = '[1.2.3.5]'
+    sender = "#{localpart}@#{domain}"
+    si = Coppertone::SenderIdentity.new(sender)
+    expect(si.sender).to eq(sender)
+    expect(si.localpart).to eq(localpart)
+    expect(si.domain).to eq(domain)
+  end
+end

data/spec/spec_helper.rb

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

data/spec/term_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Coppertone::Term do
+  context '#build' do
+    it 'should return nil for a nil argument' do
+      expect(Coppertone::Term.build_from_token(nil)).to be_nil
+    end
+
+    it 'should check Directive first' do
+      token = SecureRandom.hex(10)
+      term = double(:term)
+      expect(Coppertone::Directive)
+        .to receive(:matching_term).with(token).and_return(term)
+      expect(Coppertone::Modifier).not_to receive(:matching_term)
+      expect(Coppertone::Term.build_from_token(token)).to eq(term)
+    end
+
+    it 'should fallback to Modifier' do
+      token = SecureRandom.hex(10)
+      term = double(:term)
+      expect(Coppertone::Directive)
+        .to receive(:matching_term).with(token).and_return(nil)
+      expect(Coppertone::Modifier)
+        .to receive(:matching_term).with(token).and_return(term)
+      expect(Coppertone::Term.build_from_token(token)).to eq(term)
+    end
+
+    it 'should propagate errors' do
+      token = SecureRandom.hex(10)
+      expect(Coppertone::Directive)
+        .to receive(:matching_term).with(token)
+        .and_raise(Coppertone::Error)
+      expect do
+        Coppertone::Term.build_from_token(token)
+      end.to raise_error(Coppertone::Error)
+    end
+  end
+end

data/spec/utils/domain_utils_spec.rb

@@ -0,0 +1,60 @@
+# -- encoding : utf-8 --
+
+require 'spec_helper'
+
+describe Coppertone::Utils::DomainUtils do
+  subject { Coppertone::Utils::DomainUtils }
+  context '#valid?' do
+    it 'should validate standard domains' do
+      expect(subject.valid?('gmail.com')).to eq(true)
+      expect(subject.valid?('fermion.mit.edu')).to eq(true)
+      expect(subject.valid?('abc.bit.ly')).to eq(true)
+    end
+
+    it 'should validate domains when they are dot-terminated' do
+      expect(subject.valid?('gmail.com.')).to eq(true)
+      expect(subject.valid?('fermion.mit.edu.')).to eq(true)
+      expect(subject.valid?('abc.bit.ly.')).to eq(true)
+    end
+
+    it 'should reject domains with less than two labels' do
+      expect(subject.valid?('')).to eq(false)
+      expect(subject.valid?('one')).to eq(false)
+    end
+
+    it 'should handle IDNA domains' do
+      expect(subject.valid?('清华大学.cn')).to eq(true)
+      expect(subject.valid?('ジェーピーニック.jp')).to eq(true)
+    end
+  end
+
+  context '#macro_expanded_domain' do
+    it 'returns nil for nil' do
+      expect(subject.macro_expanded_domain(nil)).to be_nil
+    end
+
+    it 'returns nil for a blank string' do
+      expect(subject.macro_expanded_domain('')).to be_nil
+    end
+
+    it 'returns the domain for an ASCII domain' do
+      expect(subject.macro_expanded_domain('fermion.mit.edu'))
+        .to eq('fermion.mit.edu')
+    end
+
+    it 'returns the ASCII domain for an IDNA domain' do
+      expect(subject.macro_expanded_domain('清华大学.cn'))
+        .to eq('xn--xkry9kk1bz66a.cn')
+    end
+
+    it 'truncates overlong domains' do
+      domain_candidate_labels = 50.times.map { "a-#{SecureRandom.hex(2)}" }
+      domain_candidate = domain_candidate_labels.join('.')
+      truncated_labels = domain_candidate_labels.drop(14)
+      truncated_domain = truncated_labels.join('.')
+
+      expect(subject.macro_expanded_domain(domain_candidate))
+        .to eq(truncated_domain)
+    end
+  end
+end

data/spec/utils/host_utils_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Coppertone::Utils::HostUtils do
+  context '#hostname' do
+    let(:raw_hostname) { SecureRandom.hex(10) }
+    let(:no_error_hostname) { SecureRandom.hex(10) }
+    let(:hostname_list) { [no_error_hostname, SecureRandom.hex(10)] }
+
+    before do
+      allow(Socket).to receive(:gethostname).and_return(raw_hostname)
+      Coppertone::Utils::HostUtils.clear_hostname
+    end
+
+    it 'should retrieve the hostname based on gethostbyname' do
+      allow(Socket).to receive(:gethostbyname)
+        .with(raw_hostname).and_return(hostname_list)
+      expect(Coppertone::Utils::HostUtils.hostname).to eq(no_error_hostname)
+      expect(Socket).not_to receive(:gethostname)
+      expect(Socket).not_to receive(:gethostbyname)
+      expect(Coppertone::Utils::HostUtils.hostname).to eq(no_error_hostname)
+    end
+
+    it 'should retrieve the hostname based on gethostname' do
+      expect(Socket).to receive(:gethostbyname)
+        .with(raw_hostname).and_raise(SocketError)
+      expect(Coppertone::Utils::HostUtils.hostname).to eq(raw_hostname)
+      expect(Socket).not_to receive(:gethostname)
+      expect(Socket).not_to receive(:gethostbyname)
+      expect(Coppertone::Utils::HostUtils.hostname).to eq(raw_hostname)
+    end
+  end
+end

data/spec/utils/ip_in_domain_checker_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Coppertone::Utils::IPInDomainChecker do
+end

data/spec/utils/validated_domain_finder_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Coppertone::Utils::ValidatedDomainFinder do
+end

metadata

@@ -0,0 +1,306 @@
+--- !ruby/object:Gem::Specification
+name: coppertone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter M. Goldstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: 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.
+email:
+- peter.m.goldstein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- coppertone.gemspec
+- lib/coppertone.rb
+- lib/coppertone/class_builder.rb
+- lib/coppertone/directive.rb
+- lib/coppertone/dns.rb
+- lib/coppertone/dns/error.rb
+- lib/coppertone/dns/mock_client.rb
+- lib/coppertone/dns/resolv_client.rb
+- lib/coppertone/domain_spec.rb
+- lib/coppertone/error.rb
+- lib/coppertone/ip_address_wrapper.rb
+- lib/coppertone/macro_context.rb
+- lib/coppertone/macro_string.rb
+- lib/coppertone/macro_string/macro_expand.rb
+- lib/coppertone/macro_string/macro_literal.rb
+- lib/coppertone/macro_string/macro_parser.rb
+- lib/coppertone/macro_string/macro_static_expand.rb
+- lib/coppertone/mechanism.rb
+- lib/coppertone/mechanism/a.rb
+- lib/coppertone/mechanism/all.rb
+- lib/coppertone/mechanism/cidr_parser.rb
+- lib/coppertone/mechanism/domain_spec_mechanism.rb
+- lib/coppertone/mechanism/domain_spec_optional.rb
+- lib/coppertone/mechanism/domain_spec_required.rb
+- lib/coppertone/mechanism/domain_spec_with_dual_cidr.rb
+- lib/coppertone/mechanism/exists.rb
+- lib/coppertone/mechanism/include.rb
+- lib/coppertone/mechanism/include_matcher.rb
+- lib/coppertone/mechanism/ip4.rb
+- lib/coppertone/mechanism/ip6.rb
+- lib/coppertone/mechanism/ip_mechanism.rb
+- lib/coppertone/mechanism/mx.rb
+- lib/coppertone/mechanism/ptr.rb
+- lib/coppertone/modifier.rb
+- lib/coppertone/modifier/base.rb
+- lib/coppertone/modifier/exp.rb
+- lib/coppertone/modifier/redirect.rb
+- lib/coppertone/modifier/unknown.rb
+- lib/coppertone/qualifier.rb
+- lib/coppertone/record.rb
+- lib/coppertone/record_evaluator.rb
+- lib/coppertone/record_finder.rb
+- lib/coppertone/request.rb
+- lib/coppertone/request_context.rb
+- lib/coppertone/request_count_limiter.rb
+- lib/coppertone/result.rb
+- lib/coppertone/sender_identity.rb
+- lib/coppertone/spf_service.rb
+- lib/coppertone/term.rb
+- lib/coppertone/utils.rb
+- lib/coppertone/utils/domain_utils.rb
+- lib/coppertone/utils/host_utils.rb
+- lib/coppertone/utils/ip_in_domain_checker.rb
+- lib/coppertone/utils/validated_domain_finder.rb
+- lib/coppertone/version.rb
+- lib/resolv/dns/resource/in/spf.rb
+- spec/directive_spec.rb
+- spec/dns/resolv_client_spec.rb
+- spec/domain_spec_spec.rb
+- spec/ip_address_wrapper_spec.rb
+- spec/macro_context_spec.rb
+- spec/macro_string/macro_expand_spec.rb
+- spec/macro_string/macro_literal_spec.rb
+- spec/macro_string/macro_static_expand_spec.rb
+- spec/macro_string_spec.rb
+- spec/mechanism/a_spec.rb
+- spec/mechanism/all_spec.rb
+- spec/mechanism/exists_spec.rb
+- spec/mechanism/include_spec.rb
+- spec/mechanism/ip4_spec.rb
+- spec/mechanism/ip6_spec.rb
+- spec/mechanism/mx_spec.rb
+- spec/mechanism/ptr_spec.rb
+- spec/mechanism_spec.rb
+- spec/modifier_spec.rb
+- spec/open_spf/ALL_mechanism_syntax_spec.rb
+- spec/open_spf/A_mechanism_syntax_spec.rb
+- spec/open_spf/EXISTS_mechanism_syntax_spec.rb
+- spec/open_spf/IP4_mechanism_syntax_spec.rb
+- spec/open_spf/IP6_mechanism_syntax_spec.rb
+- spec/open_spf/Include_mechanism_semantics_and_syntax_spec.rb
+- spec/open_spf/Initial_processing_spec.rb
+- spec/open_spf/MX_mechanism_syntax_spec.rb
+- spec/open_spf/Macro_expansion_rules_spec.rb
+- spec/open_spf/PTR_mechanism_syntax_spec.rb
+- spec/open_spf/Processing_limits_spec.rb
+- spec/open_spf/Record_evaluation_spec.rb
+- spec/open_spf/Record_lookup_spec.rb
+- spec/open_spf/Selecting_records_spec.rb
+- spec/open_spf/Semantics_of_exp_and_other_modifiers_spec.rb
+- spec/open_spf/Test_cases_from_implementation_bugs_spec.rb
+- spec/qualifier_spec.rb
+- spec/record_evaluator_spec.rb
+- spec/record_finder_spec.rb
+- spec/record_spec.rb
+- spec/request_context_spec.rb
+- spec/request_count_limiter_spec.rb
+- spec/result_spec.rb
+- spec/rfc7208-tests.yml
+- spec/sender_identity_spec.rb
+- spec/spec_helper.rb
+- spec/term_spec.rb
+- spec/utils/domain_utils_spec.rb
+- spec/utils/host_utils_spec.rb
+- spec/utils/ip_in_domain_checker_spec.rb
+- spec/utils/validated_domain_finder_spec.rb
+homepage: https://github.com/petergoldstein/coppertone
+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: A Sender Policy Framework (SPF) toolkit
+test_files:
+- spec/directive_spec.rb
+- spec/dns/resolv_client_spec.rb
+- spec/domain_spec_spec.rb
+- spec/ip_address_wrapper_spec.rb
+- spec/macro_context_spec.rb
+- spec/macro_string/macro_expand_spec.rb
+- spec/macro_string/macro_literal_spec.rb
+- spec/macro_string/macro_static_expand_spec.rb
+- spec/macro_string_spec.rb
+- spec/mechanism/a_spec.rb
+- spec/mechanism/all_spec.rb
+- spec/mechanism/exists_spec.rb
+- spec/mechanism/include_spec.rb
+- spec/mechanism/ip4_spec.rb
+- spec/mechanism/ip6_spec.rb
+- spec/mechanism/mx_spec.rb
+- spec/mechanism/ptr_spec.rb
+- spec/mechanism_spec.rb
+- spec/modifier_spec.rb
+- spec/open_spf/ALL_mechanism_syntax_spec.rb
+- spec/open_spf/A_mechanism_syntax_spec.rb
+- spec/open_spf/EXISTS_mechanism_syntax_spec.rb
+- spec/open_spf/IP4_mechanism_syntax_spec.rb
+- spec/open_spf/IP6_mechanism_syntax_spec.rb
+- spec/open_spf/Include_mechanism_semantics_and_syntax_spec.rb
+- spec/open_spf/Initial_processing_spec.rb
+- spec/open_spf/MX_mechanism_syntax_spec.rb
+- spec/open_spf/Macro_expansion_rules_spec.rb
+- spec/open_spf/PTR_mechanism_syntax_spec.rb
+- spec/open_spf/Processing_limits_spec.rb
+- spec/open_spf/Record_evaluation_spec.rb
+- spec/open_spf/Record_lookup_spec.rb
+- spec/open_spf/Selecting_records_spec.rb
+- spec/open_spf/Semantics_of_exp_and_other_modifiers_spec.rb
+- spec/open_spf/Test_cases_from_implementation_bugs_spec.rb
+- spec/qualifier_spec.rb
+- spec/record_evaluator_spec.rb
+- spec/record_finder_spec.rb
+- spec/record_spec.rb
+- spec/request_context_spec.rb
+- spec/request_count_limiter_spec.rb
+- spec/result_spec.rb
+- spec/rfc7208-tests.yml
+- spec/sender_identity_spec.rb
+- spec/spec_helper.rb
+- spec/term_spec.rb
+- spec/utils/domain_utils_spec.rb
+- spec/utils/host_utils_spec.rb
+- spec/utils/ip_in_domain_checker_spec.rb
+- spec/utils/validated_domain_finder_spec.rb