qualtrics_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 629272d717f8d529b095c1771e54a7a3e2482a16
+  data.tar.gz: cf3fa9bf32e67fc055b5ead552334106d824b2cd
+SHA512:
+  metadata.gz: 9a1db695a3d34f476fd90da22cdc6c6653606053f5602de3e18d4836f42fb91d414ed37f62483c30ce86e32f95339c05c01e549e7a76585fbca3ee0bbf9a1811
+  data.tar.gz: 0234a120e01f2d24b4e879c973207a330c28bfefee8685ed34aa5c8c62812916c7dfe3e9c604425ed022570bc8bd32a9708630760770b6ae0876af34b4a4bdc4

data/.gitignore

@@ -0,0 +1,74 @@
+#----------------------------------------------------------------------------
+# Ignore these files when commiting to a git repository.
+#
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# The original version of this file is found here:
+# https://github.com/RailsApps/rails3-application-templates/raw/master/files/gitignore.txt
+#
+# Corrections? Improvements? Create a GitHub issue:
+# http://github.com/RailsApps/rails3-application-templates/issues
+#----------------------------------------------------------------------------
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# bundler state
+/.bundle/
+/vendor/bundle/
+
+# tmp files and logs
+/log/*
+/tmp/*
+
+# various artifacts
+**.war
+.rspec
+.tags
+.env
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject/
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp
+
+# local todo file
+TODO
+
+# sublime
+/*.sublime-project
+/*.sublime-workspace
+
+# floobits
+.floo
+.flooignore
+FLOOBITS_README.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qualtrics_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yurui Zhang
+
+MIT License
+
+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,141 @@
+# QualtricsAPI
+
+Ruby wrapper for Qualtrics REST ControlPanel API version 3.0.
+[API Documents/Play Ground](https://co1.qualtrics.com/APIDocs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qualtrics_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qualtrics_api
+
+## Usage
+
+### Initialize
+
+```ruby
+client = QualtricsAPI.new "YOUR_QUALTRICS_API_KEY"
+# => #<QualtricsAPI::Client:0x007fcb74496528 @api_token="YOUR_QUALTRICS_API_KEY">
+```
+
+### Surveys
+
+To get all your surveys:
+
+```ruby
+client.surveys.fetch
+# => #<QualtricsAPI::SurveyCollection:0x007fcb72cce350 ....>
+```
+
+You can also add a scopeId:
+
+```ruby
+client.surveys.fetch(scope_id: "someOwnerIdMaybe")
+# => #<QualtricsAPI::SurveyCollection:0x007fcb72adaf21 ....>
+```
+
+After you have received results, you can search for a survey by id:
+
+```ruby
+survey = client.surveys.find("surveyIdHere")
+# => #<QualtricsAPI::Survey:0x007fcb724f9468 @id="surveyIdHere" ...>
+```
+
+or just:
+
+```ruby
+survey = client.surveys["surveyIdHere"]
+# =>  #<QualtricsAPI::Survey:0x007fcb724f9468 @id="surveyIdHere" ...>
+```
+
+#### Export Responses From a Survey
+
+Once you have a `survey` object (`QualtricsAPI::Survey`], you can start
+an export like so:
+
+(You can pass any supported options in ruby style!)
+
+```ruby
+export_service = survey.export_responses({ start_date: "2015-03-03 11:11:10" })
+# => #<QualtricsAPI::Services::ResponseExportService:0x007fcb742e4e50 ....>
+```
+
+or you can configure it laster...
+
+```ruby
+export_service = survey.export_responses
+# => #<QualtricsAPI::Services::ResponseExport:0x007fcb742e4e50 ....>
+export_service.start_date = "2015-03-03 11:11:10"
+```
+(See Qualtrics API doc for a full list of options)
+
+Then start the export:
+
+```ruby
+export = export_service.start
+# => #<QualtricsAPI::ResponseExport:0x007fcb742e4e50 ....>
+```
+
+Then to check the progress
+
+```ruby
+export.status
+# => "20.333333%"
+
+export.completed?
+# => fasle
+
+# call again to refresh
+export.status
+# => "100%"
+
+export.completed?
+# => true
+```
+
+Once it's finished, you can get the response file URL:
+```ruby
+export.file_url
+# => "https://some.amazon.s3.com/file/path?withTimeStamps=AndOtherStuff"
+```
+
+#### Checking status on a previous response export
+
+Each response export yeilds an `id`
+
+```ruby
+export = survey.export_responses({ }).start
+# => #<QualtricsAPI::ResponseExport:0x007fcb742e4e50 ....>
+
+export.id
+# => "someExportID"
+```
+
+You can save it somewhere in your app and check back later (if you know
+it's gonna take a while!)
+
+```ruby
+client = QualtricsAPI.new "YOUR QUALTRICS API TOKEN"
+export = client.response_exports["someExportID"]
+# => #<QualtricsAPI::ResponseExport:0x007fcb742e4e50 ....>
+export.status
+=> "99.99999%"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/pallymore/qualtrics_api/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/fixtures/vcr_cassettes/response_export_start_success.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v1/surveys/SV_djzgZ6eJXqnIUyF/responseExports?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ&decimalFormat=.&fileType=CSV&useLabels=false&useLocalTime=false
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 200
+      message:
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - application/json
+      content-length:
+      - '178'
+      date:
+      - Mon, 23 Mar 2015 00:05:00 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"exportStatus":"http://co1.qualtrics.com/API/v1/surveys/responseExports/ES_cwLvnQHobKfV9t3"},"meta":{"status":"Success","qualtricsErrorCode":null,"errorMessage":null}}'
+    http_version:
+  recorded_at: Mon, 23 Mar 2015 00:05:01 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/response_export_update_success.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://co1.qualtrics.com/API/v1/surveys/responseExports/ES_cwLvnQHobKfV9t3?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 301
+      message: 
+    headers:
+      location:
+      - https://co1.qualtrics.com/API/v1/surveys/responseExports/ES_cwLvnQHobKfV9t3?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+      server:
+      - BigIP
+      content-length:
+      - '0'
+      date:
+      - Mon, 23 Mar 2015 00:58:29 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 23 Mar 2015 00:58:29 GMT
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v1/surveys/responseExports/ES_cwLvnQHobKfV9t3?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - application/json
+      content-length:
+      - '278'
+      date:
+      - Mon, 23 Mar 2015 00:58:30 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":{"percentComplete":100.0,"fileUrl":"https://qualtrics-export.s3.amazonaws.com/F_bJamXsfzuGyjRWJ?Expires=1427673600&AWSAccessKeyId=AKIAI3EW3KB5A6DT2WDA&Signature=cBuebySMaFIU/St4q8idIUuxuG4%3D"},"meta":{"status":"Success","qualtricsErrorCode":null,"errorMessage":null}}'
+    http_version: 
+  recorded_at: Mon, 23 Mar 2015 00:58:30 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/survey_collection_fetch_fail.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v1/surveys?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ&scopeId=fake
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - application/json
+      content-length:
+      - '186'
+      date:
+      - Sun, 22 Mar 2015 21:05:58 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"status":"Error","errorMessage":"You do not have permission
+        to access this resource.","internalErrorCode":"GS_5","errorId":"3d6a9018-3b87-4265-b662-572ad96bbe6c"},"result":null}'
+    http_version: 
+  recorded_at: Sun, 22 Mar 2015 21:05:58 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v1/surveys?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - application/json
+      content-length:
+      - '223'
+      date:
+      - Sun, 22 Mar 2015 21:05:57 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":[{"id":"SV_djzgZ6eJXqnIUyF","name":"test_survey","ownerId":"UR_3fnAz35QCGlr725","lastModified":"2015-03-20
+        12:56:33","status":"Inactive"}],"meta":{"status":"Success","qualtricsErrorCode":null,"errorMessage":null}}'
+    http_version: 
+  recorded_at: Sun, 22 Mar 2015 21:05:57 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/survey_collection_fetch_with_scopeId_success.yml

@@ -0,0 +1,33 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://co1.qualtrics.com/API/v1/surveys?apiToken=6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ&scopeId=UR_3fnAz35QCGlr725
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - Apache-Coyote/1.1
+      content-type:
+      - application/json
+      content-length:
+      - '223'
+      date:
+      - Sun, 22 Mar 2015 21:05:58 GMT
+      connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"result":[{"id":"SV_djzgZ6eJXqnIUyF","name":"test_survey","ownerId":"UR_3fnAz35QCGlr725","lastModified":"2015-03-20
+        12:56:33","status":"Inactive"}],"meta":{"status":"Success","qualtricsErrorCode":null,"errorMessage":null}}'
+    http_version: 
+  recorded_at: Sun, 22 Mar 2015 21:05:58 GMT
+recorded_with: VCR 2.9.3