rapidfire 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ea12eeb53ecdad94ef33490322027254065a6a9
-  data.tar.gz: fd44602e45d96497ddbfdb4d04ef1278e0cea876
+  metadata.gz: bf282cfdca2422d38ece7af4cb87094810907d87
+  data.tar.gz: e9270a2229db1cb26aa3e502446756e0975be8e2
 SHA512:
-  metadata.gz: cbac5a8118882bfed5d9a0e8f74fd05f56e867194411e330179ff7f52e54defc55d3191f8e09da4278335a2188549e5b9e693e4df98d3681db9dcac1b6a998ff
-  data.tar.gz: ec8e3aeb29b4321ec31021ea9e0c67ea1fd8cf8bf6883defe6a6570119679ecdda599ce2d8bbee4ab3268a1cc71f360b149c69fca8fd984e4a81bd56c5d15fc7
+  metadata.gz: e06b07da985f333727aa9673f3551b1e06aa0cbfc34ab0c883d574462c22bdf6fbe13a5603c06ef685331039a410bfb7e9fed6e70d01b1e25679deda62cd565f
+  data.tar.gz: 55bad4a32186f3fca55958be7c5e8a7703f59d7064394cfe040c0aadc7b99961876a555cd66f361520979c4f5622c6e3d8004059eeabf7c222559318221a1703

data/README.md

@@ -4,13 +4,15 @@
 
 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', git: "git@github.com:code-mancers/rapidfire.git"
+    gem 'rapidfire'
 
 And then execute:
 
@@ -70,6 +72,79 @@ You can see them by running `bundle exec rake routes`.
    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
@@ -111,9 +186,9 @@ The typical flow about how to use this gem is:
 
 
 ## TODO
-1. Provide a way for admin to see survey results
-2. Add support for rails-4
-3. Add ability to sort questions, so that order is preserved.
+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
 

data/app/controllers/rapidfire/answer_groups_controller.rb

@@ -1,14 +1,13 @@
 module Rapidfire
-  class AnswerGroupsController < ApplicationController
+  class AnswerGroupsController < Rapidfire::ApplicationController
     before_filter :find_question_group!
 
     def new
-      @answer_group_builder = AnswerGroupBuilder.new(current_user, @question_group)
+      @answer_group_builder = AnswerGroupBuilder.new(answer_group_params)
     end
 
     def create
-      @answer_group_builder =
-        AnswerGroupBuilder.new(current_user, @question_group, params[:answer_group])
+      @answer_group_builder = AnswerGroupBuilder.new(answer_group_params)
 
       if @answer_group_builder.save
         redirect_to question_groups_path
@@ -21,5 +20,10 @@ module Rapidfire
     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)
+    end
   end
 end

data/app/controllers/rapidfire/question_groups_controller.rb

@@ -1,7 +1,8 @@
 module Rapidfire
-  class QuestionGroupsController < ApplicationController
+  class QuestionGroupsController < Rapidfire::ApplicationController
     before_filter :authenticate_administrator!, except: :index
-    respond_to :html
+    respond_to :html, :js
+    respond_to :json, only: :results
 
     def index
       @question_groups = QuestionGroup.all
@@ -14,10 +15,10 @@ module Rapidfire
     end
 
     def create
-      @question_group = QuestionGroup.new(params[:question_group])
+      @question_group = QuestionGroup.new(question_group_params)
       @question_group.save
 
-      respond_with(@question_group, location: rapidfire.question_groups_path)
+      respond_with(@question_group, location: rapidfire.question_groups_url)
     end
 
     def destroy
@@ -26,5 +27,22 @@ module Rapidfire
 
       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

@@ -1,7 +1,7 @@
 module Rapidfire
-  class QuestionsController < ApplicationController
+  class QuestionsController < Rapidfire::ApplicationController
     before_filter :authenticate_administrator!
-    respond_to :html
+    respond_to :html, :js
 
     before_filter :find_question_group!
     before_filter :find_question!, :only => [:edit, :update, :destroy]
@@ -12,38 +12,34 @@ module Rapidfire
     end
 
     def new
-      @question = QuestionProxy.new(:question_group => @question_group)
+      @question = QuestionForm.new(:question_group => @question_group)
       respond_with(@question)
     end
 
     def create
-      proxy_params = params[:question].merge(:question_group => @question_group)
-      @question = QuestionProxy.new(proxy_params)
+      form_params = params[:question].merge(:question_group => @question_group)
+      @question = QuestionForm.new(form_params)
       @question.save
 
-      location = rapidfire.question_group_questions_path(@question_group)
-      respond_with(@question, location: location)
+      respond_with(@question, location: index_location)
     end
 
     def edit
-      @question = QuestionProxy.new(:question => @question)
+      @question = QuestionForm.new(:question => @question)
       respond_with(@question)
     end
 
     def update
-      proxy_params = params[:question].merge(:question => @question)
-      @question = QuestionProxy.new(proxy_params)
+      form_params = params[:question].merge(:question => @question)
+      @question = QuestionForm.new(form_params)
       @question.save
 
-      location = rapidfire.question_group_questions_path(@question_group)
-      respond_with(@question, location: location)
+      respond_with(@question, location: index_location)
     end
 
     def destroy
       @question.destroy
-
-      location = rapidfire.question_group_questions_path(@question_group)
-      respond_with(@question, location: location)
+      respond_with(@question, location: index_location)
     end
 
     private
@@ -54,5 +50,9 @@ module Rapidfire
     def find_question!
       @question = @question_group.questions.find(params[:id])
     end
+
+    def index_location
+      rapidfire.question_group_questions_url(@question_group)
+    end
   end
 end

data/app/models/rapidfire/answer.rb

@@ -6,7 +6,9 @@ module Rapidfire
     validates :question, :answer_group, presence: true
     validate  :verify_answer_text, :if => "question.present?"
 
-    attr_accessible :question_id, :answer_group, :answer_text
+    if Rails::VERSION::MAJOR == 3
+      attr_accessible :question_id, :answer_group, :answer_text
+    end
 
     private
     def verify_answer_text

data/app/models/rapidfire/answer_group.rb

@@ -4,6 +4,8 @@ module Rapidfire
     belongs_to :user, polymorphic: true
     has_many   :answers, inverse_of: :answer_group, autosave: true
 
-    attr_accessible :question_group, :user
+    if Rails::VERSION::MAJOR == 3
+      attr_accessible :question_group, :user
+    end
   end
 end

data/app/models/rapidfire/question.rb

@@ -1,12 +1,16 @@
 module Rapidfire
   class Question < ActiveRecord::Base
     belongs_to :question_group, :inverse_of => :questions
-    default_scope order(:position)
+    has_many   :answers
+
+    default_scope { order(:position) }
 
     validates :question_group, :question_text, :presence => true
     serialize :validation_rules
 
-    attr_accessible :question_group, :question_text, :validation_rules, :answer_options
+    if Rails::VERSION::MAJOR == 3
+      attr_accessible :question_group, :question_text, :validation_rules, :answer_options
+    end
 
     def self.inherited(child)
       child.instance_eval do

data/app/models/rapidfire/question_group.rb

@@ -3,6 +3,8 @@ module Rapidfire
     has_many  :questions
     validates :name, :presence => true
 
-    attr_accessible :name
+    if Rails::VERSION::MAJOR == 3
+      attr_accessible :name
+    end
   end
 end

data/app/serializers/rapidfire/question_result_serializer.rb

@@ -0,0 +1,15 @@
+module Rapidfire
+  class QuestionResultSerializer < ActiveModel::Serializer
+    self.root = false
+
+    attributes :question_type, :question_text, :results
+
+    def question_type
+      object.question.type
+    end
+
+    def question_text
+      object.question.question_text
+    end
+  end
+end

data/app/{models → services}/rapidfire/answer_group_builder.rb

@@ -1,14 +1,9 @@
 module Rapidfire
-  class AnswerGroupBuilder
-    extend  ActiveModel::Naming
-    include ActiveModel::Validations
-    include ActiveModel::Conversion
-    def persisted?; false end
-
+  class AnswerGroupBuilder < Rapidfire::BaseService
     attr_accessor :user, :question_group, :questions, :answers, :params
 
-    def initialize(user, question_group, params = {})
-      @user, @question_group, @params = user, question_group, params
+    def initialize(params = {})
+      super(params)
       build_answer_group
     end
 

data/app/services/rapidfire/base_service.rb

@@ -0,0 +1,21 @@
+module Rapidfire
+  class BaseService
+    if Rails::VERSION::MAJOR == 4
+      include ActiveModel::Model
+    else
+      extend  ActiveModel::Naming
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+
+      def persisted; false end
+
+      def initialize(params={})
+        params.each do |attr, value|
+          self.public_send("#{attr}=", value)
+        end if params
+
+        super()
+      end
+    end
+  end
+end

data/app/{models/rapidfire/question_proxy.rb → services/rapidfire/question_form.rb}

@@ -1,8 +1,5 @@
 module Rapidfire
-  class QuestionProxy
-    extend  ActiveModel::Naming
-    include ActiveModel::Conversion
-
+  class QuestionForm < Rapidfire::BaseService
     AVAILABLE_QUESTIONS =
       [
        Rapidfire::Questions::Checkbox,
@@ -27,17 +24,13 @@ module Rapidfire
 
     delegate :valid?, :errors, :id, :to => :question
 
-    def persisted?
-      false
-    end
-
     def to_model
       question
     end
 
     def initialize(params = {})
       from_question_to_attributes(params[:question]) if params[:question]
-      params.each { |k, v| send("#{k}=", v) }
+      super(params)
       @question ||= question_group.questions.new
     end
 

data/app/services/rapidfire/question_group_results.rb

@@ -0,0 +1,29 @@
+module Rapidfire
+  class QuestionGroupResults < Rapidfire::BaseService
+    attr_accessor :question_group
+
+    # extracts question along with results
+    # each entry will have the following:
+    # 1. question type and question id
+    # 2. question text
+    # 3. if aggregatable, return each option with value
+    # 4. else return an array of all the answers given
+    def extract
+      @question_group.questions.collect do |question|
+        results =
+          case question
+          when Rapidfire::Questions::Select, Rapidfire::Questions::Radio,
+            Rapidfire::Questions::Checkbox
+            answers = question.answers.map(&:answer_text).map { |text| text.split(',') }.flatten
+            answers.inject(Hash.new(0)) { |total, e| total[e] += 1; total }
+
+          when Rapidfire::Questions::Short, Rapidfire::Questions::Date,
+            Rapidfire::Questions::Long, Rapidfire::Questions::Numeric
+            question.answers.pluck(:answer_text)
+          end
+
+        QuestionResult.new(question: question, results: results)
+      end
+    end
+  end
+end

data/app/services/rapidfire/question_result.rb

@@ -0,0 +1,11 @@
+module Rapidfire
+  class QuestionResult < Rapidfire::BaseService
+    include ActiveModel::Serialization
+
+    attr_accessor :question, :results
+
+    def active_model_serializer
+      Rapidfire::QuestionResultSerializer
+    end
+  end
+end

data/app/views/rapidfire/question_groups/_question_group.html.erb

@@ -10,6 +10,7 @@
     <ul class="horizontal-list">
       <li><%= link_to "Answer Questions", new_question_group_answer_group_path(question_group) %></li>
       <% if can_administer? %>
+        <li><%= link_to "Results", [:results, question_group] %></li>
         <li><%= link_to "Delete", [question_group], method: :delete %></li>
       <% end %>
     </ul>

data/app/views/rapidfire/question_groups/results.html.erb

@@ -0,0 +1,32 @@
+<h1>Results</h1>
+
+<%- @question_group_results.each do |result| %>
+  <div>
+    <h4><%= result.question.question_text %></h4>
+    <p>
+      <%- if result.results.is_a?(Array) %>
+        <ol>
+          <%- result.results.each do |answer| %>
+            <li><%= answer %></li>
+          <% end %>
+        </ol>
+      <% elsif result.results.is_a?(Hash) %>
+        <table>
+          <thead>
+            <tr>
+              <th>Option</th>
+              <th>Count</th>
+            </tr>
+          </thead>
+          <tbody>
+            <%- result.results.each do |option, count| %>
+              <tr>
+                <td><%= option %></td>
+                <td><%= count %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      <% end %>
+  </div>
+<% end %>

data/app/views/rapidfire/questions/_form.html.erb

@@ -10,7 +10,7 @@
   <% end %>
 
   <%= f.label :type %>
-  <%= f.select :type, ::Rapidfire::QuestionProxy::QUESTION_TYPES, {}, id: "question_type" %>
+  <%= f.select :type, ::Rapidfire::QuestionForm::QUESTION_TYPES, {}, id: "question_type" %>
 
   <%= f.label :question_text %>
   <%= f.text_field :question_text %>

data/config/routes.rb

@@ -1,5 +1,7 @@
 Rapidfire::Engine.routes.draw do
   resources :question_groups do
+    get 'results', on: :member
+
     resources :questions
     resources :answer_groups, only: [:new, :create]
   end

data/lib/rapidfire/engine.rb

@@ -1,3 +1,5 @@
+require 'active_model_serializers'
+
 module Rapidfire
   class Engine < ::Rails::Engine
     isolate_namespace Rapidfire

data/lib/rapidfire/version.rb

@@ -1,3 +1,3 @@
 module Rapidfire
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapidfire
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuva Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <
-      - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -172,10 +180,8 @@ files:
 - app/helpers/rapidfire/application_helper.rb
 - app/models/rapidfire/answer.rb
 - app/models/rapidfire/answer_group.rb
-- app/models/rapidfire/answer_group_builder.rb
 - app/models/rapidfire/question.rb
 - app/models/rapidfire/question_group.rb
-- app/models/rapidfire/question_proxy.rb
 - app/models/rapidfire/questions/checkbox.rb
 - app/models/rapidfire/questions/date.rb
 - app/models/rapidfire/questions/long.rb
@@ -183,6 +189,12 @@ files:
 - app/models/rapidfire/questions/radio.rb
 - app/models/rapidfire/questions/select.rb
 - app/models/rapidfire/questions/short.rb
+- app/serializers/rapidfire/question_result_serializer.rb
+- app/services/rapidfire/answer_group_builder.rb
+- app/services/rapidfire/base_service.rb
+- app/services/rapidfire/question_form.rb
+- app/services/rapidfire/question_group_results.rb
+- app/services/rapidfire/question_result.rb
 - app/views/rapidfire/answer_groups/new.html.erb
 - app/views/rapidfire/answers/_checkbox.html.erb
 - app/views/rapidfire/answers/_date.html.erb
@@ -196,6 +208,7 @@ files:
 - app/views/rapidfire/question_groups/_question_group.html.erb
 - app/views/rapidfire/question_groups/index.html.erb
 - app/views/rapidfire/question_groups/new.html.erb
+- app/views/rapidfire/question_groups/results.html.erb
 - app/views/rapidfire/questions/_form.html.erb
 - app/views/rapidfire/questions/_question.html.erb
 - app/views/rapidfire/questions/edit.html.erb