diff --git a/app/models/bug.rb b/app/models/bug.rb index ed1f15b529a00045399c90d6e972886676ce3085..d87a20468c7ce67266a50a0563d387eb33658c2b 100644 --- a/app/models/bug.rb +++ b/app/models/bug.rb @@ -1,3 +1,4 @@ +##Represents a software issue class Bug include ActiveModel::Model attr_accessor :title, :description diff --git a/app/models/feedback.rb b/app/models/feedback.rb index 4307eb00ae7932efd8d0f520093ecc98ac619af8..a43add1966c039ed14e2163d840965dca0eb42c0 100644 --- a/app/models/feedback.rb +++ b/app/models/feedback.rb @@ -1,3 +1,4 @@ +##Feedback is an user review of the system class Feedback < ActiveRecord::Base belongs_to :user has_and_belongs_to_many :feedback_ratings diff --git a/app/services/feedback_service.rb b/app/services/feedback_service.rb index 86660f706edffa06b49c76251bff1132028b36a2..187bd61356e3ff17160cd7eb421cada0587d322e 100644 --- a/app/services/feedback_service.rb +++ b/app/services/feedback_service.rb @@ -1,3 +1,5 @@ +## +# The Feedback service abstract two actions: report_bug, that delegates behavior for a BugReporter service; and send_feedback, that stores a user review of the system. class FeedbackService def initialize(bugreporter_service) @@ -5,16 +7,17 @@ class FeedbackService end ## - # delegates the reporting behavior for a bug reporter service + # delegates the behavior for a bug reporter service def report_bug(bug) @bugreporter_service.report bug end - ## + ##Feedback is an user review of the system # store the feedbacks in database and send notification def send_feedback(feedback) # save and send an email feedback.save! + # send notification end end \ No newline at end of file diff --git a/app/services/gitlab_bugreporter_service.rb b/app/services/gitlab_bugreporter_service.rb index 2645e0b0ce53b889f16954188cf6f35d7ae97d52..43200a0e4915673c6c66008516d67ac5a8eecf5b 100644 --- a/app/services/gitlab_bugreporter_service.rb +++ b/app/services/gitlab_bugreporter_service.rb @@ -1,3 +1,6 @@ +## +# This service represents the Gitlab Bug Reporter +# The client can report a bug, that will be created an issue for PortalMEC project. class GitlabBugreporterService PORTALMEC_PROJECT_ID = 633