contact_us_website 0.4.4.beta

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in contact_us.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Dutil
+
+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,117 @@
+# Contact Us [![Build Status](https://secure.travis-ci.org/jdutil/contact_us.png)](http://travis-ci.org/jdutil/contact_us) [![Dependency Status](https://gemnasium.com/jdutil/contact_us.png?travis)](https://gemnasium.com/jdutil/contact_us) [![Click here to lend your support to: ContactUs and make a donation at www.pledgie.com !](https://www.pledgie.com/campaigns/16807.png?skin_name=chrome)][pledgie]
+A Rails 3+ Engine providing a basic contact form.  
+
+[travis]: http://travis-ci.org/jdutil/contact_us
+[gemnasium]: https://gemnasium.com/jdutil/contact_us
+[pledgie]: http://www.pledgie.com/campaigns/16807
+
+There is also a demo application showing how the ContactUs form works:
+
+* [View Demo Form In Action](http://contact-us-demo.heroku.com)
+* [View Demo Applications Source Code](http://github.com/jdutil/contact_us_demo)
+
+## REQUIREMENTS
+
+Contact Us requires:
+
+* Ruby >= 1.8.7 (will soon only support > 1.9.2)
+* Rails >= 3.0.0
+
+It is also recommended to use Formtastic or SimpleForm (see configuration) in order to hook into your apps custom form builders.
+
+## INSTALLATION
+
+In your `Gemfile`, add the following dependencies:
+
+    gem 'contact_us', '~> 0.4.0.beta'
+
+From `Rails.root` run:
+
+    $ bundle
+    $ bundle exec rake contact_us:install
+
+In `config/initializers/contact_us.rb` modify:
+
+    config.mailer_to = "contact@please-change-me.com"
+
+Change to the email address you would like to receive the form submissions at for example:
+
+    config.mailer_to = "contact@yourdomain.com"
+
+By default the emails from field will be the email entered by the user to easily reply, but this may not be allowed if your required to verify your sending email addresses.
+You may also specify an email address for the notification emails from field:
+
+    config.mailer_from = "dontreply@yourdomain.com"
+
+## CONFIGURATION
+
+The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.  If you would like to add a name or subject field to the form you may simply
+set the options to true within the contact_us initializer located at `config/initializers/contact_us.rb`:
+
+    config.require_name = true
+    config.require_subject = true
+
+You may also update your locales under `config/locales/contact_us.en.yml` or create your own.  Please feel free to submit your own locales so that other users will hopefully find this gem more useful.
+
+### Formtastic
+
+In order to use a Formtastic compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
+
+    config.form_gem = 'formtastic'
+
+* By default the HTML should match that produced by Formtastic, but to ensure it is up to date you should set Formtastic.
+
+### SimpleForm
+
+In order to use a SimpleForm compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
+
+    config.form_gem = 'simple_form'
+
+## UPGRADING
+
+When upgrading from 0.1.x to 0.2.x you should rerun the install generator to install the new settings, views, and locale updates:
+
+    $ bundle exec rake contact_us:install
+
+Or you may run the generators for each specific component you would like to update, which is quite useful when upgrading during patch releases for example from 0.2.0 to 0.2.1:
+
+    $ bundle exec rake contact_us:copy_locales
+    $ bundle exec rake contact_us:copy_views
+
+## USAGE
+
+Visit your website and navigate to `/contact-us` to see the form in action.
+
+## INTEGRATION TESTS
+
+Contact Us has 100% test coverage, and provides simple integration specs you can drop directly into your apps test suite if you use RSpec & Capybara.
+
+Simply copy the `spec/integration/contact_us_lint_spec.rb` file, and add it to your integration specs. 
+
+## ISSUES
+
+Please report any bugs or feature requests to the Github issues page @ https://github.com/jdutil/contact_us/issues
+
+## CONTRIBUTING
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by [translating to a new language](https://github.com/jdutil/contact_us/tree/master/config/locales)
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues](https://github.com/jdutil/contact_us/issues)
+* by reviewing patches
+
+## TODO
+
+* Add new language translations.
+* Stop copying views/locales by default.
+
+Copyright (c) 2011 Jeff Dutil, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/contact_us/contacts_controller.rb

@@ -0,0 +1,30 @@
+class ContactUsWebsite::ContactsController < ApplicationController
+
+  def create
+    @contact = ContactUsWebsite::Contact.new(params[:contact_us_contact])
+
+    if @contact.save
+      redirect_to('/', :notice => t('contact_us.notices.success'))
+    else
+      flash[:error] = t('contact_us.notices.error')
+      render_new_page
+    end
+  end
+
+  def new
+    @contact = ContactUsWebsite::Contact.new
+    render_new_page
+  end
+
+  protected
+
+    def render_new_page
+      case ContactUsWebsite.form_gem
+      when 'formtastic'  then render 'new_formtastic'
+      when 'simple_form' then render 'new_simple_form'
+      else
+        render 'new'
+      end
+    end
+
+end

data/app/helpers/contact_us/contacts_helper.rb

@@ -0,0 +1,2 @@
+module ContactUs::ContactsHelper
+end

data/app/mailers/contact_us/contact_mailer.rb

@@ -0,0 +1,10 @@
+class ContactUs::ContactMailer < ActionMailer::Base
+  def contact_email(contact)
+    @contact = contact
+
+    mail :from    => (ContactUs.mailer_from || @contact.email),
+         :reply_to => @contact.email,
+         :subject => (ContactUs.require_subject ? @contact.subject : t('contact_us.contact_mailer.contact_email.subject', :email => @contact.email)),
+         :to      => ContactUs.mailer_to
+  end
+end

data/app/models/contact_us/contact.rb

@@ -0,0 +1,32 @@
+class ContactUsWebsite::Contact
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  attr_accessor :email, :message, :name, :subject, :website
+
+  validates :email,   :format => { :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i },
+                      :presence => true
+  validates :message, :presence => true
+  validates :name,    :presence => {:if => Proc.new{ContactUsWebsite.require_name}}
+  validates :subject, :presence => {:if => Proc.new{ContactUsWebsite.require_subject}}
+  validates :website, :presence => {:if => Proc.new{ContactUsWebsite.require_website}}
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end
+  end
+
+  def save
+    if self.valid?
+      ContactUsWebsite::ContactMailer.contact_email(self).deliver
+      return true
+    end
+    return false
+  end
+  
+  def persisted?
+    false
+  end
+
+end

data/app/views/contact_us/contact_mailer/contact_email.html.erb

@@ -0,0 +1,3 @@
+<p><%= @contact.message %></p>
+<p>---------------------</p>
+<p><%= ContactUsWebsite.require_name ? t('.sent_by_name', :email => @contact.email, :name => @contact.name) : t('.sent_by_contact_form', :email => @contact.email) %></p>

data/app/views/contact_us/contact_mailer/contact_email.text.plain.erb

@@ -0,0 +1,4 @@
+<%= @contact.message %>
+
+-------------------------------------
+<%= ContactUsWebsite.require_name ? t('.sent_by_name', :email => @contact.email, :name => @contact.name) : t('.sent_by_contact_form', :email => @contact.email) %>

data/app/views/contact_us/contacts/new.html.erb

@@ -0,0 +1,47 @@
+<h2><%= t('.contact_us') %></h2>
+<%= form_for @contact, :url => contacts_path, :html => {:class => 'formtastic'} do |f| %>
+  <% if ContactUs.require_name %>
+    <li class='string required' id='contact_us_contact_name_input'>
+      <%= f.label :name, (t('.name') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+      <%= f.text_field :name %>
+      <% if f.object.errors[:name].present? %>
+        <p class='inline-error'><%= f.object.errors[:name].join(' and ') %></p>
+      <% end %>
+    </li>
+  <% end %>
+  <li class='string required' id='contact_us_contact_email_input'>
+    <%= f.label :email, (t('.email') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+    <%= f.text_field :email %>
+    <% if f.object.errors[:email].present? %>
+      <p class='inline-error'><%= f.object.errors[:email].join(' and ') %></p>
+    <% end %>
+  </li>
+  <% if ContactUs.require_website %>
+    <li class='string' id='contact_us_contact_website_input'>
+      <%= f.label :website, (t('.website') + content_tag(:abbr, '*', :class => 'contactleft')).html_safe %>
+      <%= f.text_field :website %>
+      <% if f.object.errors[:website].present? %>
+        <p class='inline-error'><%= f.object.errors[:website].join(' and ') %></p>
+      <% end %>
+    </li>
+  <% end %>
+  <% if ContactUs.require_subject %>
+    <li class='string required' id='contact_us_contact_subject_input'>
+      <%= f.label :subject, (t('.subject') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+      <%= f.text_field :subject %>
+      <% if f.object.errors[:subject].present? %>
+        <p class='inline-error'><%= f.object.errors[:subject].join(' and ') %></p>
+      <% end %>
+    </li>
+  <% end %>
+  <li class='text required' id='contact_us_contact_message_input'>
+    <%= f.label :message, (t('.message') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+    <%= f.text_area :message %>
+    <% if f.object.errors[:message].present? %>
+      <p class='inline-error'><%= f.object.errors[:message].join(' and ') %></p>
+    <% end %>
+  </li>
+  <li class='commit'>
+    <%= f.submit :submit, :alt => t('.submit'), :class => 'submit create', :label => t('.submit'), :title => t('.submit') %>
+  </li>
+<% end %>

data/app/views/contact_us/contacts/new_formtastic.html.erb

@@ -0,0 +1,9 @@
+<h2><%= t('.contact_us') %></h2>
+<%= semantic_form_for @contact, :url => contacts_path do |f| %>
+  <%= f.input :name, :label => t('.name') if ContactUs.require_name %>
+  <%= f.input :email, :label => t('.email') %>
+  <%= f.input :website, :label => t('.website') %>
+  <%= f.input :subject, :label => t('.subject') if ContactUs.require_subject %>
+  <%= f.input :message, :as => :text, :label => t('.message') %>
+  <%= f.action :submit, :label => t('.submit'), :button_html => { :alt => t('.submit'), :id => 'contact_us_contact_submit', :title => t('.submit') } %>
+<% end %>

data/app/views/contact_us/contacts/new_simple_form.html.erb

@@ -0,0 +1,9 @@
+<h2><%= t('.contact_us') %></h2>
+<%= simple_form_for @contact, :url => contacts_path do |f| %>
+  <%= f.input :name, :label => t('.name') if ContactUs.require_name %>
+  <%= f.input :email, :label => t('.email') %>
+  <%= f.input :website, :label => t('.website') %>
+  <%= f.input :subject, :label => t('.subject') if ContactUs.require_subject %>
+  <%= f.input :message, :as => :text, :label => t('.message') %>
+  <%= f.button :submit, :label => t('.submit'), :button_html => { :alt => t('.submit'), :id => 'contact_us_contact_submit', :title => t('.submit') } %>
+<% end %>

data/config/locales/contact_us.de.yml

@@ -0,0 +1,25 @@
+# Sample localization file for German. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+de:
+  contact_us:
+    contact_mailer:
+      contact_email:
+        sent_by_contact_form: "Gesendet durch das Kontaktformular. %{email}"
+        sent_by_name: "Sent by %{name} from %{email}"
+        subject: "Contact Us message from %{email}"
+    contacts:
+      new: &new
+        contact_us: "Kontaktiere Uns"
+        email: "Email"
+        message: "Nachricht"
+        name: "Name"
+        subject: "Subject"
+        submit: "Abschicken"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
+    notices:
+      error: "Beide Felder müssen ausgefüllt werden."
+      success: "Die Nachricht wurde erfolgreich versendet."

data/config/locales/contact_us.en.yml

@@ -0,0 +1,25 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  contact_us:
+    contact_mailer:
+      contact_email:
+        sent_by_contact_form: "Sent by contact form from %{email}"
+        sent_by_name: "Sent by %{name} from %{email}"
+        subject: "Contact Us message from %{email}"
+    contacts:
+      new: &new
+        contact_us: "Contact Us"
+        email: "Email"
+        message: "Message"
+        name: "Name"
+        subject: "Subject"
+        submit: "Submit"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
+    notices:
+      error: "You must enter both fields."
+      success: "Contact email was successfully sent."

data/config/locales/contact_us.es.yml

@@ -0,0 +1,25 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+es:
+  contact_us:
+    contact_mailer:
+      contact_email:
+        sent_by_contact_form: "Enviado por el formulario de contacto. %{email}"
+        sent_by_name: "Sent by %{name} from %{email}"
+        subject: "Contact Us message from %{email}"
+    contacts:
+      new: &new
+        contact_us: "Contactanos"
+        email: "Email"
+        message: "Mensaje"
+        name: "Name"
+        subject: "Subject"
+        submit: "Enviar"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
+    notices:
+      error: "Debes de ingresar ambos campos."
+      success: "El correo electrónico de contacto fue enviado con éxito."

data/config/locales/contact_us.it.yml

@@ -0,0 +1,25 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+it:
+  contact_us:
+    contact_mailer:
+      contact_email:
+        sent_by_contact_form: "Inviato dal formato di contatto. %{email}"
+        sent_by_name: "Sent by %{name} from %{email}"
+        subject: "Contact Us message from %{email}"
+    contacts:
+      new: &new
+        contact_us: "Contattaci"
+        email: "Email"
+        message: "Messaggio"
+        name: "Name"
+        subject: "Subject"
+        submit: "Inviare"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
+    notices:
+      error: "Devi inserire entrambi i campi."
+      success: "La mail di contatto è stata inviata."

data/config/locales/contact_us.ja.yml

@@ -0,0 +1,25 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  contact_us:
+    contact_mailer:
+      contact_email:
+        sent_by_contact_form: "お問い合せメールを送信しました : %{email}"
+        sent_by_name: "%{name} さんがお問い合せメールを送信しました : %{email}"
+        subject: "お問い合わせメール : %{email}"
+    contacts:
+      new: &new
+        contact_us: "お問い合わせ"
+        email: "メールアドレス"
+        message: "お問い合せ内容"
+        name: "お名前"
+        subject: "件名"
+        submit: "送信する"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
+    notices:
+      error: "すべての項目を入力してください。"
+      success: "お問い合わせを送信しました。"