comfy_imprint 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Nick Gorbikoff
+
+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,59 @@
+#ComfyImprint
+This is what is commonly known as a "Contact Us" page, done as a mountable Rails 3 engine. It's designed to be used in conjunction with Comfortable Mexican Sofa Content Management System ( CMS CMS :-) ) I highly suggest to check out CMS as it runs circles around all other Rails CMS systems out there.
+
+##Demo
+I don't like heroku, so there is no obligatory heroku demo, thou I might put up one later at some other provider. However you can see this gem in action on my personal blog at: http://www.gorbikoff.com/contact-us
+
+##Features / Bugs
+
+- Uses your DB as a storage (creates comfy_imprint_contacts table) for all contact attempts on your website. Really convenient if you want to find that one person who emailed you from your website about buying it for $1000000 and you accidentally deleted that email. Also can be used to send notifications to your users. (There is an opt-in / opt-out Boolean field to let users sign up for your SPAM.)
+- Several default fields that should be sufficient in 90% of use cases. Remember this should be an **EASY** contact-us form, not a credit application.
+- Built in validations / error checking for all fields ( phone, email, name, body, url, company name, is_subscribed). Has default error messages.
+- Default Placeholders (May the force be with you!).
+- Easily customizable to work with your CSS framework. Used in production on sites with both Bootstrap and Zurb Foundation.
+- I18n ready. Right now has English & Russian locales. More  translations are welcome.
+- Fields are configurable to be displayed / not displayed and required / not required.
+- Uses your Rails apps mail configuration. But you can configure who should receive notifications from contact form.
+- Right now it's not coupled to tightly with CMS so you might be able to use it outside of it as well. At least I don't see any reason why it wouldn't work.
+- Uses HAML & SimpleForm, but it can be easily overridden in your views if you want to.
+- I use it with Rails 3 and CMS 1.8 , however it should be usable with Rails 4 and CMS 1.9 . I will shortly start a new project that should confirm this.
+- Uses new hash syntax, so it's Ruby > 1.9 only.
+- Modify order in which fields are rendered. No need for overriding the view.
+- Uses minimal styling inside views, so entirely possible to style your contact form without touching gem at all with just a few rules in your application.css . If you use simple_form elsewhere it will just use your simple_form styling you already setup in your app.
+
+## Upcoming Features
+#### Pull Requests are welcome!
+
+- Tests, Tests, Tests!
+- Admin interface tie-in. Right now you need to use either a GUI tool for your DB or do some kind of export on ComfyImprint::Contact.all from console or rake task if you want to look at your contact attempts outside of your email.
+- Often  Contact Us page has  address / phone information & google / yahoo / bing map. So adding those would be nice. A proper Imprint / Impressum / Masthead page like in German-speaking countries. Right now this can be done manually by overriding view but in the future I would like to add this functionality so my users can update their own phone numbers and such.
+- Integration with delayed_job for sending emails. Right now I do this manually by overriding controller.
+- Adding some kind of Captcha mechanism.
+
+##Usage
+```ruby
+  # Gemfile
+  gem 'comfy_imprint'
+  bundle install
+
+  # Migrations
+  comfy_imprint:install:migrations
+  rake db:migrate
+
+  # Routes
+  mount ComfyImprint::Engine, at: "/contact-us"
+
+  # Config
+  # copy & edit initializer
+  rake comfy_imprint:install:copy_initializer
+
+```
+
+## Name
+Why didn't I name this ComfyContact or something similar? Because dealing with ComfyContact::Contact.contact is confusing and because I already have unrelated resource named Contact. While this gem is properly namespaced, it would be confusing for anyone else not familiar with your app. I'm guessing I'm not the only genius to have unrelated model called Contact in my app.
+
+## Acknowledgement and thank yous
+This gem was made possible due to generosity of folks at http://www.birica.com
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ComfyImprint'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/comfy_imprint/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/comfy_imprint/contacts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/comfy_imprint/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/comfy_imprint/contacts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/comfy_imprint/application_controller.rb

@@ -0,0 +1,2 @@
+class ComfyImprint::ApplicationController < ApplicationController
+end

data/app/controllers/comfy_imprint/contacts_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "comfy_imprint/application_controller"
+
+module ComfyImprint
+  class ContactsController < ApplicationController
+    before_filter :set_contact, only: [:show, :destroy]
+
+    def index
+      redirect_to root_path
+    end
+    # GET /contacts/1
+    def show
+    end
+
+    # GET /contacts/new
+    def new
+      @contact = Contact.new
+    end
+
+    # POST /contacts
+    def create
+      @contact = Contact.new(contact_params)
+      if @contact.save
+        # Contact Attempt passed validation so it's safe to mail it.
+        # In the future I may want to impleme nt some kind of delayed_job or redis hook here
+        ContactMailer.contact_email(@contact).deliver
+        redirect_to @contact#, notice: 'Contact was successfully created.'
+      else
+        render action: :new
+      end
+    end
+
+    # DELETE /contacts/1
+    def destroy
+      @contact.destroy
+      redirect_to contacts_url#, notice: 'Contact was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_contact
+        @contact = Contact.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def contact_params
+        params[:contact]
+      end
+  end
+end

data/app/helpers/comfy_imprint/application_helper.rb

@@ -0,0 +1,4 @@
+module ComfyImprint
+  module ApplicationHelper
+  end
+end

data/app/helpers/comfy_imprint/contacts_helper.rb

@@ -0,0 +1,4 @@
+module ComfyImprint
+  module ContactsHelper
+  end
+end

data/app/mailers/comfy_imprint/contact_mailer.rb

@@ -0,0 +1,11 @@
+module ComfyImprint
+  class ContactMailer < ActionMailer::Base
+    default from: ComfyImprint.configuration.mail_from,
+            to: ComfyImprint.configuration.mail_to,
+            subject: ComfyImprint.configuration.mail_subject
+    def contact_email(contact)
+      @contact = contact
+      mail
+    end
+  end
+end

data/app/models/comfy_imprint/contact.rb

@@ -0,0 +1,44 @@
+module ComfyImprint
+  class Contact < ActiveRecord::Base
+    attr_accessible :name, :email, :phone, :url, :company, :is_subscribed, :message
+
+    # You need to explictely set allow_blank: true on these validations, otherwise you'll run into a problem of blank values being invalid or too_short
+    # See comfy_imprint/app/validators for custom validators used here
+
+
+    validates :name,
+              length: {minimum: 2,  maximum: 100},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:name)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:name)}},
+              name: true
+    validates :email,
+              length: {minimum: 5,  maximum: 100},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:email)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:email)}},
+              email: true
+    validates :phone,
+              length: {minimum: 10, maximum: 20},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:phone)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:phone)}},
+              phone: true
+    validates :company,
+              length: {minimum: 2,  maximum: 200},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:company)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:company)}},
+              company_name: true
+    validates :url,
+              length: {minimum: 5,  maximum: 200},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:url)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:url)}},
+              url: true
+    validates :is_subscribed,
+              inclusion: {in: [true, false]},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:is_subscribed)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:is_subscribed)}}
+    validates :message,
+              length: {minimum: 5,  maximum: 1000},
+              presence: {if: -> {ComfyImprint.configuration.attributes_to_require.include?(:message)}},
+              allow_blank: {unless: -> {ComfyImprint.configuration.attributes_to_require.include?(:message)}},
+              clean_text: true
+  end
+end

data/app/validators/clean_text_validator.rb

@@ -0,0 +1,7 @@
+class CleanTextValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /^[a-zA-Z0-9\\(\)\-.\!\?\'\,\s]*$/i
+      record.errors.add attribute, (options[:message] || :invalid_clean_text)
+    end
+  end
+end

data/app/validators/company_name_validator.rb

@@ -0,0 +1,7 @@
+class CompanyNameValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /^[a-zA-Z0-9_\,\.\ \-]*$/i
+      record.errors.add attribute, (options[:message] || :invalid_company_name)
+    end
+  end
+end

data/app/validators/contact_method_validator.rb

@@ -0,0 +1,7 @@
+class ContactMethodValidator < ActiveModel::Validator
+  def validate(record)
+    unless (!record.addresses.empty? or !record.phones.empty? or !record.emails.empty? or !record.urls.empty?)
+      record.errors[:base] << "This contact doesn't have any methods of contacting them: like email or phone"
+    end  
+  end
+end

data/app/validators/email_validator.rb

@@ -0,0 +1,7 @@
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+      record.errors.add attribute, (options[:message] || :invalid_email)
+    end
+  end
+end

data/app/validators/name_validator.rb

@@ -0,0 +1,7 @@
+class NameValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /^[a-zA-Z0-9_\'\ \-]*$/i
+      record.errors.add attribute, (options[:message] || :invalid_name)
+    end
+  end
+end

data/app/validators/phone_validator.rb

@@ -0,0 +1,7 @@
+class PhoneValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /^[0-9x\(\)\ \.\-]*$/i
+      record.errors.add attribute, (options[:message] || :invalid_phone)
+    end
+  end
+end

data/app/validators/url_validator.rb

@@ -0,0 +1,7 @@
+class UrlValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$/ix
+      record.errors.add attribute, (options[:message] || :invalid_url)
+    end
+  end
+end

data/app/views/admin/comfy_imprint/contacts/edit.html.haml

@@ -0,0 +1,3 @@
+%h2
+  = t('comfy_imprint.contact_us')
+= render 'form'

data/app/views/admin/comfy_imprint/contacts/index.html.haml

@@ -0,0 +1,15 @@
+%h2 Listing contacts
+%table
+  %thead
+    %tr
+      %th
+      %th
+      %th
+  %tbody
+    - @contacts.each do |contact|
+      %tr
+        %td= link_to 'Show', contact
+        %td= link_to 'Edit', edit_contact_path(contact)
+        %td= link_to 'Destroy', contact, method: :delete, data: { confirm: 'Are you sure?' }
+%br/
+= link_to 'New Contact', new_contact_path

data/app/views/admin/comfy_imprint/contacts/new.html.haml

@@ -0,0 +1,3 @@
+%h2
+  = t('comfy_imprint.contact_us')
+= render 'form'

data/app/views/admin/comfy_imprint/contacts/show.html.haml

@@ -0,0 +1,6 @@
+%h2
+  = t('comfy_imprint.contact_us')
+
+= link_to 'Edit', edit_contact_path(@contact)
+|
+\#{link_to 'Back', contacts_path}