postmark-spam_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c66515023d6d89be09b058efb14e3469cec95d9
+  data.tar.gz: bdff52f5748403623beb06e7071945fc19671aed
+SHA512:
+  metadata.gz: 22878ace8708d824312cabdb290b7851cc8a8028da24fa0d0648e2ee608b7480a5f5f3b9143400b746e690beb16aec42c0a058fc56cd89e82feac8f2b81d31eb
+  data.tar.gz: 0b0b6335b3b9761dc2cfe1b24d1eb09e552370e8fb40812d06f52cd124bf6768c789d0c90160a02349695058109bc6f239543d817a4a8a9cfad7775cfbb3797d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brad Pauly
+
+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,79 @@
+# Postmark::SpamCheck
+
+This is a simple client for http://spamcheck.postmarkapp.com/
+
+I wrote it because the [one that is available](https://github.com/krasio/postmark_spamcheck) has a number of dependencies that I didn't want and is getting old. This library only uses the Ruby standard library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postmark-spam_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postmark-spam_check
+
+## Usage
+
+Give it a raw email and an optional format and timeout.
+
+```ruby
+Postmark::SpamCheck.check(raw_email, report_format = :long, timeout = 60)
+```
+
+You can get a raw email by calling #to_s on a Mail object.
+
+```ruby
+mail = Mail.new do
+  from     "bill.lumbergh@example.net"
+  to       "peter.gibbons@example.com"
+  subject  "TPS reports"
+  body     "Peter, What's happening? Yeah, about those TPS reports. Did you get the memo?"
+end
+
+Postmark::SpamCheck.check(mail.to_s)
+
+=> #<Postmark::SpamCheck::Report:0x007fd61e189970
+ @details=
+  [{:points=>-0.0, :rule=>"NO_RELAYS", :description=>"Informational: message was not relayed via SMTP"},
+   {:points=>-0.0, :rule=>"NO_RECEIVED", :description=>"Informational: message has no Received headers"}],
+ @email=
+  "Date: Mon, 19 Oct 2015 16:50:00 -0700\r\nFrom: bill.lumbergh@example.net\r\nTo: peter.gibbons@example.com\r\nMessage-ID: <562581a848336_c663feb09065bec23540@venus.local.mail>\r\nSubject: TPS reports\r\nMime-Version: 1.0\r\nContent-Type: text/plain;\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 7bit\r\n\r\nPeter, What's happening? Yeah, about those TPS reports. Did you get the memo?",
+ @error=nil,
+ @score="-0.0">
+ ```
+
+If you don't want the details, call with :short format instead. This will only fetch the score.
+
+```ruby
+Postmark::SpamCheck.check(mail.to_s, :short)
+
+=> #<Postmark::SpamCheck::Report:0x007fd61e080088
+ @details=[],
+ @email=
+  "Date: Mon, 19 Oct 2015 16:50:00 -0700\r\nFrom: bill.lumbergh@example.net\r\nTo: peter.gibbons@example.com\r\nMessage-ID: <562581a848336_c663feb09065bec23540@venus.local.mail>\r\nSubject: TPS reports\r\nMime-Version: 1.0\r\nContent-Type: text/plain;\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 7bit\r\n\r\nPeter, What's happening? Yeah, about those TPS reports. Did you get the memo?",
+ @error=nil,
+ @score="0.0">
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradpauly/postmark-spam_check. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "postmark/spam_check"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/postmark/spam_check.rb

@@ -0,0 +1,15 @@
+require "postmark/spam_check/client"
+require "postmark/spam_check/report"
+require "postmark/spam_check/version"
+
+module Postmark
+  module SpamCheck
+    def self.check(raw_email, report_format = :long, timeout = 60)
+      self.client(timeout).check(raw_email, report_format)
+    end
+
+    def self.client(timeout)
+      Postmark::SpamCheck::Client.new(timeout)
+    end
+  end
+end

data/lib/postmark/spam_check/client.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+# The Client is responsible for making requests to the remote API. It doesn't
+# know about the format of the results, only that it is JSON and passes
+# the parsed result to the Report, which will handle the rest.
+module Postmark
+  module SpamCheck
+    class Client
+      SPAM_CHECK_URI = "http://spamcheck.postmarkapp.com/filter"
+
+      def initialize(timeout = 60)
+        @timeout = timeout
+      end
+
+      def check(raw_email, report_format = :long)
+        report = SpamCheck::Report.new(raw_email)
+        result = fetch_report(raw_email, report_format)
+        report.load_results(result)
+      rescue StandardError => error
+        report.error = error.message || error.inspect
+        report
+      end
+
+    private
+      def fetch_report(raw_email, report_format)
+        response = http_request({email: raw_email, options: report_format})
+        JSON.parse(response.body)
+      end
+
+      def http_request(params)
+        uri = URI.parse(SPAM_CHECK_URI)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = @timeout
+        request = Net::HTTP::Post.new(uri.request_uri, {'Content-Type' =>'application/json'})
+        request.body = params.to_json
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/postmark/spam_check/report.rb

@@ -0,0 +1,66 @@
+module Postmark
+  module SpamCheck
+    class Report
+      attr_reader :email, :score, :details
+      attr_accessor :error
+
+      def initialize(email)
+        @email = email
+        @score = nil
+        @error = nil
+        @details = []
+      end
+
+      def load_results(results)
+        # Truthy success means the report was generated successfully.
+        if results['success']
+          results_for_success(results)
+        else
+          results_for_failure(results)
+        end
+
+        self
+      end
+
+    private
+      def results_for_success(results)
+        @score = results['score']
+        parse_spamassassin_report(results['report'])
+      end
+
+      def results_for_failure(results)
+        @error = results['message']
+      end
+
+      def parse_spamassassin_report(report_text = nil)
+        return [] unless report_text
+
+        # NOTE: Possible multi-line description. Example:
+
+        #  pts rule name               description
+        # ---- ---------------------- --------------------------------------------------
+        #  0.0 FREEMAIL_FROM          Sender email is commonly abused enduser mail provider
+        #                             (hello[at]example.com)
+        last_rule = nil
+
+        # Ignore the first two lines.
+        report_text.split(/\n/)[2..-1].each do |line|
+          rule, description = line[5..-1].strip.split(/\s{2,}/, 2).map(&:strip)
+
+          if description
+            points = line[0..3].strip.to_f
+            last_rule = { points: points, rule: rule, description: description }
+            @details << last_rule
+
+          # Nil description means second line of description is in "rule".
+          # Tack it on to the description of the last one.
+          elsif last_rule
+            last_rule[:description] << " #{rule}"
+          end
+        end
+      rescue StandardError => error
+        @error = error.message
+      end
+    end
+  end
+end

data/lib/postmark/spam_check/version.rb

@@ -0,0 +1,5 @@
+module Postmark
+  module SpamCheck
+    VERSION = "0.1.0"
+  end
+end

data/postmark-spam_check.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postmark/spam_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "postmark-spam_check"
+  spec.version       = Postmark::SpamCheck::VERSION
+  spec.authors       = ["Brad Pauly"]
+  spec.email         = ["hi@bradpauly.com"]
+
+  spec.summary       = %q{ruby client for http://spamcheck.postmarkapp.com/doc}
+  spec.description   = %q{Takes a raw email and fetches the spamassassin score and report. No dependencies outside of ruby's standard libraries.}
+  spec.homepage      = "https://github.com/bradpauly/postmark-spam_check"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: postmark-spam_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Pauly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: Takes a raw email and fetches the spamassassin score and report. No dependencies
+  outside of ruby's standard libraries.
+email:
+- hi@bradpauly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/postmark/spam_check.rb
+- lib/postmark/spam_check/client.rb
+- lib/postmark/spam_check/report.rb
+- lib/postmark/spam_check/version.rb
+- postmark-spam_check.gemspec
+homepage: https://github.com/bradpauly/postmark-spam_check
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ruby client for http://spamcheck.postmarkapp.com/doc
+test_files: []
+has_rdoc: