Module: FeedbackEngine

Defined in:
lib/feedback_engine.rb,
lib/feedback_engine/engine.rb,
lib/feedback_engine/widget.rb,
lib/feedback_engine/version.rb,
lib/feedback_engine/configuration.rb,
app/models/feedback_engine/feedback.rb,
app/helpers/feedback_engine/widget_helper.rb,
app/models/feedback_engine/application_record.rb,
app/controllers/feedback_engine/feedbacks_controller.rb,
app/controllers/feedback_engine/application_controller.rb,
lib/generators/feedback_engine/install/install_generator.rb

Overview

In-app product feedback collection for Rails. A drop-in widget lets users send bug reports, feature requests, and general feedback (with screenshots) from any page; submissions land in your own database, with a minimal built-in dashboard to browse and triage them.

Defined Under Namespace

Modules: Generators, Widget, WidgetHelper Classes: ApplicationController, ApplicationRecord, Configuration, Engine, Feedback, FeedbacksController

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.admin?(request) ⇒ Boolean

Can this request browse and triage feedback? Checked by every dashboard action.

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/feedback_engine.rb', line 30

def admin?(request)
  !!config.authorize_admin.call(request)
end

.config ⇒ Object 



14
15
16
 
# File 'lib/feedback_engine.rb', line 14

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:



18
19
20
 
# File 'lib/feedback_engine.rb', line 18

def configure
  yield config
end

.enabled?(request) ⇒ Boolean

Can this request send feedback? Checked on the server for the endpoint and by the helper before rendering the widget.

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/feedback_engine.rb', line 24

def enabled?(request)
  !!config.enabled.call(request)
end