quiz_api_client 4.1.0 → 4.3.0

data/spec/contracts/quiz_clone_job_service_spec.rb

@@ -0,0 +1,20 @@
+describe QuizApiClient::Services::QuizCloneJobService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api' do
+    let(:request_description) { 'a request to retrieve a quiz clone job' }
+    let(:quizzes_api_path) { "/api/quiz_clone_jobs/#{resource_id}" }
+    let(:provider_state) { 'a quiz clone job' }
+    let(:scope) { 'quiz_clone_job.show' }
+    let(:params) { { id: resource_id } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_clone_job_service }
+  end
+end

data/spec/contracts/quiz_clone_jobs_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizCloneJobsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:request_description) { 'a request to clone a quiz' }
+    let(:quizzes_api_path) { "/api/quizzes/#{resource_id}/quiz_clone_jobs" }
+    let(:provider_state) { 'a quiz' }
+    let(:scope) { 'quiz.clone' }
+    let(:params) { { quiz_id: resource_id } }
+    let(:body) { {} }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_clone_jobs_service }
+  end
+end

data/spec/contracts/quiz_entries_service_spec.rb

@@ -0,0 +1,125 @@
+describe QuizApiClient::Services::QuizEntriesService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402549] do
+    let(:request_description) { 'a request to retrieve a list of quiz entries' }
+    let(:quiz_id) { 1 }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/quiz_entries" }
+    let(:provider_state) { 'a set of quiz entries' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz.build' }
+    let(:params) { { id: '1' } }
+    let(:response_body) do
+      [
+        {
+          entry_editable: Pact.like(true),
+          entry_type: 'Item',
+          id: Pact.like('1'),
+          position: Pact.like(0),
+          properties: {},
+          regrade_adjusted_points_possible: nil,
+          status: 'mutable',
+          stimulus_quiz_entry_id: Pact.like('1'),
+          entry: {
+            id: Pact.like('1'),
+            title: Pact.like('item 1 title'),
+            label: Pact.like('item 1 label'),
+            user_response_type: Pact.like('Uuid'),
+            item_body: Pact.like('item 1 body'),
+            interaction_data: Pact.like({}),
+            interaction_type: {
+              id: Pact.like('1')
+            }
+          }
+        },
+        {
+          entry_editable: Pact.like(true),
+          entry_type: 'Item',
+          id: Pact.like('1'),
+          position: Pact.like(0),
+          properties: {},
+          regrade_adjusted_points_possible: nil,
+          status: 'mutable',
+          stimulus_quiz_entry_id: Pact.like('1'),
+          entry: {
+            id: Pact.like('1'),
+            title: Pact.like('item 1 title'),
+            label: Pact.like('item 1 label'),
+            user_response_type: Pact.like('Uuid'),
+            item_body: Pact.like('item 1 body'),
+            interaction_data: Pact.like({}),
+            interaction_type: {
+              id: Pact.like('1')
+            }
+          }
+        }
+      ]
+    end
+    let(:service_name) { :quiz_entries_service }
+  end
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:request_description) { 'a request to create a quiz entry' }
+    let(:quiz_id) { 1 }
+    let(:resource_id) { quiz_id }
+    let(:provider_state) { 'a quiz with an item' }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/quiz_entries" }
+    let(:scope) { 'quiz.build' }
+    let(:params) do
+      {
+        id: quiz_id,
+        quiz_id: quiz_id,
+        entry_type: 'Item',
+        entry_id: 1,
+        points_possible: 1,
+        position: 1,
+        properties: {
+          points_possible: 1,
+          position: 1
+        }
+      }
+    end
+    let(:body) { { quiz_entry: params } }
+    let(:response_body) do
+      {
+        entry_editable: Pact.like(true),
+        entry_type: 'Item',
+        id: Pact.like('1'),
+        position: Pact.like(0),
+        properties: Pact.like({}),
+        regrade_adjusted_points_possible: nil,
+        status: 'mutable',
+        stimulus_quiz_entry_id: Pact.like('1'),
+        entry: {
+          id: Pact.like('1'),
+          title: Pact.like('item 1 title'),
+          label: Pact.like('item 1 label'),
+          user_response_type: Pact.like('Uuid'),
+          item_body: Pact.like('item 1 body'),
+          interaction_data: Pact.like({}),
+          interaction_type: {
+            id: Pact.like('1')
+          }
+        }
+      }
+    end
+    let(:service_name) { :quiz_entries_service }
+  end
+
+  it_behaves_like 'a http delete request to quiz_api' do
+    let(:request_description) { 'a request to delete a quiz entry' }
+    let(:quiz_id) { 1 }
+    let(:item_id) { 1 }
+    let(:resource_id) { quiz_id }
+    let(:provider_state) { 'a set of quiz entries' }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/quiz_entries/#{item_id}" }
+    let(:scope) { 'quiz.build' }
+    let(:params) do
+      {
+        quiz_id: quiz_id,
+        id: item_id
+      }
+    end
+    let(:service_name) { :quiz_entries_service }
+  end
+end

data/spec/contracts/quiz_service_spec.rb

@@ -0,0 +1,68 @@
+describe QuizApiClient::Services::QuizService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api', testrail_id: %w[3402550] do
+    let(:service_name) { :quiz_service }
+    let(:request_description) { 'a request to retrieve a single quiz' }
+    let(:quizzes_api_path) { '/api/quizzes/1' }
+    let(:provider_state) { 'a quiz' }
+    let(:scope) { 'quiz.build' }
+    let(:params) { { id: '1' } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        title: Pact.like('quiz title'),
+        context_id: Pact.like('1'),
+        session_time_limit_in_seconds: Pact.like(1),
+        instructions: Pact.like('quiz instructions'),
+        shuffle_questions: Pact.like(false),
+        shuffle_answers: Pact.like(false),
+        status: 'uninitialized',
+        owner: Pact.like('teacher'),
+        has_time_limit: Pact.like(false),
+        outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a'),
+        one_at_a_time_type: 'question',
+        allow_backtracking: Pact.like(true)
+      }
+    end
+  end
+
+  it_behaves_like 'a http patch request to quiz_api', testrail_id: %w[3402551] do
+    let(:service_name) { :quiz_service }
+    let(:request_description) { 'a request to update a quiz' }
+    let(:quizzes_api_path) { '/api/quizzes/1' }
+    let(:provider_state) { 'a quiz' }
+    let(:scope) { 'quiz.build' }
+    let(:title) { 'some new title' }
+    let(:params) do
+      {
+        id: '1',
+        title: title
+      }
+    end
+    let(:resource_id) { '1' }
+    let(:body) { { quiz: params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        title: title,
+        instructions: Pact.like('quiz instructions'),
+        context_id: Pact.like('1'),
+        owner: Pact.like('teacher1'),
+        has_time_limit: Pact.like(false),
+        allow_backtracking: Pact.like(true),
+        one_at_a_time_type: 'question',
+        session_time_limit_in_seconds: 0,
+        outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a'),
+        require_student_access_code: Pact.like(false),
+        filter_ip_address: Pact.like(false),
+        shuffle_questions: Pact.like(false),
+        shuffle_answers: Pact.like(false),
+        status: 'unpublished',
+        student_access_code: Pact.like('3uXc15S3B'),
+        filters: Pact.like({})
+      }
+    end
+  end
+end

data/spec/contracts/quiz_session_events_service_spec.rb

@@ -0,0 +1,30 @@
+describe QuizApiClient::Services::QuizSessionEventsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402552] do
+    let(:request_description) { 'a request to retrieve a list of quiz entries' }
+    let(:quiz_session_id) { 1 }
+    let(:quizzes_api_path) { "/api/quiz_sessions/#{quiz_session_id}/quiz_session_events" }
+    let(:provider_state) { 'set of session events' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz_sessions.log' }
+    let(:params) { { quiz_session_id: '1' } }
+    let(:response_body) do
+      [
+        {
+          created_at: Pact.like(''),
+          event_type: Pact.like(''),
+          event_data: {},
+          quiz_session_id: Pact.like('1')
+        },
+        {
+          created_at: Pact.like(''),
+          event_type: Pact.like(''),
+          event_data: {},
+          quiz_session_id: Pact.like('1')
+        }
+      ]
+    end
+    let(:service_name) { :quiz_session_events_service }
+  end
+end

data/spec/contracts/quiz_session_result_service_spec.rb

@@ -0,0 +1,42 @@
+describe QuizApiClient::Services::QuizSessionResultService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api', testrail_id: %w[3402553] do
+    let(:request_description) { 'a request to retrieve a quiz session result' }
+    let(:id) { 1 }
+    let(:quizzes_api_path) { "/api/results/#{id}" }
+    let(:provider_state) { 'a quiz session result' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz_session_result.show' }
+    let(:params) { { id: '1' } }
+    let(:response_body) do
+      {
+        created_at: Pact.like(''),
+        fudge_points: Pact.like(1.0),
+        grading_method: 'autograde',
+        id: Pact.like('1'),
+        percentage: Pact.like(1.0),
+        quiz_session_id: Pact.like('1'),
+        score: Pact.like(1.0),
+        status: 'graded',
+        quiz_session: {
+          id: Pact.like('1'),
+          account_uuid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a'),
+          end_at: nil,
+          start_at: Pact.like(''),
+          status: 'graded',
+          metadata: nil,
+          accepted_student_access_code: Pact.like(false),
+          attempt: Pact.like(1),
+          disable_timer: nil,
+          extra_time_in_seconds: nil,
+          timer_multiplier: nil,
+          elapsed_time: Pact.like(3600),
+          allow_backtracking: nil,
+          one_at_a_time_type: nil
+        }
+      }
+    end
+    let(:service_name) { :quiz_session_result_service }
+  end
+end

data/spec/contracts/quiz_session_service_spec.rb

@@ -0,0 +1,56 @@
+describe QuizApiClient::Services::QuizSessionService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api', testrail_id: %w[3402554] do
+    let(:request_description) { 'a request to retrieve the graded quiz session' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1' }
+    let(:provider_state) { 'a graded quiz session' }
+    let(:scope) { 'quiz_session.show' }
+    let(:params) { { id: '1' } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        account_uuid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a'),
+        end_at: nil,
+        start_at: Pact.like(''),
+        status: 'graded',
+        metadata: nil,
+        accepted_student_access_code: Pact.like(false),
+        attempt: Pact.like(1),
+        disable_timer: nil,
+        extra_time_in_seconds: nil,
+        timer_multiplier: nil,
+        elapsed_time: Pact.like(3600),
+        allow_backtracking: nil,
+        one_at_a_time_type: nil
+      }
+    end
+    let(:service_name) { :quiz_session_service }
+  end
+
+  it_behaves_like 'a http patch request to quiz_api', testrail_id: %w[3402555] do
+    let(:request_description) { 'a request to update a quiz session' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1' }
+    let(:provider_state) { 'a quiz session' }
+    let(:scope) { 'quiz_session.update' }
+    let(:attempt) { 2 }
+    let(:params) do
+      {
+        id: '1',
+        attempt: { attempt: 2 }
+      }
+    end
+    let(:resource_id) { '1' }
+    let(:body) { { quiz_session: params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        status: 'graded',
+        start_at: Pact.like(''),
+        end_at: Pact.like('')
+      }
+    end
+    let(:service_name) { :quiz_session_service }
+  end
+end

data/spec/contracts/quiz_sessions_service_spec.rb

@@ -0,0 +1,28 @@
+describe QuizApiClient::Services::QuizSessionsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api', testrail_id: %w[3402556] do
+    let(:request_description) { 'a request to create a quiz session' }
+    let(:provider_state) { 'a quiz' }
+    let(:quiz_id) { 1 }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/quiz_sessions" }
+    let(:scope) { 'quiz_session.create' }
+    let(:resource_id) { quiz_id }
+    let(:params) do
+      {
+        quiz_id: quiz_id,
+        attempt: 1
+      }
+    end
+    let(:body) { { quiz_session: params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        status: 'pending',
+        start_at: Pact.like(''),
+        end_at: Pact.like('')
+      }
+    end
+    let(:service_name) { :quiz_sessions_service }
+  end
+end

data/spec/contracts/quiz_sync_job_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizSyncJobService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api' do
+    let(:request_description) { 'a request to retrieve a quiz sync job' }
+    let(:quizzes_api_path) { "/api/quiz_sync_jobs/#{resource_id}" }
+    let(:provider_state) { 'a quiz sync job' }
+    let(:scope) { 'quiz_sync_job.show' }
+    let(:params) { { id: resource_id } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        cloned_quiz_id: Pact.like('2'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_sync_job_service }
+  end
+end

data/spec/contracts/quiz_sync_jobs_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizSyncJobsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:batch) { true }
+    let(:request_description) { 'a request to sync many quizzes' }
+    let(:quizzes_api_path) { '/api/quiz_sync_jobs/create_batch' }
+    let(:provider_state) { 'a completed quiz clone job' }
+    let(:scope) { 'quiz_sync_job.create_batch' }
+    let(:params) { { quiz_ids: ['1'] } }
+    let(:body) { { quiz_ids: ['1'] } }
+    let(:response_body) do
+      [
+        {
+          id: Pact.like('1')
+        }
+      ]
+    end
+    let(:service_name) { :quiz_sync_jobs_service }
+  end
+end

data/spec/contracts/quizzes_service_spec.rb

@@ -0,0 +1,80 @@
+describe QuizApiClient::Services::QuizzesService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402557] do
+    let(:request_description) { 'a request specifying a quiz id' }
+    let(:quizzes_api_path) { '/api/quizzes' }
+    let(:provider_state) { 'a quiz' }
+    let(:scope) { 'quiz.list' }
+    let(:params) { { 'id' => '1' } }
+    let(:query_params) { { 'id' => '1' } }
+    let(:response_body) do
+      [
+        {
+          # TODO: figure out why Pact specs' responses for GET requests from
+          # quiz_api have integers for *ID fields given quiz_api actually returns strings
+          id: Pact.like(1),
+          title: Pact.like('quiz title'),
+          context_id: Pact.like(1),
+          outcome_declaration: nil,
+          session_time_limit_in_seconds: Pact.like(1),
+          quiz_type: nil,
+          minimum_passing_score: nil,
+          lti_resource_id: nil,
+          created_at: Pact.like('2017-06-15T22:14:51.215Z'),
+          updated_at: Pact.like('2017-06-15T22:14:51.215Z'),
+          instructions: Pact.like('quiz instructions'),
+          shuffle_questions: Pact.like(false),
+          shuffle_answers: Pact.like(false),
+          status: 'uninitialized',
+          owner: Pact.like('teacher'),
+          has_time_limit: Pact.like(false),
+          outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a'),
+          one_at_a_time_type: 'question',
+          allow_backtracking: Pact.like(true)
+        }
+      ]
+    end
+    let(:service_name) { :quizzes_service }
+  end
+
+  it_behaves_like 'a http post request to quiz_api', testrails_id: %w[3402558] do
+    let(:request_description) { 'a request to create a quiz' }
+    let(:quizzes_api_path) { '/api/quizzes' }
+    let(:provider_state) { 'a context' }
+    let(:scope) { 'quiz.create' }
+    let(:title) { 'Pop Quiz' }
+    let(:instructions) { 'Select the best answer.' }
+    let(:context_id) { '1' }
+    let(:params) do
+      {
+        'title' => title,
+        'instructions' => instructions,
+        'context_id' => context_id
+      }
+    end
+    let(:body) { { quiz: params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        title: title,
+        instructions: instructions,
+        context_id: context_id,
+        owner: Pact.like('teacher1'),
+        has_time_limit: Pact.like(false),
+        allow_backtracking: Pact.like(true),
+        one_at_a_time_type: 'none',
+        session_time_limit_in_seconds: 0,
+        outcome_alignment_set_guid: nil,
+        require_student_access_code: Pact.like(false),
+        filter_ip_address: Pact.like(false),
+        shuffle_questions: Pact.like(false),
+        shuffle_answers: Pact.like(false),
+        status: 'uninitialized',
+        student_access_code: nil,
+        filters: Pact.like({})
+      }
+    end
+    let(:service_name) { :quizzes_service }
+  end
+end

data/spec/contracts/session_item_results_service_spec.rb

@@ -0,0 +1,60 @@
+describe QuizApiClient::Services::SessionItemResultsService, :pact do
+  include PactHelper
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402559] do
+    let(:request_description) { 'a request to retrieve a session item result' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1/results/1/session_item_results' }
+    let(:provider_state) { 'a set of session_item_results' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz_session.results' }
+    let(:params) { { quiz_session_id: '1', quiz_session_result_id: '1' } }
+    let(:response_body) do
+      [
+        {
+          position: Pact.like(1),
+          attempt: Pact.like(1),
+          item_id: Pact.like('1'),
+          graded_at: Pact.like('2017-06-15T22:14:51.215Z'),
+          grading_method: 'autograde',
+          points_possible: Pact.like(1.0),
+          score: Pact.like(1.0),
+          scored_data: {},
+          feedback: {}
+        }
+      ]
+    end
+    let(:service_name) { :session_item_results_service }
+  end
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint' do
+    let(:request_description) { 'a request to retrieve a session item result for all interaction_types' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1/results/1/session_item_results' }
+    let(:provider_state) { 'a set of session_item_results of autograded interaction_types' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz_session.results' }
+    let(:params) { { quiz_session_id: '1', quiz_session_result_id: '1' } }
+    let(:response_body) do
+      Pact.each_like(
+        grading_method: 'autograde',
+        score: Pact.like(1.0)
+      )
+    end
+    let(:service_name) { :session_item_results_service }
+  end
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint' do
+    let(:request_description) { 'a request to retrieve a session item result for manually graded interaction_types' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1/results/1/session_item_results' }
+    let(:provider_state) { 'a set of session_item_results of manually graded interaction_types' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz_session.results' }
+    let(:params) { { quiz_session_id: '1', quiz_session_result_id: '1' } }
+    let(:response_body) do
+      Pact.each_like(
+        graded_at: Pact.like('2017-06-15T22:14:51.215Z'),
+        grading_method: 'manual_grading',
+        score: Pact.like(1.0)
+      )
+    end
+    let(:service_name) { :session_item_results_service }
+  end
+end

data/spec/contracts/session_items_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::SessionItemsService, :pact do
+  include PactHelper
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402560] do
+    let(:request_description) { 'a request to retrieve a session item' }
+    let(:quizzes_api_path) { '/api/quiz_sessions/1/session_items' }
+    let(:provider_state) { 'a set of session_items' }
+    let(:scope) { 'quiz_session.results' }
+    let(:resource_id) { '1' }
+    let(:params) { { quiz_session_id: '1' } }
+    let(:response_body) do
+      [
+        {
+          position: Pact.like(1),
+          item: {},
+          points_possible: Pact.like(1.0)
+        }
+      ]
+    end
+    let(:service_name) { :session_items_service }
+  end
+end