feedbacks 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83311b670590d68b9b02afd541759c4620464fc4
+  data.tar.gz: 93ba1260e27bbf8eb9a48e5717d16fc77a59c939
+SHA512:
+  metadata.gz: 60481b30b7bbb2cbd8822eda30d89a733cda5311af2c8effe024f7eb0371dd24108db68531d3ba0b3bd06f240f0d7f0536d6c3a12fa84712b483b29d9bd282e1
+  data.tar.gz: 36097f6dfd416d8de2157481d270a1f94bacc37d63d372e8cda9e8405466dec0cd4a2a07c29a748b7f640a768a4bc32b23d62159af79008e7597e7e45d343fc4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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,45 @@
+= Feedbacks
+
+Gem adds the contact us dialog window to your Rails application.
+Gem uses jquery-ui/dialog to work.
+
+Engine tested on rails 3.2.
+
+How to use it:
+
+1. Add to Gemfile:
+
+    gem 'feedbacks'
+
+2. Setup ActionMailer::Base.smtp_settings
+3. Run and change in generated initializers/feedbacks.rb :from and :to emails:
+
+    rails generate feedbacks:initializer
+
+4. Run:
+
+    rake feedbacks:install:migrations && rake db:migrate
+
+5. Add to config/routes.rb:
+
+    mount Feedbacks::Engine => "/feedbacks"
+
+6. Add to view where you need feedback form:
+
+    <div id='feedback-form' title='Feedback form title' >
+      <%= link_to "Contact us", feedbacks.new_feedback_sender_path, :remote => true, :class => 'feedback' %>
+    </div>
+
+7. Add to application.js and application.css:
+
+    require feedbacks/application
+
+8. Thats all. Feedback saves in feedbacks_feedbacks table in database and then sends to your :to email.
+
+Tests are placed in test/dummy.
+
+To try this engine goto test/dummy and enjoy it in the localhost by running rails server.
+
+Using at http://www.rbcitynews.ru/
+
+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    = 'Feedbacks'
+  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/feedbacks/application.js

@@ -0,0 +1,16 @@
+// 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 jquery-ui/dialog
+//= require_tree .

data/app/assets/stylesheets/feedbacks/application.css

@@ -0,0 +1,16 @@
+/*
+ * 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 jquery-ui/dialog
+ *= require_tree .
+ */
+
+label.required:after{content:"*"}

data/app/controllers/feedbacks/application_controller.rb

@@ -0,0 +1,5 @@
+module Feedbacks
+  class ApplicationController < ::ApplicationController
+
+  end
+end

data/app/controllers/feedbacks/feedback_sender_controller.rb

@@ -0,0 +1,17 @@
+module Feedbacks
+  class FeedbackSenderController < ApplicationController
+    def new
+      @feedback = Feedback.new(:topic => params[:topic])
+      respond_to do |format|
+        format.js
+      end
+    end
+
+    def create
+      @feedback = Feedback.create(params[:feedback])
+      respond_to do |format|
+        format.js
+      end
+    end
+  end
+end

data/app/mailers/feedbacks/feedback_mailer.rb

@@ -0,0 +1,12 @@
+module Feedbacks
+  class FeedbackMailer < ActionMailer::Base
+    default :from => Feedbacks.from_email,
+            :to => Feedbacks.to_email
+
+
+    def feedback_email(feedback)
+      @feedback = feedback
+      mail :subject => feedback.topic
+    end
+  end
+end

data/app/models/feedbacks/feedback.rb

@@ -0,0 +1,20 @@
+module Feedbacks
+  class Feedback < ActiveRecord::Base
+    attr_accessible :email, :text, :topic, :url
+
+    validates :text, :presence => true
+    validates :email, :presence => true, :format => {
+      :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+    }
+
+    after_create :send_email
+
+
+    private
+
+
+    def send_email
+      FeedbackMailer.feedback_email(self).deliver
+    end
+  end
+end

data/app/views/feedbacks/feedback_mailer/feedback_email.html.erb

@@ -0,0 +1,27 @@
+<% if @feedback.email %>
+  <p>
+    <strong><%= I18n.t('activerecord.attributes.feedbacks/feedback.email') %></strong>
+    <%= @feedback.email %>
+  </p>
+<% end %>
+
+<p>
+  <strong> <%= I18n.t('activerecord.attributes.feedbacks/feedback.created_at') %> </strong>
+  <%= @feedback.created_at.strftime "%d %B %Y, %A %H:%M" %>
+</p>
+
+<p>
+  <b> <%= I18n.t('activerecord.attributes.feedbacks/feedback.url') %></b>
+  <%= link_to @feedback.url, @feedback.url %>
+</p>
+
+<p>
+  <b> <%= I18n.t('activerecord.attributes.feedbacks/feedback.topic') %></b>
+  <%= @feedback.topic %>
+</p>
+
+<p>
+  <b><%= I18n.t('activerecord.attributes.feedbacks/feedback.text') %></b>
+  <br />
+  <%= @feedback.text %>
+</p>

data/app/views/feedbacks/feedback_sender/_feedback_form.html.erb

@@ -0,0 +1,19 @@
+<%= form_for feedback_form, :url => feedback_sender_index_path, :remote => true do |f| %>
+  <%= f.label :topic %>
+  <%= f.text_field :topic, :class => "text ui-widget-content ui-corner-all" %>
+  <br />
+  <%= f.label :text, :class => 'required' %>
+  <%= f.text_area :text, :size => '20x10', :class => "text ui-widget-content ui-corner-all" %>
+  <br />
+  <%= f.label :email, :class => 'required' %>
+  <%= f.text_field :email, :class => "text ui-widget-content ui-corner-all" %>
+  <%= f.hidden_field :url, :class => "text ui-widget-content ui-corner-all" %>
+<% end %>
+
+<% # Set document.url in the form's url because request.url returns feedback_send_path %>
+<% # but we need the url which placed in a address bar %>
+<script>
+  $(function() {
+    $("#feedback_url").val(document.URL);
+  });
+</script>

data/app/views/feedbacks/feedback_sender/create.js.erb

@@ -0,0 +1,5 @@
+<% if @feedback.errors.any? %>
+    $("#feedback-form").prepend("<%=escape_javascript( render :partial => 'shared/error_messages', :locals => {:target => @feedback} ) %>")
+<% else %>
+    $("#feedback-form").dialog("close");
+<% end %>

data/app/views/feedbacks/feedback_sender/new.js.erb

@@ -0,0 +1,14 @@
+$("#feedback-form").html("<%= escape_javascript(render :partial => 'feedback_form', :object => @feedback) %>");
+
+$("#feedback-form").dialog({
+  modal: true,
+  width: 300,
+  height: 550,
+  buttons:  {
+    "<%= escape_javascript(I18n.t('feedbacks.submit'))%>": function(){
+      $("#feedback-form").children().submit();
+    },
+    "<%= escape_javascript(I18n.t('feedbacks.cancel'))%>": function() { $( this ).dialog( "close" ); }
+  },
+  close:  function() { }
+});

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

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

data/app/views/shared/_error_messages.html.erb

@@ -0,0 +1,9 @@
+<% if target.errors.any? %>
+  <div id='errorExplanation' class='errorExplanation' >
+    <ul>
+      <% target.errors.full_messages.each do |msg| %>
+        <li> <%= msg %> </li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  activerecord:
+    attributes:
+      feedbacks/feedback:
+        topic: 'Topic'
+        text: 'Text'
+        created_at: 'Created at'
+        url: 'Url'
+        email: 'Email'
+  feedbacks:
+    submit: 'Submit'
+    cancel: 'Cancel'

data/config/routes.rb

@@ -0,0 +1,7 @@
+Feedbacks::Engine.routes.draw do
+  # Old api support
+  get "feedback" => "feedback_sender#new"
+  post "feedback_send" => "feedback_sender#create"
+
+  resources :feedback_sender, :only => [:new, :create]
+end

data/db/migrate/20121108115745_create_feedbacks_feedbacks.rb

@@ -0,0 +1,12 @@
+class CreateFeedbacksFeedbacks < ActiveRecord::Migration
+  def change
+    create_table :feedbacks_feedbacks do |t|
+      t.string :topic
+      t.text :text
+      t.string :email
+      t.string :url
+
+      t.timestamps
+    end
+  end
+end

data/lib/feedbacks.rb

@@ -0,0 +1,12 @@
+require "feedbacks/engine"
+
+module Feedbacks
+  mattr_accessor :from_email, :to_email
+  @@from_email = "thisis@example.email"
+  @@to_email = "thisis@example.email"
+
+
+  def self.setup
+    yield self
+  end
+end

data/lib/feedbacks/engine.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'jquery-ui-rails'
+
+module Feedbacks
+  class Engine < ::Rails::Engine
+    isolate_namespace Feedbacks
+  end
+end

data/lib/feedbacks/version.rb

@@ -0,0 +1,3 @@
+module Feedbacks
+  VERSION = "0.0.2"
+end

data/lib/generators/feedbacks/initializer_generator.rb

@@ -0,0 +1,14 @@
+module Feedbacks
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      desc "This generator creates Feedbacks initializer with default :from and :to emails"
+      def create_initializer_file
+        create_file "config/initializers/feedbacks.rb",
+'Feedbacks.setup do |config|
+  config.from_email = "example_from@example.example"
+  config.to_email   = "example_to@example.example"
+end'
+      end
+    end
+  end
+end

data/test/dummy/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'feedbacks', path: '../../'
+gem 'rails', '~> 3.2.0'
+gem 'sqlite3'
+
+gem "jquery-rails"
+gem "jquery-ui-rails", :group => :assets
+
+
+group :development, :test do
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+end

data/test/dummy/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: ../../
+  specs:
+    feedbacks (0.0.2)
+      jquery-rails
+      jquery-ui-rails
+      rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.19)
+      actionpack (= 3.2.19)
+      mail (~> 2.5.4)
+    actionpack (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.2.1)
+      factory_girl (~> 4.2.0)
+      railties (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    journey (1.0.4)
+    jquery-rails (3.1.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.0)
+      railties (>= 3.2.16)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    multi_json (1.10.1)
+    polyglot (0.3.5)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.19)
+      actionmailer (= 3.2.19)
+      actionpack (= 3.2.19)
+      activerecord (= 3.2.19)
+      activeresource (= 3.2.19)
+      activesupport (= 3.2.19)
+      bundler (~> 1.0)
+      railties (= 3.2.19)
+    railties (3.2.19)
+      actionpack (= 3.2.19)
+      activesupport (= 3.2.19)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-rails (3.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.40)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl_rails
+  feedbacks!
+  jquery-rails
+  jquery-ui-rails
+  rails (~> 3.2.0)
+  rspec-rails
+  sqlite3