qrapi-wrapper 0.6.0

data/lib/qrapi/models/response_export.rb

@@ -0,0 +1,71 @@
+module QRAPI
+  class ResponseExport < BaseModel
+    attribute :id
+    attribute :percent_complete
+    attribute :file
+
+    # Unzips and maps the serialized responses to a Response object
+    #
+    # @return [QRAPI::Response]
+    def get_responses
+      unzip_responses(file)
+    end
+
+    private
+
+      # Creates a temporary zip file from api response, and maps the
+      # contents of the file inside to an array of QRAPI::Response models
+      # TODO: Add CSV support
+      # @return [QRAPI::Response]
+      def unzip_responses(response_zip)
+        File.open("/tmp/qualtrics_response_export_#{id}.zip", "wb") { |f| f.write response_zip }
+        responses = ""
+
+        Zip::File.open("/tmp/qualtrics_response_export_#{id}.zip") do |zip|
+          zip.each do |file|
+            case file.name
+            when /.+\.json/
+              responses = create_responses(file.get_input_stream.read, :json)
+            when /.+\.xml/
+              responses = create_responses(file.get_input_stream.read, :xml)
+            else
+              raise QRAPI::Error.new("Unkown Response Export file type for file: #{file.name}")
+            end
+          end
+        end
+
+        File.delete("/tmp/qualtrics_response_export_#{id}.zip")
+        responses
+      end
+
+      # Sends the serialized responses to the correct mapping function
+      # TODO: Add CSV Mapping
+      # @return [QRAPI::Response]
+      def create_responses(serialized_responses, f_type)
+        if (f_type == :json) || (f_type == :xml)
+          responses = ResponsesMapping.from_json_or_xml(serialized_responses, f_type)
+        end
+
+        responses
+      end
+
+      ##
+      # Make the model serializeable by ActiveModelSerializer
+      #
+      # @return [OpenStruct]
+      #
+      def self.model_name
+        OpenStruct.new(name: "QRAPI::ResponseExport",
+                       klass: self,
+                       singular: "qualtrics_response_export",
+                       plural: "qualtrics_response_exports",
+                       element: "response_exports",
+                       human: "response_export",
+                       collection: "qrapi/response_exports",
+                       param_key: "qualtrics_response_exports",
+                       i18n_key: "qrapi/response_exports",
+                       route_key: "qualtrics_response_exports",
+                       singular_route_key: "qualtrics_response_export")
+      end
+  end
+end

data/lib/qrapi/models/survey.rb

@@ -0,0 +1,45 @@
+module QRAPI
+  class Survey < BaseModel
+    attribute :id
+    attribute :name
+    attribute :owner_id
+    attribute :organization_id
+    attribute :creation_date
+    attribute :last_modified
+    attribute :is_active
+    attribute :expiration
+    attribute :questions
+    attribute :export_column_map
+    attribute :blocks
+    attribute :flow
+    attribute :embedded_data
+    attribute :response_counts
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::Survey",
+                     klass: self,
+                     singular: "qualtrics_survey",
+                     plural: "qualtrics_surveys",
+                     element: "survey",
+                     human: "Survey",
+                     collection: "qrapi/surveys",
+                     param_key: "qualtrics_surveys",
+                     i18n_key: "qrapi/surveys",
+                     route_key: "qualtrics_surveys",
+                     singular_route_key: "qualtrics_survey")
+    end
+
+    def created_at
+      creation_date
+    end
+
+    def updated_at
+      last_modified
+    end
+  end
+end

data/lib/qrapi/models/survey/expiration.rb

@@ -0,0 +1,25 @@
+module QRAPI
+  class Survey::Expiration < BaseModel
+    attribute :start_date
+    attribute :end_date
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_survey_expiration",
+                     plural: "qualtrics_survey_expirations",
+                     element: "survey_expiration",
+                     human: "survey_expiration",
+                     collection: "qrapi/survey_expirations",
+                     param_key: "qualtrics_survey_expirations",
+                     i18n_key: "qrapi/survey_expirations",
+                     route_key: "qualtrics_survey_expirations",
+                     singular_route_key: "qualtrics_survey_expiration")
+    end
+  end
+end

data/lib/qrapi/models/user.rb

@@ -0,0 +1,44 @@
+module QRAPI
+  class User < BaseModel
+    attribute :id
+    attribute :username
+    attribute :first_name
+    attribute :last_name
+    attribute :user_type
+    attribute :division_id
+    attribute :status
+    attribute :language
+    # attribute :permissions
+    attribute :organization_id
+    attribute :unsubscribed
+    attribute :account_creation_date
+    attribute :account_expiration_date
+    attribute :password_last_changed_date
+    attribute :password_expiration_date
+    attribute :last_login_date
+    attribute :response_counts
+
+    # Create only attributes
+    attribute :password
+    attribute :email
+
+    ##
+    # Make the model serializeable by ActiveModelSerializer
+    #
+    # @return [OpenStruct]
+    #
+    def self.model_name
+      OpenStruct.new(name: "QRAPI::MailingList",
+                     klass: self,
+                     singular: "qualtrics_user",
+                     plural: "qualtrics_users",
+                     element: "user",
+                     human: "user",
+                     collection: "qrapi/users",
+                     param_key: "qualtrics_users",
+                     i18n_key: "qrapi/users",
+                     route_key: "qualtrics_users",
+                     singular_route_key: "qualtrics_user")
+    end
+  end
+end

data/lib/qrapi/resources/distribution_resource.rb

@@ -0,0 +1,47 @@
+module QRAPI
+  class DistributionResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :all, "GET /API/v3/distributions" do
+        query_keys surveyId: :survey_id, mailingListId: :mailing_list_id,
+                   distributionRequestType: :distribution_request_type,
+                   sendStartDate: :send_start_date, sendEndDate: :send_end_date
+
+        handler(200) do |response|
+          response_body = JSON.parse(response.body)["result"].to_json
+          DistributionMapping.extract_collection(response_body, :read)
+        end
+      end
+
+      action :find, "GET /API/v3/distributions/:id" do
+        query_keys surveyId: :survey_id
+        handler(200) { |response| DistributionMapping.extract_single(response.body, :read) }
+      end
+
+      action :create, "POST /API/v3/distributions" do
+        body { |object| DistributionMapping.representation_for(:create, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["id"]
+          object
+        end
+      end
+
+      action :create_thankyou, "POST /API/v3/distributions/:id/thankyous" do
+        body { |object| DistributionMapping.representation_for(:create_child, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["distributionId"]
+          object
+        end
+      end
+
+      action :create_reminder, "POST /API/v3/distributions/:id/reminders" do
+        body { |object| DistributionMapping.representation_for(:create_child, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["distributionId"]
+          object
+        end
+      end
+    end
+  end
+end

data/lib/qrapi/resources/division_resource.rb

@@ -0,0 +1,24 @@
+module QRAPI
+  class DivisionResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :find, "GET /API/v3/divisions/:id" do
+        handler(200) { |response| DivisionMapping.extract_single(response.body, :read) }
+      end
+
+      action :create, "POST /API/v3/divisions" do
+        body { |object| DivisionMapping.representation_for(:create, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["id"]
+          object
+        end
+      end
+
+      action :update, "PUT /API/v3/divisions/:id" do
+        body { |object| DivisionMapping.representation_for(:update, object) }
+        handler(200) { |_| true }
+      end
+    end
+  end
+end

data/lib/qrapi/resources/group_resource.rb

@@ -0,0 +1,44 @@
+module QRAPI
+  class GroupResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :all, "GET /API/v3/groups" do
+        handler(200) do |response|
+          body = JSON.parse(response.body)["result"].to_json
+          GroupMapping.extract_collection(body, :read)
+        end
+      end
+
+      action :find, "GET /API/v3/groups/:id" do
+        handler(200) { |response| GroupMapping.extract_single(response.body, :read) }
+      end
+
+      action :create, "POST /API/v3/groups" do
+        body { |object| GroupMapping.representation_for(object, :create) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["groupId"]
+          object
+        end
+      end
+
+      action :update, "PUT /API/v3/groups/:id" do
+        body { |object| GroupMapping.representation_for(object, :update) }
+        handler(200) { |_| true }
+      end
+
+      action :delete, "DELETE /API/v3/groups/:id" do
+        handler(200) { |_| true }
+      end
+
+      action :add_user, "POST /API/v3/groups/:id/members" do
+        body { |user_id| { userId: user_id }.to_json }
+        handler(200) { |_| true }
+      end
+
+      action :delete_user, "DELETE /API/v3/groups/:id/members/:user_id" do
+        handler(200) { |_| true }
+      end
+    end
+  end
+end

data/lib/qrapi/resources/library_message_resource.rb

@@ -0,0 +1,41 @@
+module QRAPI
+  class LibraryMessageResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :all, "GET /API/v3/libraries/:library_id/messages" do
+        handler(200) do |response|
+          body = JSON.parse(response.body)["result"].to_json
+          LibraryMessageMapping.extract_collection(body, :read)
+        end
+      end
+
+      action :find, "GET /API/v3/libraries/:library_id/messages/:id" do
+        # Qualtrics doesn't return the id in the response
+        # so we have to assign it from the passed message_id
+        handler(200) do |response, id|
+          lib_msg = LibraryMessageMapping.extract_single(response.body, :read)
+          lib_msg.id = id
+          lib_msg
+        end
+      end
+
+      action :create, "POST /API/v3/libraries/:library_id/messages" do
+        body { |object| LibraryMessageMapping.representation_for(:create, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["id"]
+          object
+        end
+      end
+
+      action :update, "PUT /API/v3/libraries/:library_id/messages/:id" do
+        body { |object| LibraryMessageMapping.representation_for(:update, object) }
+        handler(200) { |_| true }
+      end
+
+      action :delete, "DELETE /API/v3/libraries/:library_id/messages/:id" do
+        handler(200) { |_| true }
+      end
+    end
+  end
+end

data/lib/qrapi/resources/mailing_list_resource.rb

@@ -0,0 +1,51 @@
+module QRAPI
+  class MailingListResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :all, "GET /API/v3/mailinglists" do
+        handler(200) do |response|
+          body = JSON.parse(response.body)["result"].to_json
+          MailingListMapping.extract_collection(body, :read)
+        end
+      end
+
+      action :find, "GET /API/v3/mailinglists/:id" do
+        handler(200) { |response| MailingListMapping.extract_single(response.body, :read) }
+      end
+
+      action :create, "POST /API/v3/mailinglists" do
+        body { |object| MailingListMapping.representation_for(:create, object) }
+        handler(200) do |response, object|
+          object.id = JSON.parse(response.body)["result"]["id"]
+          object
+        end
+      end
+
+      action :update, "PUT /API/v3/mailinglists/:id" do
+        body { |object| MailingListMapping.representation_for(:update, object) }
+        handler(200) { |_| true }
+      end
+
+      action :delete, "DELETE /API/v3/mailinglists/:id" do
+        handler(200) { |_| true }
+      end
+
+      action :list_contacts, "GET /API/v3/mailinglists/:id/contacts" do
+        handler(200) do |response|
+          body = JSON.parse(response.body)["result"].to_json
+          ContactMapping.extract_collection(body, :read)
+        end
+      end
+
+      action :update_contact, "PUT /API/v3/mailinglists/:id/contacts/:contact_id" do
+        body { |object| ContactMapping.representation_for(:update, object) }
+        handler(200) { |_| true }
+      end
+
+      action :delete_contact, "DELETE /API/v3/mailinglists/:id/contacts/:contact_id" do
+        handler(200) { |_| true }
+      end
+    end
+  end
+end

data/lib/qrapi/resources/organization_resource.rb

@@ -0,0 +1,12 @@
+module QRAPI
+  class OrganizationResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    resources do
+      action :find do
+        path "/API/v3/organizations/:id"
+        handler(200) { |response| OrganizationMapping.extract_single(response.body, :read) }
+      end
+    end
+  end
+end

data/lib/qrapi/resources/response_export_resource.rb

@@ -0,0 +1,49 @@
+module QRAPI
+  class ResponseExportResource < ResourceKit::Resource
+    include ErrorHandlingResourceable
+
+    [:csv, :csv_2013, :xml, :json, :spss].each do |file_type|
+      define_method file_type do |opts|
+        opts[:file_type] = file_type
+        create(opts)
+      end
+    end
+
+    resources do
+      action :find, "GET /API/v3/responseexports/:id" do
+        handler(200) do |response, hash|
+          resp_exp = ResponseExportMapping.extract_single(response.body, :read)
+          resp_exp.id = hash[:id]
+
+          unless resp_exp.percent_complete < 100
+            resp_exp.file = get_file(id: hash[:id])
+          end
+
+          resp_exp
+        end
+      end
+
+      action :create, "POST /API/v3/responseexports" do
+        body do |hash|
+          params = { surveyId: hash[:survey_id], format: hash[:file_type] }
+          optional_params = [:last_response_id, :start_date, :end_date, :limit,
+                             :included_question_ids, :use_label, :decimal_separator,
+                             :seen_unanswered_record, :use_local_time]
+
+          optional_params.each do |optional_param|
+            key = optional_param.to_s.camelize(:lower).to_sym
+            params[key] = hash[optional_param] if hash.has_key?(optional_param)
+          end
+
+          params.to_json
+        end
+
+        handler(200) { |response| JSON.parse(response.body)["result"]["id"] }
+      end
+
+      action :get_file, "GET /API/v3/responseexports/:id/file" do
+        handler(200) { |response| response.body }
+      end
+    end
+  end
+end