send_to_friends_generator 1.0.0

data/README.txt

@@ -0,0 +1,57 @@
+SendToFriendsGenerator
+    by Jeroen Houben <jeroen.houben@lostboys.nl>
+
+
+== DESCRIPTION:
+  
+This will create two models (sender and recipient), a controller and a bunch of templates
+Together they implement basic send to friend functionality
+
+== FEATURES/PROBLEMS:
+
+* a simple FriendMailer object
+* email templates for HTML and plain text alternative
+* configurable amount of friends
+* support for including a user submitted message in the email
+* support for HTML as well as XML (nice for Flash integration)
+* server-side validation
+* error messages in HTML or XML
+  
+* future feature: search and replace script to replace all relative image tags with absolute ones (http://) 
+
+== SYNOPSIS:
+
+./script/generate send_to_friends [options]
+
+== REQUIREMENTS:
+
+rails plugin: http://agilewebdevelopment.com/plugins/activerecord_base_without_table
+
+== INSTALL:
+
+sudo gem install send_to_friends_generator
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+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/USAGE

@@ -0,0 +1,11 @@
+Description:
+	This will create two models (sender and recipient), a controller and a bunch of templates
+	Together they implement basic send to friend functionality
+	
+	You can optionally choose to include a plaintext alternative. The mailer will automatically pick this up.
+	
+Example:
+	./script/generate send_to_friends
+
+	./script/generate send_to_friends --include-plaintext
+

data/bin/replace_vars

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+#
+#  Created by jeroen.houben on 2007-09-30.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'optparse'
+
+USAGE = "Usage: #{$0} inputfile [options]\n\nexample: #{$0} html/sendfriend.html > app/views/friendmailer/message.text.html.rhtml"
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = USAGE
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+end.parse!
+
+unless src_file = ARGV[0]
+  puts("\n" + USAGE + "\n\n")
+  exit(0)
+end
+ 
+
+begin
+  output = File.read(src_file)
+rescue Exception => e
+  puts "error: #{e}"
+  exit(0)
+end
+
+
+output.gsub!("]", " %>")
+output.gsub!("[", "<%= ")
+output.gsub!('<img src="../static', '<img src="<%= HOME_URL %>/static') 
+output.gsub!('<img src="images',    '<img src="<%= HOME_URL %>/images') 
+output.gsub!('<img src="../images', '<img src="<%= HOME_URL %>/images') 
+
+puts output

data/send_to_friends_generator.rb

@@ -0,0 +1,65 @@
+class SendToFriendsGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      # create directories that might not exist
+      m.directory File.join('app', 'views', 'send_to_friends')
+      m.directory File.join('app', 'views', 'friend_mailer')
+      # controller
+      m.file 'send_to_friends_controller.rb', File.join('app', 'controllers', 'send_to_friends_controller.rb')
+      # stf views
+      %w(_errors.rhtml errors.rxml create.rhtml index.rhtml).each do |f|
+        m.file f, File.join('app', 'views', 'send_to_friends', f)
+      end
+      # models
+      %w(friend_mailer.rb recipient.rb sender.rb).each do |f|
+        m.file f, File.join('app', 'models', f)
+      end
+      # email file
+      if options[:include_plaintext]
+        m.file 'message.text.html.rhtml', File.join('app', 'views', 'friend_mailer', 'message.text.html.rhtml')
+        m.file 'message.text.plain.rhtml', File.join('app', 'views', 'friend_mailer', 'message.text.plain.rhtml')
+      else
+        m.file 'message.text.html.rhtml', File.join('app', 'views', 'friend_mailer', 'message.rhtml')
+      end
+
+      add_route
+      m.readme "INSTRUCTIONS"
+      m.readme "INSTRUCTIONS_FOR_MISSING_PLUGIN"  unless File.exists? RAILS_ROOT + '/plugins/active_record_base_without_table'
+    end
+    
+  end
+  
+  def add_route
+    # now add a route
+    route_definition  = "map.resources :send_to_friends"
+    routes_file       = "#{RAILS_ROOT}/config/routes.rb"
+    begin
+      lines = IO.readlines(routes_file)
+      # add the route on line 2
+      File.open(routes_file, 'w') do |f|
+        lines.insert(1, "  #{route_definition}\n")
+        f.write lines.join
+      end
+    rescue => e
+      puts "Could not add route to your config/routes.rb : #{e} \n\n"
+      puts "Please add '#{route_definition}' to your routes file"
+    end
+    
+  end
+  
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} send_to_friends [options]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--include-plaintext", 
+             "Generate a multipart email message including a plain text alternative") { |v| options[:include_plaintext] = v }
+    end
+  
+  
+end

data/templates/INSTRUCTIONS

@@ -0,0 +1,11 @@
+
+All done. Point you browser to http://localhost:3000/send_to_friends to see if it works
+NOTE: you will need to restart your server!
+
+Also, make sure your environment config has:
+
+- a valid smtp config
+- a value for HOME_URL (the generated views use this value)
+
+If you would like the result of the send_to_friends to be XML, POST to /send_to_friends.xml
+

data/templates/INSTRUCTIONS_FOR_MISSING_PLUGIN

@@ -0,0 +1,4 @@
+
+** WARNING: please install required plugin **  
+ruby scrip/plugin install http://svn.viney.net.nz/things/rails/plugins/active_record_base_without_table
+

data/templates/_errors.rhtml

@@ -0,0 +1,24 @@
+<h2>The form was is valid</h2>
+
+<% if !@sender.valid? %>
+	<h3>Sender Invalid</h3>
+	<ul class="errors">
+		<% @sender.errors.each do |field, msg|  %>			
+		<li><%= msg %></li>
+		<% end %>
+	</ul>
+<% end %>
+
+<% if @all_friends_empty %>
+	<ul class="errors">
+	<li>Supply at least on friend</li>
+	</ul>
+<% elsif @invalid_recipients %>	
+	<ul class="errors">
+		<% for r in @invalid_recipients %>
+			<% r.errors.each do |field, msg|  %>			
+			<li><%= msg %></li>
+			<% end %>
+		<% end %>
+	</ul>
+<% end %>

data/templates/create.rhtml

@@ -0,0 +1 @@
+Bedankt voor het sturen

data/templates/errors.rxml

@@ -0,0 +1,22 @@
+xml.response(:success => 0) do
+	xml.errors do
+    
+    if !@sender.valid?
+  		@sender.errors.each do |field, msg|			
+        xml.error(msg, :field => "sender[#{field}]")
+  		end
+    end
+    
+    if @all_friends_empty
+      xml.error("Supply at least on friend")
+    
+    elsif @invalid_recipients	
+		  @invalid_recipients.each_with_index do |r, index|
+			  r.errors.each do |field, msg|			
+          xml.error(msg, :field => "recipient_#{index}[#{field}]")
+			  end
+		  end
+    end  
+  
+  end
+end

data/templates/friend_mailer.rb

@@ -0,0 +1,11 @@
+class FriendMailer < ActionMailer::Base
+
+  def message(sender, recipient)
+    subject       'Dit is het onderwerp van de stf mail'
+    recipients    "#{recipient.name} <#{recipient.email}>"
+    from          "#{sender.name} <#{sender.email}>"
+    body          :sender => sender, :recipient => recipient
+    content_type  "text/html" 
+  end
+
+end

data/templates/index.rhtml

@@ -0,0 +1,41 @@
+<% if !@form_valid %>
+	<%= render :partial => "errors" %>
+<% end %>
+
+<% form_for(nil, :url => send_to_friends_path) do |f| %>
+  <fieldset>
+	<h3>Your friends</h3>
+    <% @recipients.each_with_index do |recipient, i| %>
+		<% f.object_name = "recipient_#{i}" %>
+		<% f.object = recipient %>
+        <div>
+	        <label for="name_recipient">Name<% if i==0 %><span class="required">*</span><% end %></label>
+	        <%= f.text_field :name, :class => "text" %>
+				</div>
+				<div>
+	        <label for="email_recipient">Email<% if i==0 %><span class="required">*</span><% end %></label>
+	        <%= f.text_field :email, :class => "text" %>
+        </div>
+    <% end %>
+    
+    <% f.object_name = "sender" %>
+    <% f.object = @sender %>
+    <div>
+    <label for="name_sender">Your name<span class="required">*</span></label>
+    <%= f.text_field :name, :class => "text" %>
+  	</div>
+    <div>
+    <label for="email_sender">Your email<span class="required">*</span></label>
+    <%= f.text_field :email, :class => "text" %>
+  	</div>
+		<div>
+    <%= f.text_area :message %>
+		</div>
+  <input type="submit" class="submit-button" value="Send-a-Friend" />
+
+	<div>
+		<span class="required">*</span> required fields
+	</div>
+
+	</fieldset>
+<% end %>

data/templates/message.text.html.rhtml

@@ -0,0 +1,19 @@
+<h1>Dear <%= @recipient.name %>,</h1>
+
+<p>
+have a look at this site, it's cool!! <a href="<%= HOME_URL %>"><%= HOME_URL %></a> 
+</p>
+
+<p>
+<% if !@sender.message.blank? %>
+  <%= h @sender.message %>
+<% else %>
+	no custom message was sent
+<% end %>
+</p>
+
+<p>
+Regards,
+<br><br><br>
+<%= @sender.name %>
+</p>

data/templates/message.text.plain.rhtml

@@ -0,0 +1,15 @@
+** plain text alternative **
+
+Dear <%= @recipient.name %>,
+
+have a look at this site: <%= HOME_URL %> 
+
+<% if !@sender.message.blank? %>
+  <%= @sender.message %>
+<% else %>
+	no custom message was sent
+<% end %>
+
+Regards,
+
+<%= @sender.name %>

data/templates/recipient.rb

@@ -0,0 +1,15 @@
+class Recipient < ActiveRecord::BaseWithoutTable
+
+  column :name, :string
+  column :email, :string
+
+  validates_presence_of :name,  :message => 'empty_recipient_name'
+
+  validates_format_of   :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/, 
+								        :message => "invalid_recipient_email_ address"
+								        							        
+	def empty?
+	 self.name.blank? && self.email.blank?
+	end
+
+end

data/templates/send_to_friends_controller.rb

@@ -0,0 +1,60 @@
+class SendToFriendsController < ApplicationController
+
+  FRIEND_COUNT = 3
+
+  # GET /send_to_friends
+  # shows the stf friend form
+  def index
+    @form_valid = true # don't show errors on unsubmitted form
+    # init senderr
+    @sender = Sender.new
+    @sender.name  = "Your name"
+    @sender.email = "sender@example.com"
+    # init recipients    
+    @recipients  = Array.new(FRIEND_COUNT) { |i| Recipient.new }
+  end
+  
+  # POST /send_to_friends
+  # POST /send_to_friends.xml
+  def create
+    @sender = Sender.new params[:sender]
+    @recipients  = Array.new(FRIEND_COUNT) { |i| Recipient.new params["recipient_#{i}"] }
+    
+    @valid_recipients   = []
+    @invalid_recipients = []
+    @empty_recipients   = []
+    
+    @recipients.each do |r|
+      if r.empty?
+        @empty_recipients   << r
+      elsif r.valid?
+        @valid_recipients   << r
+      else
+        @invalid_recipients << r
+      end
+    end
+    
+    # the form is only valid if the sender if valid 
+    # and at least one valid friend was received
+    # and no invalid friends were received
+    if @sender.valid? && @valid_recipients.size >= 1 && @invalid_recipients.empty?
+      @form_valid = true
+      # send out emails one-by-one
+      @valid_recipients.each {|r| FriendMailer.deliver_message(@sender, r) }
+    else
+      @form_valid = false
+      @all_friends_empty = @empty_recipients.size == FRIEND_COUNT
+    end
+  
+    respond_to do |format|
+      if @form_valid
+        format.xml { render :xml => '<response success="0" />' }
+        format.html # create.rhtml
+      else
+        format.xml  { render :action => 'errors' }
+        format.html { render :action => 'index' }
+      end
+    end
+    
+  end
+end

data/templates/sender.rb

@@ -0,0 +1,13 @@
+class Sender < ActiveRecord::BaseWithoutTable
+
+  column :name, :string
+  column :email, :string
+  column :url, :string
+  column :message, :text
+
+  validates_format_of   :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/, 
+								        :message => "invalid_sender_address"
+
+  validates_presence_of :name, :message => 'invalid_sender_name'
+
+end

data/test/test_send_to_friends_generator.rb

@@ -0,0 +1,12 @@
+require "test/unit"
+class SendToFriendsGeneratorTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_send_to_friends_generator
+    assert true
+  end
+end
+
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: send_to_friends_generator
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-10-01 00:00:00 +02:00
+summary: Rails generator for boiler plate send-to-friend code
+require_paths: 
+- lib
+email: jeroen.houben@lostboys.nl
+homepage: "    by Jeroen Houben <jeroen.houben@lostboys.nl>"
+rubyforge_project: lostboysrb
+description: "== FEATURES/PROBLEMS:  * a simple FriendMailer object * email templates for HTML and plain text alternative * configurable amount of friends * support for including a user submitted message in the email * support for HTML as well as XML (nice for Flash integration) * server-side validation * error messages in HTML or XML  * future feature: search and replace script to replace all relative image tags with absolute ones (http://)   == SYNOPSIS:  ./script/generate send_to_friends [options]"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNDCCAhygAwIBAgIBADANBgkqhkiG9w0BAQUFADBAMQ8wDQYDVQQDDAZqZXJv
+  ZW4xGTAXBgoJkiaJk/IsZAEZFglzdXBlcmNvb2wxEjAQBgoJkiaJk/IsZAEZFgJu
+  bDAeFw0wNzA5MjkxNzQyNTNaFw0wODA5MjgxNzQyNTNaMEAxDzANBgNVBAMMBmpl
+  cm9lbjEZMBcGCgmSJomT8ixkARkWCXN1cGVyY29vbDESMBAGCgmSJomT8ixkARkW
+  Am5sMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApAoWdXiqyx8ykSf6
+  vo9cLxji1BzPlXKtm4KazoseSI6l3Tfn4Y1Uj5qVH7wU215wccuAVjQRvORfC/St
+  f7epz77zKLLGbTsgI75UYs04NmYqKb0qs9Z1VQezuextLKxuBucwIftJ1Gc+BoQV
+  /aZyfXIstvVXtEb1goVx92+UZhoLbYl1Y2E7dwFkAIQFisLxbYitkgkf5Qs0S5fJ
+  Ps4JeZbxyCZSpBvIHf9mqBpuz8EgxoA8wHgqYbRH+6r7QpZIktL9PGpCetk8O5Lp
+  nQ37TtDe90PN6YzD8nTa2E27ENEPoWrcrdgk34ZoAyvczgSgCCVksAHupVdeauuY
+  0gbOowIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
+  2bc9z2clRZmUJFhabTaD49ztV64wDQYJKoZIhvcNAQEFBQADggEBABhLP2zJCOj4
+  BSDxOM7DKtFxbQxVvJ+cp1Bh+qxKWnIzf+zIsXo3dS/leqwu90ttemPiA1jx4dlR
+  z2sEUMc0UT8nmE8+BYrC40CZEGWeLQJf/3PnHmDBBWi8sXtCk52YA6Y+e+Guiict
+  Nb4xLZy5Cj7AWhRnkb7t50hveBlggUMvGqVCI8y5Bw9CG5JZJLyO4kKee+E1cEr+
+  ViFjbjwsynRO3D9HQK9bybqh0T47KAKAU8FJN6SAxZbWC6HIJ6QqQsoc9J3CfPiM
+  8HsOzocrGEmlI+ACaz+n3gEKCnGdwqxxxU0zUJAFNGBfKl71IKjQioyPrLc/y+nF
+  jNXDjwyAUrA=
+  -----END CERTIFICATE-----
+
+post_install_message: 
+authors: 
+- Jeroen Houben
+files: 
+- README.txt
+- send_to_friends_generator.rb
+- USAGE
+- lib/dummy.txt
+- bin/replace_vars
+- templates/INSTRUCTIONS
+- templates/INSTRUCTIONS_FOR_MISSING_PLUGIN
+- templates/_errors.rhtml
+- templates/create.rhtml
+- templates/errors.rxml
+- templates/friend_mailer.rb
+- templates/index.rhtml
+- templates/message.text.html.rhtml
+- templates/message.text.plain.rhtml
+- templates/recipient.rb
+- templates/send_to_friends_controller.rb
+- templates/sender.rb
+- test/test_send_to_friends_generator.rb
+test_files: 
+- test/test_send_to_friends_generator.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- README.txt
+- lib/dummy.txt
+executables: 
+- replace_vars
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: