quiz_api_client 4.20.0 → 4.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 790a9d7b1622cf0d9d98e9eb3f62c1e481178223ee8e8f32f2461be744c2577a
-  data.tar.gz: 36c83c014b77e91890c91e6f3081c38ef2d81965d274196dd5559eb9f644a556
+  metadata.gz: 0326a0567d52565a328e8baeef1121dd071fd3a6cc33d4f36a472d394c353382
+  data.tar.gz: d93ac7d560e617f2156ce313701826640791b78d5581f9c6a0298978d3281e67
 SHA512:
-  metadata.gz: a0a74a8ea7236a4778eaeb13dd1d1e98d3f18d766260ca6151fbab889b7e036e3dc588282f587342fce1b2c867a690c8d6d091df8e2c04c117dcd164dd46d2d6
-  data.tar.gz: c00de63348f7bf03c024ff5eb5f81d379139168a8e22faeedecacd7aa17692959a77a23e0ecefcc46c722ab0ce93a1ae0fd15536754a6ae0882dc746951d9d76
+  metadata.gz: 48d7c949f232d01e3cc6cd9a5408fd2ac921893154af5ea4ad244d0783d8950f966c0faab371a1d17f7a2265d64590b4061b18a33eaf3e3d4c2e98c8639e907a
+  data.tar.gz: 7aa68e7db93d0943492d7851b73a1f2b99c16d8cb7b7275bcbbc0001a956410bb45dc83a0e5e60c75c448169d57c9a186875e5044b7bde9ffaa13d18e2f04eec

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/youtube_service.rb

@@ -0,0 +1,14 @@
+module QuizApiClient::Services
+  class YoutubeService < BaseApiService
+    def start_scan(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
+    end
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        '/api/youtube/start_youtube_migration_scan',
+        params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

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

data/lib/quiz_api_client.rb

@@ -125,6 +125,10 @@ module QuizApiClient
     def shared_banks
       @_shared_banks ||= QuizApiClient::Services::SharedBanks.new(config)
     end
+
+    def youtube_service
+      @_youtube_service ||= Services::YoutubeService.new(config)
+    end
   end
 end
 
@@ -163,3 +167,4 @@ require 'quiz_api_client/services/quiz_sync_jobs_service'
 require 'quiz_api_client/services/session_items_service'
 require 'quiz_api_client/services/session_item_results_service'
 require 'quiz_api_client/services/shared_banks'
+require 'quiz_api_client/services/youtube_service'

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/youtube_service_spec.rb

@@ -0,0 +1,33 @@
+describe QuizApiClient::Services::YoutubeService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+  let(:stubbed_response) do
+    {
+      'id' => 1,
+      'scan_id' => 'abc-123',
+      'status' => 'in_progress'
+    }
+  end
+
+  describe '#start_scan' do
+    let(:params) { { course_id: 42, scan_id: 'abc-123', quiz_assignment_map: { 123 => 456 } } }
+    let(:expected_url) { "https://#{host}/api/youtube/start_youtube_migration_scan" }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: params.to_json)
+        .to_return(
+          status: 202,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to the correct endpoint and returns the response' do
+      expect(
+        subject.start_scan(params: params, token: 'token').parsed_response
+      ).to eq(stubbed_response)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.20.0
+  version: 4.22.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-15 00:00:00.000000000 Z
+date: 2025-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -207,6 +207,7 @@ files:
 - lib/quiz_api_client/services/session_item_results_service.rb
 - lib/quiz_api_client/services/session_items_service.rb
 - lib/quiz_api_client/services/shared_banks.rb
+- lib/quiz_api_client/services/youtube_service.rb
 - lib/quiz_api_client/version.rb
 - spec/config_spec.rb
 - spec/http_client_spec.rb
@@ -240,6 +241,7 @@ files:
 - spec/services/quizzes_service_spec.rb
 - spec/services/session_item_results_service_spec.rb
 - spec/services/session_items_service_spec.rb
+- spec/services/youtube_service_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses: []
@@ -259,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api
@@ -296,4 +298,5 @@ test_files:
 - spec/services/quizzes_service_spec.rb
 - spec/services/session_item_results_service_spec.rb
 - spec/services/session_items_service_spec.rb
+- spec/services/youtube_service_spec.rb
 - spec/spec_helper.rb