quiz_api_client 4.18.0 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0876cb763ece686d1cedc404bb62633c5971bea43528a718b6fee780dedcff
-  data.tar.gz: 128e36dfb1454227664c0ba02aafe361003407f7dbf30d9d7c29c9e52b95e3bc
+  metadata.gz: 790a9d7b1622cf0d9d98e9eb3f62c1e481178223ee8e8f32f2461be744c2577a
+  data.tar.gz: 36c83c014b77e91890c91e6f3081c38ef2d81965d274196dd5559eb9f644a556
 SHA512:
-  metadata.gz: daf54ed83085516b8f6e1715baf2fe39428f0cc39631361b4a70ddffd4a7f0a4efddf7563cd03c9112a35578f68786799656eceefe904932b26592a8a826b6a8
-  data.tar.gz: b78454c69b4e7d505a8eca415bee8c85206975ca03af2cd801f3f4ad1264981aeec1d95192f642cba8b959897522ac7457d13c5e94d835aadee79dfbc9b8bc31
+  metadata.gz: a0a74a8ea7236a4778eaeb13dd1d1e98d3f18d766260ca6151fbab889b7e036e3dc588282f587342fce1b2c867a690c8d6d091df8e2c04c117dcd164dd46d2d6
+  data.tar.gz: c00de63348f7bf03c024ff5eb5f81d379139168a8e22faeedecacd7aa17692959a77a23e0ecefcc46c722ab0ce93a1ae0fd15536754a6ae0882dc746951d9d76

data/lib/quiz_api_client/services/analyses_service.rb

@@ -1,7 +1,15 @@
 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
+
+    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)
@@ -27,11 +35,23 @@ module QuizApiClient::Services
 
     private
 
-    def post_to_quiz_api(params:, token:)
-      client(token: token).post(
-        "/api/quizzes/#{params[:quiz_id]}/analyses",
-        params
-      )
+    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/services/quizzes_service.rb

@@ -8,6 +8,10 @@ module QuizApiClient::Services
       get_from_quiz_api(params: params, token: token, all: all)
     end
 
+    def quiz_question_counts(params:, token: nil, all: false)
+      get_quiz_question_counts(params: params, token: token, all: all)
+    end
+
     private
 
     def post_to_quiz_api(params:, token:)
@@ -24,5 +28,13 @@ module QuizApiClient::Services
         query: params
       )
     end
+
+    def get_quiz_question_counts(params:, token:, all:)
+      client(token: token).get(
+        '/api/quizzes/question_count',
+        all: all,
+        query: params
+      )
+    end
   end
 end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.18.0'.freeze
+  VERSION = '4.20.0'.freeze
 end

data/spec/services/analyses_service_spec.rb

@@ -31,6 +31,32 @@ describe QuizApiClient::Services::AnalysesService do
     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 }
@@ -109,4 +135,27 @@ describe QuizApiClient::Services::AnalysesService do
       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

data/spec/services/quizzes_service_spec.rb

@@ -68,4 +68,42 @@ describe QuizApiClient::Services::QuizzesService do
       end
     end
   end
+
+  describe '#quiz_question_counts' do
+    let(:quiz_ids) { [1, 2, 3] }
+    let(:params) { { quiz_ids: quiz_ids } }
+    let(:stubbed_response) { { 'quiz_id' => '1', 'question_count' => 10 } }
+
+    context 'on success' do
+      before do
+        query_params = URI.encode_www_form(quiz_ids.map { |id| ['quiz_ids[]', id] })
+        expected_url = "https://#{host}/api/quizzes/question_count?#{query_params}"
+        stub_request(:get, expected_url)
+          .to_return(
+            status: 200,
+            body: [stubbed_response].to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'gets quiz_api/api/quizzes/question_count and returns the response' do
+        result = subject.quiz_question_counts(params: params, token: 'token')
+        expect(result.parsed_response[0]).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+      before do
+        expected_url = "https://#{host}/api/quizzes/question_count"
+        stub_request(:get, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns the response with the correct code' do
+        response = subject.quiz_question_counts(params: nil, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
 end

metadata

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