hssc_surveyor 1.4.1.pre

data/doc/response_set_schema.json

@@ -0,0 +1,54 @@
+{
+    "$schema": "http://json-schema.org/draft-03/schema#",
+    "description": "Response set",
+    "properties": {
+        "completed_at": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+        },
+        "created_at": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+        },
+        "responses": {
+            "description": "Responses in the response set",
+            "items": {
+                "properties": {
+                    "answer_id": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "created_at": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+                    },
+                    "question_id": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "response_group": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "updated_at": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+                    },
+                    "uuid": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "value": {
+                        "type": [
+                            "string",
+                            "number",
+                            "null"
+                        ]
+                    }
+                }
+            },
+            "type": "array"
+        },
+        "survey_id": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+        },
+        "uuid": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+        }
+    }
+}

data/doc/surveyor_timestamp_schema.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "http://json-schema.org/draft-03/schema#",
+    "description": "Timestamp on a Surveyor entity",
+    "format": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2})",
+    "type": [
+        "string",
+        "null"
+    ]
+}

data/features/ajax_submissions.feature

@@ -0,0 +1,140 @@
+@javascript
+Feature: AJAX submissions
+  As a survey administrator
+  I want participants' responses to be saved as soon as possible
+
+Scenario: With a simple pick-one question
+  Given the question
+    """
+    q_1 "Was this saved?", :pick => :one
+    a_y "Yes"
+    a_n "No"
+    """
+  When I start the survey
+   And I choose "Yes"
+  Then there should be a response for answer "y"
+
+Scenario: With a simple pick-any question
+  Given the question
+    """
+    q_1 "What is the state of the cat?", :pick => :any
+    a_d "Dead"
+    a_a "Alive"
+    a_s "Sleeping"
+    """
+  When I start the survey
+   And I check "Alive"
+   And I check "Sleeping"
+  Then there should be a response for answer "a"
+   And there should be a response for answer "s"
+   And there should not be a response for answer "d"
+
+Scenario: With a free text question
+  Given the question
+    """
+    q_1 "What is your favorite movie?"
+    answer "Title", :string
+    """
+  When I start the survey
+   And I fill in "Title" with "The Shawshank Redemption"
+   And I click elsewhere
+  Then there should be a string response with value "The Shawshank Redemption"
+
+Scenario: With a date question
+  Given the question
+    """
+    q_1 "When do you want to depart?"
+    answer "Departure date", :date
+    """
+    When I start the survey
+     And I click "Departure date"
+     And I select "Mar" as the datepicker's month
+     And I select "2013" as the datepicker's year
+     And I follow "9"
+    Then there should be a date response with value "2013-03-09"
+
+Scenario: With a datetime question
+  Given the question
+    """
+    q_1 "When do you want to depart?"
+    answer "Departure date and time", :datetime
+    """
+    When I start the survey
+     And I click "Departure date and time"
+     And I select "Apr" as the datepicker's month
+     And I select "2013" as the datepicker's year
+     And I follow "8"
+    Then there should be a date response with value "2013-04-08 00:00:00"
+
+# How to move the sliders progammatically?
+@wip
+Scenario: With a time question
+  Given the question
+    """
+    q_1 "When do you want lunch?"
+    answer "Meal time", :time
+    """
+    When I start the survey
+     And I click "Meal time"
+     And ?
+    Then there should be a time response with value "11:45:00"
+
+Scenario: With a pick-one plus free text question
+  Given the question
+    """
+    q_1 "Where is Panama City?", :pick => :one
+    a_florida "Florida"
+    a_panama "Panama"
+    a_other :other, :string
+    """
+  When I start the survey
+   And I fill in the string for "other" with "Chicago"
+  Then I click elsewhere
+   And there should be a string response for answer "other" with value "Chicago"
+
+# How to move the slider programmatically?
+@wip
+Scenario: With a slider
+  Given the question
+    """
+    q_1 "How many?", :pick => :one, :display_type => :slider
+    a_0   "None"
+    a_10  "Some"
+    a_100 "Lots"
+    """
+  When I start the survey
+   And ?
+  Then there should be a response for answer "100"
+
+# Issue #339
+Scenario: With a grid question
+  Given the question
+    """
+    grid "Tell us how often do you cover these each day" do
+      a_1 "1"
+      a_2 "2"
+      a_3 "3"
+      q_h "Head", :pick => :one
+      q_k "Knees", :pick => :one
+      q_t "Toes", :pick => :one
+    end
+    """
+  When I start the survey
+   And I choose "3"
+  Then there should be a response for answer "3"
+
+Scenario: With a repeater
+  Given the question
+    """
+    repeater "List your former addresses" do
+      q "Address"
+      a_address_line "Line", :string
+    end
+    """
+  When I start the survey
+   And I fill in the 1st string for "address_line" with "10 Downing St."
+   And I press "+ add row"
+   And I fill in the 2nd string for "address_line" with "1600 Penn Ave."
+   And I click elsewhere
+  Then there should be a string response for answer "address_line" with value "10 Downing St."
+   And there should be a string response for answer "address_line" with value "1600 Penn Ave."

data/features/export_to_json.feature

@@ -0,0 +1,344 @@
+Feature: Survey export
+  As an api consumer
+  I want to represent a survey in JSON
+  So that I can use it offline
+
+  Scenario: Exporting basic questions
+    Given I parse
+    """
+      survey "Simple json" do
+        section "Basic questions" do
+          label "These questions are examples of the basic supported input types"
+
+          question_1 "What is your favorite color?", :pick => :one
+          answer "red"
+          answer "blue"
+          answer "green"
+          answer :other
+
+          q_2b "Choose the colors you don't like", :pick => :any
+          a "orange"
+          a "purple"
+          a "brown"
+          a :omit
+        end
+      end
+    """
+    And I visit "/surveys/simple-json.json"
+    Then the JSON should be:
+    """
+    {
+      "title": "Simple json",
+      "uuid": "*",
+      "sections": [{
+        "title": "Basic questions",
+        "display_order":0,
+        "questions_and_groups": [
+          { "uuid": "*", "type": "label", "text": "These questions are examples of the basic supported input types" },
+          { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "answers": [{"text": "red", "uuid": "*"}, {"text": "blue", "uuid": "*"}, {"text": "green", "uuid": "*"}, {"text": "Other", "uuid": "*"}]},
+          { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*"},{"text": "purple", "uuid": "*"},{"text": "brown", "uuid": "*"},{"text": "Omit", "exclusive":true, "uuid": "*"}]}]
+        }]
+      }
+    """
+
+  Scenario: Exporting export and reference identifiers
+    Given I parse
+    """
+      survey "Exportable" do
+        section "First section" do
+          question_1 "What is your favorite color?", :pick => :one, :data_export_identifier => "favorite_color"
+          a_red "red"
+          a_blue "blue"
+
+          q_2b "Choose the colors you don't like", :pick => :any
+          a_1 "orange", :data_export_identifier => "dont_like_orange"
+          a_2 "purple"
+        end
+      end
+    """
+    And I visit "/surveys/exportable.json"
+    Then the JSON should be:
+    """
+    {
+      "title": "Exportable",
+      "uuid": "*",
+      "sections": [{
+        "title": "First section",
+        "display_order":0,
+        "questions_and_groups": [
+          { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "data_export_identifier": "favorite_color", "answers": [{"text": "red", "uuid": "*", "reference_identifier": "red"}, {"text": "blue", "uuid": "*", "reference_identifier": "blue"}]},
+          { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*", "reference_identifier": "1", "data_export_identifier": "dont_like_orange"},{"text": "purple", "uuid": "*", "reference_identifier": "2"}]}]
+        }]
+      }
+    """
+
+  Scenario: Exporting versioned survey questions
+  Given I parse
+  """
+    survey "Simple json" do
+      section "Basic questions" do
+        label "These questions are examples of the basic supported input types"
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer :other
+
+        q_2b "Choose the colors you don't like", :pick => :any
+        a "orange"
+        a "purple"
+        a "brown"
+        a :omit
+      end
+    end
+  """
+  And I parse
+  """
+    survey "Simple json" do
+      section "Not so basic questions" do
+        label "These questions are examples of the basic supported input types"
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "reddish"
+        answer "blueish"
+        answer "greenish"
+        answer :other
+
+        q_2b "Choose the colors you don't like", :pick => :any
+        a "orange"
+        a "purple"
+        a "brown"
+        a :omit
+      end
+    end
+  """
+  And I visit "/surveys/simple-json.json"
+  Then the JSON should be:
+  """
+  {
+    "title": "Simple json",
+    "uuid": "*",
+    "sections": [{
+      "title": "Not so basic questions",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "type": "label", "text": "These questions are examples of the basic supported input types" },
+        { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "answers": [{"text": "reddish", "uuid": "*"}, {"text": "blueish", "uuid": "*"}, {"text": "greenish", "uuid": "*"}, {"text": "Other", "uuid": "*"}]},
+        { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*"},{"text": "purple", "uuid": "*"},{"text": "brown", "uuid": "*"},{"text": "Omit", "exclusive":true, "uuid": "*"}]}]
+      }]
+    }
+  """
+  And I visit "/surveys/simple-json.json?survey_version=0"
+  Then the JSON should be:
+  """
+  {
+    "title": "Simple json",
+    "uuid": "*",
+    "sections": [{
+      "title": "Basic questions",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "type": "label", "text": "These questions are examples of the basic supported input types" },
+        { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "answers": [{"text": "red", "uuid": "*"}, {"text": "blue", "uuid": "*"}, {"text": "green", "uuid": "*"}, {"text": "Other", "uuid": "*"}]},
+        { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*"},{"text": "purple", "uuid": "*"},{"text": "brown", "uuid": "*"},{"text": "Omit", "exclusive":true, "uuid": "*"}]}]
+      }]
+    }
+  """
+
+  Scenario: Exporting input mask and mask placeholder
+  Given I parse
+  """
+    survey "Personal" do
+      section "Guy" do
+        q "What is your phone number?"
+        a :string, :input_mask => '(999)999-9999', :input_mask_placeholder => '#'
+      end
+    end
+  """
+  And I visit "/surveys/personal.json"
+  Then the JSON should be:
+    """
+    {
+      "title": "Personal",
+      "uuid": "*",
+      "sections": [{
+        "display_order": 0,
+        "title": "Guy",
+        "questions_and_groups": [
+          { 
+            "uuid": "*", 
+            "text": "What is your phone number?",
+            "answers": [
+              {
+                "input_mask": "(999)999-9999",
+                "input_mask_placeholder": "#",
+                "text": "String",
+                "type": "string", 
+                "uuid": "*"
+              }
+            ]
+          }]
+        }]
+      }
+    """
+
+  Scenario: Exporting response sets
+  Given I parse
+  """
+    survey "Simple json response sets" do
+      section "Section 1" do
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer :other
+
+        q_2b "What color don't you like?"
+        a_1 "color", :string
+      end
+      section "Section 2" do
+        label "no"
+      end
+    end
+  """
+  When I start the "Simple json response sets" survey
+  And I choose "red"
+  And I press "Section 2"
+  And I press "Section 1"
+  And I fill in "color" with "orange"
+  And I press "Section 2"
+  And I press "Click here to finish"
+  Then there should be 1 response set with 2 responses with:
+    | answer |
+    | red    |
+  And I export the response set
+  Then the JSON at "responses" should have 2 entries
+  Then the JSON should not have "responses/0/value"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "red"
+  And the JSON response at "responses/1/value" should be "orange"
+  And the JSON response at "responses/1/answer_id" should correspond to an answer with text "color"
+
+  # Issue #294 - ResponseSet#to_json generates unexpected results with zero Responses
+  Scenario: Exporting response sets without responses
+  Given I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer :other
+
+        q_2b "What color don't you like?"
+        a_1 "color", :string
+      end
+      section "Other" do
+        label "no"
+      end
+    end
+  """
+  When I start the "Simple json response sets" survey
+  And I export the response set
+  Then the JSON at "responses" should be an array
+  Then the JSON at "responses" should have 0 entries
+
+  Scenario: Exporting response sets for versioned surveys
+  Given I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+        question "What is your least favorite color?"
+        a "least favorite color", :string
+      end
+    end
+  """
+  And I start the "Simple json response sets" survey
+  And I fill in "color" with "orange"
+  And I press "Click here to finish"
+  And I export the response set
+  Then the JSON at "responses" should have 1 entry
+  And the JSON response at "responses/0/value" should be "orange"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "least favorite color"
+  And I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+        question_1 "What is your most favorite color?"
+        a "most favorite color", :string
+      end
+    end
+  """
+  And I start the "Simple json response sets" survey
+  And I fill in "color" with "blueish"
+  And I press "Click here to finish"
+  And I export the response set
+  Then the JSON at "responses" should have 1 entry
+  And the JSON response at "responses/0/value" should be "blueish"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "most favorite color"
+
+  Scenario: Exporting null datetime response
+  Given I parse
+  """
+    survey "Health" do
+      section "Doctor" do
+        question "When did you visit?", :pick => :one
+        a "Date", :date
+        a "Not sure"
+      end
+    end
+  """
+  And I start the "Health" survey
+  And I choose "Date"
+  And I press "Click here to finish"
+  And I export the response set
+  Then the JSON at "responses" should have 1 entry
+  And the JSON response at "responses/0/value" should be null
+
+  Scenario: Exporting non-existent surveys
+    When I visit "/surveys/simple-json.json"
+    Then I should get a "404" response
+
+  Scenario: Exporting with survey modifications
+  Given I parse
+  """
+    survey "Simple" do
+      section "Colors" do
+        question "What is your least favorite color?"
+        a "least favorite color", :string
+      end
+    end
+  """
+  When I prefix the titles of exported surveys with "NUBIC - "
+  Then the JSON representation for "Simple" should be:
+  """
+  {
+    "title": "NUBIC - Simple",
+    "uuid": "*",
+    "sections": [{
+      "title": "Colors",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "text": "What is your least favorite color?", "answers": [{"text": "least favorite color", "uuid": "*", "type": "string"}]}
+      ]
+    }]
+  }
+  """
+  When I visit "/surveys/simple.json"
+  Then the JSON should be:
+  """
+  {
+    "title": "NUBIC - Simple",
+    "uuid": "*",
+    "sections": [{
+      "title": "Colors",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "text": "What is your least favorite color?", "answers": [{"text": "least favorite color", "uuid": "*", "type": "string"}]}
+      ]
+    }]
+  }
+  """

data/features/internationalization.feature

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+Feature: Internationalization
+  As survey taker
+  I want to see surveys in my own language
+  So that I understand what they're asking
+
+  Scenario:
+  Given I parse
+    """
+    survey "One language is never enough" do
+      translations :en => :default
+      translations :es => {"title"=>"Un idioma nunca es suficiente", "survey_sections"=>{"one"=>{"title"=>"Uno"}}, "question_groups"=>{"hello"=>{"text"=>"¡Hola!"}}, "questions"=>{"name"=>{"text"=>"¿Cómo se llama Usted?", "answers"=>{"name"=>{"help_text"=>"Mi nombre es..."}}}}}
+      translations :he => {"title"=>"ידיעת שפה אחת אינה מספיקה", "survey_sections"=>{"one"=>{"title"=>"אחת"}}, "question_groups"=>{"hello"=>{"text"=>"שלום"}}, "questions"=>{"name"=>{"text"=>"מה שמך?", "answers"=>{"name"=>{"help_text"=>"שמי..."}}}}}
+      translations :ko => {"title"=>"한가지 언어로는 충분치 않습니다.", "survey_sections"=>{"one"=>{"title"=>"하나"}}, "question_groups"=>{"hello"=>{"text"=>"안녕하십니까"}}, "questions"=>{"name"=>{"text"=>"성함이 어떻게 되십니까?", "answers"=>{"name"=>{"help_text"=>"제 이름은 ... 입니다"}}}}}
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+    end
+    """
+  Then there should be 4 translations with
+    | locale |
+    | en     |
+    | es     |
+    | he     |
+    | ko     |
+  When I start the survey
+  Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "One"
+    And I should see "Hello"
+    And I should see "What is your name?"
+    And I should see "My name is..."
+  When I start the survey in "en"
+  Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "One"
+    And I should see "Hello"
+    And I should see "What is your name?"
+    And I should see "My name is..."
+  When I start the survey in "es"
+  Then I should see "Un idioma nunca es suficiente"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "Uno"
+    And I should see "¡Hola!"
+    And I should see "¿Cómo se llama Usted?"
+    And I should see "Mi nombre es..."
+  When I start the survey in "he"
+  Then I should see "ידיעת שפה אחת אינה מספיקה"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "אחת"
+    And I should see "שלום"
+    And I should see "מה שמך?"
+    And I should see "שמי..."
+  When I start the survey in "ko"
+  Then I should see "한가지 언어로는 충분치 않습니다."
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "하나"
+    And I should see "안녕하십니까"
+    And I should see "성함이 어떻게 되십니까?"
+    And I should see "제 이름은 ... 입니다"
+  When I start the survey
+  Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "One"
+    And I should see "Hello"
+    And I should see "What is your name?"
+    And I should see "My name is..."
+
+
+  Scenario:
+  Given I parse
+    """
+    survey "Favorites" do
+      section "Foods" do
+        question_1 "What is the best meat?", :pick => :one, :correct => "oink"
+        a_oink "bacon"
+        a_tweet "chicken"
+        a_moo "beef"
+      end
+    end
+    """
+   When I start the survey
+   Then I should not see "Language"
+
+  @javascript
+  Scenario:
+  Given I parse
+    """
+    survey "One language is never enough" do
+      translations :en => :default
+      translations :es => {"title"=>"Un idioma nunca es suficiente", "survey_sections"=>{"one"=>{"title"=>"Uno"}, "two"=>{"title"=>"Dos"}}, "question_groups"=>{"hello"=>{"text"=>"¡Hola!"}}, "questions"=>{"name"=>{"text"=>"¿Cómo se llama Usted?", "answers"=>{"name"=>{"help_text"=>"Mi nombre es..."}}}, "color"=>{"text"=>"¿Cuál es tu color favorito?"}}}
+      translations :he => {"title"=>"ידיעת שפה אחת אינה מספיקה", "survey_sections"=>{"one"=>{"title"=>"אחת"}, "two"=>{"title"=>"שנים"}}, "question_groups"=>{"hello"=>{"text"=>"שלום"}}, "questions"=>{"name"=>{"text"=>"מה שמך?", "answers"=>{"name"=>{"help_text"=>"שמי..."}}}, "color"=>{"text"=>"מהו הצבע האהוב עליך?"}}}
+
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+
+      section_two "Two" do
+        q_color "What is your favorite color?"
+        a_name :string
+      end
+    end
+    """
+  When I start the survey in "en"
+  Then I should see "One language is never enough"
+    And I should see "What is your name?"
+    And I should see "Language"
+    And a dropdown should exist with the options "en, es, he"
+  When I change the locale to "es"
+  Then I should see "Un idioma nunca es suficiente"
+    And I should see "¿Cómo se llama Usted?"
+  When I press "Dos"
+  Then I should see "¿Cuál es tu color favorito?"
+  When I change the locale to "he"
+  Then I should see "מהו הצבע האהוב עליך?"