bearcat 1.6.10 → 1.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da81a40773d9eba82a151acdfbca17550ae9a707b6089f31a1df74f5e9c8abd
-  data.tar.gz: 0f6de89595ede0206490f91d7490311e29d4206c42f35b21e8f35e36ea3dabd1
+  metadata.gz: f52b8360f7ce34fd388a13bb54935a02f659eb85f283d99f2afcfadb8c2ad2fa
+  data.tar.gz: d22ffcf503be32f35771341fc2183bde298a1f9802172efba7ba5d1813ec7725
 SHA512:
-  metadata.gz: fd621b13dbecaeabadce71ddc403836f40d78e62439db93dd0066fd7f823a761b469250ba51692d5ea68368d6632cab5da7faf45da55b2c8077777c85167d696
-  data.tar.gz: 35497af71785998f52ac54d9f5729b56777d76f94f882878aecd21d33281b5058f0df4a9ba6db414fe87c179c002bb6599ffab18d9d80a8bbf73e98220fe2d82
+  metadata.gz: 947870a0adcbde03d22ed11db07c853f03d7236376d04b9f4a138e7f3033c65470ea68c9216f0689361af969560c575675940a6d15e7a59c1d6f570318060ae7
+  data.tar.gz: 200a1712dbb4449d892fa8821efecf6208fc72f931205fd9ff48b6f955cccfbcc6d62cf365a41cd5042927705ce36ee7b2e78216f271632225ac14dd3b62d68a

data/lib/badgrcat/client.rb

@@ -10,6 +10,17 @@ module Badgrcat
       include "Badgrcat::Client::#{mname}".constantize
     end
 
+    attr_reader :access_token, :refresh_token, :expires_in
+
+    def initialize(options = {}, &block)
+      super
+      @refresh_token = config[:refresh_token] if config[:refresh_token].present?
+      if config[:access_token].present?
+        connection.headers[:authorization] = "Bearer #{config[:access_token]}"
+        connection.headers['Content-Type'] = 'application/json'
+      end
+    end
+
     # Override Footrest request for ApiArray support
     def request(method, &block)
       response = begin
@@ -44,6 +55,7 @@ module Badgrcat
 
     def authenticate!
       connection.headers[:authorization] = nil
+      connection.headers['Content-Type'] = nil
 
       auth_url = config[:auth_url]
 
@@ -71,10 +83,11 @@ module Badgrcat
       authresp = connection.send(:post, auth_url, tok_params)
       authdata = authresp.body
 
+      @access_token = authdata["access_token"]
       @refresh_token = authdata["refresh_token"].presence || @refresh_token
-      connection.headers[:authorization] = "#{authdata['token_type']} #{authdata['access_token']}"
+      @expires_in = authdata["expires_in"]
 
-      # Set content type as application/json
+      connection.headers[:authorization] = "#{authdata['token_type']} #{@access_token}"
       connection.headers['Content-Type'] = "application/json"
     end
   end

data/lib/bearcat/rate_limiting/functions.lua

@@ -0,0 +1,11 @@
+#!lua name=bearcat_rate_limiting
+
+local function checkin_time(keys, args)
+    local return_time = args[1]
+    local true_remaining = args[2]
+
+    local hash = keys[1]
+    return redis.call('HGET', hash, '_last_modified_')
+end
+
+redis.register_function('my_hset', my_hset)

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.6.10' unless defined?(Bearcat::VERSION)
+  VERSION = '1.6.12' unless defined?(Bearcat::VERSION)
 end

data/lib/catalogcat/api_array.rb

@@ -13,7 +13,7 @@ module Catalogcat
         key = 'order' if path =~ %r{.*/order/[0-9]*}
         key = 'orders' if path =~ %r{.*/orders}
         key = 'completed_certificates' if path =~ %r{.*/completed_certificates}
-        key = 'user_registrations' if path =~ %r{.*/user_registrations}
+        key = 'users' if path =~ %r{.*/users}
         key = 'email_domain_sets' if path =~ %r{.*/email_domain_sets}
       end
       key.present? ? key : super(response)

data/lib/catalogcat/client/user_registrations.rb

@@ -2,7 +2,7 @@ module Catalogcat
   class Client < Footrest::Client
     module UserRegistrations
       def list_user_registrations(params = {})
-        get("/api/v1/user_registrations", params)
+        get("/api/v1/users", { registered_in_catalog: true }.merge(params))
       end
     end
   end

data/spec/badgrcat/client_spec.rb

@@ -0,0 +1,151 @@
+require 'helper'
+require 'badgrcat/client'
+
+describe Badgrcat::Client do
+  let(:auth_url) { 'http://localhost:3000/o/token' }
+  let(:token_response) do
+    {
+      'access_token' => 'new_access_token',
+      'refresh_token' => 'new_refresh_token',
+      'expires_in' => 86400,
+      'token_type' => 'Bearer'
+    }
+  end
+
+  before do
+    stub_request(:post, auth_url)
+      .to_return(status: 200, body: token_response.to_json, headers: { 'Content-Type' => 'application/json' })
+  end
+
+  describe '#authenticate!' do
+    context 'with username/password credentials' do
+      let(:client) do
+        Badgrcat::Client.new(
+          prefix: 'http://localhost:3000',
+          auth_url: auth_url,
+          username: 'user@example.com',
+          password: 'password123'
+        )
+      end
+
+      it 'exposes token attributes' do
+        client.authenticate!
+
+        expect(client.access_token).to eq('new_access_token')
+        expect(client.refresh_token).to eq('new_refresh_token')
+        expect(client.expires_in).to eq(86400)
+      end
+
+      it 'sends username and password in the auth request' do
+        client.authenticate!
+
+        expect(WebMock).to have_requested(:post, auth_url)
+          .with(body: hash_including(username: 'user@example.com', password: 'password123'))
+      end
+
+      it 'sets the authorization header' do
+        client.authenticate!
+
+        expect(client.connection.headers[:authorization]).to eq('Bearer new_access_token')
+      end
+    end
+
+    context 'with a refresh token from config' do
+      let(:client) do
+        Badgrcat::Client.new(
+          prefix: 'http://localhost:3000',
+          auth_url: auth_url,
+          refresh_token: 'stored_refresh_token'
+        )
+      end
+
+      it 'sends the refresh token in the auth request' do
+        client.authenticate!
+
+        expect(WebMock).to have_requested(:post, auth_url)
+          .with(body: hash_including(grant_type: 'refresh_token', refresh_token: 'stored_refresh_token'))
+      end
+
+      it 'does not send username or password' do
+        client.authenticate!
+
+        expect(WebMock).not_to have_requested(:post, auth_url)
+          .with(body: hash_including(:username))
+      end
+
+      it 'exposes updated token attributes after auth' do
+        client.authenticate!
+
+        expect(client.access_token).to eq('new_access_token')
+        expect(client.refresh_token).to eq('new_refresh_token')
+        expect(client.expires_in).to eq(86400)
+      end
+    end
+
+    context 'when both refresh token and credentials are provided' do
+      let(:client) do
+        Badgrcat::Client.new(
+          prefix: 'http://localhost:3000',
+          auth_url: auth_url,
+          username: 'user@example.com',
+          password: 'password123',
+          refresh_token: 'stored_refresh_token'
+        )
+      end
+
+      it 'uses the refresh token' do
+        client.authenticate!
+
+        expect(WebMock).to have_requested(:post, auth_url)
+          .with(body: hash_including(grant_type: 'refresh_token', refresh_token: 'stored_refresh_token'))
+      end
+    end
+
+    context 'on subsequent auth calls' do
+      let(:client) do
+        Badgrcat::Client.new(
+          prefix: 'http://localhost:3000',
+          auth_url: auth_url,
+          username: 'user@example.com',
+          password: 'password123'
+        )
+      end
+
+      it 'uses the refresh token obtained from the first auth call' do
+        client.authenticate!
+        expect(client.refresh_token).to eq('new_refresh_token')
+
+        client.authenticate!
+        expect(client.refresh_token).to eq('new_refresh_token')
+        expect(client.access_token).to eq('new_access_token')
+
+        expect(WebMock).to have_requested(:post, auth_url)
+          .with(body: hash_including(grant_type: 'refresh_token', refresh_token: 'new_refresh_token'))
+      end
+    end
+
+    context 'when the response omits a refresh token' do
+      let(:token_response) do
+        {
+          'access_token' => 'another_access_token',
+          'refresh_token' => nil,
+          'expires_in' => 86400,
+          'token_type' => 'Bearer'
+        }
+      end
+
+      let(:client) do
+        Badgrcat::Client.new(
+          prefix: 'http://localhost:3000',
+          auth_url: auth_url,
+          refresh_token: 'original_refresh_token'
+        )
+      end
+
+      it 'keeps the existing refresh token' do
+        client.authenticate!
+        expect(client.refresh_token).to eq('original_refresh_token')
+      end
+    end
+  end
+end

data/spec/bearcat/client/new_quizzes_spec.rb

@@ -83,6 +83,117 @@ describe Bearcat::Client::NewQuizzes do
     expect { @client.delete_new_quiz_item('1', '1', '1') }.not_to raise_error
   end
 
+  # Item types
+  it 'returns a true/false item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/2').to_return(json_response('new_quizzes/new_quiz_item_true_false.json'))
+    item = @client.new_quiz_item('1', '1', '2')
+    item['entry']['interaction_type_slug'].should == 'true-false'
+    item['entry']['interaction_data']['true_choice'].should == 'True'
+    item['entry']['interaction_data']['false_choice'].should == 'False'
+    item['entry']['scoring_data']['value'].should == true
+  end
+
+  it 'returns a matching item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/3').to_return(json_response('new_quizzes/new_quiz_item_matching.json'))
+    item = @client.new_quiz_item('1', '1', '3')
+    item['entry']['interaction_type_slug'].should == 'matching'
+    item['entry']['interaction_data']['questions'].count.should == 4
+    item['entry']['interaction_data']['answers'].count.should == 5
+    item['entry']['scoring_data']['value'].should be_a(Hash)
+    item['entry']['scoring_data']['value']['q1'].should == 'Mammal'
+    item['entry']['scoring_algorithm'].should == 'PartialDeep'
+  end
+
+  it 'returns a categorization item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/4').to_return(json_response('new_quizzes/new_quiz_item_categorization.json'))
+    item = @client.new_quiz_item('1', '1', '4')
+    item['entry']['interaction_type_slug'].should == 'categorization'
+    item['entry']['interaction_data']['categories'].count.should == 2
+    item['entry']['interaction_data']['choices'].count.should == 3
+  end
+
+  it 'returns a rich-fill-blank item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/5').to_return(json_response('new_quizzes/new_quiz_item_fill_in_multiple_blanks.json'))
+    item = @client.new_quiz_item('1', '1', '5')
+    item['entry']['interaction_type_slug'].should == 'rich-fill-blank'
+    item['entry']['interaction_data']['blanks'].count.should == 2
+    item['entry']['interaction_data']['blanks'].first['answer_type'].should == 'openEntry'
+    item['entry']['interaction_data']['blanks'].last['answer_type'].should == 'dropdown'
+    item['entry']['scoring_algorithm'].should == 'MultipleMethods'
+  end
+
+  it 'returns a multi-answer item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/6').to_return(json_response('new_quizzes/new_quiz_item_multiple_answer.json'))
+    item = @client.new_quiz_item('1', '1', '6')
+    item['entry']['interaction_type_slug'].should == 'multi-answer'
+    item['entry']['scoring_data']['value'].count.should == 3
+    item['entry']['scoring_algorithm'].should == 'PartialScore'
+  end
+
+  it 'returns an ordering item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/7').to_return(json_response('new_quizzes/new_quiz_item_ordering.json'))
+    item = @client.new_quiz_item('1', '1', '7')
+    item['entry']['interaction_type_slug'].should == 'ordering'
+    item['entry']['interaction_data']['choices'].should be_a(Hash)
+    item['entry']['scoring_data']['value'].should == ['choice1', 'choice2', 'choice3', 'choice4']
+    item['entry']['scoring_algorithm'].should == 'DeepEquals'
+  end
+
+  it 'returns a short_answer item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/8').to_return(json_response('new_quizzes/new_quiz_item_short_answer.json'))
+    item = @client.new_quiz_item('1', '1', '8')
+    item['entry']['interaction_type_slug'].should == 'short_answer'
+    item['entry']['interaction_data']['answers'].first['item_body'].should == 'photosynthesis'
+  end
+
+  it 'returns an essay item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/9').to_return(json_response('new_quizzes/new_quiz_item_essay.json'))
+    item = @client.new_quiz_item('1', '1', '9')
+    item['entry']['interaction_type_slug'].should == 'essay'
+    item['entry']['scoring_algorithm'].should == 'None'
+  end
+
+  it 'returns a file-upload item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/10').to_return(json_response('new_quizzes/new_quiz_item_file_upload.json'))
+    item = @client.new_quiz_item('1', '1', '10')
+    item['entry']['interaction_type_slug'].should == 'file-upload'
+    item['entry']['interaction_data']['files_count'].should == '1'
+    item['entry']['scoring_algorithm'].should == 'None'
+  end
+
+  it 'returns a numeric item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/11').to_return(json_response('new_quizzes/new_quiz_item_numeric.json'))
+    item = @client.new_quiz_item('1', '1', '11')
+    item['entry']['interaction_type_slug'].should == 'numeric'
+    item['entry']['interaction_data'].should == {}
+    item['entry']['scoring_data']['value'].first['type'].should == 'exactResponse'
+    item['entry']['scoring_algorithm'].should == 'Numeric'
+  end
+
+  it 'returns a formula item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/12').to_return(json_response('new_quizzes/new_quiz_item_formula.json'))
+    item = @client.new_quiz_item('1', '1', '12')
+    item['entry']['interaction_type_slug'].should == 'formula'
+    item['entry']['interaction_data'].should == {}
+    item['entry']['scoring_data']['value']['variables'].count.should == 2
+    item['entry']['scoring_algorithm'].should == 'Numeric'
+  end
+
+  it 'returns a hot_spot item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/13').to_return(json_response('new_quizzes/new_quiz_item_hot_spot.json'))
+    item = @client.new_quiz_item('1', '1', '13')
+    item['entry']['interaction_type_slug'].should == 'hot_spot'
+    item['entry']['interaction_data']['regions'].first['shape'].should == 'rectangle'
+  end
+
+  it 'returns a stimulus item' do
+    stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/items/14').to_return(json_response('new_quizzes/new_quiz_item_stimulus.json'))
+    item = @client.new_quiz_item('1', '1', '14')
+    item['entry_type'].should == 'Stimulus'
+    item['entry']['interaction_type_slug'].should == 'stimulus'
+    item['points_possible'].should == 0.0
+  end
+
   # Submissions
   it 'returns a list of submissions for a new quiz' do
     stub_get(@client, '/api/quiz/v1/courses/1/quizzes/1/submissions').to_return(json_response('new_quizzes/new_quiz_submissions.json'))