quiz_api_client 4.6.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbda532d39d3bc76cb64465b5e393d150a469448b9747f5556a0e09f0ccb70cd
-  data.tar.gz: dc2b0545c2b6b7b031fdec7e9fcf084cb69ab897444521fabd62944cfd38e70a
+  metadata.gz: 057d0dea94cbf0a0781d3c8144906a8ea7b29790f278f4d4a55891aaf6c3a12b
+  data.tar.gz: c5241135784c367e250fe0fb0a1e6012fc391c2a9d09c1225173f1acfbb3a595
 SHA512:
-  metadata.gz: b12c35f7e25194b3e9aa20ecbdd4f9bdc835ba4f948f6659cc62dd360b0288629d4ccda99c65c8b0ba155573c26f0516f1395c5b5151dbc1da4cd30504136695
-  data.tar.gz: 5547cc8b2d32ec019868f88e346285b6fb03b5ebe68bd1c1018aa278a658c38a4f7f76dd1f26aaa8cbb10767731210d94984850dd80077c48cfc6af08a4f41f6
+  metadata.gz: 89212f479d1081e38ad2005e5f7b84a4c3c5088b1620c6673cc2538fa719ed73f9eba1df31c5bca786c0efa4c3755d9e5bcd37e2508e7aaec73ee8ad41b1bdc4
+  data.tar.gz: b2be42851612a9fae066ff5dcfdd322e6d66d821ddd03fa53083e8713e90c8d4ad780de177c4f13752919897ffc0e720e8b8aa2db98f27e159c73e3f64e9cd2f

data/lib/quiz_api_client/services/content_exports_service.rb

@@ -0,0 +1,16 @@
+module QuizApiClient::Services
+  class ContentExportsService < BaseApiService
+    def create(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        '/api/content_exports',
+        content_export: params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/items_service.rb

@@ -12,6 +12,13 @@ module QuizApiClient::Services
       post_to_quiz_api(params: params, token: token)
     end
 
+    def update(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+      raise 'Item Id Required' unless params && params[:item_id]
+
+      put_to_quiz_api(params: params, token: token)
+    end
+
     private
 
     def list_from_quiz_api(params:, token:)
@@ -27,5 +34,15 @@ module QuizApiClient::Services
         item: params
       )
     end
+
+    def put_to_quiz_api(params:, token:)
+      quiz_id = params.delete(:quiz_id)
+      item_id = params.delete(:item_id)
+      client(token: token).put(
+        "/api/quizzes/#{quiz_id}/items/#{item_id}",
+        quiz_id: quiz_id,
+        item: params
+      )
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_entries_service.rb

@@ -1,11 +1,25 @@
 module QuizApiClient::Services
   class QuizEntriesService < BaseApiService
+    def show(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+      raise 'Entry Id Required' unless params[:entry_id]
+
+      get_single_entry_from_quiz_api(params: params, token: token)
+    end
+
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:id]
 
       post_to_quiz_api(params: params, token: token)
     end
 
+    def update(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+      raise 'Entry Id Required' unless params[:entry_id]
+
+      put_to_quiz_api(params: params, token: token)
+    end
+
     def list(params:, token: nil, all: false)
       raise 'Quiz Id Required' unless params && params[:id]
 
@@ -21,6 +35,12 @@ module QuizApiClient::Services
 
     private
 
+    def get_single_entry_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}"
+      )
+    end
+
     def post_to_quiz_api(params:, token:)
       client(token: token).post(
         "/api/quizzes/#{params[:id]}/quiz_entries",
@@ -28,6 +48,13 @@ module QuizApiClient::Services
       )
     end
 
+    def put_to_quiz_api(params:, token:)
+      client(token: token).put(
+        "/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}",
+        quiz_entry: params
+      )
+    end
+
     def get_from_quiz_api(params:, token:, all:)
       client(token: token).get(
         "/api/quizzes/#{params[:id]}/quiz_entries",

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.6.0'.freeze
+  VERSION = '4.8.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -22,6 +22,10 @@ module QuizApiClient
       @_config ||= QuizApiClient::Config.new
     end
 
+    def content_exports_service
+      @_content_exports_service ||= Services::ContentExportsService.new(config)
+    end
+
     def courses_service
       @_courses_service ||= Services::CoursesService.new(config)
     end
@@ -118,6 +122,7 @@ require 'quiz_api_client/http_request/metrics'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 
+require 'quiz_api_client/services/content_exports_service'
 require 'quiz_api_client/services/courses_service'
 require 'quiz_api_client/services/interaction_types_service'
 require 'quiz_api_client/services/item_analyses_service'

data/spec/quiz_api_client_spec.rb

@@ -51,6 +51,13 @@ describe QuizApiClient do
       end
     end
 
+    describe '#content_exports_service' do
+      it 'creates the service' do
+        expect(QuizApiClient::Services::ContentExportsService).to receive(:new).with(subject.config)
+        subject.content_exports_service
+      end
+    end
+
     describe '#courses_service' do
       it 'creates the service' do
         expect(QuizApiClient::Services::CoursesService).to receive(:new).with(subject.config)

data/spec/services/content_exports_service_spec.rb

@@ -0,0 +1,50 @@
+describe QuizApiClient::Services::ContentExportsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#create' do
+    let(:params) do
+      {
+        canvas_content_export_id: 1234,
+        export_settings: {
+          quizzes: [10, 11],
+          everything: false,
+          content_export_type: 'qti'
+        }
+      }
+    end
+
+    let(:response) do
+      {
+        'id' => '1',
+        'canvas_content_export_id' => '1234',
+        'export_settings' => {
+          'quizzes' => [10, 11],
+          'everything' => false,
+          'content_export_type' => 'qti'
+        },
+        'created_at' => '2023-02-17T01:00:00.000Z',
+        'updated_at' => '2023-02-17T01:00:00.000Z'
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/content_exports" }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: { content_export: params }.to_json)
+        .to_return(
+          status: 201,
+          body: response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to the correct endpoint and returns the response' do
+      expect(
+        subject.create(params: params, token: 'token').parsed_response
+      ).to eq(response)
+    end
+  end
+end

data/spec/services/items_service_spec.rb

@@ -53,4 +53,30 @@ describe QuizApiClient::Services::ItemsService do
       expect(result.parsed_response).to eql(stubbed_response)
     end
   end
+
+  describe '#update' do
+    let(:params) { { quiz_id: 1, item_id: 1, item: { item_body: 'item body' } } }
+    let(:stubbed_response) { { 'item' => { 'id' => 1 } } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/items/#{params[:item_id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:put, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'puts to quiz_api/api/quizzes/{quiz_id}/items/{item_id} and returns the response' do
+      result = subject.update(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises errors on missing ids' do
+      expect { subject.update(params: {}, token: 'token') }.to raise_error('Quiz Id Required')
+      expect { subject.update(params: { quiz_id: 1 }, token: 'token') }.to raise_error('Item Id Required')
+    end
+  end
 end

data/spec/services/quiz_entries_service_spec.rb

@@ -24,6 +24,32 @@ describe QuizApiClient::Services::QuizEntriesService do
     end
   end
 
+  describe '#show' do
+    let(:params) { { quiz_id: 1, entry_id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}" }
+    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 from quiz_api/api/quizzes/{quiz_id}/quiz_entries/{entry_id} and returns the response' do
+      result = subject.show(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises errors on missing ids' do
+      expect { subject.update(params: {}, token: 'token') }.to raise_error('Quiz Id Required')
+      expect { subject.update(params: { quiz_id: 1 }, token: 'token') }.to raise_error('Entry Id Required')
+    end
+  end
+
   describe '#create' do
     let(:params) do
       { id: 1, entry_id: 1, entry_type: 'Item', points_possible: 1 }
@@ -47,6 +73,31 @@ describe QuizApiClient::Services::QuizEntriesService do
     end
   end
 
+  describe '#update' do
+    let(:params) { { quiz_id: 1, entry_id: 1, points_possible: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}" }
+    let(:status_code) { 200 }
+    before do
+      stub_request(:put, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'puts to quiz_api/api/quizzes/{quiz_id}/quiz_entries/{entry_id} and returns the response' do
+      result = subject.update(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises errors on missing ids' do
+      expect { subject.update(params: {}, token: 'token') }.to raise_error('Quiz Id Required')
+      expect { subject.update(params: { quiz_id: 1 }, token: 'token') }.to raise_error('Entry Id Required')
+    end
+  end
+
   describe '#destroy' do
     let(:params) do
       { id: 6, quiz_id: 1 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -180,6 +180,7 @@ files:
 - lib/quiz_api_client/http_request/metrics.rb
 - lib/quiz_api_client/json_formatter.rb
 - lib/quiz_api_client/services/base_api_service.rb
+- lib/quiz_api_client/services/content_exports_service.rb
 - lib/quiz_api_client/services/courses_service.rb
 - lib/quiz_api_client/services/interaction_types_service.rb
 - lib/quiz_api_client/services/item_analyses_service.rb
@@ -209,6 +210,7 @@ files:
 - spec/quiz_api_client/http_request/metrics_spec.rb
 - spec/quiz_api_client_spec.rb
 - spec/services/base_api_service_spec.rb
+- spec/services/content_exports_service_spec.rb
 - spec/services/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb
@@ -260,6 +262,7 @@ test_files:
 - spec/quiz_api_client/http_request/metrics_spec.rb
 - spec/quiz_api_client_spec.rb
 - spec/services/base_api_service_spec.rb
+- spec/services/content_exports_service_spec.rb
 - spec/services/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb