quiz_api_client 4.19.0 → 4.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a0d785f0b483d712f8c6cbbef7407ef0f41831f013d7c90d1bbf686236681a
-  data.tar.gz: 2ab9f601ee6ec4f73b2319bbe0fedb7f733932266f6ebe5d306248811c2b1e98
+  metadata.gz: 1163e85cb5fd4c258330d4d8a6fdd298e6a252bc453b28ca7f3a02cbfb06b968
+  data.tar.gz: 230852d9477251d2b97a49a3ab5b7f84bdc96505e9636d01f1257859c3641d80
 SHA512:
-  metadata.gz: f331cf1b2338ff28c863a920694783c615e42ecaeedf9b50d273c6e37b36da6a9285931ee8ab86ac7b898b22118442893595b2981a07443179e952d70f76922e
-  data.tar.gz: 8b2761df171c12a676dd3d7efb01af5eb9da737330d03023159c8178d60056ed94d799d0871301fbf9897d481591e33a76f07609f1c038621f2d7d07d96d8995
+  metadata.gz: 4d550ce6a725dc72a605a4ef037662143d553cc6ac2ea47411e1739abdf32f3e3e1a61f24e80c00755aafaad0c410df753f26cd83e90b4efca241ed5a9a91812
+  data.tar.gz: ca76400aee18a66010e821cb3b4a3e8b720f69106031445da5dbdb1851f9bf7d2976683c4a711d3ae762e288576d5ae06fbfd643393f41afc8070b330dd0bbf4

data/lib/quiz_api_client/services/analyses_service.rb

@@ -15,26 +15,30 @@ module QuizApiClient::Services
     def show(params:, token: nil)
       client(token: token).get(
         "/api/quizzes/#{params[:quiz_id]}/reports/#{params[:id]}",
-        query: { filter: :last_attempt }
+        query: { filter: filter_value(params) }
       )
     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] }
+        query: { filter: filter_value(params), format: :csv, analysis_type: params[:analysis_type] }
       )
     end
 
     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] }
+        query: { filter: filter_value(params), analysis_type: params[:analysis_type] }
       )
     end
 
     private
 
+    def filter_value(params)
+      params[:filter] || :last_attempt
+    end
+
     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)

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.19.0'.freeze
+  VERSION = '4.21.0'.freeze
 end

data/spec/services/analyses_service_spec.rb

@@ -58,81 +58,152 @@ describe QuizApiClient::Services::AnalysesService do
   end
 
   describe '#show' do
-    let(:params) do
-      { quiz_id: 1, id: 2 }
-    end
+    let(:params) { { quiz_id: 1, id: 2 } }
     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' }
-        )
+    context 'when filter is last_attempt' do
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/reports/#{params[:id]}?filter=last_attempt"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'returns the last_attempt report' do
+        result = subject.show(params: params.merge(filter: 'last_attempt'), token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
     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)
+    context 'when filter is all_attempts' do
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/reports/#{params[:id]}?filter=all_attempts"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'returns the all_attempts report' do
+        result = subject.show(params: params.merge(filter: 'all_attempts'), token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
     end
   end
 
-  describe 'status' do
-    let(:params) do
-      { quiz_id: 1, analysis_type: 'item_analysis' }
-    end
+  describe '#status' do
+    let(:base_params) { { quiz_id: 1, analysis_type: 'item_analysis' } }
     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' }
-        )
+    context 'when filter is last_attempt' do
+      let(:params) { base_params.merge(filter: 'last_attempt') }
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/status" \
+        "?filter=#{params[:filter]}&analysis_type=#{params[:analysis_type]}"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'returns the last_attempt analysis status' do
+        result = subject.status(params: params, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
     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)
+    context 'when filter is all_attempts' do
+      let(:params) { base_params.merge(filter: 'all_attempts') }
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/status" \
+        "?filter=#{params[:filter]}&analysis_type=#{params[:analysis_type]}"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'returns the all_attempts analysis status' do
+        result = subject.status(params: params, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
     end
   end
 
-  describe 'export' do
-    let(:params) do
-      { quiz_id: 1, analysis_type: 'item_analysis' }
-    end
+  describe '#export' do
+    let(:base_params) { { quiz_id: 1, analysis_type: 'item_analysis' } }
     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' }
-        )
+    context 'when filter is last_attempt' do
+      let(:params) { base_params.merge(filter: 'last_attempt') }
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/export" \
+        "?analysis_type=#{params[:analysis_type]}&filter=#{params[:filter]}&format=csv"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response,
+            headers: { 'Content-Type' => 'text/csv' }
+          )
+      end
+
+      it 'returns the last_attempt CSV export' do
+        result = subject.export(params: params, token: 'token')
+        expect(result.parsed_response).to eql([%w[column1 column2 column3]])
+      end
     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]])
+    context 'when filter is all_attempts' do
+      let(:params) { base_params.merge(filter: 'all_attempts') }
+      let(:expected_url) do
+        "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses/export" \
+        "?analysis_type=#{params[:analysis_type]}&filter=#{params[:filter]}&format=csv"
+      end
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response,
+            headers: { 'Content-Type' => 'text/csv' }
+          )
+      end
+
+      it 'returns the all_attempts CSV export' do
+        result = subject.export(params: params, token: 'token')
+        expect(result.parsed_response).to eql([%w[column1 column2 column3]])
+      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.19.0
+  version: 4.21.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty