europeana-feedback-button 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 113b65138abc0cf99712cea95a0e75f29c7be998
-  data.tar.gz: 3f940b87272c66151d47e5a0aaa78a28dbe62d8f
+SHA256:
+  metadata.gz: b94361c1bc78192b1cc1457df6b77407ed3ad5435a3e0538031ef958f426934b
+  data.tar.gz: 43d3ffbf8b53ba737b4f4aa7beebea7d3bfcccbeb33432b7a662566722cfe8d2
 SHA512:
-  metadata.gz: 32d4bc1d1cb4d428e9ef0a884be44abbfbebc4feee682336df84e4cb3c6d06c139acb0f57d5f348840429d8389b14b6e7d4c511c4ba4732c04ad37415471385d
-  data.tar.gz: ce1250b90c213203a3293a13814d6d2082ed67b70ce182a4ab047cef8d50a0b7f2bf69d72f820c8f4e7a712e7d6987fc6a4473c5fbd68749802054c481624bf1
+  metadata.gz: 9d2c5f733f9baa166193392c8d5b3c2413202c633c3bbb4ae56e62306a9673fa6c78c81c8c3c5be1133a863c3b0066ab9a5d8abd51378457aa477f3defe8bd3f
+  data.tar.gz: 158dcc448e4cac5fbcaa3d8e814d5d3012bcc57b8641bdc85b942eeb43dd123e3fe03613dce0283fcfc43a87a7d4efc8256a56307fc50fe6719c9713b254147f

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+plugins:
+  brakeman:
+    enabled: true
+  rubocop:
+    enabled: true

data/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
     - "vendor/**/*"
     - "db/schema.rb"
   UseCache: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 Style/CollectionMethods:
   Description: Preferred collection methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
@@ -41,7 +41,6 @@ Style/IfUnlessModifier:
   Description: Favor modifier if/unless usage when you have a single-line body.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
   Enabled: false
-  MaxLineLength: 80
 Style/OptionHash:
   Description: Don't use option hashes when you can use keyword arguments.
   Enabled: false
@@ -125,11 +124,6 @@ Style/TrailingCommaInArguments:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   Enabled: false
   EnforcedStyleForMultiline: no_comma
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  Enabled: false
-  EnforcedStyleForMultiline: no_comma
 Metrics/AbcSize:
   Description: A calculated magnitude based on number of assignments, branches, and
     conditions.
@@ -241,7 +235,7 @@ Lint/HandleExceptions:
   Description: Don't suppress exception.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
   Enabled: false
-Lint/LiteralInCondition:
+Lint/LiteralAsCondition:
   Description: Checks of literals used in conditions.
   Enabled: false
 Lint/LiteralInInterpolation:

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.1
-  - 2.3.1
+  - 2.5.1
 notifications:
   email: false
 sudo: false

data/Gemfile

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in europeana-blacklight.gemspec
+# Specify your gem's dependencies in europeana-feedback-button.gemspec
 gemspec
 
-group :test do
-  gem 'simplecov', require: false
+group :test, :develop do
+  gem 'rails', '> 5.2', '< 6'
+  gem 'rubocop', '0.53', require: false
 end
 
-group :test, :develop do
-  gem 'sqlite3'
-  gem 'rubocop', require: false
+group :develop do
+  gem 'brakeman'
+end
+
+group :test do
+  gem 'simplecov', require: false
 end

data/README.md

@@ -1,21 +1,31 @@
 # Europeana::FeedbackButton
 
-[![Build Status](https://travis-ci.org/europeana/europeana-feedback-button.svg?branch=develop)](https://travis-ci.org/europeana/europeana-feedback-button) [![Coverage Status](https://coveralls.io/repos/github/europeana/europeana-feedback-button/badge.svg?branch=develop)](https://coveralls.io/github/europeana/europeana-feedback-button?branch=develop) [![security](https://hakiri.io/github/europeana/europeana-feedback-button/develop.svg)](https://hakiri.io/github/europeana/europeana-feedback-button/develop) [![Dependency Status](https://gemnasium.com/europeana/europeana-feedback-button.svg)](https://gemnasium.com/europeana/europeana-feedback-button)
+[![Build Status](https://travis-ci.org/europeana/europeana-feedback-button.svg?branch=develop)](https://travis-ci.org/europeana/europeana-feedback-button) [![Security](https://hakiri.io/github/europeana/europeana-feedback-button/develop.svg)](https://hakiri.io/github/europeana/europeana-feedback-button/develop) [![Maintainability](https://api.codeclimate.com/v1/badges/326e7cf35738e64c36d6/maintainability)](https://codeclimate.com/github/europeana/europeana-feedback-button/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/326e7cf35738e64c36d6/test_coverage)](https://codeclimate.com/github/europeana/europeana-feedback-button/test_coverage)
 
-Ruby gem providing feedback buttons for europeana pages.
+Rails engine providing feedback functionality for various Europeana websites.
 
 ## Usage
 
-See the [Quick Start Guide](QUICKSTART.md).
+### Include gem
 
-## Configurations
+* ``gem 'europeana-feedback-button', require: 'europeana/feedback_button'``
+* Run ``bundle install``
 
-The following options can be configured in your .env file
+### Generate an initializer
 
-- FEEDBACK_MAIL_TO=example@example.org
+* Run ``bundle exec rails g europeana:feedback_button:install``
+* Edit config/initializers/europeana_feedback_button.rb to configure the engine
 
+### Mount the engine
 
+* In config/routes.rb add: ``mount Europeana::FeedbackButton::Engine, at: '/'``
+
+### Add FeedbackableView to your views
+
+* Add ``include Europeana::FeedbackButton::FeedbackableView`` to any view you want to have a feedback button. Add it to app/views/application_view.rb for feedback buttons on all pages.
 
 ## License
 
-See the [License](License.md).
+Licensed under the EUPL V.1.1.
+
+For full details, see [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 task default: :spec

data/app/controllers/europeana/feedback_button/application_controller.rb

@@ -1,8 +1,36 @@
 # frozen_string_literal: true
+
 module Europeana
   module FeedbackButton
     class ApplicationController < ActionController::Base
       protect_from_forgery with: :exception
+
+      before_action :fail_unless_feedback_enabled
+
+      rescue_from ApplicationError do |exception|
+        respond_to do |format|
+          format.json do
+            response = { success: false, message: exception.message }
+            response[:errors] = exception.errors if exception.errors.present?
+            render json: response, status: 400
+          end
+        end
+      end
+
+      rescue_from NoRecipientError do |exception|
+        respond_to do |format|
+          format.json do
+            response = { success: false, message: exception.message }
+            render json: response, status: 500
+          end
+        end
+      end
+
+      protected
+
+      def fail_unless_feedback_enabled
+        fail NoRecipientError, 'Feedback is not enabled' unless Europeana::FeedbackButton.enabled?
+      end
     end
   end
 end

data/app/controllers/europeana/feedback_button/feedback_controller.rb

@@ -1,25 +1,33 @@
 # frozen_string_literal: true
+
 module Europeana
   module FeedbackButton
-    class FeedbackController < ApplicationController
-      include FeedbackHelper
-
+    class FeedbackController < Europeana::FeedbackButton::ApplicationController
       def create
-        if feedback_enabled? && FeedbackMailer.post(mailer_post_args).deliver_later
-          respond_to do |format|
-            format.json { render json: { success: true } }
-          end
-        else
-          respond_to do |format|
-            format.json { render json: { success: false }, status: 500 }
-          end
+        feedback = Feedback.new(feedback_params)
+
+        feedback.validate
+
+        unless feedback.valid?
+          fail ApplicationError.new('Feedback is invalid. See "errors" for details.',
+                                    errors: feedback.errors.messages)
+        end
+
+        FeedbackMailer.post(**mailer_post_args).deliver_later
+
+        respond_to do |format|
+          format.json { render json: { success: true } }
         end
       end
 
       private
 
+      def feedback_params
+        @feedback_params ||= params.permit(:text, :type, :page, :email, :privacy_policy)
+      end
+
       def mailer_post_args
-        { text: params[:text], type: params[:type], page: params[:page], ip: request.remote_ip }
+        feedback_params.to_h.symbolize_keys.slice(:text, :type, :page, :email)
       end
     end
   end

data/app/mailers/europeana/feedback_button/feedback_mailer.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
+
 module Europeana
   module FeedbackButton
     class FeedbackMailer < ApplicationMailer
-      include FeedbackHelper
-
-      def post(text:, type:, page:, ip:)
-        fail Errors::NoRecipient unless feedback_enabled?
+      def post(text:, type:, page:, email: nil)
+        fail NoRecipientError unless Europeana::FeedbackButton.enabled?
 
         @text = text
         @type = type
         @page = page
-        @ip = ip
+        @email = email
 
-        mail(to: Rails.application.config.x.feedback_mail_to, subject: text.truncate(100, separator: ' '))
+        mail_options = {
+          to: Europeana::FeedbackButton.mail_to,
+          subject: text.truncate(100, separator: ' ')
+        }
+        mail(mail_options)
       end
     end
   end

data/app/models/europeana/feedback_button/feedback.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Europeana
+  module FeedbackButton
+    class Feedback
+      include ActiveModel::Model
+
+      MAX_LENGTH = 400
+      MIN_WORDS = 5
+      TYPES = %w(comment correction bug).freeze
+
+      attr_accessor :text, :type, :page, :email, :privacy_policy
+
+      validates :text, :type, :page, presence: true
+      validates :type, inclusion: { in: TYPES }
+      validates :privacy_policy, acceptance: true, allow_nil: false, allow_blank: false
+      validates :text, length: { maximum: MAX_LENGTH }
+      validates :text, word_count: { minimum: MIN_WORDS }, allow_nil: true, allow_blank: true
+    end
+  end
+end

data/app/validators/europeana/feedback_button/word_count_validator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Europeana
+  module FeedbackButton
+    class WordCountValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return if options[:allow_nil] && value.nil?
+        return if options[:allow_blank] && value.blank?
+
+        minimum = options[:minimum] || 5
+        validate_minimum_words(record, attribute, value, minimum)
+      end
+
+      def validate_minimum_words(record, attribute, value, minimum)
+        word_count = count_words(value)
+        unless word_count >= minimum
+          record.errors[attribute] << (options[:message] || "has too few words (#{word_count} < #{minimum})")
+        end
+      end
+
+      def count_words(value)
+        value&.strip&.scan(/\w+/)&.size || 0
+      end
+    end
+  end
+end

data/app/views/concerns/europeana/feedback_button/feedbackable_view.rb

@@ -2,18 +2,18 @@
 
 module Europeana
   module FeedbackButton
-    ##
     # Feedback form display methods
     module FeedbackableView
       extend ActiveSupport::Concern
-      include FeedbackHelper
 
       def feedback
-        return nil unless feedback_enabled?
+        return nil unless Europeana::FeedbackButton.enabled?
+
         {
           form_action: europeana_feedback_button.feedback_path,
-          maxlength: 400,
-          minwords: 5
+          maxlength: Europeana::FeedbackButton::Feedback::MAX_LENGTH,
+          minwords: Europeana::FeedbackButton::Feedback::MIN_WORDS,
+          privacy_policy_url: Europeana::FeedbackButton.privacy_policy_url
         }
       end
     end

data/app/views/europeana/feedback_button/feedback_mailer/post.text.erb

@@ -1,4 +1,6 @@
 Type: <%= @type %>
 URL: <%= @page %>
+Email: <%= @email %>
+
 Text:
 <%= @text %>

data/bin/rails

@@ -1,13 +1,27 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/europeana/feedback_button/engine', __FILE__)
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/europeana/feedback_button/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
 
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
-require 'rails/all'
+require 'rails'
+# Pick the frameworks you want:
+require 'active_model/railtie'
+require 'active_job/railtie'
+# require "active_record/railtie"
+# require "active_storage/engine"
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+# require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
 require 'rails/engine/commands'

data/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Europeana::FeedbackButton::Engine.routes.draw do
   post 'feedback', to: 'feedback#create', defaults: { format: 'json' }
 end

data/europeana-feedback-button.gemspec

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# lib = File.expand_path('../lib', __FILE__)
-# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-$:.push File.expand_path('../lib', __FILE__)
+$:.push File.expand_path('lib', __dir__)
 
 require 'europeana/feedback_button/version'
 
 Gem::Specification.new do |s|
   s.name        = 'europeana-feedback-button'
   s.version     = Europeana::FeedbackButton::VERSION
-  s.authors     = ['Lutz Biedinger']
-  s.email       = ['lutz.biedinger@gmail.com']
+  s.authors     = ['Lutz Biedinger', 'Richard Doe']
+  s.email       = %w(lutz.biedinger@europeana.eu richard.doe@europeana.eu)
   s.homepage    = 'http://github.org/europeana/europeana-feedback-button'
   s.summary     = 'Europeana Feedback Button.'
   s.description = 'An engine which allows the Europeana Feedback Button to be displayed.'
@@ -18,15 +16,14 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files -z`.split("\x0")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
+  s.require_paths = %w(lib)
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency 'rails', '~> 4.2', '>= 4.2.7.1'
+  s.add_dependency 'rails', '>= 4.2.7.1', '< 6'
 
   s.add_development_dependency 'bundler', '~> 1.8'
   s.add_development_dependency 'rake', '~> 11.0'
   s.add_development_dependency 'rspec-rails', '~> 3.0'
-  s.add_development_dependency 'dotenv-rails', '~> 2.1'
-  s.add_development_dependency 'shoulda-matchers', '~> 2.8'
+  s.add_development_dependency 'shoulda-matchers', '~> 3'
 end

data/lib/europeana/feedback_button.rb

@@ -1,8 +1,39 @@
 # frozen_string_literal: true
+
 require 'europeana/feedback_button/engine'
 
 module Europeana
   module FeedbackButton
-    autoload :FeedbackableView, 'europeana/feedback_button/feedbackable_view'
+    PRIVACY_POLICY_URL = 'https://www.europeana.eu/portal/rights/privacy.html'
+
+    class << self
+      # @return [String] Email recipient of feedback submissions
+      attr_accessor :mail_to
+
+      # @return [String] URL to the privacy policy users must accept
+      attr_accessor :privacy_policy_url
+
+      # Is feedback enabled?
+      #
+      # Feedback will be enabled if +mail_to+ is set.
+      #
+      # @return [Boolean]
+      def enabled?
+        mail_to.present?
+      end
+    end
+
+    self.privacy_policy_url = PRIVACY_POLICY_URL
+
+    class ApplicationError < StandardError
+      attr_reader :errors
+
+      def initialize(message, **options)
+        super(message)
+        @errors = options[:errors]
+      end
+    end
+
+    class NoRecipientError < StandardError; end
   end
 end