ruby-spfquery 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-spfquery.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brett Gibson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Ruby Spfquery
+
+It's a thin wrapper around spfquery which is assumed to be in the PATH of the ruby process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-spfquery', require: 'spfquery'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install ruby-spfquery
+
+## Usage
+
+     Spfquery.pass?(ip_address, mail_from, helo)
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+desc 'Run the tests'
+task :test do
+  exec 'ruby -rminitest/pride test/spfquery_test.rb'
+end
+
+task default: :test
+
+

data/lib/spfquery/version.rb

@@ -0,0 +1,3 @@
+class Spfquery
+  VERSION = '0.0.1'
+end

data/lib/spfquery.rb

@@ -0,0 +1,33 @@
+require 'stringio'
+
+class Spfquery
+  attr_reader :ip, :sender, :helo
+
+  def self.pass?(*args)
+    new(*args).pass?
+  end
+
+  def initialize(ip, sender, helo=nil)
+    @ip = ip
+    @sender = sender
+    @helo = helo
+  end
+
+  def pass?
+    'pass' == result
+  end
+
+  def result
+    @result ||= output.lines.first.chomp.downcase
+  end
+
+  private
+
+  def output
+    @output ||= run_spfquery
+  end
+
+  def run_spfquery
+    `spfquery --ip=#{ip} --sender=#{sender} #{" --helo=#{helo}" if helo} 2>/dev/null`
+  end
+end

data/ruby-spfquery.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'spfquery/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby-spfquery"
+  gem.version       = '0.0.1'
+  gem.authors       = ['Brett Gibson']
+  gem.email         = ['bdg@brettdgibson.com']
+  gem.description   = %q{very thin ruby wrapper for spfquery cli}
+  gem.summary       = %q{very thin ruby wrapper for spfquery cli}
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ['lib']
+end

data/test/spfquery_test.rb

@@ -0,0 +1,64 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require_relative '../lib/spfquery'
+
+# Will change if outlook.com's SPF DNS record changes.
+VALID_OUTLOOK_IP = '65.54.190.100'
+
+describe Spfquery do
+  describe 'being created' do
+    it 'accepts an ip and a sender' do
+      ip = '1.1.1.1'
+      sender = 'abc@example.org'
+      sq = Spfquery.new(ip, sender)
+      sq.ip.must_equal(ip)
+      sq.sender.must_equal(sender)
+    end
+    it 'optionallys also accepts a helo' do
+      helo = 'abc.example.org'
+      sq = Spfquery.new('', '', helo)
+      sq.helo.must_equal(helo)
+    end
+  end
+
+  describe '.pass?' do
+    it 'should create an instance and return true if it is a pass' do
+      Spfquery.pass?('1.1.1.1', 'abc@probably-wont-have-spf.org').must_equal false
+      Spfquery.pass?(VALID_OUTLOOK_IP, 'abc@example.org', 'outlook.com').must_equal true
+    end
+  end
+
+  describe '#result' do
+    it 'handles none' do
+      Spfquery.new('1.1.1.1', 'abc@probably-wont-have-spf.org').result.must_equal 'none'
+    end
+    it 'handles neutral' do
+      Spfquery.new('1.1.1.1', 'abc@gmail.com').result.must_equal 'neutral'
+    end
+    it 'handles fail' do
+      Spfquery.new('1.1.1.1', 'abc@example.org').result.must_equal 'fail'
+    end
+    it 'handles pass' do
+      Spfquery.new(VALID_OUTLOOK_IP, 'abc@outlook.com').result.must_equal 'pass'
+      Spfquery.new(VALID_OUTLOOK_IP, 'abc@example.org', 'outlook.com').result.must_equal 'pass'
+    end
+  end
+
+  describe '#pass?' do
+    %w{neutral fail none something}.each do |non_pass|
+      it "should be false for #{non_pass} result" do
+        sq = Spfquery.new('', '')
+        sq.instance_eval { @output = non_pass }
+        sq.pass?.must_equal false
+      end
+    end
+    it 'should be false for a pass result' do
+      sq = Spfquery.new('', '')
+      sq.instance_eval { @output = 'pass' }
+      sq.pass?.must_equal true
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: ruby-spfquery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brett Gibson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies: []
+description: very thin ruby wrapper for spfquery cli
+email:
+- bdg@brettdgibson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spfquery.rb
+- lib/spfquery/version.rb
+- ruby-spfquery.gemspec
+- test/spfquery_test.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: very thin ruby wrapper for spfquery cli
+test_files:
+- test/spfquery_test.rb