qrapi-wrapper 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f55c877f28d86f3eef311c12ca12259e4cc657f9e62ace2f9276dae6f81a460
+  data.tar.gz: 4ae23eaeb89fb89ba8e08cb4247828c9b30326865abfdcb99bc32de6631fd5fe
+SHA512:
+  metadata.gz: 91bfc6a270ee30f6cf7b27707271c8806994090fde5bcb5ea12b0ae169c8c3a84aec0c0554214da6277d3741eb1a5139253e860bd5aa759e13e69af7fcb7a537
+  data.tar.gz: eda8bb8744cd27b4e5a0ca1c740beaffb6e4d62fdea5e6d3372b08f3318c5427660e118f150f73e5245f3952c62678eea98e735ce4246823f9c775223fcd66fc

data/lib/qrapi.rb

@@ -0,0 +1,79 @@
+require "zip"
+require "json"
+require "kartograph"
+require "resource_kit"
+require "qrapi/version"
+require "active_model"
+require "active_support/all"
+
+module QRAPI
+  autoload :Client,                             "qrapi/client"
+
+  # Models
+  autoload :BaseModel,                          "qrapi/models/base_model"
+  autoload :Organization,                       "qrapi/models/organization"
+  autoload :Division,                           "qrapi/models/division"
+  autoload :Group,                              "qrapi/models/group"
+  autoload :Survey,                             "qrapi/models/survey"
+  Survey.autoload :Expiration,                "qrapi/models/survey/expiration"
+  autoload :User,                               "qrapi/models/user"
+  autoload :LibraryMessage,                     "qrapi/models/library_message"
+  autoload :Distribution,                       "qrapi/models/distribution"
+  Distribution.autoload :Headers,             "qrapi/models/distribution/headers"
+  Distribution.autoload :Message,             "qrapi/models/distribution/message"
+  Distribution.autoload :Recipients,          "qrapi/models/distribution/recipients"
+  Distribution.autoload :SurveyLink,          "qrapi/models/distribution/survey_link"
+  autoload :ResponseExport,                     "qrapi/models/response_export"
+  autoload :Response,                           "qrapi/models/response"
+  autoload :MailingList,                        "qrapi/models/mailing_list"
+  MailingList.autoload :Contact,              "qrapi/models/mailing_list/contact"
+
+  # Resources
+  autoload :OrganizationResource,               "qrapi/resources/organization_resource"
+  autoload :DivisionResource,                   "qrapi/resources/division_resource"
+  autoload :GroupResource,                      "qrapi/resources/group_resource"
+  autoload :SurveyResource,                     "qrapi/resources/survey_resource"
+  autoload :UserResource,                       "qrapi/resources/user_resource"
+  autoload :LibraryMessageResource,             "qrapi/resources/library_message_resource"
+  autoload :DistributionResource,               "qrapi/resources/distribution_resource"
+  autoload :ResponseExportResource,             "qrapi/resources/response_export_resource"
+  autoload :ResponseImportResource,             "qrapi/resources/response_import_resource"
+  autoload :MailingListResource,                "qrapi/resources/mailing_list_resource"
+
+  # JSON Maps
+  autoload :OrganizationMapping,                "qrapi/mappings/organization_mapping"
+  autoload :DivisionMapping,                    "qrapi/mappings/division_mapping"
+  autoload :GroupMapping,                       "qrapi/mappings/group_mapping"
+  autoload :SurveyMapping,                      "qrapi/mappings/survey_mapping"
+  autoload :ExpirationMapping,                  "qrapi/mappings/expiration_mapping"
+  autoload :UserMapping,                        "qrapi/mappings/user_mapping"
+  autoload :LibraryMessageMapping,              "qrapi/mappings/library_message_mapping"
+  autoload :DistributionMapping,                "qrapi/mappings/distribution_mapping"
+  autoload :ResponseExportMapping,              "qrapi/mappings/response_export_mapping"
+  autoload :ResponsesMapping,                   "qrapi/mappings/responses_mapping"
+  autoload :MailingListMapping,                 "qrapi/mappings/mailing_list_mapping"
+  autoload :ContactMapping,                     "qrapi/mappings/contact_mapping"
+
+  # Utils
+  autoload :ErrorHandlingResourceable,          "qrapi/error_handling_resourceable"
+  autoload :Kartograph,                         "qrapi/utils/kartograph_optional_properties"
+
+  # Errors
+  autoload :ErrorMapping,                       "qrapi/mappings/error_mapping"
+  Error = Class.new(StandardError)
+  FailedCreate = Class.new(QRAPI::Error)
+  FailedUpdate = Class.new(QRAPI::Error)
+
+  class RateLimitReached < QRAPI::Error
+    attr_accessor :reset_at
+    attr_writer :limit, :remaining
+
+    def limit
+      @limit.to_i if @limit
+    end
+
+    def remaining
+      @remaning.to_i if @remaning
+    end
+  end
+end

data/lib/qrapi/client.rb

@@ -0,0 +1,58 @@
+require "faraday"
+
+module QRAPI
+  class Client
+    attr_reader :api_token, :data_center_id
+
+    def initialize(options = {})
+      @api_token = options[:api_token]
+      @data_center_id = options[:data_center_id]
+    end
+
+    def connection
+      Faraday.new(connection_options) do |req|
+        req.adapter :net_http
+      end
+    end
+
+    def self.resources
+      {
+        organization: OrganizationResource,
+        divisions: DivisionResource,
+        groups: GroupResource,
+        users: UserResource,
+        surveys: SurveyResource,
+        response_exports: ResponseExportResource,
+        response_imports: ResponseImportResource,
+        library_messages: LibraryMessageResource,
+        distributions: DistributionResource,
+        mailing_lists: MailingListResource
+      }
+    end
+
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(connection: connection)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+      def connection_options
+        {
+          url: "https://#{@data_center_id}.qualtrics.com",
+          headers: {
+            content_type: "application/json",
+            X_API_TOKEN: api_token
+          }
+        }
+      end
+  end
+end

data/lib/qrapi/error_handling_resourceable.rb

@@ -0,0 +1,22 @@
+module ErrorHandlingResourceable
+  def self.included(base)
+    base.send(:resources) do
+      default_handler do |response|
+        if (200...299).include?(response.status)
+          next
+        elsif response.status == 429
+          error = QRAPI::RateLimitReached.new("#{response.status}: #{response.body}")
+          error.limit = response.headers["RateLimit-Limit"]
+          error.remaining = response.headers["RateLimit-Remaining"]
+          error.reset_at = response.headers["RateLimit-Reset"]
+          raise error
+        else
+          body = JSON.parse(response.body)
+          error_message = body["meta"]["error"]["errorMessage"]
+          error_code = body["meta"]["error"]["errorCode"]
+          raise QRAPI::Error.new("Status: #{response.status} Error: #{error_code} - #{error_message}")
+        end
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/contact_mapping.rb

@@ -0,0 +1,22 @@
+module QRAPI
+  class ContactMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping MailingList::Contact
+      root_key plural: "elements", scopes: [:read]
+
+      property :id, scopes: [:read]
+
+      scoped :read, :update do
+        property :first_name,               key: "firstName",             optional: true
+        property :last_name,                key: "lastName",              optional: true
+        property :email,                                                  optional: true
+        property :external_data_reference,  key: "externalDataReference", optional: true
+        property :language,                                               optional: true
+        property :embedded_data,            key: "embeddedData",          optional: true
+        property :unsubscribed,                                           optional: true
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/distribution_mapping.rb

@@ -0,0 +1,68 @@
+module QRAPI
+  class DistributionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Distribution
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :send_date, scopes: [:read, :create, :create_child],  key: "sendDate"
+
+      property :recipients, scopes: [:read, :create] do
+        mapping Distribution::Recipients
+
+        property :mailing_list_id,  scopes: [:read, :create], key: "mailingListId"
+        property :contact_id,       scopes: [:read, :create], key: "contactId", optional: true
+      end
+
+      property :headers, scopes: [:read, :create, :create_child] do
+        mapping Distribution::Headers
+
+        property :from_email,     scopes: [:read, :create, :create_child], key: "fromEmail"
+        property :from_name,      scopes: [:read, :create, :create_child], key: "fromName"
+        property :reply_to_email, scopes: [:read, :create, :create_child], key: "replyToEmail"
+        property :subject,        scopes: [:read, :create, :create_child]
+      end
+
+      property :message, scopes: [:read, :create], optional: true do
+        mapping Distribution::Message
+
+        property :message_id,   scopes: [:read, :create], key: "messageId"
+        property :library_id,   scopes: [:read, :create], key: "libraryId"
+        property :message_text, scopes: [:read, :create], key: "messageText"
+      end
+
+      property :survey_link, scopes: [:read, :create], optional: true, key: "surveyLink" do
+        mapping Distribution::SurveyLink
+
+        property :survey_id,        scopes: [:read, :create], key: "surveyId"
+        property :expiration_date,  scopes: [:read, :create], key: "expirationDate"
+        property :type,             scopes: [:read, :create]
+      end
+
+      scoped :read do
+        property :id
+        property :parent_distribution_id, key: "parentDistributionId"
+        property :owner_id,               key: "ownerId"
+        property :organization_id,        key: "organizationId"
+        property :request_status,         key: "requestStatus"
+        property :request_type,           key: "requestType"
+        property :created_date,           key: "createdDate"
+        property :modified_date,          key: "modifiedDate"
+        property :stats
+      end
+
+      scoped :create_child do
+        property :message do
+          mapping Distribution::Message
+
+          scoped :create_child do
+            property :message_id, key: "messageId"
+            property :library_id, key: "libraryId"
+            property :message_text, key: "messageText"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/division_mapping.rb

@@ -0,0 +1,27 @@
+module QRAPI
+  class DivisionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Division
+      root_key singular: "result", scopes: [:read]
+
+      property :name,   scopes: [:read, :update], optional: true
+      property :status, scopes: [:read, :update], optional: true
+      # property :permissions, scopes: [:read, :create, :update], optional: true
+
+      scoped :read do
+        property :id
+        property :organization_id,  key: "organizationId"
+        property :creation_date,    key: "creationDate"
+        property :creator_id,       key: "creatorId"
+        property :response_counts,  key: "responseCounts"
+      end
+
+      scoped :create do
+        property :name
+        property :division_admins, key: "divisionAdmins", optional: true
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/error_mapping.rb

@@ -0,0 +1,19 @@
+module QRAPI
+  class ErrorMapping
+    Error = Struct.new(:message, :id)
+
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Error
+
+      property :id, scopes: [:read]
+      property :message, scopes: [:read]
+    end
+
+    def self.fail_with(klass, content)
+      error = extract_single(content, :read)
+      raise klass, error.message
+    end
+  end
+end

data/lib/qrapi/mappings/group_mapping.rb

@@ -0,0 +1,27 @@
+module QRAPI
+  class GroupMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Group
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :type, scopes: [:read, :create]
+      property :name, scopes: [:read, :create]
+      property :division_id, scopes: [:read, :update], key: "divisionId", optional: true
+
+      scoped :read do
+        property :id
+        property :organization_id,  key: "organizationId"
+        property :all_users,        key: "allUsers"
+        property :creation_date,    key: "creationDate"
+        property :creator_id,       key: "creatorId"
+      end
+
+      scoped :update do
+        property :type, optional: true
+        property :name, optional: true
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/library_message_mapping.rb

@@ -0,0 +1,20 @@
+module QRAPI
+  class LibraryMessageMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping LibraryMessage
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :id,           scopes: [:read]
+      property :category,     scopes: [:read, :create]
+      property :messages,     scopes: [:read, :update], optional: true
+      property :description,  scopes: [:read, :update], optional: true
+
+      scoped :create do
+        property :description
+        property :messages
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/mailing_list_mapping.rb

@@ -0,0 +1,20 @@
+module QRAPI
+  class MailingListMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping MailingList
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :id,         scopes: [:read]
+      property :name,       scopes: [:read, :create]
+      property :library_id, scopes: [:read, :create], key: "libraryId"
+      property :category,   scopes: [:read, :create, :update], optional: true
+
+      scoped :update do
+        property :name, optional: true
+        property :library_id, key: "libraryId", optional: true
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/organization_mapping.rb

@@ -0,0 +1,19 @@
+module QRAPI
+  class OrganizationMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Organization
+      root_key singular: "result", scopes: [:read]
+
+      scoped :read do
+        property :id
+        property :name
+        property :base_url
+        property :type
+        property :status
+        property :stats
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/response_export_mapping.rb

@@ -0,0 +1,14 @@
+module QRAPI
+  class ResponseExportMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping ResponseExport
+      root_key singular: "result", scopes: [:read]
+
+      scoped :read do
+        property :percent_complete, key: "percentComplete"
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/responses_mapping.rb

@@ -0,0 +1,45 @@
+module QRAPI
+  class ResponsesMapping
+    # Maps each of the responses to a QRAPI::Response model
+    #
+    # @return [QRAPI::Response]
+    def self.from_json_or_xml(serialized_response, f_type)
+      case f_type
+      when :json
+        responses_hash = JSON.parse(serialized_response)
+        unmapped_responses = responses_hash["responses"]
+      when :xml
+        responses_hash = Hash.from_xml(serialized_response)
+        unmapped_responses = responses_hash["xml"]["Response"]
+      end
+
+      responses = []
+      unmapped_responses.each do |response|
+        r = Response.new
+        r.id                        = response["ResponseID"]
+        r.response_set              = response["ResponseSet"]
+        r.ip_address                = response["IPAddress"]
+        r.start_date                = response["StartDate"]
+        r.end_date                  = response["EndDate"]
+        r.last_name                 = response["RecipientLastName"]
+        r.first_name                = response["RecipientFirstName"]
+        r.email                     = response["RecipientEmail"]
+        r.external_data_reference   = response["ExternalDataReference"]
+        r.finished                  = response["Finished"]
+        r.status                    = response["Status"]
+        r.location_latitude         = response["LocationLatitude"]
+        r.location_longitude        = response["LocationLongitude"]
+        r.location_accuracy         = response["LocationAccuracy"]
+
+        r.questions = {}
+        response.keys.grep(/Q([0-9xy_]+)/).each do |key|
+          r.questions[key] = response[key]
+        end
+
+        responses << r
+      end
+
+      responses
+    end
+  end
+end