unique_rapidfire 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Yuva Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# Rapidfire
+[![Code Climate](https://codeclimate.com/repos/51a70089f3ea000534070811/badges/aedc90c3b5481e7569bb/gpa.png)](https://codeclimate.com/repos/51a70089f3ea000534070811/feed)
+[![Build Status](https://travis-ci.org/code-mancers/rapidfire.png?branch=master)](https://travis-ci.org/code-mancers/rapidfire)
+
+One stop solution for all survey related requirements! Its tad easy!
+
+This gem supports both **rails 3.2.13+** and **rails4** versions.
+
+You can see a demo of this gem [here](https://rapidfire.herokuapp.com).
+And the source code of demo [here](https://github.com/code-mancers/rapidfire-demo).
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'rapidfire'
+
+And then execute:
+
+    $ bundle install
+    $ bundle exec rake rapidfire:install:migrations
+    $ bundle exec rake db:migrate
+
+And if you want to customize rapidfire views, you can do
+
+    $ bundle exec rails generate rapidfire:views
+
+## Usage
+
+Add this line to your routes will and you will be good to go!
+
+    mount Rapidfire::Engine => "/rapidfire"
+
+And point your browser to [http://localhost:3000/rapidfire](http://localhost:3000/rapidfire)
+
+All rapidfire controllers inherit from your `ApplicationController`. So define 2
+methods `current_user` and `can_administer?` on your `ApplicationController`
+
+1. `current_user` : the user who is answering the survey. can be `nil`
+2. `can_administer?` : a method which determines whether current user can
+   create/update survey questions.
+
+Typical implementation would be:
+
+```ruby
+  class ApplicationController < ActionController::Base
+    def current_user
+      @current_user ||= User.find(session[:user_id])
+    end
+
+    def can_administer?
+      current_user.try(:admin?)
+    end
+  end
+```
+
+If you are using authentication gems like devise, you get `current_user` for free
+and you don't have to define it.
+
+### Routes Information
+Once this gem is mounted on, say at 'rapidfire', it generates several routes
+You can see them by running `bundle exec rake routes`.
+
+1. The `root_path` i.e `localhost:3000/rapidfire` always points to list of
+   surveys {they are called question groups}. Admin can manage surveys, and
+   any user {who cannot administer} can see list of surveys.
+2. Optionally, each survey can by answered by visiting this path:
+
+   ```
+     localhost:3000/rapidfire/question_groups/<survey-id>/answer_groups/new
+   ```
+
+   You can distribute this url so that survey takers can answer a particular survey
+   of your interest.
+
+### Survey Results
+A new api is released which helps in seeing results for each survey. The api is:
+
+```
+  GET /rapidfire/question_groups/<survey-id>/results
+```
+This new api supports two formats: `html` and `json`. The `json` format is supported
+so that end user can use any javascript based chart solutions and render results
+in the format they pleased. An example can be seen [here](https://github.com/code-mancers/rapidfire-demo),
+which uses chart.js to display results.
+
+Diving into details of `json` format, all the questions can be categorized into
+one of the two categories:
+1. **aggregatable**: questions like checkboxes, selects, radio buttons fall into
+   this category.
+2. **non-aggregatable**: questions like long answers, short answers, date, numeric
+   etc.
+
+All the aggregatable answers will be returned in the form of hash, and the
+non-aggregatable answers will be returned in the form of an array. A typical json
+output will be like this:
+
+```json
+[
+{
+    "question_type": "Rapidfire::Questions::Radio",
+    "question_text": "Who is author of Waiting for godot?",
+    "results": {
+        "Sublime": 1,
+        "Emacs": 1,
+        "Vim": 1
+    }
+},
+{
+    "question_type": "Rapidfire::Questions::Checkbox",
+    "question_text": "Best rock band?",
+    "results": {
+        "Led Zeppelin": 2
+    }
+},
+{
+    "question_type": "Rapidfire::Questions::Date",
+    "question_text": "When is your birthday?",
+    "results": [
+        "04-02-1983",
+        "01/01/1970"
+    ]
+},
+{
+    "question_type": "Rapidfire::Questions::Long",
+    "question_text": "If Apple made a android phone what it will be called?",
+    "results": [
+        "Idude",
+        "apdroid"
+    ]
+},
+{
+    "question_type": "Rapidfire::Questions::Numeric",
+    "question_text": "Answer of life, universe and everything?",
+    "results": [
+        "42",
+        "0"
+    ]
+},
+{
+    "question_type": "Rapidfire::Questions::Select",
+    "question_text": "Places you want to visit after death",
+    "results": {
+        "Iran": 2
+    }
+}
+]
+```
+
+## How it works
+This gem gives you access to create questions in a groups, something similar to
+survey. Once you have created a group and add questions to it, you can pass
+around the form url where others can answer your questions.
+
+The typical flow about how to use this gem is:
+
+1. Create a question group by giving it a name.
+2. Once group is created, you can click on the group which takes you to another
+   page where you can manage questions.
+3. Create a question by clicking on add new, and you will be provided by these
+   options: Each question will have a type
+   - **Checkbox** Create a question which contains multiple checkboxes with the
+     options that you provide in `answer options` field. Note that each option
+     should be on a separate line.
+   - **Date** It takes date as an answer
+   - **Long** It needs a description as answer. Renders a textarea.
+   - **Numeric** It takes a number as an answer
+   - **Radio** It renders set of radio buttons by taking answer options.
+   - **Select** It renders a dropdown by taking answer options.
+   - **Short** It takes a string as an answer. Short answer.
+
+4. Once the type is filled, you can optionally fill other details like
+   - **Question text** What is the question?
+   - **Answer options** Give options separated by newline for questions of type
+     checkbox, radio buttons or select.
+   - **Answer presence** Should you mandate answering this question?
+   - **min and max length** Checks whether answer if in between min and max length.
+     Ignores if blank.
+   - **greater than and less than** Applicable for numeric question where answer
+     is validated with these values.
+
+5. Once the questions are populated, you can return to root_path ie by clicking
+   `Question Groups` and share distribute answer url so that others can answer
+   the questions populated.
+6. Note that answers fail to persist of the criteria that you have provided while
+   creating questions fail.
+
+
+## TODO
+1. Add ability to sort questions, so that order is preserved.
+2. Add multi tenant support.
+3. Rename question-groups to surveys, and change routes accordingly.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rapidfire'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run rspec tests.'
+task :default => :rspec
+
+desc 'Run rspec unit and integration tests'
+task :rspec do |t|
+  exec('bundle exec rspec spec')
+end

data/app/assets/javascripts/rapidfire/application.js

@@ -0,0 +1,12 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//

data/app/assets/stylesheets/rapidfire/application.css

@@ -0,0 +1,22 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ */
+
+.horizontal-list {
+  list-style: none;
+}
+
+.horizontal-list > li {
+  float: left;
+  display: inline;
+  margin: 0px 5px;
+}

data/app/controllers/rapidfire/answer_groups_controller.rb

@@ -0,0 +1,34 @@
+module Rapidfire
+  class AnswerGroupsController < Rapidfire::ApplicationController
+    before_filter :find_question_group!
+
+    def new      
+      @answer_group_builder = AnswerGroupBuilder.new(answer_group_params)
+    end
+
+    def create
+      @answer_group_builder = AnswerGroupBuilder.new(answer_group_params)
+    
+      respond_to do |format|
+        if @answer_group_builder.save
+          format.html { redirect_to question_groups_path, notice: 'Survey was successfully created.' }
+          format.json { render json: @answer_group_builder, status: :created, location: @answer_group_builder }
+        else
+          @answer_group_builder.errors.add(:base, "already answered")
+          format.html { render "new" }
+          format.json { render json: @answer_group_builder.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    private
+    def find_question_group!
+      @question_group = QuestionGroup.find(params[:question_group_id])
+    end
+
+    def answer_group_params
+      answer_params = { params: params[:answer_group] }
+      answer_params.merge(user: current_user, question_group: @question_group, unique_id: request.env["action_dispatch.secret_key_base"] )
+    end
+  end
+end

data/app/controllers/rapidfire/application_controller.rb

@@ -0,0 +1,11 @@
+module Rapidfire
+  class ApplicationController < ::ApplicationController
+    helper_method :can_administer?
+
+    def authenticate_administrator!
+      unless can_administer?
+        raise Rapidfire::AccessDenied.new("cannot administer questions")
+      end
+    end
+  end
+end

data/app/controllers/rapidfire/question_groups_controller.rb

@@ -0,0 +1,48 @@
+module Rapidfire
+  class QuestionGroupsController < Rapidfire::ApplicationController
+    before_filter :authenticate_administrator!, except: :index
+    respond_to :html, :js
+    respond_to :json, only: :results
+
+    def index
+      @question_groups = QuestionGroup.all
+      respond_with(@question_groups)
+    end
+
+    def new
+      @question_group = QuestionGroup.new
+      respond_with(@question_group)
+    end
+
+    def create
+      @question_group = QuestionGroup.new(question_group_params)
+      @question_group.save
+
+      respond_with(@question_group, location: rapidfire.question_groups_url)
+    end
+
+    def destroy
+      @question_group = QuestionGroup.find(params[:id])
+      @question_group.destroy
+
+      respond_with(@question_group)
+    end
+
+    def results
+      @question_group = QuestionGroup.find(params[:id])
+      @question_group_results =
+        QuestionGroupResults.new(question_group: @question_group).extract
+
+      respond_with(@question_group_results, root: false)
+    end
+
+    private
+    def question_group_params
+      if Rails::VERSION::MAJOR == 4
+        params.require(:question_group).permit(:name)
+      else
+        params[:question_group]
+      end
+    end
+  end
+end

data/app/controllers/rapidfire/questions_controller.rb

@@ -0,0 +1,58 @@
+module Rapidfire
+  class QuestionsController < Rapidfire::ApplicationController
+    before_filter :authenticate_administrator!
+    respond_to :html, :js
+
+    before_filter :find_question_group!
+    before_filter :find_question!, :only => [:edit, :update, :destroy]
+
+    def index
+      @questions = @question_group.questions
+      respond_with(@questions)
+    end
+
+    def new
+      @question = QuestionForm.new(:question_group => @question_group)
+      respond_with(@question)
+    end
+
+    def create
+      form_params = params[:question].merge(:question_group => @question_group)
+      @question = QuestionForm.new(form_params)
+      @question.save
+
+      respond_with(@question, location: index_location)
+    end
+
+    def edit
+      @question = QuestionForm.new(:question => @question)
+      respond_with(@question)
+    end
+
+    def update
+      form_params = params[:question].merge(:question => @question)
+      @question = QuestionForm.new(form_params)
+      @question.save
+
+      respond_with(@question, location: index_location)
+    end
+
+    def destroy
+      @question.destroy
+      respond_with(@question, location: index_location)
+    end
+
+    private
+    def find_question_group!
+      @question_group = QuestionGroup.find(params[:question_group_id])
+    end
+
+    def find_question!
+      @question = @question_group.questions.find(params[:id])
+    end
+
+    def index_location
+      rapidfire.question_group_questions_url(@question_group)
+    end
+  end
+end