bootstrap_feedbacker 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 533c53a29a065ddbbb09d89df4cab1bad3e58f85
+  data.tar.gz: 2b2c52685e92eb92363c18d095e4f203865def7e
+SHA512:
+  metadata.gz: 970d03c61b7b3a0422f2986ae78d8ee188369cf726d1c2de852d8b9c8fac61abf616efe17b913ae57d004c432b2d754e16f035d40a5770c0873cfbbcfd877375
+  data.tar.gz: 20832f2291f7b911b2b21e2796fa44389801c658896bdd900f5e337b2796acf8d4c5f1cc6ee756c6dca065525fcc9b5a098eb583917b2175f592c3a85f80a536

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 WWIDEA, Inc.
+
+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,65 @@
+[![Gem Version](https://badge.fury.io/rb/boostrap_feedbacker.png)](http://badge.fury.io/rb/bootstrap_feedbacker)
+[![Code Climate](https://codeclimate.com/github/wwidea/bootstrap_feedbacker.png)](https://codeclimate.com/github/wwidea/bootstrap_feedbacker)
+
+
+### BoostrapFeedbacker
+BoostrapFeedbacker provides a tab for users to contact developers from within the application
+
+### Assumptions
+
+BoostrapFeedbacker assumes that you're using...
+
+* At least Rails 4.2.2
+* The Rails Asset Pipeline
+* Jquery
+* Bootstrap
+
+That you have a User class(can be configured to use a different class name) with email and name methods (name can be configured to something else)
+and probably some other things that we've failed to mention.
+
+Installation
+
+Add the following to your Gemfile.
+
+```gem 'bootstrap_feedbacker'```
+
+Run bundle install
+
+Add the following line at at appropriate position in your application layout.
+
+```<%= render partial: 'bootstrap_feedbacker/remarks/button_with_modal' unless current_user.is_guest? %>```
+ 
+OR: If you only want the modal, and want to use your own button, use:
+
+```<%= render partial: 'bootstrap_feedbacker/remarks/modal' unless current_user.is_guest? %>```
+
+Then do something like this:
+ 
+```link_to("Feedback", "#", data: { toggle: 'modal', target: '#modalFeedbackForm'})```
+
+
+Run ```rake bootstrap_feedbacker:install:migrations``` to add migration to your app, and then run ```rake db:migrate``` to add the remarks table.
+
+Create feedbacker.rb in config/initializers and add the following line.
+
+```BootstrapFeedbacker::SETTINGS.email_to = 'support@yourdomain.com'```
+
+OR
+```
+  BootstrapFeedbacker::SETTINGS.update do |settings|
+    settings.email_to = 'support@yourdomain.com'
+    settings.user_name_method = :name             # default value
+    settings.email_prefix = '[FEEDBACKER]'        # default value
+  end
+```
+
+Mount the gem in your routes file:
+```
+mount BootstrapFeedbacker::Engine => "/bootstrap_feedbacker"
+```
+
+Contributions
+
+If have improvements to contribute to this gem, please feel free to fork, commit with tests (if applicable), and then send a pull request. Thank You!
+
+Copyright (c) 2009-2013 WWIDEA, Inc. released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BootstrapFeedbacker'
+  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'
+
+
+load 'rails/tasks/statistics.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/bootstrap_feedbacker/application.js

@@ -0,0 +1,13 @@
+// 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 any plugin's vendor/assets/javascripts directory 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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/bootstrap_feedbacker/remarks.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/bootstrap_feedbacker/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/bootstrap_feedbacker/remarks.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/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/bootstrap_feedbacker/application_controller.rb

@@ -0,0 +1,4 @@
+module BootstrapFeedbacker
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/bootstrap_feedbacker/remarks_controller.rb

@@ -0,0 +1,25 @@
+require_dependency "bootstrap_feedbacker/application_controller"
+
+module BootstrapFeedbacker
+  class RemarksController < ApplicationController
+
+    # POST /remarks
+    def create
+      @remark = Remark.new(remark_params.merge(user_id: current_user.id))
+      @remark.source_url = request.env['HTTP_REFERER'] || "no referrer"
+      if @remark.save
+        FeedbackMailer.feedback(@remark).deliver_now
+        respond_to do |format|
+          format.js
+        end
+      end
+    end
+
+    private
+
+    # Only allow a trusted parameter "white list" through.
+    def remark_params
+      params.require(:remark).permit(:content)
+    end
+  end
+end

data/app/helpers/bootstrap_feedbacker/application_helper.rb

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

data/app/helpers/bootstrap_feedbacker/remarks_helper.rb

@@ -0,0 +1,4 @@
+module BootstrapFeedbacker
+  module RemarksHelper
+  end
+end

data/app/mailers/bootstrap_feedbacker/feedback_mailer.rb

@@ -0,0 +1,13 @@
+module BootstrapFeedbacker
+  class FeedbackMailer < ActionMailer::Base
+    def feedback(remark)
+      @remark = remark
+      mail(
+        to:         BootstrapFeedbacker::SETTINGS.email_to,
+        from:       BootstrapFeedbacker::SETTINGS.email_to,
+        reply_to:   remark.user.email,
+        subject:    "#{BootstrapFeedbacker::SETTINGS.email_prefix} Feedback Notification"
+      )
+    end
+  end
+end

data/app/models/bootstrap_feedbacker/remark.rb

@@ -0,0 +1,9 @@
+module BootstrapFeedbacker
+  class Remark < ActiveRecord::Base
+    belongs_to :user, class_name: BootstrapFeedbacker::SETTINGS.user_class
+
+    def user_name
+      return user.send(BootstrapFeedbacker::SETTINGS.user_name_method)
+    end
+  end
+end

data/app/views/bootstrap_feedbacker/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/bootstrap_feedbacker/remarks/_button_with_modal.html.erb

@@ -0,0 +1,6 @@
+<!-- Button trigger modal -->
+<button type="button" id='feedbackButton' class="btn btn-warning feedback_button_position" data-toggle="modal" data-target="#modalFeedbackForm">
+  Feedback
+</button>
+
+<%= render partial: 'bootstrap_feedbacker/remarks/modal' %>

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

@@ -0,0 +1,12 @@
+<%= form_for @remark, url: "#{bootstrap_feedbacker.remarks_path}", remote: true do |f| %>
+  <div class="modal-body">
+    <%= f.text_area :content, class: 'form-control'%>
+  </div>
+  <div class="modal-footer">
+    <div id='feedback_submit_button'>
+      <%= f.submit 'Submit Feedback', class: 'btn btn-success' %>
+      <button type="button" class="btn btn-info" data-dismiss="modal">Close</button>
+    </div>
+    <div id='feedback_thank_you_message' style='display:none'>Thank you for your feedback!</div>
+  </div>
+<% end %>

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

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

data/app/views/bootstrap_feedbacker/remarks/_modal.html.erb

@@ -0,0 +1,13 @@
+<div class="modal fade" id="modalFeedbackForm" tabindex="-1" role="dialog" aria-labelledby="modalFeedbackLabel">
+  <div class="modal-dialog" role="document">
+    <div class="modal-content">
+      <div class="modal-header">
+        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+        <h4 class="modal-title" id="modalFeedbackLabel">Feedback</h4>
+        <%= render partial: 'bootstrap_feedbacker/remarks/greeting' %>
+      </div>
+      <% @remark = BootstrapFeedbacker::Remark.new %>
+      <%= render partial: 'bootstrap_feedbacker/remarks/form' %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,11 @@
+$('#feedback_submit_button').hide();
+$('#feedback_thank_you_message').fadeIn('500')
+setTimeout(function() {
+  $('#feedback_thank_you_message').fadeOut('500');
+  $('#modalFeedbackForm').modal("hide");
+  setTimeout(function(){
+    $('#feedback_submit_button').show(); 
+    $('#remark_content').val("");
+  },
+  1000);
+}, 2000);

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

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

data/config/routes.rb

@@ -0,0 +1,3 @@
+BootstrapFeedbacker::Engine.routes.draw do
+  resources :remarks, only: :create
+end

data/db/migrate/20150901232221_create_bootstrap_feedbacker_remarks.rb

@@ -0,0 +1,11 @@
+class CreateBootstrapFeedbackerRemarks < ActiveRecord::Migration
+  def change
+    create_table :bootstrap_feedbacker_remarks do |t|
+      t.integer :user_id
+      t.string :source_url
+      t.text :content
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/bootstrap_feedbacker.rb

@@ -0,0 +1,8 @@
+require "bootstrap_feedbacker/engine"
+require "bootstrap_feedbacker/settings"
+
+require "bootstrap-sass"
+require "jquery-rails"
+
+module BootstrapFeedbacker
+end

data/lib/bootstrap_feedbacker/engine.rb

@@ -0,0 +1,5 @@
+module BootstrapFeedbacker
+  class Engine < ::Rails::Engine
+    isolate_namespace BootstrapFeedbacker
+  end
+end

data/lib/bootstrap_feedbacker/settings.rb

@@ -0,0 +1,18 @@
+module BootstrapFeedbacker
+  class Settings
+    attr_accessor :email_to, :email_prefix, :user_name_method, :user_class
+    
+    def initialize
+      self.email_to           = ''
+      self.email_prefix       = '[FEEDBACKER]'
+      self.user_class         = "User"
+      self.user_name_method   = :name
+    end
+    
+    def update
+      yield self
+    end
+  end
+  
+  SETTINGS = Settings.new
+end

data/lib/bootstrap_feedbacker/version.rb

@@ -0,0 +1,3 @@
+module BootstrapFeedbacker
+  VERSION = "0.3.0"
+end

data/lib/tasks/bootstrap_feedbacker_tasks.rake

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