qrapi-wrapper 0.6.0

data/lib/qrapi/mappings/survey_mapping.rb

@@ -0,0 +1,33 @@
+module QRAPI
+  class SurveyMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Survey
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :name,       scopes: [:read, :update], optional: true
+      property :is_active,  scopes: [:read, :update], key: "isActive", optional: true
+      property :expiration, scopes: [:read, :update], optional: true do
+        mapping Survey::Expiration
+
+        property :start_date, scopes: [:read, :update], key: "startDate"
+        property :end_date,   scopes: [:read, :update], key: "endDate"
+      end
+
+      scoped :read do
+        property :id
+        property :name
+        property :owner_id,           key: "ownerId"
+        property :organization_id,    key: "organizationId"
+        property :creation_date,      key: "creationDate"
+        property :last_modified,      key: "lastModified"
+        property :flow
+        property :embedded_data,      key: "embeddedData"
+        property :response_counts,    key: "responseCounts"
+        property :questions
+        property :export_column_map,  key: "exportColumnMap"
+      end
+    end
+  end
+end

data/lib/qrapi/mappings/user_mapping.rb

@@ -0,0 +1,40 @@
+module QRAPI
+  class UserMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping User
+      root_key singular: "result", plural: "elements", scopes: [:read]
+
+      property :username,     scopes: [:read, :create, :update]
+      property :first_name,   scopes: [:read, :create, :update],   key: "firstName"
+      property :last_name,    scopes: [:read, :create, :update],   key: "lastName"
+      property :user_type,    scopes: [:read, :create, :update],   key: "userType"
+      property :language,     scopes: [:read, :create, :update]
+      property :status,       scopes: [:read, :update]
+      # property :permissions,  scopes: [:read, :update]
+
+      scoped :read do
+        property :id
+        property :organization_id,            key: "organizationId"
+        property :division_id,                key: "divisionId"
+        property :unsubscribed
+        property :account_creation_date,      key: "accountCreationDate"
+        property :account_expiration_date,    key: "accountExpirationDate"
+        property :password_last_changed_date, key: "passwordLastChangedDate"
+        property :password_expiration_date,   key: "passwordExpirationDate"
+        property :last_login_date,            key: "lastLoginDate"
+        property :response_counts,            key: "responseCounts"
+      end
+
+      scoped :create do
+        property :password,     scopes: [:create]
+        property :email,        scopes: [:create]
+      end
+
+      scoped :create, :update do
+        property :division_id,  key: "divisionId", optional: true
+      end
+    end
+  end
+end

data/lib/qrapi/models/base_model.rb

@@ -0,0 +1,22 @@
+require "virtus"
+
+module QRAPI
+  class BaseModel
+    include Virtus.model
+    include Virtus::Equalizer.new(name || inspect)
+    include ::ActiveModel::Serialization
+
+    def inspect
+      values = Hash[instance_variables.map { |name| [name, instance_variable_get(name)] }]
+      "<#{self.class.name} #{values}>"
+    end
+
+    def created_at
+      nil
+    end
+
+    def updated_at
+      nil
+    end
+  end
+end

data/lib/qrapi/models/distribution.rb

@@ -0,0 +1,45 @@
+module QRAPI
+  class Distribution < BaseModel
+    attribute :id
+    attribute :parent_distribution_id
+    attribute :owner_id
+    attribute :organization_id
+    attribute :request_status
+    attribute :request_type
+    attribute :send_date
+    attribute :created_date
+    attribute :modified_date
+    attribute :headers
+    attribute :recipients
+    attribute :message
+    attribute :survey_link
+    attribute :stats
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::Distribution",
+                     klass: self,
+                     singular: "qualtrics_distribution",
+                     plural: "qualtrics_distributions",
+                     element: "distribution",
+                     human: "distribution",
+                     collection: "qrapi/distributions",
+                     param_key: "qualtrics_distributions",
+                     i18n_key: "qrapi/distributions",
+                     route_key: "qualtrics_distributions",
+                     singular_route_key: "qualtrics_distribution")
+    end
+
+    def created_at
+      creation_date
+    end
+
+    def updated_at
+      modified_date
+    end
+  end
+end

data/lib/qrapi/models/distribution/headers.rb

@@ -0,0 +1,27 @@
+module QRAPI
+  class Distribution::Headers < BaseModel
+    attribute :from_email
+    attribute :from_name
+    attribute :reply_to_email
+    attribute :subject
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_distribution_header",
+                     plural: "qualtrics_distribution_headers",
+                     element: "distribution_header",
+                     human: "distribution_header",
+                     collection: "qrapi/distribution_headers",
+                     param_key: "qualtrics_distribution_headers",
+                     i18n_key: "qrapi/distribution_headers",
+                     route_key: "qualtrics_distribution_headers",
+                     singular_route_key: "qualtrics_distribution_header")
+    end
+  end
+end

data/lib/qrapi/models/distribution/message.rb

@@ -0,0 +1,26 @@
+module QRAPI
+  class Distribution::Message < BaseModel
+    attribute :message_id
+    attribute :library_id
+    attribute :message_text
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_distribution_message",
+                     plural: "qualtrics_distribution_messages",
+                     element: "distribution_message",
+                     human: "distribution_message",
+                     collection: "qrapi/distribution_messages",
+                     param_key: "qualtrics_distribution_messages",
+                     i18n_key: "qrapi/distribution_messages",
+                     route_key: "qualtrics_distribution_messages",
+                     singular_route_key: "qualtrics_distribution_message")
+    end
+  end
+end

data/lib/qrapi/models/distribution/recipients.rb

@@ -0,0 +1,26 @@
+module QRAPI
+  class Distribution::Recipients < BaseModel
+    attribute :mailing_list_id
+    attribute :distribution_recipient_id
+    attribute :contact_id
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_distribution_recipient",
+                     plural: "qualtrics_distribution_recipients",
+                     element: "distribution_recipient",
+                     human: "distribution_recipient",
+                     collection: "qrapi/distribution_recipients",
+                     param_key: "qualtrics_distribution_recipients",
+                     i18n_key: "qrapi/distribution_recipients",
+                     route_key: "qualtrics_distribution_recipients",
+                     singular_route_key: "qualtrics_distribution_recipient")
+    end
+  end
+end

data/lib/qrapi/models/distribution/survey_link.rb

@@ -0,0 +1,26 @@
+module QRAPI
+  class Distribution::SurveyLink < BaseModel
+    attribute :survey_id
+    attribute :expiration_date
+    attribute :type
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_distribution_survey_link",
+                     plural: "qualtrics_distribution_survey_links",
+                     element: "distribution_survey_link",
+                     human: "distribution_survey_link",
+                     collection: "qrapi/distribution_survey_links",
+                     param_key: "qualtrics_distribution_survey_links",
+                     i18n_key: "qrapi/distribution_survey_links",
+                     route_key: "qualtrics_distribution_survey_links",
+                     singular_route_key: "qualtrics_distribution_survey_link")
+    end
+  end
+end

data/lib/qrapi/models/division.rb

@@ -0,0 +1,32 @@
+module QRAPI
+  class Division < BaseModel
+    attribute :id
+    attribute :organization_id
+    attribute :creator_id
+    attribute :name
+    attribute :creation_date
+    attribute :status
+    attribute :response_counts
+    attribute :division_admins
+    # attribute :permissions
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_division",
+                     plural: "qualtrics_divisions",
+                     element: "division",
+                     human: "division",
+                     collection: "qrapi/divisions",
+                     param_key: "qualtrics_divisions",
+                     i18n_key: "qrapi/divisions",
+                     route_key: "qualtrics_divisions",
+                     singular_route_key: "qualtrics_division")
+    end
+  end
+end

data/lib/qrapi/models/group.rb

@@ -0,0 +1,31 @@
+module QRAPI
+  class Group < BaseModel
+    attribute :id
+    attribute :type
+    attribute :organization_id
+    attribute :division_id
+    attribute :name
+    attribute :all_users
+    attribute :creation_date
+    attribute :creator_id
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_group",
+                     plural: "qualtrics_groups",
+                     element: "group",
+                     human: "group",
+                     collection: "qrapi/groups",
+                     param_key: "qualtrics_groups",
+                     i18n_key: "qrapi/groups",
+                     route_key: "qualtrics_groups",
+                     singular_route_key: "qualtrics_group")
+    end
+  end
+end

data/lib/qrapi/models/library_message.rb

@@ -0,0 +1,27 @@
+module QRAPI
+  class LibraryMessage < BaseModel
+    attribute :id
+    attribute :category
+    attribute :description
+    attribute :messages
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_library_message",
+                     plural: "qualtrics_library_messages",
+                     element: "library_message",
+                     human: "library_message",
+                     collection: "qrapi/library_messages",
+                     param_key: "qualtrics_library_messages",
+                     i18n_key: "qrapi/library_messages",
+                     route_key: "qualtrics_library_messages",
+                     singular_route_key: "qualtrics_library_message")
+    end
+  end
+end

data/lib/qrapi/models/mailing_list.rb

@@ -0,0 +1,27 @@
+module QRAPI
+  class MailingList < BaseModel
+    attribute :id
+    attribute :library_id
+    attribute :name
+    attribute :category
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_mailing_list",
+                     plural: "qualtrics_mailing_lists",
+                     element: "mailing_list",
+                     human: "mailing_list",
+                     collection: "qrapi/mailing_lists",
+                     param_key: "qualtrics_mailing_lists",
+                     i18n_key: "qrapi/mailing_lists",
+                     route_key: "qualtrics_mailing_lists",
+                     singular_route_key: "qualtrics_mailing_list")
+    end
+  end
+end

data/lib/qrapi/models/mailing_list/contact.rb

@@ -0,0 +1,33 @@
+module QRAPI
+  class MailingList::Contact < BaseModel
+    attribute :id
+    attribute :first_name
+    attribute :last_name
+    attribute :email
+    attribute :external_data_reference
+    attribute :embedded_data
+    attribute :language
+    attribute :unsubscribed
+    attribute :response_history
+    attribute :email_history
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList::Contact",
+                     klass: self,
+                     singular: "qualtrics_mailing_list_contact",
+                     plural: "qualtrics_mailing_list_contacts",
+                     element: "mailing_list_contacts",
+                     human: "mailing_list_contact",
+                     collection: "qrapi/mailing_list_contacts",
+                     param_key: "qualtrics_mailing_list_contacts",
+                     i18n_key: "qrapi/mailing_list_contacts",
+                     route_key: "qualtrics_mailing_list_contacts",
+                     singular_route_key: "qualtrics_mailing_list_contact")
+    end
+  end
+end

data/lib/qrapi/models/organization.rb

@@ -0,0 +1,29 @@
+module QRAPI
+  class Organization < BaseModel
+    attribute :id
+    attribute :name
+    attribute :base_url
+    attribute :type
+    attribute :status
+    attribute :stats
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_organization",
+                     plural: "qualtrics_organizations",
+                     element: "organization",
+                     human: "organization",
+                     collection: "qrapi/organizations",
+                     param_key: "qualtrics_organizations",
+                     i18n_key: "qrapi/organizations",
+                     route_key: "qualtrics_organizations",
+                     singular_route_key: "qualtrics_organization")
+    end
+  end
+end

data/lib/qrapi/models/response.rb

@@ -0,0 +1,40 @@
+module QRAPI
+  class Response < BaseModel
+    include ::ActiveModel::Serialization
+
+    attribute :id
+    attribute :response_set
+    attribute :ip_address
+    attribute :start_date
+    attribute :end_date
+    attribute :last_name
+    attribute :first_name
+    attribute :email
+    attribute :external_data_reference
+    attribute :finished
+    attribute :status
+    attribute :location_latitude
+    attribute :location_longitude
+    attribute :location_accuracy
+    attribute :questions
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::Response",
+                     klass: self,
+                     singular: "qualtrics_response",
+                     plural: "qualtrics_responses",
+                     element: "responses",
+                     human: "response",
+                     collection: "qrapi/responses",
+                     param_key: "qualtrics_responses",
+                     i18n_key: "qrapi/responses",
+                     route_key: "qualtrics_responses",
+                     singular_route_key: "qualtrics_response")
+    end
+  end
+end