qualtrics 0.5.1

data/lib/qualtrics/message.rb

@@ -0,0 +1,75 @@
+module Qualtrics
+  class Message < Entity
+    ALLOWED_CATEGORIES = %w(InviteEmails InactiveSurveyMessages ReminderEmails
+                            ThankYouEmails EndOfSurveyMessages GeneralMessages
+                            ValidationMessages LookAndFeelMessages)
+
+    attr_accessor :id, :name, :category, :body, :language
+    validates :category, inclusion: { in: ALLOWED_CATEGORIES }
+
+    def self.all(library_id = nil)
+      lib_id = library_id || configuration.default_library_id
+      response = get('getLibraryMessages', {'LibraryID' => lib_id})
+      if response.success?
+        response.result.map do |category, messages|
+          messages.map do |message_id, name|
+            new(id: message_id, name: name, category: category_map[category])
+          end
+        end.flatten
+      else
+        []
+      end
+    end
+
+    def initialize(options={})
+      @name = options[:name]
+      @id = options[:id]
+      @category = options[:category]
+      @library_id = options[:library_id]
+      @body = options[:body]
+      @language = options[:language] || 'EN'
+    end
+    #
+    def save
+      return false if !valid?
+      response = post('createLibraryMessage', attributes)
+
+      if response.success?
+        self.id = response.result['MessageID']
+        true
+      else
+        false
+      end
+    end
+    #
+    # def destroy
+    #   response = post('deleteLibraryMessage', {
+    #     'LibraryID' => library_id,
+    #     'MessageID' => self.id
+    #   })
+    #   response.success?
+    # end
+    #
+    def attributes
+      {
+        'LibraryID' => library_id,
+        'Category' => category,
+        'Name' => name,
+        'Message' => body,
+        'Language' => language
+      }
+    end
+
+    def self.category_map
+      {
+        'INVITE' =>         'InviteEmails',
+        'REMINDER' =>       'ReminderEmails',
+        'THANKYOU' =>       'ThankYouEmails',
+        'ENDOFSURVEY' =>    'EndOfSurveyMessages',
+        'INACTIVESURVEY' => 'InactiveSurveyMessages',
+        'GENERAL' =>        'GeneralMessages',
+        'LOOKANDFEEL' =>    'LookAndFeelMessages'
+      }
+    end
+  end
+end

data/lib/qualtrics/operation.rb

@@ -0,0 +1,77 @@
+module Qualtrics
+  class Operation
+    attr_reader :http_method, :action, :options, :entity_name, :command
+    REQUEST_METHOD_WHITELIST = [:get, :post]
+    @@listeners = []
+
+    def initialize(http_method, action, options)
+      @http_method = http_method
+      @action = action
+      @options = options
+      @entity_name = action.gsub(/(create|delete|update)/, '')
+      @command = $1
+    end
+
+    def issue_request
+      raise Qualtrics::UnexpectedRequestMethod if !REQUEST_METHOD_WHITELIST.include?(http_method)
+
+      body = options.dup.merge(default_params)
+      body['Request'] = action
+
+      Qualtrics::Response.new(connection.send(http_method, path, body)).tap do |response|
+        if !@listeners_disabled
+          @@listeners.each do |listener|
+            listener.received_response(self, response)
+          end
+        end
+      end
+    end
+
+    def disable_listeners(&block)
+      @listeners_disabled = true
+      block.call(self)
+      @listeners_disabled = nil
+    end
+
+    class << self
+      def add_listener(listener)
+        @@listeners << listener
+      end
+
+      def delete_listener(listener)
+        @@listeners.delete(listener)
+      end
+
+      def flush_listeners!
+        @@listeners = []
+      end
+    end
+
+    protected
+    def path
+      '/WRAPI/ControlPanel/api.php'
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => 'https://survey.qualtrics.com') do |faraday|
+        faraday.request :multipart
+        faraday.request  :url_encoded
+        faraday.use ::FaradayMiddleware::FollowRedirects, limit: 3
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def default_params
+      {
+        'User' => configuration.user,
+        'Token' => configuration.token,
+        'Version' => configuration.version,
+        'Format' => 'JSON'
+      }
+    end
+
+    def configuration
+      Qualtrics.configuration
+    end
+  end
+end

data/lib/qualtrics/panel.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module Qualtrics
+  class Panel < Entity
+    attr_accessor :id, :name, :category
+
+    def self.all(library_id = nil)
+      lib_id = library_id || configuration.default_library_id
+      response = get('getPanels', {'LibraryID' => lib_id})
+      if response.success?
+        response.result['Panels'].map do |panel|
+          new(underscore_attributes(panel))
+        end
+      else
+        []
+      end
+    end
+
+    def self.attribute_map
+      {
+        'LibraryID' => :library_id,
+        'Category' => :category,
+        'Name' => :name,
+        'PanelID' => :id
+      }
+    end
+
+    def initialize(options={})
+      @name = options[:name]
+      @id = options[:id]
+      @category = options[:category]
+      @library_id = options[:library_id]
+    end
+
+    def save
+      response = nil
+      if persisted?
+        raise Qualtrics::UpdateNotAllowed
+      else
+        response = post('createPanel', attributes)
+      end
+
+      if response.success?
+        self.id = response.result['PanelID']
+        true
+      else
+        false
+      end
+    end
+
+    def destroy
+      response = post('deletePanel', {
+        'LibraryID' => library_id,
+        'PanelID' => self.id
+        })
+      response.success?
+    end
+
+    def attributes
+      {
+        'LibraryID' => library_id,
+        'Category' => category,
+        'Name' => name
+      }
+    end
+  end
+end

data/lib/qualtrics/panel_import.rb

@@ -0,0 +1,41 @@
+require "qualtrics/panel_import_file"
+
+module Qualtrics
+  class PanelImport < Entity
+    attr_accessor :panel, :recipients
+
+    def initialize(options={})
+      @panel = options[:panel]
+      @recipients = options[:recipients]
+    end
+
+    def save
+      payload = headers
+      payload['LibraryID'] = library_id
+      payload['ColumnHeaders'] = 1
+      file = Qualtrics::PanelImportFile.new(@recipients)
+      payload['Data'] = Faraday::UploadIO.new(file.temp_file, 'text/csv')
+      post 'importPanel', payload
+      true
+    end
+
+    def headers
+      {}.tap do |import_headers|
+        Qualtrics::RecipientImportRow.fields.each_with_index.map do |field, index|
+          import_headers[self.class.attributes[field]] = index + 1
+        end
+      end
+    end
+
+    def self.attributes
+      {
+        'email' => 'Email',
+        'first_name' => 'FirstName',
+        'last_name' => 'LastName',
+        'external_ref' => 'ExternalRef',
+        'unsubscribed' =>'Unsubscribed',
+        'language' => 'Language'
+      }
+    end
+  end
+end

data/lib/qualtrics/panel_import_file.rb

@@ -0,0 +1,28 @@
+require 'tempfile'
+require 'csv'
+require 'qualtrics/recipient_import_row'
+
+module Qualtrics
+  class PanelImportFile
+    attr_reader :recipients
+
+    def initialize(recipients)
+      @recipients = recipients
+    end
+
+    def temp_file
+      if @temp_file.nil?
+        tmp_file = Tempfile.new('panel_import')
+        csv_path = tmp_file.path
+        tmp_file.close
+        CSV.open(csv_path, 'wb', :force_quotes => true, :write_headers => true, :headers => Qualtrics::RecipientImportRow.fields) do |csv|
+          @recipients.each do |recipient|
+            csv << Qualtrics::RecipientImportRow.new(recipient).to_a
+          end
+        end
+        @temp_file = csv_path
+      end
+      @temp_file
+    end
+  end
+end

data/lib/qualtrics/recipient.rb

@@ -0,0 +1,109 @@
+module Qualtrics
+  class Recipient < Entity
+    attr_accessor :email, :first_name, :last_name, :language, :external_data, :embedded_data, :unsubscribed, :panel_id, :id
+    validates :panel_id, presence: true
+    # qualtrics_attribute :library_id, 'LibraryID'
+
+    def initialize(options={})
+      set_attributes(options)
+      @panel_id = options[:panel_id]
+      @id = options[:id]
+    end
+
+    def set_attributes(options={})
+      @email = options[:email]
+      @first_name = options[:first_name]
+      @last_name = options[:last_name]
+      @language = options[:language]
+      @external_data = options[:external_data]
+      @embedded_data = options[:embedded_data]
+      @unsubscribed = options[:unsubscribed]
+    end
+
+    def attributes
+      {
+          'LibraryID'        => library_id,
+          'PanelID'          => panel_id,
+          'Email'            => email,
+          'FirstName'        => first_name,
+          'LastName'         => last_name,
+          'ExternalDataRef'  => external_data,
+          'Language'         => language,
+          'ED'               => embedded_data,
+          'Unsubscribed'     => unsubscribed
+      }.delete_if {|key, value| value.nil? }
+    end
+
+    def panel=(panel)
+      self.panel_id = panel.id
+    end
+
+    def save
+      return false if !valid?
+      response = post('addRecipient', attributes)
+
+      if response.success?
+        self.id = response.result['RecipientID']
+        true
+      else
+        false
+      end
+    end
+
+    def info_hash
+      response = get('getRecipient', {'LibraryID' => library_id, 'RecipientID' => id})
+      if response.success? && !response.result['Recipient'].nil?
+        response.result['Recipient']
+      else
+        false
+      end
+    end
+
+    def update(options={})
+      set_attributes(options)
+      response = post('updateRecipient', update_params)
+
+      if response.success?
+        true
+      else
+        false
+      end
+    end
+
+    def delete
+      response = post('removeRecipient', {
+          'LibraryID' => library_id,
+          'RecipientID' => id,
+          'PanelID' => panel_id
+      })
+
+      if response.success?
+        true
+      else
+        false
+      end
+    end
+
+    def self.attribute_map
+      {
+        'LibraryID'        => :library_id,
+        'PanelID'          => :panel_id,
+        'Email'            => :email,
+        'FirstName'        => :first_name,
+        'LastName'         => :last_name,
+        'ExternalDataRef'  => :external_data,
+        'Language'         => :language,
+        'ED'               => :embedded_data,
+        'Unsubscribed'     => :unsubscribed
+      }
+    end
+
+    protected
+    def update_params
+      {
+          'LibraryID' => library_id,
+          'RecipientID' => id
+      }.merge(attributes)
+    end
+  end
+end

data/lib/qualtrics/recipient_import_row.rb

@@ -0,0 +1,40 @@
+module Qualtrics
+  class RecipientImportRow
+    attr_reader :recipient
+
+    def initialize(recipient)
+      @recipient = recipient
+    end
+
+    def to_a
+      self.class.fields.map do |field|
+        field_map[field]
+      end
+    end
+
+    def field_map
+      {
+        'first_name'    => recipient.first_name,
+        'last_name'     => recipient.last_name,
+        'email'         => recipient.email,
+        'embedded_data' => recipient.embedded_data,
+        'external_data' => recipient.external_data,
+        'unsubscribed'  => recipient.unsubscribed,
+        'language'      => recipient.language
+      }
+    end
+    class << self
+      def fields
+        [
+          'first_name',
+          'last_name',
+          'email',
+          'embedded_data',
+          'external_data',
+          'unsubscribed',
+          'language'
+        ]
+      end
+    end
+  end
+end