hyalin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1af9ca218cc248b79ac34cbf8ad6fd240b8a7d5a
+  data.tar.gz: b73be750259323ac19526213d9be625020f62f7f
+SHA512:
+  metadata.gz: a7c5ade430147b218675dfc30708d87d6a3d7289208052a1d10d0977b6ea43693bdef02613c61e2f70f9e6b29c9a7a94062a17a56d099b32905c4a1049ce7da7
+  data.tar.gz: 8dc49731f737ada9179d1e09f53a16bd58c9389454ec0854228388a3457be6326110c9a87b70a528910b5cf246776ccd1b1ebc89c46af77f4805f238917d57ab

data/README.md

@@ -0,0 +1,79 @@
+## Hyalin (paper)
+
+A Rails 3+ Engine providing a basic contact form.
+
+## Requirements
+
+Hyalin requires:
+
+* Ruby >= 1.9.3
+* Rails >= 3.0.0
+
+It is also recommended to use SimpleForm in order to hook into your apps custom form builders.
+Heavily inspired on [jdutil/contact_us](https://github.com/jdutil/contact_us)
+
+## Installation
+
+In your `Gemfile`, add the following dependencies:
+
+```ruby
+gem hyalin', '~> 0.1.0'
+```
+
+From `Rails.root` in your Terminal run:
+
+```shell
+bundle
+bundle exec rake hyalin:install
+```
+
+In `config/initializers/hyalin.rb` modify:
+
+```ruby
+config.mailer_to = "contact@please-change-me.com"
+```
+
+Change to the email address you would like to receive the form submissions at for example:
+
+```ruby
+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:
+
+```ruby
+config.mailer_from = "dontreply@yourdomain.com"
+```
+
+
+### Views
+
+To copy the view files to `app/views/hyalin`, and customize them to suit your needs run:
+
+```shell
+bundle exec rake hyalin:copy_views
+```
+
+### Locales
+
+To copy the locale files to `config/locales/hyalin.*.yml`, and customize them to suit your needs run:
+
+```shell
+bundle exec rake hyalin:copy_locales
+```
+
+Please feel free to submit your own locales so that other users will hopefully find this gem more useful in your language.
+
+
+## Usage
+
+Visit your website and navigate to `/messages/new` to see the form in action.
+
+## Issues
+
+Please report any bugs or feature requests to the Github issues page @
+https://github.com/indefinido/hyalin/issues
+
+
+This project rocks and uses [WTFP-LICENSE](http://www.wtfpl.net)

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    = 'Hyalin'
+  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/WTFP-LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/app/assets/javascripts/hyalin/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/hyalin/messages.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/hyalin/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/hyalin/messages.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/controllers/hyalin/messages_controller.rb

@@ -0,0 +1,39 @@
+require_dependency "hyalin_controller"
+
+module Hyalin
+  class MessagesController < HyalinController
+
+    # GET /message/new
+    # GET /message/new.json
+    def new
+      @message = Message.new
+
+      respond_to do |format|
+        format.html
+        format.json { render :json => @message }
+      end
+    end
+
+    # POST /messages
+    # POST /messages.json
+    def create
+      @message = Message.new(params[:hyalin_message])
+
+      respond_to do |format|
+        if @message.save
+          format.html { redirect_to after_send_path, :notice => t('hyalin.messages.sent_success') }
+          format.json { render :json => @message, :status => :created, :location => @message      }
+        else
+          format.html { render_new_action }
+          format.json { render :json => {errors: @message.errors}, :status => :unprocessable_entity }
+        end
+      end
+    end
+
+    private
+
+    def after_send_path
+      Hyalin.after_sent_redirect_to
+    end
+  end
+end

data/app/controllers/hyalin_controller.rb

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

data/app/helpers/hyalin/application_helper.rb

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

data/app/helpers/hyalin/messages_helper.rb

@@ -0,0 +1,4 @@
+module Hyalin
+  module MessagesHelper
+  end
+end

data/app/mailers/hyalin/postman.rb

@@ -0,0 +1,16 @@
+class Hyalin::Postman < ActionMailer::Base
+  default :from     => Hyalin.mailer_from,
+          :subject  => I18n.t('hyalin.mailer.hyalin_mail.subject'),
+          :to       => Hyalin.mailer_to
+
+  # TODO Create Hyalin.mailer_layout
+  layout 'hyalin/postman'
+
+  def hyalin_email message
+    @message = message
+
+    mail :from     => message.email,
+         :reply_to => message.email,
+         :subject  => message.subject
+  end
+end

data/app/models/hyalin/message.rb

@@ -0,0 +1,30 @@
+module Hyalin
+  class Message
+    include Mongoid::Document
+
+    field :body, type: String
+    field :email, type: String
+    field :name, type: String
+    field :phone, type: String
+    field :subject, type: String
+
+    validates :body, :presence => true
+
+    # TODO rewrite method definition when persisting
+    # messages
+
+    if Hyalin.persist_messages
+      validate :persisted?, :message => 'Can\'t update hyalin messages!'
+    end
+
+    def save
+      if self.valid?
+        Hyalin::Postman.hyalin_email(self).deliver
+        super if Hyalin.persist_messages
+        return true
+
+      end
+      return false
+    end
+  end
+end

data/app/views/hyalin/messages/new.html.erb

@@ -0,0 +1,3 @@
+<h1><%= t '.hyalin.message.new.title' %></h1>
+
+<h2>Simple hyalin form not supported yet </h2>

data/app/views/hyalin/messages/show.html.erb

@@ -0,0 +1,30 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Name:</b>
+  <%= @message.name %>
+</p>
+
+<p>
+  <b>Email:</b>
+  <%= @message.email %>
+</p>
+
+<p>
+  <b>Subject:</b>
+  <%= @message.subject %>
+</p>
+
+<p>
+  <b>Body:</b>
+  <%= @message.body %>
+</p>
+
+<p>
+  <b>Phone:</b>
+  <%= @message.phone %>
+</p>
+
+
+<%= link_to 'Edit', edit_message_path(@message) %> |
+<%= link_to 'Back', messages_path %>

data/config/locales/contact.en.yml~

@@ -0,0 +1,10 @@
+en:
+  contact:
+    messages:
+      sent_success: Message delivered!
+      new: &contact-message
+        title: Contact Us
+        submit: Send Message
+      new_formtastic:
+        <<: *contact-message
+      new_simple_form: 

data/config/locales/contact.pt-BR.yml~

@@ -0,0 +1,28 @@
+pt-BR:
+  activerecord:
+    models:
+      contact/message:
+        one: Mensagem de Contato
+        other: Mensagens de Contato
+    attributes:
+      timestamps: &timestamps
+        created_at: Criado Em
+        updated_at: Atualizado Em
+      contact/message:
+        <<: *timestamps
+        name: Nome
+        body: Mensagem
+  contact_email:
+    sent_by_name: 'Enviado por:'
+  contact:
+    messages:
+      sent_success: Mensagem enviada!
+      new: &contact-message
+        title: Contate-nos
+        name: Nome
+        message: Mensagem
+        submit: Enviar Mensagem
+      new_formtastic:
+        <<: *contact-message
+      new_simple_form:
+        <<: *contact-message

data/config/locales/hyalin.en.yml

@@ -0,0 +1,12 @@
+en:
+  hyalin:
+    messages:
+      sent_success: Message delivered!
+      new: &hyalin-message
+        title: Contact Us
+        submit: Send Message
+      new_simple_form:
+        <<: *hyalin-message
+    hyalin_email:
+      postman:
+        sent_by_name: 'Sent By:'

data/config/locales/hyalin.pt-BR.yml

@@ -0,0 +1,27 @@
+pt-BR:
+  activerecord:
+    models:
+      hyalin/message:
+        one: Mensagem de Contato
+        other: Mensagens de Contato
+    attributes:
+      timestamps: &timestamps
+        created_at: Criado Em
+        updated_at: Atualizado Em
+      hyalin/message:
+        <<: *timestamps
+        name: Nome
+        body: Mensagem
+  hyalin:
+    postman:
+      hyalin_email:
+        sent_by_name: 'Enviado por:'
+    messages:
+      sent_success: Mensagem enviada!
+      new: &hyalin-message
+        title: Contate-nos
+        name: Nome
+        message: Mensagem
+        submit: Enviar Mensagem
+      new_simple_form:
+        <<: *hyalin-message

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope module: :hyalin do
+    resource :messages
+  end
+end

data/lib/hyalin/engine.rb

@@ -0,0 +1,7 @@
+module Hyalin
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/hyalin/tasks/install.rb

@@ -0,0 +1,31 @@
+module Hyalin
+  module Tasks
+    require 'rails/generators'
+
+    class Install < Rails::Generators::Base
+
+      def copy_initializer_file
+        template 'hyalin.rb', 'config/initializers/hyalin.rb'
+      end
+
+      def copy_locales_files
+        directory 'config/locales'
+      end
+
+      def copy_view_files
+        unless self.config[:no_views]
+          directory 'app/views/hyalin/messages'
+        end
+      end
+
+      private
+      def self.add_templates_path!
+        current_directory = File.dirname(__FILE__)
+        source_paths << File.join(current_directory, 'templates')
+        source_paths << File.expand_path(File.join current_directory, '..', '..', '..')
+      end
+
+      add_templates_path!
+    end
+  end
+end

data/lib/hyalin/tasks/templates/hyalin.rb

@@ -0,0 +1,24 @@
+# Use this hook to configure hyalin mailer.
+Hyalin.setup do |config|
+
+  # ==> Mailer Configuration
+
+  # Configure the e-mail address which email notifications should be sent from.  If emails must be sent from a verified email address you may set it here.
+  # Example:
+  # config.mailer_from = "hyalin@please-change-me.com"
+  config.mailer_from = nil
+
+  # Configure the e-mail address which should receive the hyalin form email notifications.
+  config.mailer_to = "hyalin@please-change-me.com"
+
+  # ==> Controller Configuration
+
+  # Where to redirect after successufully sending message
+  # flash[:notice] will hold the message status
+  config.after_sent_redirect_to = :root_path
+
+  # Store messages on database?
+  # You must copy and run migrations
+  # rake hyalin:install:migrations
+  config.persist_messages = false
+end

data/lib/hyalin/version.rb

@@ -0,0 +1,3 @@
+module Hyalin
+  VERSION = "0.1.0"
+end

data/lib/hyalin.rb

@@ -0,0 +1,20 @@
+module Hyalin
+  require "hyalin/engine"
+
+  # Address contact email notifications are sent from.
+  mattr_accessor :mailer_from
+
+  # Address to send contact email notifications to.
+  mattr_accessor :mailer_to
+
+  # Redirect url after succefully sending message
+  mattr_accessor :after_sent_redirect_to
+
+  # Store messages on database?
+  mattr_accessor :persist_messages
+
+  # Default way to setup
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/hyalin_tasks.rake

@@ -0,0 +1,20 @@
+require File.expand_path('../../hyalin/tasks/install', __FILE__)
+
+namespace :hyalin do
+  desc "Install hyalin"
+  task :install do
+    installation = Hyalin::Tasks::Install.new
+    installation.copy_initializer_file
+    installation.copy_locales_files
+  end
+
+  desc "Copy only locale files (part of install, but useful for updates when only assets are needed)"
+  task :copy_locales do
+    Hyalin::Tasks::Install.new.copy_locales_files
+  end
+
+  desc "Copy only view files so you can customize them"
+  task :copy_views do
+    Hyalin::Tasks::Install.new.copy_view_files
+  end
+end

data/test/contact_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class HyalinTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Hyalin
+  end
+end