bouncestudio 0.0.2

data/CHANGELOG.txt

@@ -0,0 +1,2 @@
+2/27/07: Slight change to prevent calling bsBounceStudio_init() multiple times. Caused massive memory usage.
+2/6/07: Initial upload to RubyForge

data/Manifest.txt

@@ -0,0 +1,13 @@
+Rakefile
+README.txt
+CHANGELOG.txt
+Manifest.txt
+setup.rb
+lib/bouncestudio/version.rb
+lib/bouncestudio.rb
+test/test_helper.rb
+test/bouncestudio_test.rb
+test/raw_message.txt
+ext/bounce_studio.c
+ext/extconf.rb
+ext/Makefile

data/README.txt

@@ -0,0 +1,100 @@
+README for bouncestudio
+=======================
+
+== DESCRIPTION
+
+The bouncestudio ruby extension wraps the Bounce Studio C API 
+from Boogie Tools, Inc. This allows a simple method of determining
+if a given raw email message is a hard bounce, an "over quota" 
+bounce, etc. 
+
+== SYNOPSIS
+
+# Rubygems magic
+require 'rubygems'
+require 'bouncestudio'
+
+# First, set your license. If you don't have a BounceStudio license 
+# from BoogieTools, you can still test out the software. It'll just be
+# too slow for production use. Go to http://www.boogietools.com/ to learn
+# more. Using an environment variable is recommended to keep your license 
+# code out of your source. 
+BS_LICENSE = ENV["BS_LICENSE"] || ""
+
+# Create the BounceStudio worker
+bs = BoogieTools::BounceStudio.new(BS_LICENSE)
+
+# Get your message, from a file, with Net::POP, etc
+raw_message = "Subject: I love you"
+
+# Issue the check. 
+result = bs.check(raw_message)
+
+# If you're not licensed, this is where you'll get a delay and 
+# the following message:
+#
+#    Thank you for trying the BounceStudio API.
+#    To register, please visit http://www.boogietools.com.
+
+
+# Do whatever you want based on the following result codes.
+
+# Type Description
+# 0   NON BOUNCE
+# 10  HARD BOUNCE
+# 20  SOFT BOUNCE - General
+# 21  SOFT BOUNCE - Dns Failure
+# 22  SOFT BOUNCE - Mailbox Full
+# 23  SOFT BOUNCE - Message Size Too Large
+# 30  BOUNCE WITH NO EMAIL ADDRESS
+# 40  GENERAL BOUNCE
+# 50  MAIL BLOCK - General
+# 51  MAIL BLOCK - Known Spammer
+# 52  MAIL BLOCK - Spam Detected
+# 53  MAIL BLOCK - Attachment Detected
+# 54  MAIL BLOCK - Relay Denied
+# 60  AUTO REPLY
+# 70  TRANSIENT BOUNCE
+# 80  SUBSCRIBE REQUEST
+# 90  UNSUBSCRIBE REQUEST
+# 100 CHALLENGE RESPONSE
+
+
+== REQUIREMENTS
+
+Besides Ruby and Rubygems, you'll of course need the BounceStudio
+library. It is available for Linux or Windows. This wrapper has only
+been tested with the Linux version. 
+
+== INSTALL
+
+Using Rubygems:
+
+* sudo gem install bouncestudio
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2007 BoogieTools, Inc.
+
+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/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'bouncestudio', 'version')
+
+AUTHOR = "Joshua Warchol"  # can also be an array of Authors
+EMAIL = "joshua@zaadz.com"
+DESCRIPTION = "A Ruby API wrapping the BounceStudio library from Boogie Tools"
+GEM_NAME = "bouncestudio" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "bouncestudio" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "bouncestudio"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Bouncestudio::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "bouncestudio documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  p.spec_extras = {:extensions => ["ext/extconf.rb"]}
+end

data/ext/Makefile

@@ -0,0 +1,139 @@
+
+SHELL = /bin/sh
+
+#### Start of system configuration section. ####
+
+srcdir = .
+topdir = /usr/lib/ruby/1.8/i486-linux
+hdrdir = $(topdir)
+VPATH = $(srcdir):$(topdir):$(hdrdir)
+prefix = $(DESTDIR)/usr
+exec_prefix = $(prefix)
+sitedir = $(DESTDIR)/usr/local/lib/site_ruby
+rubylibdir = $(libdir)/ruby/$(ruby_version)
+archdir = $(rubylibdir)/$(arch)
+sbindir = $(exec_prefix)/sbin
+datadir = $(prefix)/share
+includedir = $(prefix)/include
+infodir = $(prefix)/info
+sysconfdir = $(DESTDIR)/etc
+mandir = $(datadir)/man
+libdir = $(exec_prefix)/lib
+sharedstatedir = $(prefix)/com
+oldincludedir = $(DESTDIR)/usr/include
+sitearchdir = $(sitelibdir)/$(sitearch)
+bindir = $(exec_prefix)/bin
+localstatedir = $(DESTDIR)/var
+sitelibdir = $(sitedir)/$(ruby_version)
+libexecdir = $(exec_prefix)/libexec
+
+CC = gcc
+LIBRUBY = $(LIBRUBY_SO)
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static
+
+CFLAGS   =  -fPIC -Wall -g -O2  -fPIC 
+CPPFLAGS = -I. -I$(topdir) -I$(hdrdir) -I$(srcdir)  
+CXXFLAGS = $(CFLAGS) 
+DLDFLAGS =   
+LDSHARED = $(CC) -shared 
+AR = ar
+EXEEXT = 
+
+RUBY_INSTALL_NAME = ruby1.8
+RUBY_SO_NAME = ruby1.8
+arch = i486-linux
+sitearch = i486-linux
+ruby_version = 1.8
+ruby = /usr/bin/ruby1.8
+RUBY = $(ruby)
+RM = rm -f
+MAKEDIRS = mkdir -p
+INSTALL = /usr/bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = $(libdir)
+LIBPATH =  -L"$(libdir)"
+DEFFILE = 
+
+CLEANFILES = 
+DISTCLEANFILES = 
+
+extout = 
+extout_prefix = 
+target_prefix = 
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED)  -lpthread -ldl -lcrypt -lm -lc -lBounceStudio
+SRCS = bounce_studio.c
+OBJS = bounce_studio.o
+TARGET = bounce_studio
+DLLIB = $(TARGET).so
+STATIC_LIB = 
+
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).so $(TARGET).il? $(TARGET).tds $(TARGET).map
+CLEANOBJS     = *.o *.a *.s[ol] *.pdb *.exp *.bak
+
+all:		$(DLLIB)
+static:		$(STATIC_LIB)
+
+clean:
+		@-$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES)
+
+distclean:	clean
+		@-$(RM) Makefile extconf.h conftest.* mkmf.log
+		@-$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
+
+realclean:	distclean
+install: install-so install-rb
+
+install-so: $(RUBYARCHDIR)
+install-so: $(RUBYARCHDIR)/$(DLLIB)
+$(RUBYARCHDIR)/$(DLLIB): $(DLLIB)
+	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+$(RUBYARCHDIR):
+	$(MAKEDIRS) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .cxx .cpp .C .o
+
+.cc.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.cxx.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.cpp.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.C.o:
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) -c $<
+
+.c.o:
+	$(CC) $(CFLAGS) $(CPPFLAGS) -c $<
+
+$(DLLIB): $(OBJS)
+	@-$(RM) $@
+	$(LDSHARED) $(DLDFLAGS) $(LIBPATH) -o $@ $(OBJS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): ruby.h defines.h

data/ext/bounce_studio.c

@@ -0,0 +1,239 @@
+#include "ruby.h"
+#include "BounceStudio.h"
+
+/*
+Type Description
+0   NON BOUNCE
+10  HARD BOUNCE
+20  SOFT BOUNCE - General
+21  SOFT BOUNCE - Dns Failure
+22  SOFT BOUNCE - Mailbox Full
+23  SOFT BOUNCE - Message Size Too Large
+30  BOUNCE WITH NO EMAIL ADDRESS
+40  GENERAL BOUNCE
+50  MAIL BLOCK - General
+51  MAIL BLOCK - Known Spammer
+52  MAIL BLOCK - Spam Detected
+53  MAIL BLOCK - Attachment Detected
+54  MAIL BLOCK - Relay Denied
+60  AUTO REPLY
+70  TRANSIENT BOUNCE
+80  SUBSCRIBE REQUEST
+90  UNSUBSCRIBE REQUEST
+100 CHALLENGE RESPONSE
+*/
+
+/*
+ * BounceStudio.new()
+ */
+static char *license; 
+static int bs_initialized;
+
+static VALUE rb_bs_init(VALUE self, VALUE lic_string) {
+  if( bs_initialized != 1 ) {
+    bsBounceStudio_init();
+    bs_initialized = 1;
+  }
+  license = StringValuePtr(lic_string);
+  return Qtrue;
+}
+
+/*
+ * BounceStudio#check(raw)
+ *  wraps C bsBounceCheck()
+ */
+static VALUE rb_bs_check(VALUE self, VALUE raw) {
+  int BounceCode;
+  char *RawMessage, *EmailAddress;
+
+  RawMessage = StringValuePtr(raw);
+  
+  BounceCode = bsBounceCheck(RawMessage, &EmailAddress, "", license);
+
+  return INT2NUM(BounceCode);
+}
+
+/*
+ * BounceStudio#get_body(raw)
+ *  wraps C bsGetBody()
+ */
+static VALUE rb_bs_body(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetBody(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#from_address(raw)
+ *  wraps C bsGetFromAddress()
+ */
+static VALUE rb_bs_from_address(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetFromAddress(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#from_friendly_name(raw)
+ *  wraps C bsGetFromFriendlyName()
+ */
+static VALUE rb_bs_from_friendly_name(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetFromFriendlyName(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#header(raw)
+ *  wraps C bsGetHeader()
+ */
+static VALUE rb_bs_header(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetHeader(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#reply_to_address(raw)
+ *  wraps C bsGetReplyToAddress()
+ */
+static VALUE rb_bs_reply_to_address(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetReplyToAddress(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#reply_to_friendly_name(raw)
+ *  wraps C bsGetReplyToFriendlyName()
+ */
+static VALUE rb_bs_reply_to_friendly_name(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetReplyToFriendlyName(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#subject(raw)
+ *  wraps C bsGetSubject()
+ */
+static VALUE rb_bs_subject(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetSubject(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#to_address(raw)
+ *  wraps C bsGetToAddress()
+ */
+static VALUE rb_bs_to_address(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetToAddress(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#to_friendly_name(raw)
+ *  wraps C bsGetToFriendlyName()
+ */
+static VALUE rb_bs_to_friendly_name(VALUE self, VALUE raw) {
+  char *RawMessage;
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  bsGetToFriendlyName(RawMessage, &ReturnValue);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#custom_header(raw)
+ *  wraps C bsGetCustomHeader()
+ */
+static VALUE rb_bs_custom_header(VALUE self, VALUE raw, VALUE header) {
+  char *RawMessage;
+  char *Header; 
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  Header = StringValuePtr(header);
+  bsGetCustomHeader(RawMessage, &ReturnValue, Header);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * BounceStudio#orig_custom_header(raw)
+ *  wraps C bsGetOrigCustomHeader()
+ */
+static VALUE rb_bs_orig_custom_header(VALUE self, VALUE raw, VALUE header) {
+  char *RawMessage;
+  char *Header; 
+  char *ReturnValue = NULL; 
+
+  RawMessage = StringValuePtr(raw);
+  Header = StringValuePtr(header);
+  bsGetOrigCustomHeader(RawMessage, &ReturnValue, Header);
+
+  return rb_str_new2(ReturnValue);
+}
+
+/*
+ * Extention initializer
+ */
+void Init_bounce_studio() {
+  VALUE boogie_tools_mod =
+    rb_define_module("BoogieTools");
+
+  VALUE bs_class =
+    rb_define_class_under(boogie_tools_mod,
+    "BounceStudio", rb_cObject);
+
+  rb_define_method(bs_class, "initialize", rb_bs_init, 1);
+  rb_define_method(bs_class, "check", rb_bs_check, 1);
+  rb_define_method(bs_class, "body", rb_bs_body, 1);
+  rb_define_method(bs_class, "from_address", rb_bs_from_address, 1);
+  rb_define_method(bs_class, "from_friendly_name", rb_bs_from_friendly_name, 1);
+  rb_define_method(bs_class, "header", rb_bs_header, 1);
+  rb_define_method(bs_class, "reply_to_address", rb_bs_reply_to_address, 1);
+  rb_define_method(bs_class, "reply_to_friendly_name", rb_bs_reply_to_friendly_name, 1);
+  rb_define_method(bs_class, "subject", rb_bs_subject, 1);
+  rb_define_method(bs_class, "to_address", rb_bs_to_address, 1);
+  rb_define_method(bs_class, "to_friendly_name", rb_bs_to_friendly_name, 1);
+  rb_define_method(bs_class, "custom_header", rb_bs_custom_header, 2);
+  rb_define_method(bs_class, "orig_custom_header", rb_bs_orig_custom_header, 2);
+}
+