qualtrics_api 0.0.1

data/spec/lib/response_export_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe QualtricsAPI::ResponseExport do
+
+  let(:connection) { double('connection') }
+  subject { described_class.new id: "someId", connection: connection }
+
+  describe "#completed?" do
+    it "is true when @completed is true" do
+      subject.instance_variable_set(:@completed, true)
+      expect(subject.completed?).to eq true
+    end
+
+    it "is false when @completed is false" do
+      subject.instance_variable_set(:@completed, false)
+      expect(subject.completed?).to eq false
+    end
+  end
+
+  describe "#status" do
+    describe "when completed" do
+      it "returns the progress string without calling update" do
+        subject.instance_variable_set(:@completed, true)
+        subject.instance_variable_set(:@export_progress, 100)
+        expect(subject).to_not receive(:update_status)
+        expect(subject.status).to eq "100%"
+      end
+    end
+
+    describe "when not completed" do
+      it "calls update then prints progress" do
+        subject.instance_variable_set(:@export_progress, 10)
+        expect(subject).to receive(:update_status)
+        expect(subject.status).to eq "10%"
+      end
+    end
+  end
+
+  describe "#percent_completed" do
+    describe "when completed" do
+      it "returns the progress number without calling update" do
+        subject.instance_variable_set(:@completed, true)
+        subject.instance_variable_set(:@export_progress, 100)
+        expect(subject).to_not receive(:update_status)
+        expect(subject.percent_completed).to eq 100
+      end
+    end
+
+    describe "when not completed" do
+      it "calls update then prints progress" do
+        subject.instance_variable_set(:@export_progress, 10)
+        expect(subject).to receive(:update_status)
+        expect(subject.percent_completed).to eq 10
+      end
+    end
+  end
+
+  describe "#file_url" do
+    describe "when completed" do
+      it "returns the progress number without calling update" do
+        subject.instance_variable_set(:@completed, true)
+        subject.instance_variable_set(:@file_url, "some_url")
+        expect(subject).to_not receive(:update_status)
+        expect(subject.file_url).to eq "some_url"
+      end
+    end
+
+    describe "when not completed" do
+      it "calls update then prints progress" do
+        subject.instance_variable_set(:@export_progress, 10)
+        expect(subject).to receive(:update_status)
+        expect(subject.file_url).to be_nil
+      end
+    end
+  end
+
+  describe "#update_status" do
+    let(:client) { QualtricsAPI.new TEST_API_TOKEN }
+
+    it "updates the status of the export then returns itself" do
+      VCR.use_cassette("response_export_update_success") do
+        subject = described_class.new id: "ES_cwLvnQHobKfV9t3", connection: client.connection
+
+        result = subject.update_status
+
+        expect(subject.completed?).to be_truthy
+        expect(subject.instance_variable_get(:@file_url)).to_not be_nil
+        expect(subject.instance_variable_get(:@export_progress)).to eq 100.0
+
+        expect(result).to eq subject
+      end
+    end
+  end
+end

data/spec/lib/services/response_export_service_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe QualtricsAPI::Services::ResponseExportService do
+
+  describe "initialize" do
+    let(:params) do
+      {
+        survey_id: "s_id",
+        response_set_id: "r_set_id",
+        file_type: "file type",
+        last_response_id: "l_id",
+        start_date: "03/22/2015 06:11:11",
+        end_date: "03/25/2015 06:00:00",
+        limit: "1000",
+        included_question_ids: "ids,ids",
+        max_rows: "1000",
+        use_labels: true,
+        decimal_format: ",",
+        seen_unanswered_recode: "something",
+        use_local_time: true,
+        spss_string_length: "15",
+      }
+    end
+    let(:connection) { double("connection") }
+
+    subject { described_class.new params.merge(connection: connection)}
+
+    describe "assgin options" do
+      before do
+        allow_any_instance_of(described_class).to receive(:start)
+      end
+
+      it "assigns passed options" do
+        params.each do |key, value|
+          expect(subject.send(key)).to eq value
+        end
+      end
+
+      it "assigns connection" do
+        expect(subject.instance_variable_get(:@conn)).to eq connection
+      end
+
+      describe "defaults" do
+        subject { described_class.new connection: connection }
+
+        it "has default @use_labels - false" do
+          expect(subject.use_labels).to eq false
+        end
+
+        it "has default @use_local_time - false" do
+          expect(subject.use_local_time).to eq false
+        end
+
+        it "has default @file_type - csv" do
+          expect(subject.file_type).to eq 'CSV'
+        end
+
+        it "has default @decimal_format - ." do
+          expect(subject.decimal_format).to eq '.'
+        end
+      end
+    end
+
+    describe "#start" do
+      it "calls url with export params" do
+        expect(connection).to receive(:get).with("surveys/s_id/responseExports", {
+          "responseSetId" => "r_set_id",
+          "fileType" => "file type",
+          "lastResponseId" => "l_id",
+          "startDate" => "03/22/2015 06:11:11",
+          "endDate" => "03/25/2015 06:00:00",
+          "limit" => "1000",
+          "includedQuestionIds" => "ids,ids",
+          "maxRows" => "1000",
+          "useLabels" => true,
+          "decimalFormat" => ",",
+          "seenUnansweredRecode" => "something",
+          "useLocalTime" => true,
+          "spssStringLength" => "15"
+        }).and_return(double('resBody', body: {"result" => { "exportStatus" => "some/url" }}))
+        subject.start
+      end
+
+      it "assigns and returns a ResponseExport with the id in the url" do
+        allow(connection).to receive(:get)
+          .and_return(double('resBody', body: {"result" => { "exportStatus" => "some/url/exportId" }}))
+        sut = subject.start
+        expect(sut).to be_a QualtricsAPI::ResponseExport
+        expect(subject.result).to eq sut
+      end
+    end
+  end
+
+  describe "#integration" do
+    let(:client) { QualtricsAPI.new TEST_API_TOKEN }
+
+    subject do
+      VCR.use_cassette("response_export_start_success") do
+        client.surveys["SV_djzgZ6eJXqnIUyF"].export_responses.start
+      end
+    end
+
+    it "assigns @result with the export id" do
+      expect(subject).to_not be_nil
+      expect(subject).to be_a QualtricsAPI::ResponseExport
+      expect(subject.id).to eq "ES_cwLvnQHobKfV9t3"
+    end
+  end
+
+end

data/spec/lib/survey_collection_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe QualtricsAPI::SurveyCollection do
+
+  let(:connection) { double('connection') }
+
+  subject { described_class.new connection: connection, scope_id: "fake_scopeId" }
+
+  it "has a scope_id" do
+    expect(subject.scope_id).to eq "fake_scopeId"
+  end
+
+  it "has no @all when initialized" do
+    expect(subject.all).to eq []
+  end
+
+  it "can assign scope_id" do
+    expect(subject).to respond_to :scope_id=
+  end
+
+  it "takes a connection" do
+    expect(subject.instance_variable_get(:@conn)).to eq connection
+  end
+
+  describe "#query_attributes" do
+    it "returns only scope_id" do
+      expect(subject.query_attributes.size).to eq 1
+      expect(subject.query_attributes[:scope_id]).to eq "fake_scopeId"
+    end
+  end
+
+  describe "#find, #[]" do
+    let(:survey_1) { QualtricsAPI::Survey.new "id" => "s1" }
+    let(:survey_2) { QualtricsAPI::Survey.new "id" => "s2" }
+
+    it "finds the survey by id" do
+      subject.instance_variable_set :@all, [survey_1, survey_2]
+      expect(subject.find("s1")).to eq survey_1
+      expect(subject["s2"]).to eq survey_2
+    end
+
+    it "returns a new survey with the id" do
+      sut = subject["s3"]
+      expect(sut).to be_a QualtricsAPI::Survey
+      expect(sut.id).to eq "s3"
+      expect(sut.instance_variable_get(:@conn)).to eq connection
+    end
+  end
+
+  describe "integration" do
+    let(:client) { QualtricsAPI.new TEST_API_TOKEN }
+
+    subject { described_class.new connection: client.connection }
+
+    describe "#fetch" do
+      describe "when success" do
+
+        before do
+          expect(subject.size).to eq 0
+        end
+
+        let!(:result) do
+          VCR.use_cassette("survey_collection_fetch_sucess") do
+            subject.fetch
+          end
+        end
+
+        it "populates the collection" do
+          expect(subject.size).to eq 1
+          expect(subject.first).to be_a QualtricsAPI::Survey
+        end
+
+        it "passes down the connection" do
+          expect(subject.all.first.instance_variable_get(:@conn)).to eq client.connection
+        end
+
+        it "returns itself" do
+          expect(result).to eq subject
+        end
+      end
+
+      describe "when failed" do
+        it "resets surveys" do
+          subject.instance_variable_set :@all, [QualtricsAPI::Survey.new({})]
+          expect {
+            VCR.use_cassette("survey_collection_fetch_fail") do
+              subject.fetch(scope_id: "fake") rescue nil
+            end
+          }.to change { subject.all }.to([])
+        end
+      end
+
+      describe "with options" do
+        it "updates the options" do
+          VCR.use_cassette("survey_collection_fetch_with_scopeId_success") do
+            expect(subject.scope_id).to be_nil
+            subject.fetch(scope_id: "UR_3fnAz35QCGlr725")
+            expect(subject.scope_id).to eq "UR_3fnAz35QCGlr725"
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lib/survey_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe QualtricsAPI::Survey do
+
+  let(:qualtrics_response) do
+    {
+      "id" => "SV_djzgZ6eJXqnIUyF",
+      "name" => "test_survey",
+      "ownerId" => "UR_3fnAz35QCGlr725",
+      "lastModified" => "2015-03-20 12:56:33",
+      "status" => "Inactive"
+    }
+  end
+
+  let(:connection) { double('connection', {get: {}}) }
+
+  subject { described_class.new qualtrics_response.merge(connection: connection)}
+
+  it "has an id" do
+    expect(subject.id).to eq qualtrics_response["id"]
+  end
+
+  it "has a name" do
+    expect(subject.name).to eq qualtrics_response["name"]
+  end
+
+  it "has an ownerId" do
+    expect(subject.owner_id).to eq qualtrics_response["ownerId"]
+  end
+
+  it "has last_modified" do
+    expect(subject.last_modified).to eq qualtrics_response["lastModified"]
+  end
+
+  it "has status" do
+    expect(subject.status).to eq qualtrics_response["status"]
+  end
+
+  it "has a connection" do
+    expect(subject.instance_variable_get(:@conn)).to eq connection
+  end
+
+  describe "export_responses" do
+    let(:options) do
+      {
+        start_date: "01/01/2015 10:11:22"
+      }
+    end
+
+    it "inits a ResponseExportService with options" do
+      expect(QualtricsAPI::Services::ResponseExportService).to receive(:new).with({
+        start_date: options[:start_date],
+        survey_id: subject.id,
+        connection: subject.instance_variable_get(:@conn)
+      })
+
+      subject.export_responses(options)
+    end
+  end
+end

data/spec/qualtrics_api_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe QualtricsAPI do
+
+  describe "#new" do
+
+    subject { QualtricsAPI.new("someToken") }
+
+    it "initializes a Client with the token passed" do
+      expect(subject).to be_kind_of(QualtricsAPI::Client)
+      expect(subject.api_token).to eq "someToken"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'qualtrics_api'
+require 'vcr'
+
+TEST_API_TOKEN = "6Wpo0Vsx1cN1kcHivCaGTz5IhOvchLrg1o4L0KOZ"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "fixtures/vcr_cassettes"
+  config.hook_into :faraday
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: qualtrics_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yurui Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+description: |-
+  A Ruby wrapper for Qualtrics REST API version 3.0.
+                            See https://co1.qualtrics.com/APIDocs/ for API documents.
+email:
+- yuruiology@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixtures/vcr_cassettes/response_export_start_success.yml
+- fixtures/vcr_cassettes/response_export_update_success.yml
+- fixtures/vcr_cassettes/survey_collection_fetch_fail.yml
+- fixtures/vcr_cassettes/survey_collection_fetch_sucess.yml
+- fixtures/vcr_cassettes/survey_collection_fetch_with_scopeId_success.yml
+- lib/qualtrics_api.rb
+- lib/qualtrics_api/client.rb
+- lib/qualtrics_api/request_error_handler.rb
+- lib/qualtrics_api/response_export.rb
+- lib/qualtrics_api/response_export_collection.rb
+- lib/qualtrics_api/services/response_export_service.rb
+- lib/qualtrics_api/survey.rb
+- lib/qualtrics_api/survey_collection.rb
+- lib/qualtrics_api/url.rb
+- lib/qualtrics_api/version.rb
+- qualtrics_api.gemspec
+- spec/lib/client_spec.rb
+- spec/lib/response_export_collection_spec.rb
+- spec/lib/response_export_spec.rb
+- spec/lib/services/response_export_service_spec.rb
+- spec/lib/survey_collection_spec.rb
+- spec/lib/survey_spec.rb
+- spec/qualtrics_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Qualtrics REST API v3.0
+test_files:
+- spec/lib/client_spec.rb
+- spec/lib/response_export_collection_spec.rb
+- spec/lib/response_export_spec.rb
+- spec/lib/services/response_export_service_spec.rb
+- spec/lib/survey_collection_spec.rb
+- spec/lib/survey_spec.rb
+- spec/qualtrics_api_spec.rb
+- spec/spec_helper.rb