formprocessor 0.0.1

data/lib/formprocessor.rb

@@ -0,0 +1,53 @@
+require 'net/smtp'
+require_relative 'required'
+require_relative 'mailer'
+# Process web forms based on the "values" Hash (typically cgi.params).
+# = Example Usage
+#	#!/usr/bin/ruby
+#	require 'cgi'
+#	require 'formprocessor'
+#	cgi = CGI.new
+#	puts cgi.header
+#	puts FormProcessor::Main(cgi.params).result
+# = Keywords
+# * _required_
+#		A CSV string. Check for the existence of these form fields.
+# * _mailto_
+#		If successful submission, mail results to this address. A valid SMTP server running on localhost is required.
+# * _redirect_
+#		Redirect to this URL upon successful submission.
+# = Return Values & Templating
+#	It is possible to template the results of the form submission by omitting the redirection key/value pair in the values Hash.
+#	If there are no errors, result will return nil. If there are errors, result will return a String containing those errors.
+module FormProcessor
+	# The gem's logic handler.
+	class Main
+		# Result of the form submission after processing. Contains error String or nil if no errors.
+		attr_reader :result
+		# Expects a Hash such as _cgi.params_
+		def initialize(values)
+			@values = values
+			@result = String.new
+			@email_output = String.new
+			setup
+			run
+		end
+		private
+		def setup
+			@values.each do |key,val|
+				if val.is_a? Array then temp = val.join(', '); val, @values[key] = temp, temp end
+				temp = val.gsub(%r{</?[^>]+?>},'').strip; val, @values[key] = temp, temp
+				@email_output += key.capitalize + ': ' + val + '<br />'
+			end
+		end
+		def run
+			if @values.has_key? 'required' then @result = Required.new(@values).result end
+			if @values.has_key? 'mailto' and @result.length == 0 then Mailer.new(@values,@email_output) end
+			if @values.has_key? 'redirect' and @result.length == 0
+				puts '<meta http-equiv="refresh" content="0;url=' + @values['redirect'] + '">'
+				exit
+			end
+			if @result.length == 0 then @result = nil end
+		end
+	end
+end

data/lib/mailer.rb

@@ -0,0 +1,27 @@
+module FormProcessor
+	# Sends an email with form results to the address specified in "mailto".
+	# A valid SMTP server running on localhost is required.
+	class Mailer
+		# Expects a Hash value and String for the email body passed from Main.
+		def initialize(values,output)
+			@values = values
+			@output = output
+			run
+		end
+		private
+		def run
+			msg = <<END_OF_MESSAGE
+From: Automated Form Mailer <#{@values['mailto']}>
+To: <#{@values['mailto']}>
+Content-type: text/html
+Subject: #{@values['subject']}
+
+#{@output}
+END_OF_MESSAGE
+			Net::SMTP.start('localhost') do |smtp|
+				smtp.send_message(msg,@values['mailto'],@values['mailto'])
+				smtp.finish
+			end
+		end
+	end
+end

data/lib/required.rb

@@ -0,0 +1,25 @@
+module FormProcessor
+	# Checks to make sure all required fields are present and accounted for.
+	class Required
+		# A String with the list of missing fields.
+		attr_reader :result
+		# Expects a Hash passed from Main.
+		def initialize(values)
+			@values = values
+			@result = String.new
+			run
+		end
+		private
+		def run
+			if @values.has_key? 'required'
+				@values['required'].to_s.split(',').each do |val|
+					val.strip!
+					if !@values.has_key? val or @values[val].empty?
+						if @result.length == 0 then @result = 'You forgot to fill in the following required fields:<br />' end
+						@result += val.capitalize + '<br />'
+					end
+				end
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: formprocessor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kenton Small
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Author: Kenton Small
+
+  Purpose: Process web forms. See docs for usage.
+
+  Provided under the MIT license (see the LICENSE file).'
+email: kentonthegreat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/formprocessor.rb
+- lib/required.rb
+- lib/mailer.rb
+homepage: http://www.kentonsmall.com
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- An SMTP server on localhost
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Process web forms and have the results emailed to you.
+test_files: []