quiz_api_client 4.17.1 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09fd6f046ee756bdce9439fb2b10585444002d42ccff124b1b74806db432830
-  data.tar.gz: 68e4132368a554d8e957cdab9250553f578e06da51e3662051d8c45f7db75372
+  metadata.gz: c6a0d785f0b483d712f8c6cbbef7407ef0f41831f013d7c90d1bbf686236681a
+  data.tar.gz: 2ab9f601ee6ec4f73b2319bbe0fedb7f733932266f6ebe5d306248811c2b1e98
 SHA512:
-  metadata.gz: 360473c5a226927eb692ccc8dc66334c9770878c9d952d10077b73b6004cbf120e79159dd3426f861fd84f1a310ea78fa133a21ed6b1e851446bec0a032db37a
-  data.tar.gz: b414958e672367c5d1c01cf5d649fcc0c0a4af5164eb91aae79a1d916d841455cb20f014aef1c13e57a48bd7a2f696926844ab19fcf3423e7d81352367f24665
+  metadata.gz: f331cf1b2338ff28c863a920694783c615e42ecaeedf9b50d273c6e37b36da6a9285931ee8ab86ac7b898b22118442893595b2981a07443179e952d70f76922e
+  data.tar.gz: 8b2761df171c12a676dd3d7efb01af5eb9da737330d03023159c8178d60056ed94d799d0871301fbf9897d481591e33a76f07609f1c038621f2d7d07d96d8995

data/lib/quiz_api_client/services/analyses_service.rb

@@ -1,16 +1,57 @@
 module QuizApiClient::Services
   class AnalysesService < BaseApiService
     def create(params:, token: nil)
-      post_to_quiz_api(params: params, token: token)
+      post_to_analyses(params: params, token: token)
     end
 
-    private
+    def create_report(params:, token: nil)
+      post_to_create_report(params: params, token: token)
+    end
+
+    def abort_report(params:, token: nil)
+      post_to_abort_report(params: params, token: token)
+    end
+
+    def show(params:, token: nil)
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/reports/#{params[:id]}",
+        query: { filter: :last_attempt }
+      )
+    end
+
+    def export(params:, token: nil)
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/analyses/export",
+        query: { filter: :last_attempt, format: :csv, analysis_type: params[:analysis_type] }
+      )
+    end
 
-    def post_to_quiz_api(params:, token:)
-      client(token: token).post(
-        "/api/quizzes/#{params[:quiz_id]}/analyses",
-        params
+    def status(params:, token: nil)
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/analyses/status",
+        query: { filter: :last_attempt, analysis_type: params[:analysis_type] }
       )
     end
+
+    private
+
+    def post_to_create_report(params:, token:)
+      path = "/api/quizzes/#{params[:quiz_id]}/analyses/create_report"
+      post_to_quiz_api(path: path, params: params, token: token)
+    end
+
+    def post_to_abort_report(params:, token:)
+      path = "/api/quizzes/#{params[:quiz_id]}/analyses/abort"
+      post_to_quiz_api(path: path, params: params, token: token)
+    end
+
+    def post_to_analyses(params:, token:)
+      path = "/api/quizzes/#{params[:quiz_id]}/analyses"
+      post_to_quiz_api(path: path, params: params, token: token)
+    end
+
+    def post_to_quiz_api(path:, params:, token:)
+      client(token: token).post(path, params)
+    end
   end
 end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.17.1'.freeze
+  VERSION = '4.19.0'.freeze
 end

data/spec/services/analyses_service_spec.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 describe QuizApiClient::Services::AnalysesService do
   let(:host) { 'api.host' }
   let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
@@ -28,4 +30,132 @@ describe QuizApiClient::Services::AnalysesService do
       expect(result.parsed_response).to eql(stubbed_response)
     end
   end
+
+  describe '#create_report' do
+    let(:params) do
+      { quiz_id: 1, quiz_session_ids: [1, 5, 10], filter: :last_attempt, analysis_type: 'student_analysis' }
+    end
+    let(:stubbed_response) { { 'job_id' => 1 } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/create_report" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(
+          body: params.to_json
+        )
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes/{id}/analyses and returns the response' do
+      result = subject.create_report(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe '#show' do
+    let(:params) do
+      { quiz_id: 1, id: 2 }
+    end
+    let(:stubbed_response) { { 'id' => 1 } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/reports/#{params[:id]}?filter=last_attempt" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets to quiz_api/api/quizzes/{id}/reports/{id} and returns the response' do
+      result = subject.show(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe 'status' do
+    let(:params) do
+      { quiz_id: 1, analysis_type: 'item_analysis' }
+    end
+    let(:stubbed_response) { { 'id' => 1 } }
+    let(:expected_url) do
+      "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/status?filter=last_attempt" +
+        + "&analysis_type=#{params[:analysis_type]}"
+    end
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets to quiz_api/api/quizzes/{id}/analyses/status and returns the response' do
+      result = subject.status(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe 'export' do
+    let(:params) do
+      { quiz_id: 1, analysis_type: 'item_analysis' }
+    end
+    let(:stubbed_response) do
+      CSV.generate(headers: true) do |csv|
+        csv << %w[column1 column2 column3]
+      end
+    end
+    let(:expected_url) do
+      "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/export" \
+      "?analysis_type=#{params[:analysis_type]}&filter=last_attempt&format=csv"
+    end
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response,
+          headers: { 'Content-Type' => 'text/csv' }
+        )
+    end
+
+    it 'gets to quiz_api/api/quizzes/{id}/analyses/export and returns the response' do
+      result = subject.export(params: params, token: 'token')
+      expect(result.parsed_response).to eql([%w[column1 column2 column3]])
+    end
+  end
+
+  describe 'abort_report' do
+    let(:params) do
+      { quiz_id: 1, report_id: 2 }
+    end
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/abort" }
+    let(:status_code) { 204 }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(
+          body: params.to_json
+        )
+        .to_return(
+          status: status_code
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes/{id}/analyses/abort and returns the response' do
+      result = subject.abort_report(params: params, token: 'token')
+      expect(result.code).to eql(status_code)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.17.1
+  version: 4.19.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty