surveillance 0.1.1

data/app/controllers/concerns/surveillance/attempts_management_concern.rb

@@ -0,0 +1,51 @@
+module Surveillance
+  module AttemptsManagementConcern
+    private
+
+    def surveillance_attempt_cookie_key_for(survey)
+      "survey-access-token-#{ survey.id }"
+    end
+
+    def previous_attempt
+      @previous_attempt ||= previous_attempt_for(survey)
+    end
+
+    def previous_attempt_for(survey)
+      if (token = cookies[surveillance_attempt_cookie_key_for(survey)])
+        attempt = survey.attempts.find_by_access_token(token)
+        return attempt if attempt
+      end
+
+      if (attempt = survey.attempts.find_by_ip_address(request.remote_ip))
+        store_attempt!(attempt)
+        return attempt
+      end
+
+      if respond_to?(:current_user) && current_user
+        attempt = survey.attempts.where(
+          surveillance_attempts: {
+            user_id: current_user.id, user_type: current_user.class.name
+          }
+        ).first
+
+        return attempt if attempt
+      end
+    end
+
+    def store_attempt!(attempt)
+      cookies[surveillance_attempt_cookie_key_for(attempt.survey)] = {
+        value: attempt.access_token,
+        expires: 1.year.from_now
+      }
+    end
+
+    def attempt_already_completed!(attempt)
+      if (callback = Surveillance.attempt_already_registered_callback)
+        instance_exec(attempt, &callback)
+      else
+        flash[:error] = t("surveillance.attempts.errors.already_completed")
+        redirect_to surveys_root_path
+      end
+    end
+  end
+end

data/app/controllers/concerns/surveillance/base_controller_concern.rb

@@ -0,0 +1,37 @@
+module Surveillance
+  module BaseControllerConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :surveys_root_path
+
+      decent_configuration do
+        if defined?(ActiveModel::ForbiddenAttributesProtection)
+          strategy DecentExposure::StrongParametersStrategy
+        end
+      end
+    end
+
+    protected
+
+    def flash_message(type)
+      I18n.t("flashes.#{ flash_key }.#{ params[:action] }.#{ type }")
+    end
+
+    def flash_key
+      @flash_key ||= self.class.name.underscore.gsub(/_controller$/, "")
+    end
+
+    def stong_parameters?
+      defined?(ActiveModel::ForbiddenAttributesProtection)
+    end
+
+    def surveys_root_path
+      if (config = Surveillance.surveys_root_path)
+        instance_exec(&config)
+      else
+        surveys_path
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/attempts_controller.rb

@@ -0,0 +1,38 @@
+module Surveillance
+  module Admin
+    class AttemptsController < Surveillance::Admin::BaseController
+      expose(:survey, model: Surveillance::Survey, finder_parameter: :survey_id)
+      expose(:attempts) { survey.attempts }
+      expose(:attempt,  model: Surveillance::Attempt, attributes: :attempt_params,
+        finder: :find_by_access_token)
+
+      def index
+        self.attempts = attempts.includes_all
+        self.survey = Surveillance::Survey.all_with_answers.find(survey.id)
+      end
+
+      def list
+      end
+
+      def overview
+      end
+
+      def show
+        self.attempt = Surveillance::Attempt.includes_all.find(attempt.id)
+        self.survey = Surveillance::Survey.includes_all.find(attempt.survey_id)
+      end
+
+      def destroy
+        attempt.destroy
+        flash[:success] = flash_message(:success)
+        redirect_to admin_survey_attempts_path(attempt.survey)
+      end
+
+      protected
+
+      def attempt_params
+        stong_parameters? ? params.require(:attempt).permit! : params[:attempt]
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/base_controller.rb

@@ -0,0 +1,15 @@
+module Surveillance
+  module Admin
+    class BaseController < Surveillance.admin_base_controller.constantize
+      if Surveillance.admin_base_controller != 'Surveillance::ApplicationController'
+        include Surveillance::BaseControllerConcern
+        include Surveillance::ApplicationHelper
+        helper Surveillance::ApplicationHelper
+      end
+
+      if Surveillance.admin_authorization_method
+        before_filter Surveillance.admin_authorization_method
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/exports_controller.rb

@@ -0,0 +1,24 @@
+module Surveillance
+  module Admin
+    class ExportsController < Surveillance::Admin::BaseController
+      expose(:survey, model: Surveillance::Survey)
+      expose(:attempts) { survey.attempts.includes_all }
+      expose(:sections) { survey.sections.includes_all }
+
+      def show
+        self.attempts = if params[:state]
+          attempts.where(state: params[:state])
+        else
+          attempts.where(state: ["partially_filled", "completed"])
+        end
+
+        send_data(
+          render_to_string(layout: false),
+          filename: "#{ t("surveillance.exports.results", survey: survey.title.parameterize) }.xls",
+          type: "application/xls",
+          disposition: "attachment"
+        )
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/options_controller.rb

@@ -0,0 +1,44 @@
+module Surveillance
+  module Admin
+    class OptionsController < Surveillance::Admin::BaseController
+      expose(:question,  model: Surveillance::Question, finder_parameter: :question_id)
+      expose(:options) { question.options }
+      expose(:option,  model: Surveillance::Option, attributes: :options_params)
+
+      def create
+        if option.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_question_path(question)
+        else
+          flash[:error] = flash_message(:error)
+          render "new"
+        end
+      end
+
+      def edit
+      end
+
+      def update
+        if option.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_question_path(option.question)
+        else
+          flash[:error] = flash_message(:error)
+          render "edit"
+        end
+      end
+
+      def destroy
+        option.destroy
+        flash[:success] = flash_message(:success)
+        redirect_to edit_admin_question_path(option.question)
+      end
+
+      protected
+
+      def options_params
+        stong_parameters? ? params.require(:option).permit! : params[:option]
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/questions_controller.rb

@@ -0,0 +1,59 @@
+module Surveillance
+  module Admin
+    class QuestionsController < Surveillance::Admin::BaseController
+      expose(:section, model: Surveillance::Section, finder_parameter: :section_id)
+      expose(:questions) { section.questions }
+      expose(:question,  model: Surveillance::Question, attributes: :question_params)
+
+      def index
+      end
+
+      def create
+        question.parent_id = params[:section_id]
+        question.parent_type = "Surveillance::Section"
+
+        if question.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_question_path(question)
+        else
+          flash[:error] = flash_message(:error)
+          render "new"
+        end
+      end
+
+      def update
+        if question.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_question_path(question)
+        else
+          flash[:error] = flash_message(:error)
+          render "edit"
+        end
+      end
+
+      def edit_rules
+        if question.update_attributes(params[:surveillance_question])
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_section_path(question.parent)
+        else
+          flash[:error] = flash_message(:error)
+          section = question.parent
+          render "admin/surveillance/sections/edit"
+        end
+      end
+
+      def destroy
+        question.destroy
+        flash[:success] = flash_message(:success)
+        redirect_to edit_admin_section_path(question.parent)
+      end
+
+      protected
+
+      def question_params
+        stong_parameters? ? params.require(:question).permit! : params[:question]
+      end
+    end
+  end
+end
+

data/app/controllers/surveillance/admin/sections_controller.rb

@@ -0,0 +1,46 @@
+module Surveillance
+  module Admin
+    class SectionsController < Surveillance::Admin::BaseController
+      expose(:survey, model: Surveillance::Survey, finder_parameter: :survey_id)
+      expose(:sections) { survey.sections }
+      expose(:section,  model: Surveillance::Section, attributes: :section_params)
+
+      def index
+      end
+
+      def create
+        section.survey_id = params[:survey_id]
+
+        if section.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_section_path(section)
+        else
+          flash[:error] = flash_message(:error)
+          render "new"
+        end
+      end
+
+      def update
+        if section.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_section_path(section)
+        else
+          flash[:error] = flash_message(:error)
+          render "edit"
+        end
+      end
+
+      def destroy
+        section.destroy
+        flash[:success] = flash_message(:success)
+        redirect_to edit_admin_survey_path(section.survey)
+      end
+
+      protected
+
+      def section_params
+        stong_parameters? ? params.require(:section).permit! : params[:section]
+      end
+    end
+  end
+end

data/app/controllers/surveillance/admin/surveys_controller.rb

@@ -0,0 +1,43 @@
+module Surveillance
+  module Admin
+    class SurveysController < Surveillance::Admin::BaseController
+      expose(:surveys) { Surveillance::Survey.order("created_at DESC") }
+      expose(:survey, attributes: :survey_params, model: Surveillance::Survey)
+
+      def index
+      end
+
+      def create
+        if survey.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_survey_path(survey)
+        else
+          flash[:error] = flash_message(:error)
+          render "new"
+        end
+      end
+
+      def update
+        if survey.save
+          flash[:success] = flash_message(:success)
+          redirect_to edit_admin_survey_path(survey)
+        else
+          flash[:error] = flash_message(:error)
+          render "edit"
+        end
+      end
+
+      def destroy
+        survey.destroy
+        flash[:success] = flash_message(:success)
+        redirect_to admin_surveys_path
+      end
+
+      protected
+
+      def survey_params
+        stong_parameters? ? params.require(:survey).permit! : params[:survey]
+      end
+    end
+  end
+end

data/app/controllers/surveillance/application_controller.rb

@@ -0,0 +1,7 @@
+module Surveillance
+  class ApplicationController < ::ApplicationController
+    include Surveillance::BaseControllerConcern
+
+    layout Surveillance.views_layout if Surveillance.views_layout
+  end
+end

data/app/controllers/surveillance/response/attempts_controller.rb

@@ -0,0 +1,50 @@
+module Surveillance
+  module Response
+    class AttemptsController < Surveillance::Response::BaseController
+      include Surveillance::AttemptsManagementConcern
+
+      def new
+        self.attempt = if previous_attempt
+          if previous_attempt.completed?
+            attempt_already_completed!(previous_attempt)
+            return
+          end
+
+          flash[:success] = t("surveillance.attempts.previous_attempt_recovered")
+          previous_attempt
+        else
+          Surveillance::Attempt.create!(
+            last_answered_section: -1,
+            ip_address: request.remote_ip,
+            survey: survey
+          )
+        end
+
+        redirect_to edit_response_attempt_path(attempt)
+      end
+
+      def edit
+        attempt_already_completed!(attempt) and return if attempt.completed?
+        self.attempt = Surveillance::Attempt.includes_all.find(attempt.id)
+        store_attempt!(attempt)
+      end
+
+      def update
+        if attempt.save!
+          attempt.complete!
+          if survey.last_page_description.presence
+            redirect_to complete_response_attempt_path(attempt)
+          else
+            redirect_to survey_path(attempt.survey)
+          end
+        else
+          flash[:error] = flash_message(:error)
+          render "edit"
+        end
+      end
+
+      def complete
+      end
+    end
+  end
+end

data/app/controllers/surveillance/response/base_controller.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module Surveillance
+  module Response
+    class BaseController < Surveillance::ApplicationController
+      expose(:attempts) { surveys.attempts }
+      expose(:attempt, model: Surveillance::Attempt, attributes: :attempt_params,
+        finder: :find_by_access_token)
+
+      before_filter :survey_closed
+
+      helper_method :survey
+
+      protected
+
+      def survey
+        @survey ||= begin
+          survey_id = params[:survey_id] || (attempt && attempt.survey_id)
+          Surveillance::Survey.includes_all.find(survey_id) if survey_id
+        end
+      end
+
+      def attempt_params
+        stong_parameters? ? params.require(:attempt).permit! : params[:attempt]
+      end
+
+      def survey_closed
+        if !survey
+          flash[:error] = t('surveillance.attempts.errors.no_survey_found')
+          redirect_to surveys_root_path
+        elsif survey.closed?
+          flash[:error] = t('surveillance.attempts.errors.survey_closed')
+          redirect_to surveys_root_path
+        end
+      end
+    end
+  end
+end