qualtrics 0.5.1

data/spec/qualtrics/configuration_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Qualtrics::Configuration do
+  it 'has a version' do
+    version = '2.3'
+    configuration = Qualtrics::Configuration.new do |config|
+      config.version = version
+    end
+    expect(configuration.version).to eq(version)
+  end
+
+  it 'defaults to latest version' do
+    configuration = Qualtrics::Configuration.new
+    expect(configuration.version).to eq(Qualtrics::Configuration::DEFAULT_VERSION)
+  end
+
+  it 'has a user' do
+    user = 'fake@example.com'
+    configuration = Qualtrics::Configuration.new do |config|
+      config.user = user
+    end
+    expect(configuration.user).to eq(user)
+  end
+
+  it 'has a token' do
+    token = '12341234'
+    configuration = Qualtrics::Configuration.new do |config|
+      config.token = token
+    end
+    expect(configuration.token).to eq(token)
+  end
+
+  it 'has an endpoint' do
+    endpoint = 'https://co1.qualtrics.com/WRAPI/ControlPanel/api.php'
+    configuration = Qualtrics::Configuration.new do |config|
+      config.endpoint = endpoint
+    end
+    expect(configuration.endpoint).to eq(endpoint)
+  end
+
+  it 'has a default endpoint' do
+    configuration = Qualtrics::Configuration.new
+    expect(configuration.endpoint).to eq(Qualtrics::Configuration::DEFAULT_ENDPOINT)
+  end
+
+  it 'has a default library id' do
+    library_id = 1
+    configuration = Qualtrics::Configuration.new do |config|
+      config.default_library_id = library_id
+    end
+    expect(configuration.default_library_id).to eql(library_id)
+  end
+end

data/spec/qualtrics/distribution_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe Qualtrics::Distribution, vcr: true do
+  it 'has a id' do
+    id = 'JOASNDOANSd'
+    distribution = Qualtrics::Distribution.new({
+      id: id
+    })
+    expect(distribution.id).to eq(id)
+  end
+
+  it 'has a survey id' do
+    survey_id = 'survey123'
+    distribution = Qualtrics::Distribution.new({
+     survey_id: survey_id
+    })
+    expect(distribution.survey_id).to eq(survey_id)
+  end
+
+  it 'has a message id' do
+    message_id = 'message123'
+    distribution = Qualtrics::Distribution.new({
+      message_id: message_id
+    })
+    expect(distribution.message_id).to eq(message_id)
+  end
+
+  it 'has response data' do
+    emails_sent      = '1'
+    emails_failed    = '2'
+    emails_responded = '3'
+    emails_bounced   = '4'
+    emails_opened    = '5'
+    emails_skipped   = '6'
+
+    distribution = Qualtrics::Distribution.new({
+      emails_sent: emails_sent,
+      emails_failed: emails_failed,
+      emails_responded: emails_responded,
+      emails_bounced: emails_bounced,
+      emails_opened: emails_opened,
+      emails_skipped: emails_skipped
+    })
+
+    expect(distribution.emails_sent).to eq(emails_sent)
+    expect(distribution.emails_failed).to eq(emails_failed)
+    expect(distribution.emails_responded).to eq(emails_responded)
+    expect(distribution.emails_bounced).to eq(emails_bounced)
+    expect(distribution.emails_opened).to eq(emails_opened)
+    expect(distribution.emails_skipped).to eq(emails_skipped)
+  end
+
+  context 'creating to qualtrics' do
+    let(:panel) do
+      Qualtrics::Panel.new({
+        name: 'Newest Panel',
+        category: 'Great Category'
+      })
+    end
+
+    let(:survey_import) do
+      survey_import = Qualtrics::SurveyImport.new({
+        survey_name: 'Complex survey',
+        survey_data_location: 'spec/fixtures/sample_survey.xml'
+      })
+    end
+
+    let(:survey) { survey_import.survey }
+
+
+    let(:recipient) do
+      Qualtrics::Recipient.new({
+        panel_id: panel.id,
+        email: 'working@hard.com'
+      })
+    end
+
+    let(:recipient2) do
+      Qualtrics::Recipient.new({
+        panel_id: panel.id,
+        email: 'notworking@hard.com'
+      })
+    end
+
+    let(:message) do
+      Qualtrics::Message.new({
+        name: 'Newest Message',
+        category: 'InviteEmails',
+        body: 'Welcome'
+      })
+    end
+
+    let(:mailer) do
+      mailer = Qualtrics::Mailer.new({
+        from_email: 'example@example.com',
+        from_name: 'yes_qualtrics',
+        subject: 'game convention'
+      })
+    end
+
+    before(:each) do
+      panel.save
+      recipient.save
+      recipient2.save
+      survey_import.save
+      message.save
+    end
+
+    after(:each) do
+      recipient.delete
+      recipient2.delete
+      panel.destroy
+      survey.destroy
+    end
+
+    it 'can retrieve a panel of distributions in qualtrics' do
+      mailer.send_survey_to_individual(recipient, message, survey)
+      mailer.send_survey_to_individual(recipient2, message, survey)
+
+      distributions = Qualtrics::Distribution.get_distribution_with_panel(panel, survey)
+      expect(distributions.length).to eql (2)
+
+      first_distribution = distributions[0]
+      expect(first_distribution.survey_id).to eql (survey.id)
+
+      expect(first_distribution.valid?).to be true
+      expect(first_distribution.emails_responded).to_not be_nil
+      expect(first_distribution.emails_sent     ).to_not be_nil
+      expect(first_distribution.emails_failed   ).to_not be_nil
+      expect(first_distribution.emails_responded).to_not be_nil
+      expect(first_distribution.emails_bounced  ).to_not be_nil
+      expect(first_distribution.emails_opened   ).to_not be_nil
+      expect(first_distribution.emails_skipped  ).to_not be_nil
+    end
+
+    it 'can update itself' do
+      distribution = mailer.send_survey_to_individual(recipient, message, survey)
+      expect(distribution.emails_responded).to be_nil
+
+      expect(distribution.refresh).to be true
+      expect(distribution.emails_responded).to_not be_nil
+    end
+  end
+end

data/spec/qualtrics/mailer_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Qualtrics::Mailer, :vcr do
+
+  it 'has a send date' do
+    send_date = Time.now.strftime('%Y-%m-%d %H:%M:%S')
+    mailer = Qualtrics::Mailer.new({
+      send_date: send_date
+    })
+    expect(mailer.send_date).to eq(send_date)
+  end
+
+  it 'has a default send date' do
+    send_date = Time.now.utc.in_time_zone(Qualtrics::Mailer::QUALTRICS_POST_TIMEZONE).strftime("%Y-%m-%d %H:%M:%S")
+    mailer = Qualtrics::Mailer.new({})
+    expect(mailer.send_date).to eq(send_date)
+  end
+
+  it 'has a from email' do
+    from_email = 'having_fun@isnthard.com'
+    mailer = Qualtrics::Mailer.new({
+      from_email: from_email
+    })
+    expect(mailer.from_email).to eq(from_email)
+  end
+
+  it 'has a from name' do
+    from_name = 'Pinkberry'
+    mailer = Qualtrics::Mailer.new({
+      from_name: from_name
+    })
+    expect(mailer.from_name).to eq(from_name)
+  end
+
+  it 'has a subject' do
+    subject = 'party invitation'
+    mailer = Qualtrics::Mailer.new({
+      subject: subject
+    })
+    expect(mailer.subject).to eq(subject)
+  end
+
+  it 'has a sent from email' do
+    sent_from_address = 'sent_here@gmail.com'
+    mailer = Qualtrics::Mailer.new({
+      sent_from_address: sent_from_address
+    })
+    expect(mailer.sent_from_address).to eq(sent_from_address)
+  end
+
+  let(:panel) do
+    Qualtrics::Panel.new({
+      name: 'Newest Panel',
+      category: 'Great Category'
+    })
+  end
+
+  let(:recipient) do
+    Qualtrics::Recipient.new({
+      panel_id: panel.id,
+      email: 'working@hard.com'
+    })
+  end
+
+  let(:message) do
+    Qualtrics::Message.new({
+      name: 'Newest Message',
+      category: 'InviteEmails',
+      body: 'Welcome'
+    })
+  end
+
+  let(:survey_import) do
+    survey_import = Qualtrics::SurveyImport.new({
+      survey_name: 'Complex survey',
+      survey_data_location: 'spec/fixtures/sample_survey.xml'
+    })
+  end
+
+  let(:survey) { survey_import.survey }
+
+  context 'creating to qualtrics' do
+    let(:from_name) { 'yes_qualtrics' }
+    let(:from_email) { 'example@example.com' }
+    let(:subject) { 'game convention' }
+    let(:mailer) do
+      mailer = Qualtrics::Mailer.new({
+        from_email: from_email,
+        from_name: from_name,
+        subject: subject
+      })
+    end
+
+    before(:each) do
+
+      panel.save
+      recipient.save
+      survey_import.save
+      message.save
+    end
+
+    after(:each) do
+      recipient.delete
+      panel.destroy
+      survey.destroy
+    end
+
+    it 'sends a survey to an individual and creates a distribution' do
+      qualtrics_distribution = mailer.send_survey_to_individual(recipient, message, survey)
+      expect(qualtrics_distribution.survey_id).to equal(survey.id)
+      expect(qualtrics_distribution.id).to_not be_nil
+    end
+
+    it 'sends a reminder to a distribution' do
+      qualtrics_distribution = mailer.send_survey_to_individual(recipient, message, survey)
+      reminder_distribution = mailer.send_reminder(qualtrics_distribution, message)
+      expect(reminder_distribution.survey_id).to equal(survey.id)
+      expect(reminder_distribution.id).to_not be_nil
+    end
+
+    it 'sends a survey to a panel and creates a distribution' do
+      qualtrics_distribution = mailer.send_survey_to_panel(panel, message, survey)
+      expect(qualtrics_distribution.survey_id).to equal(survey.id)
+      expect(qualtrics_distribution.id).to_not be_nil
+    end
+  end
+end

data/spec/qualtrics/message_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Qualtrics::Message, vcr: true do
+  it 'has a name' do
+    name = 'New message'
+    message = Qualtrics::Message.new({
+      name: name
+    })
+    expect(message.name).to eq(name)
+  end
+
+  it 'has a category' do
+    category = 'InviteEmails'
+    message = Qualtrics::Message.new({
+      category: category
+    })
+    expect(message.category).to eq(category)
+  end
+
+  it 'only accepts valid categories' do
+    category = 'Not real category'
+    message = Qualtrics::Message.new({
+      category: category
+    })
+
+    expect(message.save).to be false
+    expect(message.errors[:category]).to_not be_blank
+  end
+
+  it 'has a body' do
+    body = 'Hi take my survey'
+    message = Qualtrics::Message.new({
+      body: body
+    })
+    expect(message.body).to eq(body)
+  end
+
+  it 'has a language' do
+    language = 'FR'
+    message = Qualtrics::Message.new({
+      language: language
+    })
+    expect(message.language).to eq(language)
+  end
+
+  it 'defaults to the configured language when none is specified' do
+    message = Qualtrics::Message.new
+    expect(message.language).to eq('EN')
+  end
+
+  it 'has a library id' do
+    library_id = '1'
+    message = Qualtrics::Message.new({
+      library_id: library_id
+    })
+    expect(message.library_id).to eq(library_id)
+  end
+
+  it 'defaults to the configured library id when none is specified' do
+    message = Qualtrics::Message.new
+    expect(message.library_id).to eq(Qualtrics.configuration.default_library_id)
+  end
+
+  let(:message) do
+    Qualtrics::Message.new({
+      name: 'Newest Message',
+      category: 'InviteEmails',
+      body: 'Welcome'
+    })
+  end
+
+  context 'creating to qualtrics' do
+    # before(:each) do
+    #   Qualtrics.begin_transaction!
+    # end
+    #
+    # after(:each) do
+    #   Qualtrics.rollback_transaction!
+    # end
+
+    it 'persists to qualtrics' do
+      expect(message.save).to be true
+    end
+
+    it 'populates the message_id when successful' do
+      message.save
+      expect(message.id).to_not be_nil
+    end
+
+    it 'populates the success attribute' do
+      message.save
+      expect(message).to be_success
+    end
+  end
+
+  # it 'destroys a message that returns true when successful' do
+  #   message.save
+  #   expect(message.destroy).to be true
+  # end
+
+  it 'retrieves an array of all panels in a library' do
+    message.save
+    expect(Qualtrics::Message.all.map{|m| m.id}).to include(message.id)
+  end
+end

data/spec/qualtrics/panel_import_file_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Qualtrics::PanelImportFile do
+  let(:email) { 'user@example.com' }
+  let(:recipients) {[Qualtrics::Recipient.new(email: email), Qualtrics::Recipient.new] }
+  let(:panel_import_file) do
+    Qualtrics::PanelImportFile.new(recipients)
+  end
+
+  it 'has a list of recipients' do
+    expect(panel_import_file.recipients).to eql(recipients)
+  end
+
+  it 'writes a temp file' do
+    expect(panel_import_file.temp_file).to_not be_nil
+    expect(FileTest.exists?(panel_import_file.temp_file)).to be true
+  end
+
+  it 'contains a header' do
+    expect(File.read(panel_import_file.temp_file)).to include("first_name")
+  end
+
+  it 'contains a row of recipients' do
+    expect(File.read(panel_import_file.temp_file)).to include(email)
+  end
+end