quiz_api_client 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11e55f74ad6fd90e5f09e214394d3d44103e7027d83ce03299f5670cbc79111d
-  data.tar.gz: 836308804ec45f08806c57bf63c6d7b9167e03eee52d955e7bca38b310f75305
+  metadata.gz: 6e1f12f936c33b3cf09fe4f8475aa40dfc7dbde37e65ed81b7d62ef07d23c86c
+  data.tar.gz: 9b4895c5dedd2d56fb64a79d2d03e5c6a8989832a9a51f912920fd71aa67582b
 SHA512:
-  metadata.gz: 9ed1d073d41458ff170b5767eec5d37e560af8211f6fa5da0906d7d644411a9a4e589c7d644b807300dd76400374e0e9bcd58d4595bd2e4004d65d228e4afb9f
-  data.tar.gz: 26d1ce56705ad6a1ba18c93175ae572e4ab54e95438513095c663c6a3d6efda3a57cce29ff432ac6885b5bf139305f954bab53890360b89945fdc0c48878b123
+  metadata.gz: '009317d5880a188a2ba3ed14f1b937fc34b35f169ab819aaedfd57c09550b5a9acea19db12d6ca8591c13cd41b252e200d82022a236cfdd6f6271a682496ee38'
+  data.tar.gz: 5f8059807154051560b72466ad20452f4f42b771e528ed1a9235d3eca12e0e802af9ca7fe5434dcd740dd808908181357474659bd6c66af25d9ff0072d0ee949

data/README.md

@@ -199,7 +199,7 @@ Pact file to a local Pact Broker.
 
 ### Development Workflow:
 
-1. In the quiz_api repo, spin up the Quiz API service with `bin/dev-setup`
+1. In the quiz_api repo, spin up the Quiz API service with `bin/setup`
 2. In the quiz_pact_broker repo, spin up a Pact Broker with `bin/dev-setup`
 3. In the quiz_api repo, write Pact provider states in the
 spec/service_consumers/api/quiz_api_client_ruby/ directory as needed

data/lib/quiz_api_client/services/courses_service.rb

@@ -0,0 +1,26 @@
+module QuizApiClient::Services
+  class CoursesService < BaseApiService
+    def create(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
+    end
+
+    def destroy(params:, token: nil)
+      delete_from_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        '/api/courses',
+        course: params
+      )
+    end
+
+    def delete_from_quiz_api(params:, token:)
+      client(token: token).delete(
+        "/api/courses/#{params[:canvas_id]}"
+      )
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.3.0'.freeze
+  VERSION = '4.4.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -22,6 +22,10 @@ module QuizApiClient
       @_config ||= QuizApiClient::Config.new
     end
 
+    def courses_service
+      @_courses_service ||= Services::CoursesService.new(config)
+    end
+
     def jwt_service
       @_jwt_service ||= QuizApiClient::Services::JwtService.new(config)
     end
@@ -114,6 +118,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/courses_service'
 require 'quiz_api_client/services/interaction_types_service'
 require 'quiz_api_client/services/item_analyses_service'
 require 'quiz_api_client/services/items_service'

data/spec/quiz_api_client_spec.rb

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

data/spec/services/courses_service_spec.rb

@@ -0,0 +1,59 @@
+describe QuizApiClient::Services::CoursesService 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
+      {
+        title: 'foo',
+        canvas_id: 2,
+        is_blueprint: true
+      }
+    end
+
+    let(:response) do
+      {
+        'id' => '4',
+        'title' => 'foo',
+        'canvas_id' => '2',
+        'is_blueprint' => true,
+        'created_at' => '2022-06-22T18:59:27.577Z',
+        'updated_at' => '2022-06-22T18:59:27.577Z'
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/courses" }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: { course: 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
+
+  describe '#destroy' do
+    let(:params) { { canvas_id: 1 } }
+    let(:expected_url) { "https://#{host}/api/courses/1" }
+
+    before do
+      stub_request(:delete, expected_url).to_return(status: 204)
+    end
+
+    it 'deletes to the correct endpoint and returns the response' do
+      response = subject.destroy(params: params, token: 'token')
+      expect(response.code).to eq 204
+      expect(response.body).to be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -11,10 +11,10 @@ authors:
 - Michael Hargiss
 - Robin Kuss
 - Ryan Taylor
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -184,7 +184,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - aslaughter@instructure.com
 - jhiggins@instructure.com
@@ -206,6 +206,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/courses_service.rb
 - lib/quiz_api_client/services/interaction_types_service.rb
 - lib/quiz_api_client/services/item_analyses_service.rb
 - lib/quiz_api_client/services/items_service.rb
@@ -257,6 +258,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/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb
 - spec/services/items_service_spec.rb
@@ -279,10 +281,10 @@ files:
 - spec/spec_helper.rb
 - spec/support/pact_config.rb
 - spec/support/pact_helper.rb
-homepage:
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -297,8 +299,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api
 test_files:
@@ -332,6 +334,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/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb
 - spec/services/items_service_spec.rb