spf-query 0.0.1

data/spec/query_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'spf/query/query'
+
+describe SPF::Query do
+  subject { described_class }
+
+  describe ".query" do
+    let(:domain) { 'gmail.com' }
+
+    it "should return the first SPF record" do
+      expect(subject.query(domain)).to be == %{v=spf1 redirect=_spf.google.com}
+    end
+
+    context "when _spf.domain.com exists" do
+      let(:domain) { 'google.com' }
+
+      it "should return the first SPF record" do
+        expect(subject.query(domain)).to be == %{v=spf1 include:_netblocks.google.com include:_netblocks2.google.com include:_netblocks3.google.com ~all}
+      end
+    end
+
+    context "when the domain has a SPF type record" do
+      let(:domain) { 'getlua.com' }
+
+      it "should prefer the SPF type record over other TXT records" do
+        expect(subject.query(domain)).to be == %{v=spf1 include:mail.zendesk.com include:servers.mcsv.net include:_spf.google.com include:sendgrid.net include:mktomail.com ~all}
+      end
+    end
+
+    context "when given an invalid domain" do
+      let(:domain) { 'foo.bar.com' }
+
+      it "should return nil" do
+        expect(subject.query(domain)).to be_nil
+      end
+    end
+  end
+end

data/spec/record_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+require 'spf/query/record'
+
+describe SPF::Query::Record do
+  let(:spf) do
+    %{v=spf1 ip4:199.16.156.0/22 ip4:199.59.148.0/22 ip4:8.25.194.0/23 ip4:8.25.196.0/23 ip4:204.92.114.203 ip4:204.92.114.204/31 ip4:107.20.52.15 ip4:23.21.83.90 include:_spf.google.com include:_thirdparty.twitter.com all}
+  end
+
+  subject { described_class.parse(spf) }
+
+  describe "#initialize" do
+    let(:version) { :spf1 }
+
+    let(:ip4_rules) do
+      [
+        Mechanism.new(:ip4, value: IP.new('199.16.156.0', 22)),
+        Mechanism.new(:ip4, value: IP.new('199.59.148.0', 22)),
+        Mechanism.new(:ip4, value: IP.new('8.25.194.0',   23)),
+        Mechanism.new(:ip4, value: IP.new('8.25.196.0',   23)),
+        Mechanism.new(:ip4, value: IP.new('204.92.114.203')),
+        Mechanism.new(:ip4, value: IP.new('204.92.114.204', 31)),
+        Mechanism.new(:ip4, value: IP.new('107.20.52.15')),
+        Mechanism.new(:ip4, value: IP.new('23.21.83.90')),
+      ]
+    end
+
+    let(:include_rules) do
+      [
+        Mechanism.new(:include, value: '_spf.google.com'),
+        Mechanism.new(:include, value: '_thirdparty.twitter.com'),
+      ]
+    end
+
+    let(:all_rule) { Mechanism.new(:all) }
+    let(:rules) { ip4_rules + include_rules + [all_rule] }
+
+    subject { described_class.new(version,rules) }
+
+    it "should set version" do
+      expect(subject.version).to be version
+    end
+
+    it "should set rules" do
+      expect(subject.rules).to be rules
+    end
+
+    describe "#mechanisms" do
+      subject { super().mechanisms }
+
+      it "should contain every Mechanism object" do
+        expect(subject).to all(be_a(Mechanism))
+      end
+    end
+
+    describe "#modifiers" do
+      pending "need to add modifiers"
+    end
+
+    describe "#all" do
+      subject { super().all }
+
+      it "should find the last all mechanism" do
+        expect(subject).to be all_rule
+      end
+    end
+
+    describe "#include" do
+      subject { super().include }
+
+      it "should find all include: mechanisms" do
+        expect(subject).to be == include_rules
+      end
+    end
+
+    describe "#a" do
+      subject { super().a }
+
+      pending "need to add a: mechanisms" do
+        it "should find all a: mechanisms" do
+          expect(subject).to be == a
+        end
+      end
+    end
+
+    describe "#mx" do
+      subject { super().mx }
+
+      pending "need to add mx: mechanisms" do
+        it "should find all mx: mechanisms" do
+          expect(subject).to be == mx
+        end
+      end
+    end
+
+    describe "#ptr" do
+      subject { super().ptr }
+
+      pending "need to add ptr: mechanisms" do
+        it "should find all ptr: mechanisms" do
+          expect(subject).to be == ptr
+        end
+      end
+    end
+
+    describe "#ip4" do
+      subject { super().ip4 }
+
+      it "should find all ip4: mechanisms" do
+        expect(subject).to be == ip4_rules
+      end
+    end
+
+    describe "#ip6" do
+      subject { super().ptr }
+
+      pending "need to add ip6: mechanisms" do
+        it "should find all ip6: mechanisms" do
+          expect(subject).to be == ip6
+        end
+      end
+    end
+
+    describe "#exists" do
+      subject { super().exists }
+
+      pending "need to add exists: mechanisms" do
+        it "should find all exists: mechanisms" do
+          expect(subject).to be == exists
+        end
+      end
+    end
+
+    describe "#redirect" do
+      subject { super().exists }
+
+      pending "need to add a redirect: modifier" do
+        it "should find the first redirect: modifier" do
+          expect(subject).to be == redirect
+        end
+      end
+    end
+
+    describe "#exp" do
+      subject { super().exp }
+
+      pending "need to add a exp: modifier" do
+        it "should find the first exp: modifier" do
+          expect(subject).to be == exp
+        end
+      end
+    end
+  end
+
+  describe ".parse" do
+    context "when parsing a valid record" do
+      let(:spf) do
+        %{v=spf1 ip4:199.16.156.0/22 ip4:199.59.148.0/22 ip4:8.25.194.0/23 ip4:8.25.196.0/23 ip4:204.92.114.203 ip4:204.92.114.204/31 ip4:107.20.52.15 ip4:23.21.83.90 include:_spf.google.com include:_thirdparty.twitter.com all}
+      end
+
+      subject { described_class.parse(spf) }
+
+      it "should return a Record" do
+        expect(subject).to be_kind_of(Record)
+      end
+    end
+
+    context "when parsing an invalid record" do
+      let(:spf) { %{v=foo} }
+
+      it "should raise an InvalidRecord exception" do
+        expect {
+          described_class.parse(spf)
+        }.to raise_error(InvalidRecord)
+      end
+    end
+  end
+
+  describe ".query" do
+    let(:domain) { 'twitter.com' }
+
+    subject { described_class.query(domain) }
+
+    it "should return a Record" do
+      expect(subject).to be_kind_of(Record)
+    end
+
+    context "when given a domain without SPF" do
+      let(:domain) { 'geocities.com' }
+
+      it "should return nil" do
+        expect(subject).to be nil
+      end
+    end
+  end
+
+  describe "#each" do
+    it "should enumerate over ever record" do
+    end
+  end
+
+  describe "#to_s" do
+    it "should convert the record back into SPF" do
+      expect(subject.to_s).to be == spf
+    end
+  end
+
+  describe "#inspect" do
+    it "should display the raw SPF" do
+      expect(subject.inspect).to be == "#<#{described_class}: #{spf}>"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require 'rspec'
+require 'spf/query'
+
+include SPF::Query

data/spf-query.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spf/query/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spf-query"
+  gem.version       = SPF::Query::VERSION
+  gem.authors       = ["nicktitle"]
+  gem.email         = ["nick.esposito@trailofbits.com"]
+  gem.summary       = %q{SPF Retriever and Parser}
+  gem.description   = %q{Search and retrieve SPF records for any number of hosts}
+  gem.homepage      = "https://github.com/trailofbits/spf-query#readme"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = ['spf-query']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.9.1'
+
+  gem.add_dependency "parslet", "~> 1.0"
+
+  gem.add_development_dependency "bundler", "~> 1.6"
+  gem.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: spf-query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nicktitle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Search and retrieve SPF records for any number of hosts
+email:
+- nick.esposito@trailofbits.com
+executables:
+- spf-query
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/spf-query
+- lib/resolv/dns/resource/in/spf.rb
+- lib/spf/query.rb
+- lib/spf/query/exceptions.rb
+- lib/spf/query/ip.rb
+- lib/spf/query/macro.rb
+- lib/spf/query/macro_string.rb
+- lib/spf/query/mechanism.rb
+- lib/spf/query/modifier.rb
+- lib/spf/query/parser.rb
+- lib/spf/query/query.rb
+- lib/spf/query/record.rb
+- lib/spf/query/version.rb
+- spec/mechanism_spec.rb
+- spec/parser_spec.rb
+- spec/query_spec.rb
+- spec/record_spec.rb
+- spec/spec_helper.rb
+- spf-query.gemspec
+homepage: https://github.com/trailofbits/spf-query#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: SPF Retriever and Parser
+test_files:
+- spec/mechanism_spec.rb
+- spec/parser_spec.rb
+- spec/query_spec.rb
+- spec/record_spec.rb
+- spec/spec_helper.rb
+has_rdoc: