bridge_api 0.1.54 → 0.1.63

data/lib/bridge_api/client/clone_object.rb

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module CloneObject
-
       def clone_objects(params = {})
         post("#{API_PATH}#{ADMIN_PATH}#{CLONE_OBJECTS_PATH}", params)
       end
 
-      def clone_object_status(id, params={})
+      def clone_object_status(id, params = {})
         get("#{API_PATH}#{ADMIN_PATH}#{CLONE_OBJECTS_PATH}/#{id}", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/course_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module CourseTemplate

data/lib/bridge_api/client/custom_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module CustomField

data/lib/bridge_api/client/data_dump.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module DataDump

data/lib/bridge_api/client/enrollment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Enrollment

data/lib/bridge_api/client/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Group

data/lib/bridge_api/client/learner_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module LearnerItem

data/lib/bridge_api/client/live_course.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module LiveCourse

data/lib/bridge_api/client/live_course_enrollment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module LiveCourseEnrollment

data/lib/bridge_api/client/live_course_session.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module LiveCourseSession
-
       def get_live_course_sessions(live_course_id, params = {})
         get("#{API_PATH}#{AUTHOR_PATH}#{LIVE_COURSES_PATH}/#{live_course_id}#{SESSIONS_PATH}", params)
       end
@@ -35,4 +36,4 @@ module BridgeAPI
       end
     end
   end
-end
+end

data/lib/bridge_api/client/manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Manager

data/lib/bridge_api/client/program.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Program
@@ -10,4 +12,4 @@ module BridgeAPI
       end
     end
   end
-end
+end

data/lib/bridge_api/client/program_enrollment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     # WARNING: the API endpoint for program enrollments is currently undocumented
@@ -9,6 +11,10 @@ module BridgeAPI
         post("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}", params)
       end
 
+      def update_program_enrollment(program_id, program_enrollment_id, params = {})
+        put("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}/#{program_enrollment_id}", params)
+      end
+
       def delete_program_enrollment(program_id, enrollment_id, params = {})
         delete("#{API_PATH}#{AUTHOR_PATH}#{PROGRAM_PATH}/#{program_id}#{PROGRAM_ENROLLMENT_PATH}/#{enrollment_id}", params)
       end

data/lib/bridge_api/client/role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Role

data/lib/bridge_api/client/sub_account.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module SubAccount
       def get_sub_accounts(params = {})
-        get("#{API_PATH}#{ADMIN_PATH}#{SUB_ACCOUNT_PATH}", params)
+        path = "#{API_PATH}#{ADMIN_PATH}#{SUB_ACCOUNT_PATH}"
+        RESULT_MAPPING[path] = {
+            meta: %w[data_dump_enabled data_dump_subaccount_enabled]
+        }
+        get(path, params)
       end
 
       def get_sub_account(subaccount_id, params = {})

data/lib/bridge_api/client/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module User
@@ -53,15 +55,14 @@ module BridgeAPI
         users = get_user(user_id, 'includes[]' => 'custom_fields')
         payload = []
         return payload if users.members.empty?
+
         existing_values = users.linked['custom_field_values']
         custom_field_values.each do |field_id, value|
           field_value_id = begin
                              existing_values.find do |v|
-                               begin
-                                 v['links']['custom_field']['id'] == field_id.to_s
-                               rescue StandardError
-                                 false
-                               end
+                               v['links']['custom_field']['id'] == field_id.to_s
+                             rescue StandardError
+                               false
                              end['id']
                            rescue StandardError
                              nil

data/lib/bridge_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
-  VERSION = '0.1.54'.freeze unless defined?(BridgeAPI::VERSION)
+  VERSION = '0.1.63' unless defined?(BridgeAPI::VERSION)
 end

data/spec/bridge_api/client/account_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::CourseTemplate do
@@ -9,12 +11,10 @@ describe BridgeAPI::Client::CourseTemplate do
 
   it 'should create an account' do
     templates = @client.create_account(
-      {
-        sub_account: {
-          locale: "en",
-          subdomain: 'subdomain',
-          name: 'subdomain'
-        }
+      sub_account: {
+        locale: 'en',
+        subdomain: 'subdomain',
+        name: 'subdomain'
       }
     )
     expect(templates.status).to(eq(200))

data/spec/bridge_api/client/affiliations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::Affiliation do
@@ -6,7 +8,7 @@ describe BridgeAPI::Client::Affiliation do
   end
 
   it 'should list the affiliations' do
-    response = @client.list_affiliations({item_id: 1, item_type: 'CourseTemple'})
+    response = @client.list_affiliations(item_id: 1, item_type: 'CourseTemple')
     expect(response.status).to(eq(204))
   end
 
@@ -14,5 +16,4 @@ describe BridgeAPI::Client::Affiliation do
     response = @client.share_affiliations_batch
     expect(response.status).to(eq(204))
   end
-
 end

data/spec/bridge_api/client/clone_object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::CloneObject do
@@ -7,14 +9,12 @@ describe BridgeAPI::Client::CloneObject do
 
   it 'should clone an object' do
     response = @client.clone_objects(
-      {
-        clone_objects: [
-          {
-            source_type: 'CourseTemplate',
-            source_id: 1
-          }
-        ]
-      }
+      clone_objects: [
+        {
+          source_type: 'CourseTemplate',
+          source_id: 1
+        }
+      ]
     ).first
     expect(response['destination_id']).to(eq(1))
   end
@@ -23,5 +23,4 @@ describe BridgeAPI::Client::CloneObject do
     response = @client.clone_object_status(1).first
     expect(response['state']).to(eq('completed'))
   end
-
 end

data/spec/bridge_api/client/course_template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::CourseTemplate do

data/spec/bridge_api/client/custom_field_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'byebug'
 describe BridgeAPI::Client::CustomField do

data/spec/bridge_api/client/data_dump_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::DataDump do

data/spec/bridge_api/client/enrollment_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::Enrollment do

data/spec/bridge_api/client/group_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::Group do

data/spec/bridge_api/client/learner_items_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::LearnerItem do

data/spec/bridge_api/client/live_course_enrollments_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::LiveCourseEnrollment do

data/spec/bridge_api/client/live_course_session_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::LiveCourseSession do
@@ -28,7 +30,7 @@ describe BridgeAPI::Client::LiveCourseSession do
   end
 
   it 'should delete a live course session in bridge' do
-    response = @client.delete_live_course_session(1,5)
+    response = @client.delete_live_course_session(1, 5)
     expect(response.status).to eq(204)
   end
 
@@ -45,7 +47,7 @@ describe BridgeAPI::Client::LiveCourseSession do
   it 'should update web_conference' do
     params = {
       web_conference: {
-        provider: "Bluejeans"
+        provider: 'Bluejeans'
       }
     }
     response = @client.update_web_conference(1, 5, params)
@@ -58,7 +60,7 @@ describe BridgeAPI::Client::LiveCourseSession do
   end
 
   it 'should get default web_conference config' do
-    response = @client.get_default_web_conference({default_session: 1})
+    response = @client.get_default_web_conference(default_session: 1)
     expect(response.status).to eq(200)
   end
 end

data/spec/bridge_api/client/live_course_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::LiveCourse do

data/spec/bridge_api/client/manager_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::User do

data/spec/bridge_api/client/program_enrollment_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::ProgramEnrollment do
@@ -10,6 +12,11 @@ describe BridgeAPI::Client::ProgramEnrollment do
     expect(response.status).to(eq(204))
   end
 
+  it 'should udpate a program enrollment' do
+    response = @client.update_program_enrollment(1, 1)
+    expect(response.status).to(eq(200))
+  end
+
   it 'should delete a program enrollment' do
     response = @client.delete_program_enrollment(1, 2)
     expect(response.status).to(eq(204))

data/spec/bridge_api/client/role_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::Role do

data/spec/bridge_api/client/sub_account_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::SubAccount do
@@ -35,19 +37,19 @@ describe BridgeAPI::Client::SubAccount do
   end
 
   it 'should update the lti config' do
-    params = {lti_tool: {consumer_key: "YoooKey", shared_secret: SecureRandom.hex(16)}}
+    params = { lti_tool: { consumer_key: 'YoooKey', shared_secret: SecureRandom.hex(16) } }
     response = @client.update_sub_account_lti_config(2, 15, params)
     expect(response.body['lti_tool']['id']).to(eq '20')
   end
 
   it 'should create new lti config' do
-    params = {lti_tool: {consumer_key: "SomeKey", shared_secret: SecureRandom.hex(16)}}
-    response = @client.create_sub_account_lti_config(2,params)
+    params = { lti_tool: { consumer_key: 'SomeKey', shared_secret: SecureRandom.hex(16) } }
+    response = @client.create_sub_account_lti_config(2, params)
     expect(response.status).to(eq 201)
   end
 
   it 'should delete a lti config' do
-    response = @client.delete_lti_config(2,15)
+    response = @client.delete_lti_config(2, 15)
     expect(response.status).to(eq 204)
   end
 end

data/spec/bridge_api/client/user_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe BridgeAPI::Client::User do
@@ -37,5 +39,4 @@ describe BridgeAPI::Client::User do
     response = @client.add_user_to_role_batch(1)
     expect(response.length).to eq(7)
   end
-  
 end

data/spec/bridge_api/client_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 describe BridgeAPI::Client do
   it 'should set the auth header to basic auth' do
@@ -12,20 +13,113 @@ describe BridgeAPI::Client do
 
   it 'should set the meta property on client' do
     client = BridgeAPI::Client.new(prefix: 'https://www.fake.com', token: 'test_token')
-    users = client.get_all_users
+    users  = client.get_all_users
     expect(users.meta['next']).to(eq('http://bridge.bridgeapp.com/api/author/users?after=eyJ0eXAiOiJKV1QiLCJhSDiQQ'))
   end
 
   it 'should set the linked property on client' do
     client = BridgeAPI::Client.new(prefix: 'https://www.fake.com', token: 'test_token')
-    users = client.get_all_users
+    users  = client.get_all_users
     expect(users.linked['custom_fields'][0]['id']).to(eq('1'))
   end
 
   it 'should enforce rate limits' do
-    client = BridgeAPI::Client.new(prefix: 'https://www.fake.com', api_key: 'fake_token', api_secret: 'fake_secret')
+    client                        = BridgeAPI::Client.new(prefix: 'https://www.fake.com', api_key: 'fake_token', api_secret: 'fake_secret')
     BridgeAPI.enforce_rate_limits = true
-    users = client.get_all_users
-    users = client.get_all_users
+    users                         = client.get_all_users
+    users                         = client.get_all_users
+  end
+
+  describe 'initialize' do
+    it 'should set initial token when using a pool' do
+      expect_any_instance_of(BridgeAPI::Client).to receive(:initialize_from_token_pool).and_call_original
+      client = BridgeAPI::Client.new(prefix: 'https://www.fake.com', api_keys: { 'key1' => 'secret1', 'key2' => 'secret2' })
+      expect(client.config[:api_key]).to eq('key1')
+      expect(client.config[:api_secret]).to eq('secret1')
+    end
+
+    it 'should not call initialize_from_token_pool for a single token' do
+      expect_any_instance_of(BridgeAPI::Client).to_not receive(:initialize_from_token_pool)
+      BridgeAPI::Client.new(prefix: 'https://www.fake.com', api_key: 'fake_token', api_secret: 'fake_secret')
+    end
+  end
+
+  describe 'has_token_pool?' do
+    it 'should return true for api keys' do
+      config = { prefix: 'https://www.fake.com', api_keys: { 'key1' => 'secret1', 'key2' => 'secret2' } }
+      client = BridgeAPI::Client.new(config)
+      expect(client.has_token_pool?(config)).to be_truthy
+    end
+
+    it 'should return true for tokens' do
+      config = { prefix: 'https://www.fake.com', api_tokens: %w[token1 token2] }
+      client = BridgeAPI::Client.new(config)
+      expect(client.has_token_pool?(config)).to be_truthy
+    end
+
+    it 'should return false for single key' do
+      config = { prefix: 'https://www.fake.com', api_key: 'fake_token', api_secret: 'fake_secret' }
+      client = BridgeAPI::Client.new(config)
+      expect(client.has_token_pool?(config)).to be_falsey
+    end
+  end
+
+  describe 'initialize_from_token_pool' do
+    it 'should take first from api keys' do
+      config     = { prefix: 'https://www.fake.com', api_keys: { 'key1' => 'secret1', 'key2' => 'secret2' } }
+      client     = BridgeAPI::Client.new(config)
+      new_config = client.initialize_from_token_pool(config)
+      expect(new_config[:api_key]).to eq('key1')
+      expect(new_config[:api_secret]).to eq('secret1')
+    end
+
+    it 'should take first from tokens' do
+      config     = { prefix: 'https://www.fake.com', api_tokens: %w[token1 token2] }
+      client     = BridgeAPI::Client.new(config)
+      new_config = client.initialize_from_token_pool(config)
+      expect(new_config[:token]).to eq('token1')
+    end
+  end
+
+  describe 'get_next_key' do
+    it 'should find next key' do
+      keys   = { 'key1' => 'secret1', 'key2' => 'secret2' }
+      config = { prefix: 'https://www.fake.com', api_keys: keys }
+      client = BridgeAPI::Client.new(config)
+      expect(client.get_next_key(keys.keys, 'key1')).to eq('key2')
+      expect(client.get_next_key(keys.keys, 'key2')).to eq('key1')
+      expect(client.get_next_key(keys.keys, 'non-existent-key')).to eq('key1')
+    end
+  end
+
+  describe 'rotate_token!' do
+    context 'with api key pool' do
+      it 'should rotate to the next key' do
+        keys   = { 'key1' => 'secret1', 'key2' => 'secret2' }
+        config = { prefix: 'https://www.fake.com', api_keys: keys }
+        client = BridgeAPI::Client.new(config)
+        expect(client.config[:api_key]).to eq('key1')
+        expect(client.config[:api_secret]).to eq('secret1')
+        client.rotate_token!
+        expect(client.config[:api_key]).to eq('key2')
+        expect(client.config[:api_secret]).to eq('secret2')
+        client.rotate_token!
+        expect(client.config[:api_key]).to eq('key1')
+        expect(client.config[:api_secret]).to eq('secret1')
+      end
+    end
+
+    context 'with token pool' do
+      it 'should rotate to the next key' do
+        keys   = %w[token1 token2]
+        config = { prefix: 'https://www.fake.com', api_tokens: keys }
+        client = BridgeAPI::Client.new(config)
+        expect(client.config[:token]).to eq('token1')
+        client.rotate_token!
+        expect(client.config[:token]).to eq('token2')
+        client.rotate_token!
+        expect(client.config[:token]).to eq('token1')
+      end
+    end
   end
 end