contactus 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3213c8e94234c29cb803843ccb8da865c6d3e39b
+  data.tar.gz: a53bfaf1530e4cbc21891206bd05ab8871fbc6f5
+SHA512:
+  metadata.gz: 8d0a46381c07ace550f26f4036e06812034a1c2b3170180c16f3692087003a3bb9b35d836165fbd5df6ead8b74411f1104ac4668b23e9f757e57d336c374cd09
+  data.tar.gz: 5fff18731845e27020ebe2cf00fbbba615c2e853ed8cf3db440950721f31833ff7580920da555aca2b2ee5c7972924c11fe97363fb3292e0d302e3a04df49b34

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,36 @@
+= Contactus
+
+Contactus is a simple Ruby on Rails gem that generate a contact form for your site.
+
+Note: This game is still in development, thanks your patience :P
+
+== How to use this gem
+
+Add the gem to your Gemfile
+
+      gem 'contactus'
+
+Install the gem:
+
+      $ bundler
+      $ bundle exec rake contactus:install
+
+Go to your site
+
+      $ http://0.0.0.0:3000/contact
+
+== Customization
+
+There will be a initializer file called contactus.rb, where you can configure the next config variables:
+
+      # Configure the e-mail address which should receive the email
+      config.mailer_to = "contact@example.com"
+
+      # Configure the e-mail address which should receive the cc email
+      #config.mailer_cc = "contact@example.com"      
+
+      # Configure extra fields
+      #config.extra_fields = %w(city phone)
+
+      # Configure extra required fields
+      #config.required_extra_fields = %w(country address)

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Contactus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+ 
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+ 
+task :default => :spec

data/app/controllers/contactus/application_controller.rb

@@ -0,0 +1,5 @@
+module Contactus
+  class ApplicationController < ActionController::Base
+    layout 'layouts/application'
+  end
+end

data/app/controllers/contactus/contact_forms_controller.rb

@@ -0,0 +1,31 @@
+module Contactus
+
+  class ContactFormsController < ApplicationController 
+
+    def new 
+      @contact_form = ContactForm.new
+    end
+
+    def create
+      begin
+        @contact_form = ContactForm.new(params[:contactus_contact_form])
+        @contact_form.request = request
+
+        if !@contact_form.deliver
+          if @contact_form.spam?
+            flash[:error] = I18n.t('.contactus.contact_forms.spam')
+            redirect_to root_path
+          else
+            render :new
+          end
+        end
+
+      rescue ScriptError
+        flash[:error] = I18n.t('.contactus.contact_forms.spam')
+        redirect_to root_path
+      end
+    end
+
+  end
+
+end

data/app/models/contactus/contact_form.rb

@@ -0,0 +1,43 @@
+module Contactus
+
+  class Contactus::ContactForm < MailForm::Base
+    attribute :name,      :validate => true
+    attribute :email,     :validate => /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+    attribute :message,   :validate => true
+    attribute :nickname,  :captcha  => true
+
+    append :remote_ip, :user_agent, :session
+
+    if Contactus.extra_fields
+      Contactus.extra_fields.each do |field|
+        self.class_eval do; attribute field.to_sym; end
+      end
+    end
+
+    if Contactus.required_extra_fields
+      Contactus.required_extra_fields.each do |field|
+        self.class_eval do; attribute field.to_sym, :validate => true; end
+      end
+    end
+
+    def headers
+      default_header.merge(cc_header)
+    end
+
+    private
+
+    def default_header
+      {
+        :subject => I18n.t('.contactus.contact_forms.subject'),
+        :to => Contactus.mailer_to,
+        :from => %("#{name}" <#{email}>)
+      }      
+    end
+
+    def cc_header
+      (Contactus.mailer_cc)? { :cc => Contactus.mailer_cc } : {}
+    end
+
+  end
+
+end

data/app/views/contactus/contact_forms/create.html.haml

@@ -0,0 +1,2 @@
+= t('.thanks', default: 'Gracias por escribirnos, pronto nos pondremos en contacto contigo.')
+= link_to t('.back', default: 'Regresar'), root_path

data/app/views/contactus/contact_forms/new.html.haml

@@ -0,0 +1,11 @@
+= simple_form_for @contact_form do |f|
+
+  = f.input :name, :autofocus => true, :required => true 
+  = f.input :city
+  = f.input :email, :required => true 
+  = f.input :message, :as => :text, :required => true 
+  
+  .hidden
+    = f.input :nickname, :hint => t('.captcha_field', default: 'Leave this field blank!')
+
+  = f.button :submit, t('.send', default: 'Send')

data/config/locales/es.yml

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+es:
+  mail_form:
+    models:
+      contactus/contact_form: 
+        one: "Contacto"
+        other: 'Contactos'
+   
+    attributes:
+      contactus/contact_form:
+        name: "Nombres y Apellidos"
+        email: 'Correo electrónico'
+        message: "Comentarios"
+
+    request:
+      title: "Información técnica sobre el usuario"
+      remote_ip: "Dirección IP"
+      user_agent: "Navegador"
+
+
+  contactus:
+    contact_forms:
+      success: 'Gracias por escribirnos, pronto nos pondremos en contacto contigo.'
+      spam: 'Lo sentimos, este mensaje aparece como spam y no se entregó.'
+      subject: 'Alguien se a puesto en contacto.'
+
+      new:
+        send: 'Enviar'
+        captcha_field: 'Deje este campo en blanco'
+

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+
+  namespace :contactus do
+    resources :contact_forms, :only => [:new, :create]
+  end
+
+  get 'contact' => 'contactus/contact_forms#new', :as => :contact
+
+end

data/lib/contactus.rb

@@ -0,0 +1,21 @@
+require "contactus/engine"
+
+module Contactus
+
+  # Address to send the email.
+  mattr_accessor :mailer_to
+
+  # Address to send the cc email.
+  mattr_accessor :mailer_cc
+
+  # Extra fields
+  mattr_accessor :extra_fields
+
+  # Required Extra fields
+  mattr_accessor :required_extra_fields
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/contactus/engine.rb

@@ -0,0 +1,17 @@
+require 'mail_form'
+require 'haml-rails'
+require 'simple_form'
+require 'rails-i18n'
+
+module Contactus
+  class Engine < ::Rails::Engine
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir:     'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+  end
+end

data/lib/contactus/tasks/install.rb

@@ -0,0 +1,35 @@
+require 'rails/generators'
+
+module Contactus
+  module Tasks
+    class Install
+      class << self
+
+        def run
+          copy_initializer_file
+          puts "Done!"
+        end
+
+        def copy_initializer_file
+          print "Copying initializer file...\n"
+          app_path = Rails.root.join("config/initializers")
+          copier.copy_file File.join(gem_path, 'lib/templates/contactus.rb'), File.join(app_path, 'contactus.rb')
+        end
+
+        private
+
+        def gem_path
+          File.expand_path('../../..', File.dirname(__FILE__))
+        end
+
+        def copier
+          unless @copier
+            Rails::Generators::Base.source_root(gem_path)
+            @copier = Rails::Generators::Base.new
+          end
+          @copier
+        end
+      end
+    end
+  end
+end

data/lib/contactus/version.rb

@@ -0,0 +1,3 @@
+module Contactus
+  VERSION = "0.0.4"
+end

data/lib/tasks/hola_tasks.rake

@@ -0,0 +1,10 @@
+require File.expand_path('../../contactus/tasks/install', __FILE__)
+
+namespace :contactus do
+  
+  desc "Install contactus"
+  task :install do
+    Contactus::Tasks::Install.run
+  end
+
+end

data/lib/templates/contactus.rb

@@ -0,0 +1,17 @@
+# Use this hook to configure contact mailer.
+
+Contactus.setup do |config|
+
+  # Configure the e-mail address which should receive the email
+  config.mailer_to = "contact@example.com"
+
+  # Configure the e-mail address which should receive the cc email
+  #config.mailer_cc = "contact@example.com"
+
+  # Configure extra fields
+  #config.extra_fields = %w(city phone)
+
+  # Configure extra required fields
+  #config.required_extra_fields = %w(country address)
+
+end

data/spec/acceptance/contactus/contact_forms_spec.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+require 'spec_helper'
+
+feature 'Contact Form', %q{
+  As a user
+  I can send a message using the contact form
+} do
+
+  before do
+    Contactus.mailer_to = "webmaster@example.com"
+    visit "/contact"
+  end
+
+  scenario 'without mandatory fields' do
+    click_button 'Enviar'
+
+    page.should have_content "Nombres y Apellidosno puede estar en blanco"
+    page.should have_content "Correo electrónicono puede estar en blanco"
+    page.should have_content "Comentariosno puede estar en blanco"
+  end
+
+  scenario 'with mandatory fields' do
+    fill_in "Nombres y Apellidos", with: 'Bill Hicks'
+    fill_in "Correo electrónico", with: 'beelzebozo@example.com'
+    fill_in "Comentarios", with: "If you think you’re free, try going somewhere without fucking money, okay?"
+
+    click_button 'Enviar'
+
+    page.should have_content "Gracias por escribirnos, pronto nos pondremos en contacto contigo."
+  end
+
+  scenario 'spam email' do
+    fill_in "Nombres y Apellidos", with: 'Bill Hicks'
+    fill_in "Correo electrónico", with: 'beelzebozo@example.com'
+    fill_in "Comentarios", with: "If you think you’re free, try going somewhere without fucking money, okay?"
+    fill_in "Nickname", with: "Hey there"
+
+    click_button 'Enviar'
+
+    page.should have_content "Lo sentimos, este mensaje aparece como spam y no se entregó."
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end