feedbacker 0.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+.tmp*
+.redcar
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Worldwide IDEA, Inc  http://www.wwidea.org
+
+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

@@ -0,0 +1,34 @@
+Feedbacker
+==========
+
+Feedbacker provides a tab for users to contact developers from within the application
+
+
+Assumptions
+===========
+
+Feedbacker assumes that you're using...
+  At least Rails 3.1.3
+  The Rails Asset Pipeline
+  Jquery
+
+Installation
+============
+1. Add the following to your Gemfile
+gem :feedbacker
+
+2. Run `bundle install`
+
+3. Add the following line to your application layout
+<%= javascript_include_tag :feedbacker %>
+
+4. Add the following line to your application layout before you call application.css. Override default settings in application.css
+<%= stylesheet_link_tag :feedbacker %>
+
+5. Add the following line right after the body tag in your application layout
+<%= render(:partial => 'feedbacker/tab') unless current_user.is_guest? %>
+
+6. Add the folllowing line to config/application.rb
+config.paths['db/migrate'] = Feedbacker::Engine.paths['db/migrate'].existent
+
+Copyright (c) 2009 WWIDEA, Inc. released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the feedbacker plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the feedbacker plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Feedbacker'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/assets/javascripts/feedbacker.js

@@ -0,0 +1,12 @@
+Feedback = {
+  show_form: function() {
+    $('#expanded_feedback_form').show();
+    $('#compressed_feedback_form_tab').hide();
+  },
+  
+  hide_form: function() {
+    $('#compressed_feedback_form_tab').show();
+    $('#expanded_feedback_form').hide();
+  }
+  
+}

data/app/assets/stylesheets/feedbacker.css.erb

@@ -0,0 +1,102 @@
+/********************
+
+  FEEDBACKER DEFAULT STYLES
+  
+  OVERRIDE IN APPLICATION.CSS
+
+********************/
+
+#feedback input[value="Submit Feedback"] {
+  margin-top: -0.75em;
+}
+
+.feedback, .feedback a, .feedback a:hover {
+  background: #FFAC48;
+  color: #fff;
+  font-weight:bold;
+  padding: 0 3px;
+  border-bottom: 0;
+}
+
+#feedback {
+  position: fixed;
+  top: 55px;
+  left:0;
+  z-index: 10;
+/*  width: 440px;*/
+}
+
+#feedback p {
+  margin:0;
+  padding:0;
+  color: #fff;
+}
+
+#feedback div {
+  margin-top: 0;
+}
+  
+#compressed_feedback_form_tab {
+  float: left;
+  height: 155px;
+}
+
+#expanded_feedback_form_tab img {
+  position: absolute;
+  top: 0;
+  left: 430px;
+}
+
+:first-child+html #expanded_feedback_form_tab img {
+  position: absolute;
+  top: 0;
+  left: 436px;
+}
+
+#compressed_feedback_form_tab a {
+  border-bottom: 0;
+}
+
+#expanded_feedback_form_tab a {
+  border-bottom: 0;
+}
+
+#feedback label {
+  display:inline;
+  width: auto;
+  color: #fff;
+  margin-left: 1em;
+}
+  
+#remark_content {
+  width: 400px;
+  height: 60px;
+  padding: 0.5em;
+  margin-left: 1em;
+  font: 12px "Trebuchet MS", Verdana, Arial, sans-serif;
+  overflow-y: auto;
+}
+  
+#expanded_feedback_form {
+  background: url(<%= asset_data_uri 'feedback_tab_bottom.png' %>) top left repeat-x;
+  height: 155px;
+  padding: 0.25em;
+}
+
+.fb_cancel a {
+  margin-left: 0.5em;
+  color: #ffc;
+  border-bottom: 1px dotted #ffc;
+  font-weight:normal;
+}
+
+.fb_cancel a:hover {
+  border-bottom: 1px solid #ffc;
+}
+
+#feedback_thank_you_message {
+font-size: 14px;
+color: #D1FEA4;
+margin-left: 1em;
+font-weight:bold;
+}

data/app/controllers/remarks_controller.rb

@@ -0,0 +1,3 @@
+class RemarksController < ::ApplicationController
+  include Feedbacker::RemarksControllerMethods
+end

data/app/helpers/feedbacker_helper.rb

@@ -0,0 +1,9 @@
+module FeedbackerHelper
+  def show_feedback
+    "$('#expanded_feedback_form').show(); $('#compressed_feedback_form_tab').hide();"
+  end
+  
+  def hide_feedback
+    "$('#compressed_feedback_form_tab').show(); $('#expanded_feedback_form').hide();"
+  end
+end

data/app/mailers/feedback_mailer.rb

@@ -0,0 +1,6 @@
+class FeedbackMailer < ActionMailer::Base
+  def feedback(remark)
+    @remark = remark
+    mail(:to => "support@wwidea.org", :from => 'support@wwidea.org', :reply_to => remark.user.email, :subject => "#{(defined? FEEDBACKER_EMAIL_PREFIX) ? FEEDBACKER_EMAIL_PREFIX : '[FEEDBACKER]'} Feedback Notification")
+  end
+end

data/app/models/remark.rb

@@ -0,0 +1,3 @@
+class Remark < ActiveRecord::Base
+  include Feedbacker::RemarkMethods
+end

data/app/observers/remark_observer.rb

@@ -0,0 +1,5 @@
+class RemarkObserver < ActiveRecord::Observer
+  def after_create(remark)
+    FeedbackMailer.feedback(remark).deliver
+  end
+end

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

@@ -0,0 +1,7 @@
+<p>Feedback Received</p>
+
+<p>From: <%= @remark.user_name %> [<%= @remark.user.email %>]</p>
+<p>Page: <%= link_to(@remark.source_url, @remark.source_url) %></p>
+
+<p>Comments:</p>
+<p><%= @remark.content %></p>

data/app/views/feedbacker/_tab.html.erb

@@ -0,0 +1,10 @@
+<div id="feedback">
+  <div id="compressed_feedback_form_tab">
+    <%= link_to_function image_tag('feedback_tab.png'), show_feedback %>
+  </div>
+  <div id="expanded_feedback_form" style="display:none">
+    <div id="expanded_feedback_form_tab"><%= link_to_function image_tag('feedback_tab.png'), hide_feedback %></div>
+    <% @remark ||= Remark.new %>
+    <%= render :partial => 'remarks/form' %>
+  </div>
+</div>

data/app/views/remarks/_form.html.erb

@@ -0,0 +1,6 @@
+<%= form_for @remark, :remote => true do |f| %>
+  <p><label><%= render :partial => 'remarks/greeting' %></label></p>
+  <div><%= f.text_area :content %></div>
+  <div id='feedback_submit_button'><%= f.submit 'Submit Feedback' %> <span class="fb_cancel"><%= link_to_function 'Cancel', hide_feedback %></span></div>
+  <div id='feedback_thank_you_message' style='display:none'>Thank you for your feedback!</div>
+<% end %>

data/app/views/remarks/_greeting.html.erb

@@ -0,0 +1 @@
+Let us know what you think!

data/app/views/remarks/create.js.erb

@@ -0,0 +1,7 @@
+$('#feedback_submit_button').hide();
+$('#feedback_thank_you_message').fadeIn('500')
+setTimeout(function() {
+  Feedback.hide_form();
+  $('#feedback_thank_you_message').hide();
+  $('#feedback_submit_button').show();  
+}, 2000);

data/config/initializers/feedbacker.rb

@@ -0,0 +1,2 @@
+Feedbacker::RemarkMethods::USER_NAME_METHOD = :first_last
+FEEDBACKER_EMAIL_PREFIX = '[FEEDBACKER]'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+    resources :remarks,             :only => [:create]
+end

data/db/migrate/20101230191157_create_remarks_table.rb

@@ -0,0 +1,14 @@
+class CreateRemarksTable < ActiveRecord::Migration
+  def self.up
+    create_table :remarks do |t|
+      t.integer :user_id
+      t.string :source_url
+      t.text :content
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :remarks
+  end
+end

data/feedbacker.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/feedbacker/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "feedbacker"
+  s.version = Feedbacker::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Jonathan S. Garvin", 'Aaron Baldwin', 'WWIDEA, Inc']
+  s.email = ["developers@wwidea.org"]
+  s.homepage = "https://github.com/wwidea/feedbacker"
+  s.summary = %q{Sitewide Feedback form pinned to sidewall as verticle tab.}
+  s.description = %q{Feedbacker provides a pull out tab on the side of every page on a site for users to send feedback to the site.}
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/feedbacker.rb

@@ -0,0 +1,10 @@
+Dir[File.join(File.dirname(__FILE__), '/feedbacker/*.rb')].each {|file| require file }
+
+module Feedbacker
+  class Engine < ::Rails::Engine
+    config.active_record.observers = :remark_observer
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/feedbacker/remark_methods.rb

@@ -0,0 +1,28 @@
+module Feedbacker #:nodoc:
+  module RemarkMethods
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        include InstanceMethods
+        
+        belongs_to :user
+      end
+    end
+    
+    module ClassMethods
+
+    end
+    
+    module InstanceMethods
+      
+      def user_name
+        if defined? Feedbacker::RemarkMethods::USER_NAME_METHOD
+          return user.send(Feedbacker::RemarkMethods::USER_NAME_METHOD)
+        else
+          user.name
+        end
+      end
+      
+    end
+  end
+end

data/lib/feedbacker/remarks_controller_methods.rb

@@ -0,0 +1,13 @@
+module Feedbacker
+  module RemarksControllerMethods
+    def create 
+      @remark = Remark.new(params[:remark].merge(:user_id => current_user.id))
+      @remark.source_url = request.env['HTTP_REFERER']
+      if @remark.save
+        respond_to do |format|
+          format.js
+        end
+      end
+    end
+  end
+end

data/lib/feedbacker/version.rb

@@ -0,0 +1,3 @@
+module Feedbacker
+  VERSION = '0.1.2'
+end

data/lib/tasks/feedbacker_tasks.rake

@@ -0,0 +1,58 @@
+# desc "Explaining what the task does"
+# task :feedbacker do
+#   # Task goes here
+# end
+
+namespace :feedbacker do
+  desc "bootstrap feedbacker"
+  task :bootstrap  => :environment do
+    require 'fileutils'
+    unless File.exist?("#{Rails.root}/config/initializers/feedbacker.rb")
+      FileUtils.copy(File.expand_path('../../../config/packaged_initializers/feedbacker.rb', __FILE__), "#{Rails.root}/config/initializers")
+    end
+    #unless File.exist?("#{RAILS_ROOT}/public/images/feedback_tab.png")
+    #  FileUtils.copy("#{RAILS_ROOT}/vendor/plugins/feedbacker/public/images/feedback_tab.png","#{RAILS_ROOT}/public/images")
+    #end
+    #unless File.exist?("#{RAILS_ROOT}/public/images/feedback_tab_bottom.png")
+    #  FileUtils.copy("#{RAILS_ROOT}/vendor/plugins/feedbacker/public/images/feedback_tab_bottom.png","#{RAILS_ROOT}/public/images")
+    #end
+    #unless File.exist?("#{RAILS_ROOT}/public/stylesheets/feedbacker.css")
+    #  FileUtils.copy("#{RAILS_ROOT}/vendor/plugins/feedbacker/public/stylesheets/feedbacker.css","#{RAILS_ROOT}/public/stylesheets")
+    #end
+    #unless File.exist?("#{RAILS_ROOT}/public/javascripts/feedbacker.js")
+    #  FileUtils.copy("#{RAILS_ROOT}/vendor/plugins/feedbacker/public/javascripts/feedbacker.js","#{RAILS_ROOT}/public/javascripts")
+    #end
+    #unless File.exist?("#{RAILS_ROOT}/db/migrate/20101230191157_create_remarks_table.rb")
+    #  FileUtils.copy("#{RAILS_ROOT}/vendor/plugins/feedbacker/db/migrate/20101230191157_create_remarks_table.rb","#{RAILS_ROOT}/db/migrate")
+    #  Rake::Task['db:migrate'].execute
+    #end
+  end
+  
+  ########################################################################
+  ### Below task simply for use during initial building of Feedbacker, ###
+  ### not intended to be used once plugin is considered complete.      ###
+  ########################################################################
+  
+  task :debootstrap => :environment do
+    if File.exist?("#{RAILS_ROOT}/config/initializers/feedbacker.rb")
+      File.delete("#{RAILS_ROOT}/config/initializers/feedbacker.rb")
+    end
+    if File.exist?("#{RAILS_ROOT}/public/images/feedback_tab.png")
+      File.delete("#{RAILS_ROOT}/public/images/feedback_tab.png")
+    end
+    if File.exist?("#{RAILS_ROOT}/public/images/feedback_tab_bottom.png")
+      File.delete("#{RAILS_ROOT}/public/images/feedback_tab_bottom.png")
+    end
+    if File.exist?("#{RAILS_ROOT}/public/stylesheets/feedbacker.css")
+      File.delete("#{RAILS_ROOT}/public/stylesheets/feedbacker.css")
+    end
+    if File.exist?("#{RAILS_ROOT}/public/javascripts/feedbacker.js")
+      File.delete("#{RAILS_ROOT}/public/javascripts/feedbacker.js")
+    end
+    if File.exist?("#{RAILS_ROOT}/db/migrate/20101230191157_create_remarks_table.rb")
+      ENV['VERSION'] = '20101230191156'
+      Rake::Task['db:migrate'].execute
+      File.delete("#{RAILS_ROOT}/db/migrate/20101230191157_create_remarks_table.rb")
+    end
+  end
+end

data/test/feedbacker_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class FeedbackerTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: feedbacker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Jonathan S. Garvin
+- Aaron Baldwin
+- WWIDEA, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Feedbacker provides a pull out tab on the side of every page on a site for users to send feedback to the site.
+email: 
+- developers@wwidea.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- app/assets/images/feedback_tab.png
+- app/assets/images/feedback_tab_bottom.png
+- app/assets/javascripts/feedbacker.js
+- app/assets/stylesheets/feedbacker.css.erb
+- app/controllers/remarks_controller.rb
+- app/helpers/feedbacker_helper.rb
+- app/mailers/feedback_mailer.rb
+- app/models/remark.rb
+- app/observers/remark_observer.rb
+- app/views/feedback_mailer/feedback.html.erb
+- app/views/feedbacker/_tab.html.erb
+- app/views/remarks/_form.html.erb
+- app/views/remarks/_greeting.html.erb
+- app/views/remarks/create.js.erb
+- config/initializers/feedbacker.rb
+- config/routes.rb
+- db/migrate/20101230191157_create_remarks_table.rb
+- feedbacker.gemspec
+- init.rb
+- install.rb
+- lib/feedbacker.rb
+- lib/feedbacker/remark_methods.rb
+- lib/feedbacker/remarks_controller_methods.rb
+- lib/feedbacker/version.rb
+- lib/tasks/feedbacker_tasks.rake
+- test/feedbacker_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: https://github.com/wwidea/feedbacker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Sitewide Feedback form pinned to sidewall as verticle tab.
+test_files: 
+- test/feedbacker_test.rb
+- test/test_helper.rb