RubyGems - europeana-feedback-button - Versions diffs - 0.0.2 - Mend

europeana-feedback-button 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

checksums.yaml +7 -0
data/.gitignore +13 -0
data/.rspec +3 -0
data/Gemfile +13 -0
data/Gemfile.lock +174 -0
data/LICENSE.md +119 -0
data/QUICKSTART.md +30 -0
data/README.md +19 -0
data/Rakefile +4 -0
data/app/assets/images/europeana_feedback_button/.keep +0 -0
data/app/assets/javascripts/europeana_feedback_button/application.js +13 -0
data/app/assets/stylesheets/europeana_feedback_button/application.css +15 -0
data/app/controllers/europeana/feedback_button/application_controller.rb +7 -0
data/app/controllers/europeana/feedback_button/feedback_controller.rb +26 -0
data/app/helpers/europeana/feedback_button/application_helper.rb +6 -0
data/app/helpers/europeana/feedback_button/feedback_helper.rb +13 -0
data/app/mailers/europeana/feedback_button/feedback_mailer.rb +19 -0
data/app/models/.keep +0 -0
data/app/views/concerns/europeana/feedback_button/feedbackable_view.rb +20 -0
data/app/views/europeana/feedback_button/feedback_mailer/post.text.erb +5 -0
data/app/views/layouts/europeana/feedback_button/application.html.erb +14 -0
data/bin/rails +12 -0
data/config/initializers/action_mailer.rb +1 -0
data/config/routes.rb +3 -0
data/europeana-feedback-button.gemspec +29 -0
data/lib/europeana/feedback_button.rb +7 -0
data/lib/europeana/feedback_button/engine.rb +18 -0
data/lib/europeana/feedback_button/version.rb +5 -0
data/lib/tasks/europeana_feedback_button_tasks.rake +4 -0
data/spec/controllers/feedback_controller_spec.rb +39 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/images/.keep +0 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/controllers/concerns/.keep +0 -0
data/spec/dummy/app/controllers/welcome_controller.rb +9 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/.keep +0 -0
data/spec/dummy/app/mailers/application_mailer.rb +4 -0
data/spec/dummy/app/models/.keep +0 -0
data/spec/dummy/app/models/concerns/.keep +0 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +9 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +29 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +31 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +41 -0
data/spec/dummy/config/environments/production.rb +79 -0
data/spec/dummy/config/environments/test.rb +42 -0
data/spec/dummy/config/initializers/assets.rb +11 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +60 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/lib/assets/.keep +0 -0
data/spec/dummy/log/.keep +0 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/helpers/feedback_helper_spec.rb +0 -0
data/spec/spec_helper.rb +22 -0
metadata +257 -0

data/app/helpers/europeana/feedback_button/application_helper.rb ADDED

@@ -0,0 +1,6 @@
+module Europeana
+  module FeedbackButton
+    module ApplicationHelper
+    end
+  end
+end

data/app/helpers/europeana/feedback_button/feedback_helper.rb ADDED

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Europeana
+  module FeedbackButton
+    ##
+    # Methods used by feedback controller and views
+    module FeedbackHelper
+      def feedback_enabled?
+        Rails.application.config.x.feedback_mail_to.present?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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?
+        @text = text
+        @type = type
+        @page = page
+        @ip = ip
+        mail(to: Rails.application.config.x.feedback_mail_to, subject: 'User feedback')
+      end
+    end
+  end
+end

data/app/models/.keep ADDED

File without changes

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Europeana
+  module FeedbackButton
+    ##
+    # Feedback form display methods
+    module FeedbackableView
+      extend ActiveSupport::Concern
+      def feedback
+        return nil unless feedback_enabled?
+        {
+            form_action: europeana_feedback_button.feedback_path,
+            maxlength: 400,
+            minwords: 5
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+IP: <%= @ip %>
+Type: <%= @type %>
+URL: <%= @page %>
+Text:
+<%= @text %>

data/app/views/layouts/europeana/feedback_button/application.html.erb ADDED

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

data/bin/rails ADDED

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# 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__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+require 'rails/all'
+require 'rails/engine/commands'

data/config/initializers/action_mailer.rb ADDED

	@@ -0,0 +1 @@
1	+ Rails.application.config.x.feedback_mail_to = ENV['FEEDBACK_MAIL_TO']

data/config/routes.rb ADDED

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

data/europeana-feedback-button.gemspec ADDED

@@ -0,0 +1,29 @@
+#lib = File.expand_path('../lib', __FILE__)
+#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
+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.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."
+  s.license = 'EUPL-1.1'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.add_dependency 'rails', '~> 4.2', '>= 4.2.7.1'
+  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'
+end

data/lib/europeana/feedback_button.rb ADDED

@@ -0,0 +1,7 @@
+require 'europeana/feedback_button/engine'
+module Europeana
+  module FeedbackButton
+    autoload :FeedbackableView, 'europeana/feedback_button/feedbackable_view'
+  end
+end

data/lib/europeana/feedback_button/engine.rb ADDED

@@ -0,0 +1,18 @@
+module Europeana
+  module FeedbackButton
+    class Engine < ::Rails::Engine
+      isolate_namespace Europeana::FeedbackButton
+      engine_name 'europeana_feedback_button'
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+      config.autoload_paths += %W(
+        #{config.root}/app/views/concerns
+        #{config.root}/app/views/layouts
+      )
+    end
+  end
+end

data/lib/europeana/feedback_button/version.rb ADDED

@@ -0,0 +1,5 @@
+module Europeana
+  module FeedbackButton
+    VERSION = "0.0.2"
+  end
+end

data/lib/tasks/europeana_feedback_button_tasks.rake ADDED

@@ -0,0 +1,4 @@
+# desc "runs rspec tests"
+# task :europeana-feedback-button do
+#   # Task goes here
+# end

data/spec/controllers/feedback_controller_spec.rb ADDED

@@ -0,0 +1,39 @@
+RSpec.describe Europeana::FeedbackButton::FeedbackController do
+  def main_app
+    Rails.application.class.routes.url_helpers
+  end
+  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 }
+    context 'with recipient configured' do
+      before do
+        Rails.application.config.x.feedback_mail_to = 'feedback@example.com'
+      end
+      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
+    end
+    context 'without recipient configured' do
+      before do
+        Rails.application.config.x.feedback_mail_to = nil
+      end
+      it 'should not queue an email job' do
+        expect { subject }.to_not change(ActionMailer::Base.deliveries, :length)
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc ADDED

@@ -0,0 +1,28 @@
+== README
+This README would normally document whatever steps are necessary to get the
+application up and running.
+Things you may want to cover:
+* Ruby version
+* System dependencies
+* Configuration
+* Database creation
+* Database initialization
+* How to run the test suite
+* Services (job queues, cache servers, search engines, etc.)
+* Deployment instructions
+* ...
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile ADDED

@@ -0,0 +1,6 @@
+# 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__)
+Rails.application.load_tasks

data/spec/dummy/app/assets/images/.keep ADDED

File without changes

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

@@ -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/spec/dummy/app/assets/stylesheets/application.css ADDED

@@ -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/spec/dummy/app/controllers/application_controller.rb ADDED

@@ -0,0 +1,5 @@
+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/concerns/.keep ADDED

File without changes

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

@@ -0,0 +1,9 @@
+##
+# Static pages controller
+class WellcomeController < ApplicationController
+  def index
+  end
+end

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

	@@ -0,0 +1,2 @@
1	+ module ApplicationHelper
2	+ end

data/spec/dummy/app/mailers/.keep ADDED

File without changes

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

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@exmaple.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/.keep ADDED

File without changes

data/spec/dummy/app/models/concerns/.keep ADDED

File without changes

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

@@ -0,0 +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>
+<%= yield %>
+</body>
+</html>

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

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/spec/dummy/bin/bundle ADDED

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup ADDED

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # 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
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru ADDED

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

data/spec/dummy/config/application.rb ADDED

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+# Pick the frameworks you want:
+require 'active_record/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.
+    # 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
+  end
+end

data/spec/dummy/config/boot.rb ADDED

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