qualtrics 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38dac26d3a42c7605dbcd2719a27c619dcc50d7c
+  data.tar.gz: dbdf572cb5c95ec562aa25175ea5e96645ddccdd
+SHA512:
+  metadata.gz: da1cae4b7d293c3166293df258060c70554ce125118b98c996526105f9ee81f311dc6648173ba057ccd2cf697956087dd5ae6043ca11762bc6cbbd60ece82cd3
+  data.tar.gz: 2c311bd28014ed213781f64b3629942cc1d6a8af72e1e3cf6bcace3df7d0cb2d2a766ea75f7d24ecccbaa9d64e519c3555da0cd8fe08ccd12708b94917f21bee

data/.env.example

@@ -0,0 +1,3 @@
+QUALTRICS_USER=''
+QUALTRICS_TOKEN=''
+QUALTRICS_LIBRARY_ID=''

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qualtrics.gemspec
+gemspec
+group :development do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin Sun
+
+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,29 @@
+# Qualtrics
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qualtrics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qualtrics
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/qualtrics/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(:spec)
+
+task :default => :spec

data/lib/qualtrics.rb

@@ -0,0 +1,52 @@
+require 'configatron'
+
+require "qualtrics/configuration"
+require "qualtrics/version"
+require "qualtrics/operation"
+require "qualtrics/response"
+require "qualtrics/entity"
+require "qualtrics/recipient"
+require "qualtrics/panel"
+require "qualtrics/panel_import"
+require "qualtrics/survey"
+require "qualtrics/survey_import"
+
+require "qualtrics/message"
+require "qualtrics/distribution"
+require "qualtrics/mailer"
+
+# not always necessary for runtime
+# consider adding only when necessary
+require "qualtrics/transaction"
+
+module Qualtrics
+  def self.configure(&block)
+    configuration.update(&block)
+  end
+
+  def self.configuration
+    if !configatron.has_key?(:qualtrics)
+      configatron.qualtrics = Configuration.new
+    end
+    configatron.qualtrics
+  end
+
+  class << self
+    def begin_transaction!
+      configatron.qualtrics_transaction = Qualtrics::Transaction.new
+      Qualtrics::Operation.add_listener(configatron.qualtrics_transaction)
+    end
+
+    def rollback_transaction!
+      if configatron.has_key?(:qualtrics_transaction)
+        configatron.qualtrics_transaction.rollback!
+        Qualtrics::Operation.delete_listener(configatron.qualtrics_transaction)
+      end
+    end
+  end
+
+  class Error < StandardError; end
+  class ServerErrorEncountered < Error; end
+  class UpdateNotAllowed < Error; end
+  class UnexpectedRequestMethod < Error; end
+end

data/lib/qualtrics/configuration.rb

@@ -0,0 +1,17 @@
+module Qualtrics
+  class Configuration
+    attr_accessor :version, :user, :token, :library_id, :endpoint, :default_library_id
+    DEFAULT_VERSION = '2.3'
+    DEFAULT_ENDPOINT = 'https://co1.qualtrics.com/WRAPI/ControlPanel/api.php'
+
+    def initialize(&block)
+      block.call(self) if block_given?
+      self.version ||= DEFAULT_VERSION
+      self.endpoint ||= DEFAULT_ENDPOINT
+    end
+
+    def update(&block)
+      block.call(self) if block_given?
+    end
+  end
+end

data/lib/qualtrics/distribution.rb

@@ -0,0 +1,90 @@
+module Qualtrics
+  class Distribution < Entity
+
+    include ActiveModel::Validations
+
+    validates :id, presence: true
+    validates :message_id, presence: true
+    validates :survey_id, presence: true
+
+    attr_accessor :id, :survey_id, :message_id,
+                  :emails_sent, :emails_failed, :emails_responded,
+                  :emails_bounced, :emails_opened, :emails_skipped
+
+    def initialize(options={})
+      @id = options[:id]
+      @message_id = options[:message_id]
+      @survey_id = options[:survey_id]
+      set_email_response_data(options)
+    end
+
+    def set_email_response_data(options={})
+      @emails_sent      = options[:emails_sent]
+      @emails_failed    = options[:emails_failed]
+      @emails_responded = options[:emails_responded]
+      @emails_bounced   = options[:emails_bounced]
+      @emails_opened    = options[:emails_opened]
+      @emails_skipped   = options[:emails_skipped]
+    end
+
+    def self.attributes
+      {
+        'EmailDistributionID'   => :id,
+        'MessageID'             => :message_id,
+        'SurveyID'              => :survey_id,
+        'EmailsSent'            => :emails_sent,
+        'EmailsFailed'          => :emails_failed,
+        'EmailsResponded'       => :emails_responded,
+        'EmailsBounced'         => :emails_bounced,
+        'EmailsOpened'          => :emails_opened,
+        'EmailsSkipped'         => :emails_skipped
+      }
+    end
+
+    def refresh
+      response = get('getDistributions',
+        {
+          'SurveyID' => survey_id,
+          'DistributionID' => id,
+          'LibraryID' => library_id
+        }
+      )
+
+      if response.success?
+        distribution_hash = response.result['Distributions']
+        set_email_response_data(self.class.response_hash(distribution_hash ))
+        true
+      else
+        false
+      end
+    end
+
+    def self.get_distribution_with_panel(panel, survey, library_id = configuration.default_library_id)
+      response = get('getDistributions',
+        {
+          'SurveyID' => survey.id,
+          'PanelID' => panel.id,
+          'LibraryID' => library_id
+        }
+      )
+
+      if response.success?
+        response.result['Distributions'].map do |distribution|
+          Qualtrics::Distribution.new(response_hash(distribution))
+        end
+      else
+        false
+      end
+    end
+
+    private
+
+    def self.response_hash(distribution_response)
+      {}.tap do |result|
+        attributes.each do |k,v|
+          result[v] = distribution_response[k]
+        end
+      end.delete_if {|key, value| value.nil? }
+    end
+  end
+end

data/lib/qualtrics/entity.rb

@@ -0,0 +1,55 @@
+require 'active_model'
+module Qualtrics
+  class Entity
+    include ActiveModel::Model
+    include ActiveModel::Validations
+
+    def library_id=(lib_id)
+      @library_id = lib_id
+    end
+
+    def library_id
+      @library_id || configuration.default_library_id
+    end
+
+    def success?
+      @last_response && @last_response.success?
+    end
+
+    def persisted?
+      !id.nil?
+    end
+
+    def post(request, options = {})
+      @last_response = self.class.post(request, options)
+    end
+
+    def get(request, options = {})
+      @last_response = self.class.get(request, options)
+    end
+
+    def configuration
+      self.class.configuration
+    end
+
+    def self.underscore_attributes(attributes)
+      attribute_map.inject({}) do |map, keys|
+        qualtrics_key, ruby_key = keys[0], keys[1]
+        map[ruby_key] = attributes[qualtrics_key]
+        map
+      end
+    end
+
+    def self.post(request, options = {})
+      Qualtrics::Operation.new(:post, request, options).issue_request
+    end
+
+    def self.get(request, options = {})
+      Qualtrics::Operation.new(:get, request, options).issue_request
+    end
+
+    def self.configuration
+      Qualtrics.configuration
+    end
+  end
+end

data/lib/qualtrics/mailer.rb

@@ -0,0 +1,111 @@
+require 'active_support/time'
+require 'active_model/validations'
+
+module Qualtrics
+  class Mailer < Entity
+    include ActiveSupport
+    include ActiveModel::Validations
+
+    attr_accessor :send_date, :from_email, :from_name, :subject, :sent_from_address
+    validates :send_date, presence: true
+    validates :from_email, presence: true
+    validates :from_name, presence: true
+    validates :subject, presence: true
+
+    QUALTRICS_POST_TIMEZONE = 'Mountain Time (US & Canada)'
+
+    def initialize(options={})
+      @send_date = options[:send_date] || post_time
+      @from_email = options[:from_email]
+      @from_name = options[:from_name]
+      @subject = options[:subject]
+      @sent_from_address = options[:sent_from_address] || 'noreply@qemailserver.com'
+    end
+
+    def send_survey_to_individual(recipient, message, survey)
+      return false if !valid?
+
+      response = post('sendSurveyToIndividual', attributes.merge(
+        {
+          'RecipientID' => recipient.id,
+          'MessageID' => message.id,
+          'SurveyID' => survey.id,
+          'MessageLibraryID' => library_id,
+          'PanelID' => recipient.panel_id,
+          'PanelLibraryID' => library_id
+        })
+      )
+
+      if response.success?
+        create_distribution(response, survey.id, message.id)
+      else
+        false
+      end
+    end
+
+    def send_survey_to_panel(panel, message, survey)
+      return false if !valid?
+
+      response = post('sendSurveyToPanel', attributes.merge(
+        {
+          'PanelID' => panel.id,
+          'MessageID' => message.id,
+          'SurveyID' => survey.id,
+          'MessageLibraryID' => library_id,
+          'PanelLibraryID' => library_id
+        })
+      )
+
+      if response.success?
+        create_distribution(response, survey.id, message.id)
+      else
+        false
+      end
+    end
+
+    def send_reminder(distribution, message)
+      return false if !valid?
+
+      response = post('sendReminder', attributes.merge(
+        {
+          'ParentEmailDistributionID' => distribution.id,
+          'MessageID' => message.id,
+          'LibraryID' => library_id,
+        })
+      )
+
+      if response.success?
+        create_distribution(response, distribution.survey_id, message.id)
+      else
+        false
+      end
+    end
+
+    def attributes
+      {
+        'SendDate'        => send_date,
+        'FromEmail'       => from_email,
+        'FromName'        => from_name,
+        'Subject'         => subject,
+        'SentFromAddress' => sent_from_address
+      }
+    end
+
+    private
+    def post_time
+      formatted_time Time.now.utc.in_time_zone(QUALTRICS_POST_TIMEZONE)
+    end
+
+    def formatted_time(time)
+      time.strftime("%Y-%m-%d %H:%M:%S")
+    end
+
+    def create_distribution(response, survey_id, message_id)
+      Qualtrics::Distribution.new({
+        message_id: message_id,
+        survey_id: survey_id,
+        id: response.result['EmailDistributionID']
+      })
+    end
+  end
+end