bearcat 1.6.10 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da81a40773d9eba82a151acdfbca17550ae9a707b6089f31a1df74f5e9c8abd
-  data.tar.gz: 0f6de89595ede0206490f91d7490311e29d4206c42f35b21e8f35e36ea3dabd1
+  metadata.gz: ff6d6d1426d021f6c2e7146de2884ecd9eb721b5529e56e49e25e82332dc3ddf
+  data.tar.gz: c59d392750a2b15b877c47efd96c317ce65299089aab856fa0944a0da5601cfe
 SHA512:
-  metadata.gz: fd621b13dbecaeabadce71ddc403836f40d78e62439db93dd0066fd7f823a761b469250ba51692d5ea68368d6632cab5da7faf45da55b2c8077777c85167d696
-  data.tar.gz: 35497af71785998f52ac54d9f5729b56777d76f94f882878aecd21d33281b5058f0df4a9ba6db414fe87c179c002bb6599ffab18d9d80a8bbf73e98220fe2d82
+  metadata.gz: 359e37b3e095419a8d74276b06dfeb2b41e5c68b5a19e4bd8c846abb5442e0dd0453738ceac3f121dd81099ee75b89c9ce8b3c01126f6e5327c5ef661d1743b2
+  data.tar.gz: 8f15f81e9d1ac4392104c4b8d3e65936ccfe4eeff9cf39ae77407086a8418eb82513ee984fc923e7a50b4169a8ee63c5795c4fa3768575119e8986a0d1264887

data/bearcat.gemspec

@@ -26,14 +26,16 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "bundler", ">= 1.0.0"
-  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "rspec", "~> 3.13"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'sidekiq', "< 7.0"
   gem.add_development_dependency "ffi", "~> 1.16.3"
+  gem.add_development_dependency "appraisal", "~> 2.5"
 
   gem.add_dependency "activesupport"
-  gem.add_dependency "faraday", "> 1.0", "< 2.0"
-  gem.add_dependency "footrest", ">= 0.2.2"
+  gem.add_dependency "faraday", ">= 1.0", "< 3"
+  gem.add_dependency "faraday-multipart", "~> 1.0"
+  gem.add_dependency "footrest", ">= 0.6.1"
   gem.add_dependency "rediconn", "~> 0.1.0"
 end

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

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/module'
+require 'cgi' # for CGI.parse; no longer loaded transitively by activesupport 8
 
 module Bearcat
   class ApiArray

data/lib/bearcat/client/file_helper.rb

@@ -14,7 +14,7 @@ module Bearcat
 
       def post_file(url, params, file_path)
         params['Filename'] = File.basename(file_path)
-        params['file'] = Faraday::UploadIO.new(file_path, params['content-type'])
+        params['file'] = upload_io(file_path, params['content-type'])
         response = upload_connection.post(url, params)
         if [201, 302, 303].include? response.status #success if it is a redirect or 201
           response.headers['Location']

data/lib/bearcat/client/outcome_imports.rb

@@ -4,7 +4,7 @@ module Bearcat
 
       def import_outcomes(file_path, params={})
         params = params.with_indifferent_access
-        params['attachment'] = Faraday::UploadIO.new(file_path, 'text/csv')
+        params['attachment'] = upload_io(file_path, 'text/csv')
         url = "api/v1/#{outcome_import_context_slug(params)}"
         url += "group/#{params[:group]}/" if params[:group].present?
         params.delete(:group)

data/lib/bearcat/client/sis_imports.rb

@@ -2,7 +2,7 @@ module Bearcat
   class Client < Footrest::Client
     module SisImports
       def import_sis_data(account, file, options = {}, content_type: nil)
-        options['attachment'] = Faraday::UploadIO.new(file, content_type || "application/zip")
+        options['attachment'] = upload_io(file, content_type || "application/zip")
         post("/api/v1/accounts/#{account}/sis_imports", options)
       end
 

data/lib/bearcat/client.rb

@@ -1,4 +1,6 @@
 require 'active_support/core_ext/hash'
+require 'faraday'
+require 'faraday/multipart'
 require 'footrest/client'
 require_relative 'rate_limiting'
 require_relative 'client_module'
@@ -75,6 +77,18 @@ module Bearcat
       connection.builder.delete(Faraday::Request::UrlEncoded)
     end
 
+    # Builds a multipart file part for uploads, bridging Faraday 1.x and 2.x.
+    # Faraday 2.x dropped Faraday::UploadIO in favor of
+    # Faraday::Multipart::FilePart (from the faraday-multipart gem). Both accept
+    # the same (path_or_io, content_type) signature.
+    def upload_io(path_or_io, content_type)
+      if defined?(Faraday::Multipart::FilePart)
+        Faraday::Multipart::FilePart.new(path_or_io, content_type)
+      else
+        Faraday::UploadIO.new(path_or_io, content_type)
+      end
+    end
+
     def self.cache_on_self(key, &block)
       @cache ||= {}
       if Rails.env.development? || Rails.env.test?

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.7.0' 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/api_array_spec.rb

@@ -28,24 +28,24 @@ describe Bearcat::ApiArray do
     end
 
     it 'gets a page of results' do
-      expect(request).to receive(:url).with('https://fake.com', 'page' => '2')
+      expect(request).to receive(:url).with('https://fake.com', { 'page' => '2' })
       api_array.send(:get_page, 'https://fake.com?page=2', {})
     end
 
     it 'merges additonal params to the url query' do
-      expect(request).to receive(:url).with('https://fake.com', 'test' => 'param', 'page' => 2)
-      api_array.send(:get_page, 'https://fake.com?test=param', 'page' => 2)
+      expect(request).to receive(:url).with('https://fake.com', { 'test' => 'param', 'page' => 2 })
+      api_array.send(:get_page, 'https://fake.com?test=param', { 'page' => 2 })
     end
 
     it 'handles array parameters' do
-      expect(request).to receive(:url).with('https://fake.com', 'test' => ['param'], 'second' => ['param'])
-      api_array.send(:get_page, 'https://fake.com?test%5B%5D=param', 'second' => ['param'])
+      expect(request).to receive(:url).with('https://fake.com', { 'test' => ['param'], 'second' => ['param'] })
+      api_array.send(:get_page, 'https://fake.com?test%5B%5D=param', { 'second' => ['param'] })
     end
 
     it 'sets the per_page parameter if not already set and @page_count has a value' do
       api_array.instance_variable_set('@page_count', 50)
 
-      expect(request).to receive(:url).with('https://fake.com', 'per_page' => 50)
+      expect(request).to receive(:url).with('https://fake.com', { 'per_page' => 50 })
       api_array.send(:get_page, 'https://fake.com?', {})
     end
 
@@ -59,8 +59,8 @@ describe Bearcat::ApiArray do
     it 'does not set the per_page parameter if it is already set' do
       api_array.instance_variable_set('@page_count', 50)
 
-      expect(request).to receive(:url).with('https://fake.com', 'per_page' => 10)
-      api_array.send(:get_page, 'https://fake.com?', 'per_page' => 10)
+      expect(request).to receive(:url).with('https://fake.com', { 'per_page' => 10 })
+      api_array.send(:get_page, 'https://fake.com?', { 'per_page' => 10 })
     end
   end