feedback_popup 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Levente Bagi
+
+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,50 @@
+# feedback_popup
+
+Simple feedback popup for Rails 3 applications.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'feedback_popup'
+```
+
+Run `bundle install`
+
+`config/initializers/feedback_popup.rb`:
+
+```ruby
+FeedbackPopup.setup do |config|
+  config.mail_to   = 'you@example.com'
+  config.mail_from = 'sender@example.com'
+end
+```
+
+Add to your `app/assets/stylesheets/application.css' or equivalent,
+normally just before the `require_tree` line:
+
+```
+ *= require feedback_popup
+```
+
+Add to your `app/assets/javascripts/application.js' or equivalent,
+normally just before the `require_tree` line:
+
+```
+//= require feedback_popup
+```
+
+Add to your layout:
+
+```
+<%= feedback_popup %>
+```
+
+Make sure you have ActionMailer configured.
+
+Restart your app.
+
+## Copyright
+
+See the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'FeedbackPopup'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/feedback_popup.coffee

@@ -0,0 +1,70 @@
+$ ->
+  FeedbackForm =
+    $el: $("#feedback_popup")
+
+    open: ->
+      if ! @isOpen()
+        @$el.addClass("open")
+        @$el.find('textarea').focus()
+
+    close: ->
+      if @isOpen()
+        @$el.removeClass("open")
+
+    isOpen: ->
+      @$el.hasClass("open")
+
+    toggle: ->
+      if @isOpen()
+        @close()
+      else
+        @open()
+
+    updateWithResponse: (response) ->
+      if response.success
+        @replaceFormWithMessage(response.success)
+        @waitThen =>
+          @close()
+          @reset()
+          @clear()
+      else
+        @replaceFormWithMessage(response.error)
+        @waitThen =>
+          @reset()
+
+    replaceFormWithMessage: (message) ->
+      @$el.find('form').hide()
+      @$el.find('.message').text(message).show()
+      @$el.find('.title').hide()
+
+    waitThen: (callback) ->
+      setTimeout(callback, 2000)
+
+    reset: ->
+      @$el.find('.message').hide()
+      @$el.find('.title').show()
+      @$el.find('form').show()
+
+    clear: ->
+      @$el.find('form')[0].reset()
+
+    showSending: ->
+      @replaceFormWithMessage "Sending..."
+
+    hideSending: ->
+
+
+  $('#feedback_popup .title').click ->
+    FeedbackForm.toggle()
+    false
+
+  $('#feedback_popup form').bind 'ajax:beforeSend', ->
+    FeedbackForm.showSending()
+  $('#feedback_popup form').bind 'ajax:complete', ->
+    FeedbackForm.hideSending()
+
+  $('#feedback_popup form').bind 'ajax:error', ->
+    FeedbackForm.updateWithResponse
+      error: "Internal error. Try again later."
+
+  window.FeedbackForm = FeedbackForm

data/app/assets/stylesheets/feedback_popup.sass

@@ -0,0 +1,44 @@
+#feedback_popup
+  font-family: Verdana, sans-serif
+  font-size: 14px
+  position: fixed
+  bottom: 0
+  right: 2em
+  background: #F70
+  padding: 5px
+  border-radius: 0.5em 0.5em 0 0
+
+  h4
+    padding: 0 1em
+    margin: 0em 0
+    text-transform: uppercase
+    text-align: center
+    color: white
+    text-shadow: #000 1px 1px 2px
+    font-size: 23px
+    cursor: pointer
+
+  .content
+    display: none
+    margin: 0.5em
+    text-align: right
+    form
+      display: block
+      width: 100%
+    textarea
+      display: block
+      font-family: Verdana, sans-serif
+      font-size: 14px
+      width: 20em
+      height: 10em
+    input[type=submit]
+      font-size: 16px
+
+  .message
+    display: none
+    text-align: center
+    color: white
+
+  &.open
+    .content
+      display: block

data/app/controllers/feedback_popup/messages_controller.rb

@@ -0,0 +1,26 @@
+class FeedbackPopup::MessagesController < ApplicationController
+  def create
+    message = FeedbackPopup::Message.new(message_params)
+    if message.deliver
+      @success_message = t('feedback_popup.message_sent')
+    else
+      @error_message = message.errors.full_messages.join("; ")
+    end
+    respond_to do |format|
+      format.html {
+        flash[:notice] = @success_message if @success_message
+        flash[:alert] = @error_message if @error_message
+        redirect_to root_url
+      }
+      format.js {
+        render :layout => nil
+      }
+    end
+  end
+
+  private
+
+  def message_params
+    params[:feedback_popup_message].slice(:body)
+  end
+end

data/app/helpers/feedback_popup/feedback_popup_helper.rb

@@ -0,0 +1,5 @@
+module FeedbackPopup::FeedbackPopupHelper
+  def feedback_popup
+    render 'feedback_popup/popup'
+  end
+end

data/app/mailers/feedback_popup/mailer.rb

@@ -0,0 +1,12 @@
+class FeedbackPopup::Mailer < ActionMailer::Base
+  def feedback(message)
+    @message = message
+
+    mail(
+      :from    => FeedbackPopup.mail_from,
+      :to      => FeedbackPopup.mail_to,
+      :subject => t('feedback_popup.email.subject')
+    )
+  end
+end
+

data/app/models/feedback_popup/message.rb

@@ -0,0 +1,28 @@
+class FeedbackPopup::Message
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  attr_accessor :body
+
+  validates :body, :presence => true
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end
+  end
+
+  def deliver
+    if self.valid?
+      FeedbackPopup::Mailer.feedback(self).deliver
+      return true
+    end
+    return false
+  end
+
+  def persisted?
+    false
+  end
+
+end
+

data/app/views/feedback_popup/_popup.html.erb

@@ -0,0 +1,10 @@
+<div id="feedback_popup">
+  <h4 class="title"><%= t('feedback_popup.title') %></h4>
+  <div class="content">
+    <%= form_for FeedbackPopup::Message.new, :remote => true do |f| %>
+      <%= f.text_area :body %>
+      <%= f.submit t('feedback_popup.send_button') %>
+    <% end %>
+    <div class="message"></div>
+  </div>
+</div>

data/app/views/feedback_popup/mailer/feedback.text.erb

@@ -0,0 +1 @@
+<%= @message.body %>

data/app/views/feedback_popup/messages/create.js.erb

@@ -0,0 +1 @@
+FeedbackForm.updateWithResponse({ success: <%=raw @success_message.to_json %>, error: <%=raw @error_message.to_json %> });

data/config/locales/feedback_popup.en.yml

@@ -0,0 +1,8 @@
+
+en:
+  feedback_popup:
+    title: "Feedback"
+    send_button: "Send"
+    message_sent: "Thanks!"
+    email:
+      subject: "Feedback received"

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  namespace :feedback_popup do
+    resources :messages, :only => :create
+  end
+  match 'feedback' => 'feedback_popup/messages#new'
+end
+

data/lib/feedback_popup.rb

@@ -0,0 +1,24 @@
+module FeedbackPopup
+  class Engine < Rails::Engine
+
+    initializer 'feedback_popup.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper FeedbackPopup::FeedbackPopupHelper
+      end
+    end
+
+  end
+
+  mattr_accessor :mail_from
+  mattr_accessor :mail_to
+
+  # Makes possible configuration with block:
+  #
+  # FeedbackPopup.setup do |config|
+  #   config.mail_from = "dummy@example.com"
+  #   config.mail_to   = "dummy@example.com"
+  # end
+  def self.setup
+    yield self
+  end
+end

data/lib/feedback_popup/version.rb

@@ -0,0 +1,3 @@
+module FeedbackPopup
+  VERSION = "0.0.1"
+end

data/lib/tasks/feedback_popup_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.