bounce_studio_ffi 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d55f124f1986f1abe6d236ab361d17f987608bca
-  data.tar.gz: 1d097c1e1770441598efca0cde85b616e140cdd4
+  metadata.gz: a67c70ab38153699c64aacffa59e9650f9f1b0c9
+  data.tar.gz: 1cd49f1a70faff6ba40c9d609a2db6aad824339e
 SHA512:
-  metadata.gz: 175869132a2b373dafbd52500eddf9411d7935b1b4c5b901b37660beff963d334868323baded564fdbe4d8fa26297743595b87e1e336fa6ba0db5d3c56b03694
-  data.tar.gz: 9f982c438bc41ed6b591fc2b52321efef1612e81f6fff29e0759538cb28d82f9339bc7b3d70632467ef96bf43c36e51090c2605e7578b63ffb78dba0ee675d8d
+  metadata.gz: 57ff9c4d8299b238f4ccd19a8eecb87def1e0b762a8311f0351113741927cc1b0b037349504160cdbd2bec624fffefcbe1e163cb444eb73ad1047df4fe404879
+  data.tar.gz: 43120b862f6f3110a2a748a2be5c8f64248f07b45d1b0b0c9f4f86b4ed137829b54fc89cdac03c39512a61c4294c12fc87e0d618e041a0fe42f35478166dcac2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 TODO: Write your name
+Copyright (c) 2013 Benjamin Ortega
 
 MIT License
 

data/README.md

@@ -1,9 +1,17 @@
-# BounceStudioFfi
+# bounce\_studio\_ffi
 
-TODO: Write a gem description
+A Ruby FFI binding for the (commercial) [BounceStudio API 3.7 for Linux](http://www.boogietools.com/Products/Linux/). Designed to be compatible with the included native extension.
+
+## Requirements
+
+* FFI-supporting Ruby 1.9+ (MRI/JRuby)
+* Linux
+* BounceStudio API libs
 
 ## Installation
 
+Follow [these installation instructions](http://www.boogietools.com/Products/Linux/BounceStudioAPI/help/files/installation.html) to install the C API library.
+
 Add this line to your application's Gemfile:
 
     gem 'bounce_studio_ffi'
@@ -18,7 +26,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    # 32-bit lib is used by default; set ENV['BOUNCE_STUDIO_MODE'] to 64 to use 64-bit lib before requiring
+    require 'bounce_studio_ffi'
+    BS_LICENSE = "Foobar/1234567890"
+    bs = BoogieTools::BounceStudio.new(BS_LICENSE)
+    bs.check(raw_message_text)
+    
+    # all functions documented at http://www.boogietools.com/Products/Linux/BounceStudioAPI/help/help.html
+    # are supported, e.g.
+    bs.subject(raw_message_text)    
+    bs.orig_custom_header(raw_message_text, 'x-subscriber')
+
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+desc('Runs all tests in the subdirectories of lib')
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.pattern = 'test/**/*_test.rb'
+  end
+end

data/bounce_studio_ffi.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "ffi"
-  spec.add_development_dependency "activesupport"  
+  spec.add_runtime_dependency "ffi"
+  spec.add_runtime_dependency "activesupport"
 end

data/lib/bounce_studio_ffi/version.rb

@@ -1,3 +1,3 @@
 module BounceStudioFfi
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/bounce_studio_ffi.rb

@@ -6,23 +6,23 @@ module BoogieTools
   class BounceStudio  
     module BounceStudioLib
       extend FFI::Library
-      ffi_lib "libBounceStudio32.so"
+      ffi_lib "libBounceStudio#{ENV['BOUNCE_STUDIO_MODE'] || '32'}.so"
       attach_function :bsBounceStudio_init, [], :int
       
-      STRING_POINTER_METHODS = [:header, :subject, :body, :to_address, :to_friendly_name, :reply_to_address, :reply_to_friendly_name, :from_address, :from_friendly_name].freeze    
-      STRING_POINTER_METHODS.each do |ruby_method_name|
+      STRING_OUTPUT_METHODS = [:header, :subject, :body, :to_address, :to_friendly_name, :reply_to_address, :reply_to_friendly_name, :from_address, :from_friendly_name].freeze    
+      STRING_OUTPUT_METHODS.each do |ruby_method_name|
         attach_function :"bsGet#{ruby_method_name.to_s.camelize}", [:string, :pointer], :void
       end
-      attach_function :bsBounceCheck, [:string, :pointer, :string, :string], :int
       
       CUSTOM_HEADER_METHODS = [:custom_header, :orig_custom_header].freeze
       CUSTOM_HEADER_METHODS.each do |ruby_method_name|
         attach_function :"bsGet#{ruby_method_name.to_s.camelize}", [:string, :pointer, :string], :void
       end
       
-      attach_function :bsGetOrigCustomHeader, [:string, :pointer, :string], :void        
+      attach_function :bsBounceCheck, [:string, :pointer, :string, :string], :int  
     end
     
+    # gotta call this before we do anything
     BounceStudioLib.bsBounceStudio_init
     
     attr_accessor :license
@@ -30,7 +30,7 @@ module BoogieTools
       self.license=license
     end
 
-    BounceStudioLib::STRING_POINTER_METHODS.each do |ruby_method_name|
+    BounceStudioLib::STRING_OUTPUT_METHODS.each do |ruby_method_name|
       define_method ruby_method_name do |raw_message|
         string_output do |ptr|
           BounceStudioLib.send(:"bsGet#{ruby_method_name.to_s.camelize}", raw_message, ptr)
@@ -44,13 +44,13 @@ module BoogieTools
           BounceStudioLib.send(:"bsGet#{ruby_method_name.to_s.camelize}", raw_message, ptr, header_name)        
         end      
       end      
-    end
-          
+    end          
     
-    def check(raw_message)
+    # ignore list is pipe-delimited string of email addresses
+    def check(raw_message, ignore_list='')
       code = nil
       string_output do |ptr|
-        code = BounceStudioLib.bsBounceCheck(raw_message, ptr, 'asdasd@sss.com', self.license)
+        code = BounceStudioLib.bsBounceCheck(raw_message, ptr, ignore_list, self.license)
       end      
       return code          
     end
@@ -66,26 +66,4 @@ module BoogieTools
     end     
   end  
   
-end
-
-
-{
-:BS_UNDETERMINED           =>  0, # Undetermined 
-:BS_HARD                   => 10, # HARD BOUNCE 
-:BS_SOFT_GENERAL           => 20, # SOFT BOUNCE - General 
-:BS_SOFT_DNSFAILURE        => 21, # SOFT BOUNCE - Dns Failure 
-:BS_SOFT_MAILBOXFULL       => 22, # SOFT BOUNCE - Mailbox Full 
-:BS_SOFT_MESSAGETOBIG      => 23, # SOFT BOUNCE - Message Size Too Large 
-:BS_NOEMAIL                => 30, # BOUNCE - email address could not be retrieved. 
-:BS_GENERAL                => 40, # GENERAL BOUNCE 
-:BS_MAILBLOCK_GENERAL      => 50, # MAIL BLOCK - General 
-:BS_MAILBLOCK_SPAMMER      => 51, # MAIL BLOCK - Known Spammer 
-:BS_MAILBLOCK_SPAMDETECTED => 52, # MAIL BLOCK - Spam Content Detected 
-:BS_MAILBLOCK_ATTACHMENT   => 53, # MAIL BLOCK - Attachment Detected 
-:BS_MAILBLOCK_RELAYDENIED  => 54, # MAIL BLOCK - Relay Denied 
-:BS_AUTOREPLY              => 60, # AUTO REPLY 
-:BS_TRANSIENT              => 70, # TRANSIENT BOUNCE 
-:BS_SUBSCRIBE              => 80, # SUBSCRIBE REQUEST 
-:BS_UNSUBSCRIBE            => 90, # UNSUBSCRIBE REQUEST 
-:BS_CHALLENGERESPONSE      =>100, # CHALLENGE-RESPONSE MESSAGE 
-}
+end

data/test/bouncestudio_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+class BounceStudioTest < Test::Unit::TestCase
+
+  def setup
+    license_code = BS_LICENSE
+    @studio = BoogieTools::BounceStudio.new license_code
+    @raw = IO.read File.join(File.dirname(__FILE__), "raw_message.txt")
+  end
+  
+  def test_truth
+    assert true
+  end
+
+  def test_studio_type
+    assert_equal Object, BoogieTools::BounceStudio.superclass
+    assert_equal BoogieTools::BounceStudio, @studio.class
+  end
+
+  def test_check
+    bounce_code = @studio.check(@raw)
+    assert bounce_code.is_a?(Fixnum)
+    assert_equal bounce_code, 10
+  end
+  
+  def test_body
+    body = @studio.body(@raw)
+    assert body.is_a?(String) 
+  end
+
+  def test_from_address
+    from_address = @studio.from_address(@raw)
+    assert from_address.is_a?(String)
+    assert !from_address.empty?
+    assert_equal from_address, "MAILER-DAEMON@mail.coinet.com".downcase
+  end
+
+  def test_from_friendly_name
+    from_friendly_name = @studio.from_friendly_name(@raw)
+    assert from_friendly_name.is_a?(String)
+    assert from_friendly_name.empty?
+  end
+
+  def test_header
+    header = @studio.header(@raw)
+    assert header.is_a?(String)
+    assert !header.empty?
+  end
+
+  def test_reply_to_address
+    reply_to_address = @studio.reply_to_address(@raw)  
+    assert reply_to_address.is_a?(String)
+    assert reply_to_address.empty?
+  end
+
+  def test_reply_to_friendly_name
+    reply_to_friendly_name = @studio.reply_to_friendly_name(@raw)  
+    assert reply_to_friendly_name.is_a?(String)
+    assert reply_to_friendly_name.empty?
+  end
+
+  def test_subject
+    subject = @studio.subject(@raw)  
+    assert subject.is_a?(String)
+    assert !subject.empty?
+    assert_equal subject.chomp, "failure notice"
+  end
+
+  def test_to_address
+    to_address = @studio.to_address(@raw)  
+    assert to_address.is_a?(String)
+    assert !to_address.empty?
+    assert_equal to_address, "joebob@joe.net"
+  end
+
+  def test_to_friendly_name
+    to_friendly_name = @studio.to_friendly_name(@raw)  
+    assert to_friendly_name.is_a?(String)
+    assert to_friendly_name.empty?
+  end
+
+  def test_custom_header
+    custom_header = @studio.custom_header(@raw, "X-OriginalArrivalTime".downcase)  
+    assert custom_header.is_a?(String)
+    assert custom_header.empty?
+
+    date_header = @studio.custom_header(@raw, "Date".downcase)
+    assert date_header.is_a?(String)
+    assert !date_header.empty?
+    assert_equal date_header.chomp, "21 Aug 2000 21:08:21 -0000"
+  end
+
+  def test_orig_custom_header
+    orig_custom_header = @studio.orig_custom_header(@raw, "X-OriginalArrivalTime".downcase)
+    assert orig_custom_header.is_a?(String)
+    assert !orig_custom_header.empty?
+    assert_equal orig_custom_header.chomp, "21 Aug 2000 21:08:20.0944 (UTC) FILETIME=[EF5F8500:01C00BB3]"
+  end
+end

data/test/raw_message.txt

@@ -0,0 +1,50 @@
+
+Return-Path: <>
+Received: from defiant.coinet.com ([204.245.234.17])
+          by detmail.somedomain.net (Post.Office MTA v3.5.3 release 223
+          ID# 0-65382U1000L100S0V35) with SMTP id net
+          for <joebob@joe.net>; Mon, 21 Aug 2000 14:07:48 -0700
+Received: (qmail 849 invoked for bounce); 21 Aug 2000 21:08:21 -0000
+Date: 21 Aug 2000 21:08:21 -0000
+From: MAILER-DAEMON@mail.coinet.com
+To: joebob@joe.net
+Subject: failure notice
+
+Hi. This is the mail transport agent at mail.coinet.com.
+I'm afraid I wasn't able to deliver your message to the following addresses.
+This is a permanent error; I've given up. If you have questions about this
+notice, please forward it to postmaster@coinet.com along with your comments.
+
+<wolfden@coinet.com>:
+Sorry, this account has been deactivated. (#5.2.1)
+
+--- Below this line is a copy of the message.
+
+Return-Path: <joebob@joe.net>
+Received: (qmail 841 invoked from network); 21 Aug 2000 21:08:21 -0000
+Received: from pool104.somedomain.com (HELO detcmail02.somedomain.net) (1.2.3.4)
+  by coinet.com with SMTP; 21 Aug 2000 21:08:21 -0000
+Received: from detcmail02 ([2.3.4.5]) by detcmail02.somedomain.net with Microsoft SMTPSVC(5.0.2172.1);
+	 Mon, 21 Aug 2000 14:08:20 -0700
+From: "JOE.NET" <joebob@joe.net>
+Reply-To: "JOE.NET" <some_reply@joe.net>
+To: <wolfden@coinet.com>
+Date: Mon, 21 Aug 00 14:08:20 -0700
+Subject: JOE.NET NEWS!
+MIME-Version: 1.0
+Content-Type: multipart/alternative; boundary="----_=_Send_NextPart_180_03281976"
+Return-Path: joebob@joe.net
+Message-ID: <DETCMAIL02agW2wx6Di000110f7@DETcmail02.somedomain.net>
+X-OriginalArrivalTime: 21 Aug 2000 21:08:20.0944 (UTC) FILETIME=[EF5F8500:01C00BB3]
+
+This is a multi-part message in MIME format.
+
+
+------_=_Send_NextPart_180_03281976
+Content-Type: text/plain; charset=us-ascii
+
+Here's my test message.  This is the body of the message....  Cool....  Okay, bye!
+
+.
+
+

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/bounce_studio_ffi'
+if ENV['BS_LICENSE']
+  BS_LICENSE = ENV['BS_LICENSE']
+else
+  puts "Set the environment variable BS_LICENSE with your BoogieTools license code to avoid tarpit"
+  BS_LICENSE = "nolicense"
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bounce_studio_ffi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Benjamin Ortega
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,6 +81,9 @@ files:
 - bounce_studio_ffi.gemspec
 - lib/bounce_studio_ffi.rb
 - lib/bounce_studio_ffi/version.rb
+- test/bouncestudio_test.rb
+- test/raw_message.txt
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -105,4 +108,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: FFI wrapper for Ruby BounceStudio API for Linux
-test_files: []
+test_files:
+- test/bouncestudio_test.rb
+- test/raw_message.txt
+- test/test_helper.rb