pointless_feedback 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b281d8e2d40297b3e4daa825101fa0edeae8151
-  data.tar.gz: 24456fba85b4355b2659eeba548a58220f4d726c
+  metadata.gz: 8e76b691ebae8a594c821eb74bb010c4759e7f58
+  data.tar.gz: 6bc634cd619fb31cc1c09cce26540de2c45617ba
 SHA512:
-  metadata.gz: bec2b60e090e5a76f6eb51f147b30902e237c4d6079fb22e6affc884ef155edf77ab57314a7b2ae4f51b24039ef2099f48304a29f8eedab409ecd7b86854af08
-  data.tar.gz: 63fb01b66ffdb4dfb06d4e36ef7553dd1c473d48a28d3185f83d0d0f6e1f564dbebff4f6f330985ac63baebd2101991f0864928ee682371c3bb3cdd56358263d
+  metadata.gz: 24c48635673c4dc97d8b25bac903d20311e50a5e365fb065da556a245670a890805804c4664681fdbccd06e7a44c85d7323908921e71057c3dc9c274e90e4d48
+  data.tar.gz: 3b5b522d81e618355d90ceb1b321b77b6fd98c13c5dfdf859c8d72d4ca00bcd8a00ad2960b6b05781438538f6061a7117fa9b1b408f8f131f9c5bd167e550f0b

data/README.md

@@ -12,20 +12,26 @@ under [Pointless Corp](http://www.pointlesscorp.com/).*
 
 ## Contents
 
-1. [Installation](#installation)
-2. [Configuration](#configuration)
-3. [Customization](#customization)
-4. [Development](#development)
-5. [Roadmap](#roadmap)
-6. [Contributors](#contributors)
+1. [Versions](#versions)
+2. [Installation](#installation)
+3. [Configuration](#configuration)
+4. [Customization](#customization)
+5. [Development](#development)
+6. [Roadmap](#roadmap)
+7. [Contributors](#contributors)
+
+## Versions
+
+As of version 4.x, the Pointless Feedback gem versions will follow Rails releases.  E.g. Pointless 4.x will support Rails 4.x.  Additionally, Pointless 4.x will only support Ruby 2.x.
+
+For Rails 3.x support, use Pointless Feedback version 1.x.
 
 ## Installation
 
-Pointless Feedback has been tested against Rails 3.2+. To install, simply add
-the following to your Gemfile:
+To install, simply add the following to your Gemfile:
 
 ```ruby
-gem 'pointless_feedback', :git => 'git@github.com:vigetlabs/pointless-feedback.git'
+gem 'pointless_feedback'
 ```
 
 After you install Pointless Feedback and add it to your Gemfile, you need to
@@ -79,6 +85,9 @@ Specifies to what addresses feedback email is sent to.
 **from_email:**
 Specifies what address the feedback email is sent from.
 
+**table_name:**
+Defaults to engine's namespace, e.g. `pointless_feedback_messages`.  Change to any desired table for `PointlessFeedback::Message` model.
+
 ## Customization
 
 Pointless Feedback provides you with a simple setup that should cover most
@@ -154,7 +163,8 @@ to customize your redirect hook.
 
 ## Contributors
 
-* [@zporter](https://github.com/zporter)
-* [@efatsi](https://github.com/efatsi)
+* [@zporter](http://github.com/zporter)
+* [@efatsi](http://github.com/efatsi)
+* [@reagent](http://github.com/reagent)
 
 This project rocks and uses MIT-LICENSE.

data/app/controllers/pointless_feedback/messages_controller.rb

@@ -7,9 +7,9 @@ module PointlessFeedback
     end
 
     def create
-      @message = Message.new(params[:message])
+      @message = Message.new(message_params)
 
-      if pass_captcha? && @message.save
+      if @message.save
         flash[:notice] = I18n.t('pointless_feedback.messages.saved',
                                 :default => 'Thanks for your feedback!')
 
@@ -21,12 +21,14 @@ module PointlessFeedback
 
     private
 
-    def pass_captcha?
-      if PointlessFeedback.using_captcha?
-        PointlessFeedback::Captcha.pass?(params["g-recaptcha-response"])
-      else
-        true
-      end
+    def message_params
+      params.require(:message).permit([
+        :description,
+        :email_address,
+        :name,
+        :topic,
+        :contact_info
+      ])
     end
   end
 end

data/app/models/pointless_feedback/message.rb

@@ -1,6 +1,9 @@
 module PointlessFeedback
   class Message < ActiveRecord::Base
-    attr_accessible :description, :email_address, :name, :topic, :contact_info
+    if PointlessFeedback.table_name.present?
+      self.table_name = PointlessFeedback.table_name
+    end
+
     attr_accessor :contact_info
 
     validates :name, :email_address, :topic, :description, :presence => true
@@ -13,9 +16,11 @@ module PointlessFeedback
     private
 
     def export_feedback
-      if PointlessFeedback.email_feedback
-        FeedbackMailer.feedback(self).deliver
-      end
+      return unless PointlessFeedback.email_feedback
+
+      # Support Rails < 4.2 and >= 4.2 delivery options
+      mailer = FeedbackMailer.feedback(self)
+      mailer.respond_to?(:deliver_now) ? mailer.deliver_now : mailer.deliver
     end
 
     def honeypot_filled_in?

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

@@ -1,9 +1,3 @@
-<% if PointlessFeedback.using_captcha? %>
-  <head>
-    <script src='https://www.google.com/recaptcha/api.js'></script>
-  </head>
-<% end %>
-
 <%= form_for @message do |f| %>
   <% if @message.errors.any? %>
     <div class="error_messages">
@@ -59,9 +53,5 @@
 
   </fieldset>
 
-  <% if PointlessFeedback.using_captcha? %>
-    <div class="g-recaptcha" data-sitekey="<%= PointlessFeedback.google_captcha_site_key %>"></div>
-  <% end %>
-
   <%= f.submit 'Submit' %>
 <% end %>

data/lib/generators/templates/pointless_feedback.rb

@@ -6,10 +6,8 @@ PointlessFeedback.setup do |config|
   # ==> Email Configuration
   # Configure feedback email properties (disabled by default)
   # Variables needed for emailing feedback
-  # config.email_feedback            = false
-  # config.send_from_submitter       = false
-  # config.from_email                = 'feedback@pointlesscorp.com'
-  # config.to_emails                 = ['first@example.com', 'second@example.com']
-  # config.google_captcha_site_key   = nil
-  # config.google_captcha_secret_key = nil
+  # config.email_feedback      = false
+  # config.send_from_submitter = false
+  # config.from_email          = 'feedback@pointlesscorp.com'
+  # config.to_emails           = ['first@example.com', 'second@example.com']
 end

data/lib/pointless_feedback.rb

@@ -1,6 +1,4 @@
 require "pointless_feedback/engine"
-require "pointless_feedback/captcha"
-require "typhoeus"
 
 module PointlessFeedback
   module Controllers
@@ -13,6 +11,11 @@ module PointlessFeedback
   mattr_accessor :parent_controller
   @@parent_controller = "ApplicationController"
 
+  # The table name that will be used to store all messages.  By default this
+  # includes the engine's namespace (e.g. `pointless_feedback_messages`), but
+  # it can be configured to whatever is desired.
+  mattr_accessor :table_name
+
   # Custom topics to display on message form
   mattr_accessor :message_topics
   @@message_topics = ['Error on page', 'Other']
@@ -30,20 +33,10 @@ module PointlessFeedback
   mattr_accessor :to_emails
   @@to_emails = ['first@example.com', 'second@example.com']
 
-  mattr_accessor :google_captcha_site_key
-  @@google_captcha_site_key = nil
-
-  mattr_accessor :google_captcha_secret_key
-  @@google_captcha_secret_key = nil
-
   # 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
-
-  def self.using_captcha?
-    @@google_captcha_site_key.present? && @@google_captcha_secret_key.present?
-  end
 end

data/lib/pointless_feedback/controllers/helpers.rb

@@ -3,7 +3,7 @@ module PointlessFeedback
     # 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 : '/'
+        main_app.try(:root_path) || '/'
       end
     end
   end

data/lib/pointless_feedback/version.rb

@@ -1,3 +1,3 @@
 module PointlessFeedback
-  VERSION = "3.0.2"
+  VERSION = "4.0.0"
 end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
 end

data/test/dummy/config/application.rb

@@ -11,16 +11,6 @@ module Dummy
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
 
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
     # config.time_zone = 'Central Time (US & Canada)'
@@ -28,32 +18,6 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable escaping HTML in JSON.
-    config.active_support.escape_html_entities_in_json = true
-
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
   end
 end
 

data/test/dummy/config/boot.rb

@@ -1,10 +1,5 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -1,5 +1,5 @@
-# Load the rails application
+# Load the Rails application.
 require File.expand_path('../application', __FILE__)
 
-# Initialize the rails application
-Dummy::Application.initialize!
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -1,37 +1,29 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  # Do not eager load code on boot.
+  config.eager_load = false
 
-  # Show full error reports and disable caching
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
+  # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
 
-  # Print deprecation notices to the Rails logger
+  # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-
-  # Do not compress assets
-  config.assets.compress = false
-
-  # Expands the lines which load the assets
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
   config.assets.debug = true
-end
+end

data/test/dummy/config/environments/production.rb

@@ -1,67 +1,80 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
-  # Code is not reloaded between requests
+  # Code is not reloaded between requests.
   config.cache_classes = true
 
-  # Full error reports are disabled and caching is turned on
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
 
-  # Disable Rails's static asset server (Apache or nginx will already do this)
-  config.serve_static_assets = false
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_files = false
 
-  # Compress JavaScripts and CSS
-  config.assets.compress = true
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
 
-  # Don't fallback to assets pipeline if a precompiled asset is missed
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
 
-  # Generate digests for assets URLs
+  # Generate digests for assets URLs.
   config.assets.digest = true
 
-  # Defaults to nil and saved in location specified by config.assets.prefix
-  # config.assets.manifest = YOUR_PATH
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
 
-  # Specifies the header that your server uses for sending files
+  # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
 
-  # Prepend all log lines with the following tags
+  # Prepend all log lines with the following tags.
   # config.log_tags = [ :subdomain, :uuid ]
 
-  # Use a different logger for distributed setups
+  # Use a different logger for distributed setups.
   # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
 
-  # Use a different cache store in production
+  # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
   # config.assets.precompile += %w( search.js )
 
-  # Disable delivery errors, bad email addresses will be ignored
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
 
-  # Enable threaded mode
-  # config.threadsafe!
-
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found)
+  # the I18n.default_locale when a translation can not be found).
   config.i18n.fallbacks = true
 
-  # Send deprecation notices to registered listeners
+  # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
 
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
 end