europeana-feedback-button 0.0.5 → 0.0.6

data/lib/europeana/feedback_button/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Europeana
   module FeedbackButton
     class Engine < ::Rails::Engine
@@ -11,8 +12,8 @@ module Europeana
       end
 
       config.autoload_paths += %W(
+        #{config.root}/app/validators
         #{config.root}/app/views/concerns
-        #{config.root}/app/views/layouts
       )
     end
   end

data/lib/europeana/feedback_button/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Europeana
   module FeedbackButton
-    VERSION = '0.0.5'
+    VERSION = '0.0.6'
   end
 end

data/lib/generators/europeana/feedback_button/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Europeana
+  module FeedbackButton
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates an initializer for Europeana::FeedbackButton.'
+
+      def copy_initializer_file
+        copy_file 'europeana_feedback_button.rb', 'config/initializers/europeana_feedback_button.rb'
+      end
+    end
+  end
+end

data/lib/generators/europeana/feedback_button/templates/europeana_feedback_button.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Set the recipient of emails containing feedback submissions
+# Europeana::FeedbackButton.mail_to = 'feedback@example.org'
+# Europeana::FeedbackButton.mail_to = ENV['FEEDBACK_MAIL_TO']
+
+# Set the URL to the privacy policy users must accept when submitting feedback.
+# Europeana::FeedbackButton.privacy_policy_url = 'https://www.europeana.eu/portal/rights/privacy.html'

data/spec/controllers/feedback_controller_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Europeana::FeedbackButton::FeedbackController do
   def main_app
     Rails.application.class.routes.url_helpers
@@ -7,33 +8,95 @@ RSpec.describe Europeana::FeedbackButton::FeedbackController do
   routes { Europeana::FeedbackButton::Engine.routes }
 
   describe 'POST create' do
-    let(:params) { { locale: 'en', type: 'comment', text: 'This is good, five words!', url: main_app.root_path(locale: 'en'), format: :json } }
-    subject { post :create, params }
+    subject { -> { post :create, params: params } }
 
-    context 'with recipient configured' do
-      before do
-        Rails.application.config.x.feedback_mail_to = 'feedback@example.com'
+    let(:valid_params) do
+      { type: 'comment', text: 'This is good, five words!',
+        page: main_app.root_path, privacy_policy: '1', format: :json }
+    end
+    let(:json) { JSON.parse(response.body) }
+
+    before do
+      Europeana::FeedbackButton.mail_to = mail_to
+    end
+
+    shared_examples 'feedback creation failure' do
+      it 'should not queue an email job' do
+        expect { subject.call }.to_not change(ActionMailer::Base.deliveries, :length)
+      end
+
+      it 'should return JSON' do
+        subject.call
+        expect(response.content_type).to eq('application/json')
       end
 
+      it 'should include "success": "false"' do
+        subject.call
+        expect(json['success']).to be(false)
+      end
+
+      it 'should include "message"' do
+        subject.call
+        expect(json['message']).to be_present
+      end
+    end
+
+    shared_examples 'feedback creation success' do
       it 'should queue an email job' do
-        expect { subject }.to change(ActionMailer::Base.deliveries, :length)
-      end
-      # it '' do
-      #  message_delivery = instance_double(ActionMailer::MessageDelivery)
-      #  expect(ServiceMailer).to receive(:new_user).with(@user).and_return(message_delivery)
-      #  expect(message_delivery).to receive(:deliver_later)
-      #  subject
-      # expect { subject }.to change { Delayed::Job.where("handler LIKE '%FeedbackMailer%'").count }.by(1)
-      # end
+        expect { subject.call }.to change(ActionMailer::Base.deliveries, :length).by(1)
+      end
+
+      it 'should have response status code 200' do
+        subject.call
+        expect(response.status).to eq(200)
+      end
+
+      it 'should return JSON' do
+        subject.call
+        expect(response.content_type).to eq('application/json')
+      end
+
+      it 'should include "success": "true"' do
+        subject.call
+        expect(json['success']).to be(true)
+      end
     end
 
-    context 'without recipient configured' do
-      before do
-        Rails.application.config.x.feedback_mail_to = nil
+    context 'with recipient configured' do
+      let(:mail_to) { 'feedback@example.com' }
+
+      context 'with valid params' do
+        let(:params) { valid_params }
+
+        it_behaves_like 'feedback creation success'
       end
 
-      it 'should not queue an email job' do
-        expect { subject }.to_not change(ActionMailer::Base.deliveries, :length)
+      context 'with invalid params' do
+        let(:params) { valid_params.except(:text) }
+
+        it_behaves_like 'feedback creation failure'
+
+        it 'should have response status code 400' do
+          subject.call
+          expect(response.status).to eq(400)
+        end
+
+        it 'includes error messages' do
+          subject.call
+          expect(json['errors']['text']).to be_present
+        end
+      end
+    end
+
+    context 'without recipient configured' do
+      let(:mail_to) { nil }
+      let(:params) { valid_params }
+
+      it_behaves_like 'feedback creation failure'
+
+      it 'should have response status code 500' do
+        subject.call
+        expect(response.status).to eq(500)
       end
     end
   end

data/spec/dummy/Rakefile

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative 'config/application'
 
 Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link europeana/feedback_button_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -5,9 +5,10 @@
 // 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.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
+//= require rails-ujs
 //= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -6,9 +6,9 @@
  * 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.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

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

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

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-##
-# Static pages controller
-class WellcomeController < ApplicationController
-  def index
-  end
+
+class WelcomeController < ApplicationController
+  def index; end
 end

data/spec/dummy/app/helpers/application_helper.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 module ApplicationHelper
 end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
+
 class ApplicationMailer < ActionMailer::Base
-  default from: 'from@exmaple.com'
+  default from: 'from@example.com'
   layout 'mailer'
 end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,14 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
 
-<%= yield %>
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
 
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -1,9 +1,13 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
-</head>
-<body>
-<%= yield %>
-</body>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-APP_PATH = File.expand_path('../../config/application', __FILE__)
+
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/spec/dummy/bin/rake

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/spec/dummy/bin/setup

@@ -1,30 +1,30 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-require 'pathname'
+
+require 'fileutils'
+include FileUtils
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
 
-Dir.chdir APP_ROOT do
+chdir APP_ROOT do
   # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
+  # Add necessary setup steps to this file.
 
   puts '== Installing dependencies =='
-  system 'gem install bundler --conservative'
-  system 'bundle check || bundle install'
-
-  # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
-  # end
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
-  puts "\n== Preparing database =="
-  system 'bin/rake db:setup'
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
 
   puts "\n== Removing old logs and tempfiles =="
-  system 'rm -f log/*'
-  system 'rm -rf tmp/cache'
+  system! 'bin/rails log:clear tmp:clear'
 
   puts "\n== Restarting application server =="
-  system 'touch tmp/restart.txt'
+  system! 'bin/rails restart'
 end

data/spec/dummy/bin/update

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  exec 'yarnpkg', *ARGV
+rescue Errno::ENOENT
+  warn 'Yarn executable was not detected in the system.'
+  warn 'Download Yarn at https://yarnpkg.com/en/docs/install'
+  exit 1
+end

data/spec/dummy/config.ru

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment', __FILE__)
+require_relative 'config/environment'
+
 run Rails.application

data/spec/dummy/config/application.rb

@@ -1,32 +1,26 @@
 # frozen_string_literal: true
-require File.expand_path('../boot', __FILE__)
 
-# Pick the frameworks you want:
-require 'active_record/railtie'
+require_relative 'boot'
+
+require 'rails'
+require 'active_model/railtie'
+require 'active_job/railtie'
 require 'action_controller/railtie'
 require 'action_mailer/railtie'
 require 'action_view/railtie'
-require 'sprockets/railtie'
-# require 'rails/test_unit/railtie'
 
 Bundler.require(*Rails.groups)
+
 require 'europeana/feedback_button'
 
 module Dummy
   class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
 
-    # 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)'
-
-    # 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
-
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    # config.active_record.raise_in_transactional_callbacks = true
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
   end
 end