pointless_feedback 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Viget
+
+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,138 @@
+# Pointless Feedback
+
+A Rails engine that provides a platform for your app to submit user feedback to
+a specified service. Messages are stored in your database as a fail-safe when
+the specified service is unavailable. Currently, only email, Unfuddle, and
+Github Issues are supported.
+
+*Brought to you by the fine folks at [Viget](http://viget.com) and commissioned
+under [Pointless Corp](http://www.pointlesscorp.com/).*
+
+## Contents
+
+1. [Installation](#installation)
+2. [Customization](#customization)
+3. [Development](#development)
+4. [Roadmap](#roadmap)
+5. [Contributors](#contributors)
+
+## Installation
+
+Pointless Feedback has been tested against Rails 3.2+. To install, simply add
+the following to your Gemfile:
+
+```ruby
+gem 'pointless_feedback', :git => 'git@github.com:vigetlabs/pointless-feedback.git'
+```
+
+After you install Pointless Feedback and add it to your Gemfile, you need to
+run the generator and install the engine migrations:
+
+```
+bundle exec rails generate pointless_feedback:install
+bundle exec rake pointless_feedback:install:migrations
+bundle exec rake db:migrate
+```
+
+The generator will install an initializer which describes ALL Pointless
+Feedback's configuration options and you MUST take a look at it. When you are
+done, you are ready to mount the routes in your `config/routes.rb` file.
+
+```ruby
+mount PointlessFeedback::Engine, :at => '/feedback'
+```
+
+Pointless Feedback uses flash messages to let users know if feedback was
+successfully sent. Pointless Feedback expects your application to call
+`flash[:notice]` as appropriate.
+
+After submitting feedback, Pointless Feedback will use your application's
+default `root_path`. This means that you need to set the root inside your
+routes:
+
+```ruby
+root :to => 'home#index'
+```
+
+That's it! Start your Rails server and navigate to `/feedback` to see a basic
+feedback form that users can submit.
+
+## Customization
+
+Pointless Feedback provides you with a simple setup that should cover most
+cases. However, certain things are customizable to suit your app's needs.
+
+#### Views
+
+Since Pointless Feedback is an engine, all its views are packaged inside the
+gem. These views will help you get started, but after some time you may want
+to change them. If this is the case, you just need to invoke the following
+generator, and it will copy all views to your application:
+
+```
+bundle exec rails generate pointless_feedback:views
+```
+
+After doing so, you will find the views at `app/views/pointless_feedback/`
+within your application.
+
+**Note: Any url helpers used while on the feedback form page will need to prefaced with `main_app`.**
+
+#### I18n
+
+Most of the messaging in the Pointless Feedback engine uses I18n and can be
+customized within your respective localization file.
+
+To customize the flash notification upon successful submission, add the
+following to your `config/locales/en.yml` file:
+
+```yml
+pointless_feedback:
+  messages:
+    saved: "Thanks for your feedback!"
+```
+
+The error messages output defaults to the following:
+
+```yml
+activerecord:
+  errors:
+    header: "Invalid Fields"
+    message: "Correct the following errors and try again."
+```
+
+To customize the subject of the feedback email, add the following to your
+`config/locales/en.yml` file as well:
+
+```yml
+pointless_feedback:
+  email:
+    subject: "Pointless Feedback"
+```
+
+#### Controllers
+
+You can overwrite `after_message_create_path` in your `ApplicationController`
+to customize your redirect hook.
+
+## Development
+
+1. Clone the repo: `git clone git://github.com/vigetlabs/pointless-feedback.git`
+2. Install dependencies: `bundle install`
+3. Setup databases: `bundle exec rake db:migrate && rake app:db:test:prepare`
+4. Run the test suite: `bundle exec rake test`
+5. Make your changes in a feature branch
+6. Make sure the test suite passes before submitting a Pull Request
+
+## Roadmap
+
+- [ ] Add service to send to Unfuddle
+- [ ] Add service to send to Github
+- [ ] Add admin view for messages with comments
+
+## Contributors
+
+* [@zporter](https://github.com/zporter)
+* [@efatsi](https://github.com/efatsi)
+
+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    = 'PointlessFeedback'
+  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/pointless_feedback/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/stylesheets/pointless_feedback/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/controllers/pointless_feedback/messages_controller.rb

@@ -0,0 +1,22 @@
+module PointlessFeedback
+  class MessagesController < PointlessFeedback.parent_controller.constantize
+    helper PointlessFeedback::ApplicationHelper
+
+    def new
+      @message = Message.new
+    end
+
+    def create
+      @message = Message.new(params[:message])
+
+      if @message.save
+        flash[:notice] = I18n.t('pointless_feedback.messages.saved',
+                                :default => 'Thanks for your feedback!')
+
+        redirect_to after_message_create_path
+      else
+        render :new
+      end
+    end
+  end
+end

data/app/helpers/pointless_feedback/application_helper.rb

@@ -0,0 +1,26 @@
+module PointlessFeedback
+  module ApplicationHelper
+    delegate :root_url, :root_path, :to => :main_app
+
+    # Can search for named routes directly in the main app, omitting
+    # the "main_app." prefix
+    def method_missing(method, *args, &block)
+      if main_app_url_helper?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_all)
+      main_app_url_helper?(method) || super
+    end
+
+
+    private
+
+    def main_app_url_helper?(method)
+      /\A\w+(_path|_url)\z/ === method.to_s && main_app.respond_to?(method)
+    end
+  end
+end

data/app/mailers/pointless_feedback/feedback_mailer.rb

@@ -0,0 +1,16 @@
+module PointlessFeedback
+  class FeedbackMailer < ActionMailer::Base
+    default :from => PointlessFeedback.from_email
+
+    def feedback(email, message)
+      @message = message
+      mail(:to => email, :subject => feedback_subject)
+    end
+
+    private
+
+    def feedback_subject
+      I18n.t('pointless_feedback.email.subject', :default => 'Pointless Feedback')
+    end
+  end
+end

data/app/models/pointless_feedback/message.rb

@@ -0,0 +1,26 @@
+module PointlessFeedback
+  class Message < ActiveRecord::Base
+    attr_accessible :description, :email_address, :name, :topic, :contact_info
+    attr_accessor :contact_info
+
+    validates :name, :email_address, :topic, :description, :presence => true
+    validates :topic, :inclusion => PointlessFeedback.message_topics
+    validates :email_address, :format => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+
+    after_save :export_feedback, :unless => :honeypot_filled_in?
+
+    private
+
+    def export_feedback
+      if PointlessFeedback.email_feedback
+        PointlessFeedback.to_emails.each do |email|
+          FeedbackMailer.feedback(email, self).deliver
+        end
+      end
+    end
+
+    def honeypot_filled_in?
+      contact_info.present?
+    end
+  end
+end

data/app/views/layouts/pointless_feedback/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PointlessFeedback</title>
+  <%= stylesheet_link_tag    "pointless_feedback/application", :media => "all" %>
+  <%= javascript_include_tag "pointless_feedback/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pointless_feedback/feedback_mailer/feedback.html.erb

@@ -0,0 +1,6 @@
+You've got feedback!
+
+<p>Name: <%= @message.name %></p>
+<p>Email Address: <%= @message.email_address %></p>
+<p>Topic: <%= @message.topic %></p>
+<p>Description: <%= @message.description %></p>

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

@@ -0,0 +1,57 @@
+<%= form_for @message do |f| %>
+  <% if @message.errors.any? %>
+    <div class="error_messages">
+      <h2>
+        <%= I18n.t('activerecord.errors.header', :default => 'Invalid Fields') %>
+      </h2>
+
+      <p>
+        <%= I18n.t('activerecord.errors.message', :default => 'Correct the following errors and try again.') %>
+      </p>
+
+      <ul>
+        <% @message.errors.full_messages.each do |message| %>
+          <li><%= message.html_safe %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <fieldset class="user-fields">
+    <legend>About You</legend>
+
+    <div class="field">
+      <%= f.label :name %>
+      <%= f.text_field :name %>
+    </div>
+
+    <div class="field">
+      <%= f.label :email_address %>
+      <%= f.text_field :email_address %>
+    </div>
+  </fieldset>
+
+  <fieldset class="feedback-fields">
+    <legend>Leave Your Feedback</legend>
+
+    <div class="field">
+      <%= f.label :topic %>
+      <%= f.select :topic, PointlessFeedback.message_topics, { :prompt => true } %>
+    </div>
+
+    <div class="field">
+      <%= f.label :description %>
+      <%= f.text_area :description %>
+    </div>
+
+    <!-- This is a honeypot field to keep the spammers away. Do not remove. -->
+    <!-- If this field is filled in, feedback will not be emailed -->
+    <div class="contact-input" style="position: absolute; left: -9999px;">
+      <%= f.text_field :contact_info %>
+    </div>
+    <!-- End of honeypot field -->
+
+  </fieldset>
+
+  <%= f.submit 'Submit' %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/config/routes.rb

@@ -0,0 +1,5 @@
+PointlessFeedback::Engine.routes.draw do
+  root :to => 'messages#new'
+
+  resources :messages, :only => [:new, :create]
+end

data/db/migrate/20130501182659_create_pointless_feedback_messages.rb

@@ -0,0 +1,12 @@
+class CreatePointlessFeedbackMessages < ActiveRecord::Migration
+  def change
+    create_table :pointless_feedback_messages do |t|
+      t.string :name
+      t.string :email_address
+      t.string :topic
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/pointless_feedback/install_generator.rb

@@ -0,0 +1,13 @@
+module PointlessFeedback
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a PointlessFeedback initializer for your application."
+
+      def copy_initializer
+        template "pointless_feedback.rb", "config/initializers/pointless_feedback.rb"
+      end
+    end
+  end
+end

data/lib/generators/pointless_feedback/views_generator.rb

@@ -0,0 +1,16 @@
+module PointlessFeedback
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copies Pointless Feedback views to your application."
+      source_root File.expand_path("../../../../app/views/pointless_feedback", __FILE__)
+
+      public_task :copy_views
+
+      def copy_views
+        directory 'messages', 'app/views/pointless_feedback/messages' do |content|
+          content
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/pointless_feedback.rb

@@ -0,0 +1,13 @@
+PointlessFeedback.setup do |config|
+  # ==> Message Configuration
+  # Configure the topics for the user to choose from on the feedback form
+  # config.message_topics = ['Error on page', 'Other']
+
+  # ==> Email Configuration
+  # Configure feedback email properties (disabled by default)
+  # Variables needed for emailing feedback
+  config.email_feedback = false
+  # config.from_email   = 'feedback@pointlesscorp.com'
+  # config.to_emails    = ['first@example.com', 'second@example.com']
+
+end

data/lib/pointless_feedback/controllers/helpers.rb

@@ -0,0 +1,10 @@
+module PointlessFeedback
+  module Controllers
+    # Those helpers are convenience methods added to ApplicationController.
+    module Helpers
+      def after_message_create_path
+        main_app.respond_to?(:root_path) ? main_app.root_path : '/'
+      end
+    end
+  end
+end

data/lib/pointless_feedback/engine.rb

@@ -0,0 +1,13 @@
+module PointlessFeedback
+  class Engine < ::Rails::Engine
+    isolate_namespace PointlessFeedback
+
+    initializer "pointless_feedback.controller.helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        if defined?(PointlessFeedback::Controllers::Helpers)
+          include PointlessFeedback::Controllers::Helpers
+        end
+      end
+    end
+  end
+end

data/lib/pointless_feedback/version.rb

@@ -0,0 +1,3 @@
+module PointlessFeedback
+  VERSION = "1.0.0"
+end

data/lib/pointless_feedback.rb

@@ -0,0 +1,32 @@
+require "pointless_feedback/engine"
+
+module PointlessFeedback
+  module Controllers
+    autoload :Helpers, 'pointless_feedback/controllers/helpers'
+  end
+
+  # The parent controller all PointlessFeedback controllers inherit from.
+  # Defaults to ApplicationController. This should be set early
+  # in the initialization process and should be set to a string.
+  mattr_accessor :parent_controller
+  @@parent_controller = "ApplicationController"
+
+  # Custom topics to display on message form
+  mattr_accessor :message_topics
+  @@message_topics = ['Error on page', 'Other']
+
+  # Variables needed for emailing feedback
+  mattr_accessor :email_feedback
+  @@send_emails = false
+  mattr_accessor :from_email
+  @@from_email = 'feedback@pointlesscorp.com'
+  mattr_accessor :to_emails
+  @@to_emails = ['first@example.com', 'second@example.com']
+
+  # Default way to setup PointlessFeedback. Run rails generate
+  # pointless_feedback_install to create a fresh initializer with all
+  # configuration values.
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/pointless_feedback_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pointless_feedback do
+#   # Task goes here
+# end