bridge_api 0.1.55 → 0.1.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83609f373a095db86732ec01372a9bb683d4bb0371fabf6eb1937f620420d815
-  data.tar.gz: e661ce7bea32043846bd1e2b0f3891eb6595a2c93409a37f1dd3ddb4341f60a7
+  metadata.gz: ba858770698bd9b2eae79613a356e002d75b7660786e33c53d999859cf9b809b
+  data.tar.gz: a9e81c5c0758deab4985332dbaec93a2dcc71f931a60033897f637bff9952efd
 SHA512:
-  metadata.gz: 68d26347ea96b47f03f1c960245741357f439b9ad81fbee453ccecb41f4fde87256c616c5772c35e4604154c48ad731220e11877e1be49ca3560518668844d1d
-  data.tar.gz: 42dea873909be1b5758ad7a896ed396d29ae7c93d5c08dfb234d20163100557b7ba45efc2319cf5e5e8ce06b6460fefc3265161385ce9222bf34fda6a98fe824
+  metadata.gz: a470154415cfe7cb6b4899d4826d63dc8e0f7ad5320229c2985d079bc2fc159ce809c16ede74cb278ffefe0c13047a697f10293afd754a2d9ef8c44a01971167
+  data.tar.gz: db6d7da0e8afe793a2e80ddf2c45ffead4256adef5559f2f2d5c10bec578ef8ef47de3b8f4d5113187f2bbd46cf332c76ee04e514d95daa06770eb55dbc1de11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bridge_api (0.1.55)
+    bridge_api (0.1.60)
       faraday (~> 0.9.0)
       faraday_middleware (>= 0.12.2)
       footrest (>= 0.5.1)

data/README.md

@@ -25,3 +25,20 @@ instantiating several instances of `client`, you can also supply your client
 initializer with `master_rate_limit: true`. This will use a redis
 keystore to track your rate limits across all instances of `client` and
 properly throttle your application as needed.
+
+## Token Pools
+
+This supports token pooling to get around rate limiting issues in bridge (but should never be used without Core approval)
+To use with Tokens:
+```
+client = BridgeAPI::Client.new(tokens: ['token1', 'token2'], prefix: "https://yourdomain.bridgeapp.com")
+```
+To use with API Keys:
+```
+client = BridgeAPI::Client.new(api_keys: {'key1' => 'secret1', 'key2' => 'secret2'}, prefix: "https://yourdomain.bridgeapp.com")
+```
+
+The logic will start with the first token provided, and check against the redis cache to see what its current limit
+is. If its already under the limit threshold, it will rotate to the next in the pool, and perform the same check. It
+will do this till it finds one that is not under the threshold, and use it. If none are found, it will sleep for the 
+configured time, and then try to make a call.

data/lib/bridge_api.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bridge_api/version'
 require 'bridge_api/client'
 
 module BridgeAPI
   class << self
     require 'logger'
-    attr_writer :enforce_rate_limits, :rate_limit_min, :rate_limits, :max_sleep_seconds, :min_sleep_seconds,
+    attr_writer :enforce_rate_limits, :beginning_rate_limit, :rate_limits, :max_sleep_seconds, :min_sleep_seconds,
                 :logger, :master_rate_limit, :master_mutex, :rate_limit_threshold
 
     def configure
@@ -15,8 +17,8 @@ module BridgeAPI
       @enforce_rate_limits ||= false
     end
 
-    def rate_limit_min
-      @rate_limit_min ||= 30
+    def beginning_rate_limit
+      @beginning_rate_limit ||= 30
     end
 
     def rate_limits

data/lib/bridge_api/api_array.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module BridgeAPI
   class ApiArray
@@ -18,7 +19,7 @@ module BridgeAPI
       @linked = {}
       @meta = {}
       @extra_meta_fields = []
-      pattern = /.*(\/api\/.*)/
+      pattern = %r{.*(/api/.*)}
       path = response.env.url
       matches = pattern.match(path.to_s)
       mapping = nil
@@ -67,7 +68,6 @@ module BridgeAPI
       !@next_page.nil?
     end
 
-
     def next_page
       load_page(@next_page)
     end
@@ -119,8 +119,10 @@ module BridgeAPI
 
     def get_response_content(response)
       return [] unless response.body.is_a?(Hash)
+
       content = response.body.reject { |k, _v| @meta_fields.include?(k) || @extra_meta_fields.include?(k) }
       return content.values[0] unless content.empty?
+
       []
     end
 

data/lib/bridge_api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'footrest/client'
 require 'faraday'
 require 'footrest'
@@ -12,60 +14,126 @@ module BridgeAPI
   class Client < Footrest::Client
     require 'bridge_api/api_array'
 
-    DATA_DUMP_DOWNLOAD_PATH = '/data_dumps/download'.freeze
-    DATA_DUMP_PATH = '/data_dumps'.freeze
-    COURSE_TEMPLATE_PATH = '/course_templates'.freeze
-    ENROLLMENT_PATH = '/enrollments'.freeze
-    LTI_TOOLS_PATH = '/lti_tools'.freeze
-    PROGRAM_PATH = '/programs'.freeze
-    PROGRAM_ENROLLMENT_PATH = '/learners'.freeze
-    USER_PATH = '/users'.freeze
-    GROUPS_PATH = '/groups'.freeze
-    MANAGER_PATH = '/managers'.freeze
-    ADMIN_PATH = '/admin'.freeze
-    AUTHOR_PATH = '/author'.freeze
-    LEARNER_PATH = '/learner'.freeze
-    LEARNERS_PATH  = '/learners'.freeze
-    LEARNER_ITEMS_PATH = '/learner_items'.freeze
-    CUSTOM_FIELD_PATH = '/custom_fields'.freeze
-    SUB_ACCOUNT_PATH = '/sub_accounts'.freeze
-    SUPPORT_PATH = '/support'.freeze
-    ACCOUNT_PATH = '/accounts'.freeze
-    CLONE_OBJECTS_PATH = '/clone_objects'.freeze
-    API_VERSION = 1
-    API_PATH = '/api'.freeze
-    ROLE_PATH = '/roles'.freeze
-    AFFILIATED_SUBACCOUNTS = '/affiliated_sub_accounts'.freeze
-    BATCH_PATH = '/batch'.freeze
-    LIVE_COURSES_PATH = '/live_courses'.freeze
-    SESSIONS_PATH = '/sessions'.freeze
-    PUBLISH_PATH = '/publish'.freeze
-    WEB_CONFERENCE_PATH = '/web_conference'.freeze
-    RESTORE_PATH = '/restore'.freeze
-    DUE_DATE_PATH = '/due_date'.freeze
-    RESET_PATH = '/reset'.freeze
-    RESULT_MAPPING = {}
+    DATA_DUMP_DOWNLOAD_PATH = '/data_dumps/download'
+    DATA_DUMP_PATH          = '/data_dumps'
+    COURSE_TEMPLATE_PATH    = '/course_templates'
+    ENROLLMENT_PATH         = '/enrollments'
+    LTI_TOOLS_PATH          = '/lti_tools'
+    PROGRAM_PATH            = '/programs'
+    PROGRAM_ENROLLMENT_PATH = '/learners'
+    USER_PATH               = '/users'
+    GROUPS_PATH             = '/groups'
+    MANAGER_PATH            = '/managers'
+    ADMIN_PATH              = '/admin'
+    AUTHOR_PATH             = '/author'
+    LEARNER_PATH            = '/learner'
+    LEARNERS_PATH           = '/learners'
+    LEARNER_ITEMS_PATH      = '/learner_items'
+    CUSTOM_FIELD_PATH       = '/custom_fields'
+    SUB_ACCOUNT_PATH        = '/sub_accounts'
+    SUPPORT_PATH            = '/support'
+    ACCOUNT_PATH            = '/accounts'
+    CLONE_OBJECTS_PATH      = '/clone_objects'
+    API_VERSION             = 1
+    API_PATH                = '/api'
+    ROLE_PATH               = '/roles'
+    AFFILIATED_SUBACCOUNTS  = '/affiliated_sub_accounts'
+    BATCH_PATH              = '/batch'
+    LIVE_COURSES_PATH       = '/live_courses'
+    SESSIONS_PATH           = '/sessions'
+    PUBLISH_PATH            = '/publish'
+    WEB_CONFERENCE_PATH     = '/web_conference'
+    RESTORE_PATH            = '/restore'
+    DUE_DATE_PATH           = '/due_date'
+    RESET_PATH              = '/reset'
+    RESULT_MAPPING          = {}
 
     Dir[File.dirname(__FILE__) + '/client/*.rb'].each do |file|
       require file
       include const_get(File.basename(file).gsub('.rb', '').split('_').map(&:capitalize).join('').to_s)
     end
 
+    def initialize(options = {}, &block)
+      if BridgeAPI.enforce_rate_limits && has_token_pool?(options)
+        options = initialize_from_token_pool(options)
+      end
+      super
+    end
+
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      enforce_rate_limits
+      if has_token_pool?(config)
+        (config[:api_tokens] || config[:api_keys].keys).size.times do
+          break unless rate_limit_reached?
+
+          rotate_token!
+        end
+      end
+      enforce_rate_limits if rate_limit_reached?
       response = connection.send(method, &block)
       apply_rate_limits(response)
       ApiArray.process_response(response, self, RESULT_MAPPING)
     end
 
+    def has_token_pool?(config)
+      config[:api_keys].is_a?(Hash) && config[:api_keys].keys.count >= 1 ||
+        config[:api_tokens].is_a?(Array) && config[:api_tokens].count >= 1
+    end
+
+    # Since a pool is passed in, initialize first token with the first token passed in
+    def initialize_from_token_pool(config)
+      if config[:api_keys].is_a?(Hash)
+        creds = config[:api_keys].first
+        config[:api_key]    ||= creds[0]
+        config[:api_secret] ||= creds[1]
+      elsif config[:api_tokens].is_a?(Array)
+        config[:token] ||= config[:api_tokens].first
+      end
+      config
+    end
+
+    # rotates to the next token in the pool (by order in which they were provided)
+    def rotate_token!
+      BridgeAPI.master_mutex.synchronize do
+        old_api_key = config[:api_key]
+        if config[:api_keys].is_a?(Hash)
+          keys = config[:api_keys].keys
+          return if keys.count <= 1
+
+          key                 = get_next_key(keys, config[:api_key])
+          config[:api_key]    = key
+          config[:api_secret] = config[:api_keys][key]
+        elsif config[:api_tokens].is_a?(Array)
+          keys = config[:api_tokens]
+          return if keys.count <= 1
+
+          token = get_next_key(keys, config[:token])
+          config[:token] = token
+        end
+        BridgeAPI.logger.debug('rotating API Keys')
+        set_connection(config)
+      end
+    end
+
+    def get_next_key(keys, current_key)
+      i = keys.index(current_key) || -1
+      i = (i + 2) > keys.count ? 0 : (i + 1)
+      keys[i]
+    end
+
+    def rate_limit_reached?
+      return false unless BridgeAPI.enforce_rate_limits && limit_remaining.present?
+
+      limit_remaining < BridgeAPI.rate_limit_threshold
+    end
+
     def enforce_rate_limits
-      return unless BridgeAPI.enforce_rate_limits && limit_remaining.present?
-      return unless limit_remaining < BridgeAPI.rate_limit_threshold
-      tts = ((BridgeAPI.rate_limit_min - limit_remaining) / 5).ceil
-      tts = BridgeAPI.min_sleep_seconds if tts < BridgeAPI.min_sleep_seconds
-      tts = BridgeAPI.max_sleep_seconds if tts > BridgeAPI.max_sleep_seconds
-      message = "Bridge API rate limit minimum #{BridgeAPI.rate_limit_min} reached for key: '#{config[:api_key]}'. "\
+      return unless rate_limit_reached?
+
+      tts     = ((BridgeAPI.beginning_rate_limit - limit_remaining) / 5).ceil
+      tts     = BridgeAPI.min_sleep_seconds if tts < BridgeAPI.min_sleep_seconds
+      tts     = BridgeAPI.max_sleep_seconds if tts > BridgeAPI.max_sleep_seconds
+      message = "Bridge API rate limit minimum #{BridgeAPI.rate_limit_threshold} reached for key: '#{config[:api_key]}'. "\
         "Sleeping for #{tts} second(s) to catch up ~zzZZ~. "\
         "Limit Remaining: #{limit_remaining}"
       BridgeAPI.logger.debug(message)
@@ -79,6 +147,7 @@ module BridgeAPI
     def apply_rate_limits(response)
       limit = response.headers['x-rate-limit-remaining']
       return if limit.nil?
+
       BridgeAPI.logger.debug("BRIDGE RATE LIMIT REMAINING: #{limit}")
       self.limit_remaining = limit.to_i
     end
@@ -88,8 +157,8 @@ module BridgeAPI
         BridgeAPI.master_mutex.synchronize do
           limit = PaulWalker::RateLimit.get(config[:api_key], config[:api_key])
           if limit.nil?
-            PaulWalker::RateLimit.add(config[:api_key], config[:api_key], 0, BridgeAPI::rate_limit_min)
-            limit = {current: 0}.with_indifferent_access
+            PaulWalker::RateLimit.add(config[:api_key], config[:api_key], 0, BridgeAPI.beginning_rate_limit)
+            limit = { current: 0 }.with_indifferent_access
           end
           limit['current']
         end
@@ -101,7 +170,7 @@ module BridgeAPI
     def limit_remaining=(value)
       if using_master_rate_limit?
         BridgeAPI.master_mutex.synchronize do
-          PaulWalker::RateLimit.add(config[:api_key], config[:api_key], value, BridgeAPI::rate_limit_min)
+          PaulWalker::RateLimit.add(config[:api_key], config[:api_key], value, BridgeAPI.beginning_rate_limit)
         end
       else
         BridgeAPI.rate_limits[config[:api_key]] = value
@@ -110,26 +179,25 @@ module BridgeAPI
 
     def set_connection(config)
       config[:logger] = config[:logging] if config[:logging]
-      @connection = Faraday.new(url: config[:prefix]) do |faraday|
-        faraday.request                     :multipart
-        faraday.request                     :url_encoded
+      @connection     = Faraday.new(url: config[:prefix]) do |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
         if config[:logger] == true
           faraday.response :logger
         elsif config[:logger]
           faraday.use Faraday::Response::Logger, config[:logger]
         end
-        faraday.use                         Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
-        faraday.adapter                     Faraday.default_adapter
-        faraday.use                         Footrest::ParseJson, content_type: /\bjson$/
-        faraday.use                         Footrest::RaiseFootrestErrors
-        faraday.use                         Footrest::Pagination
-        faraday.headers[:accept]          = 'application/json'
-        faraday.headers[:authorization]   = "Bearer #{config[:token]}" if config[:token]
-        faraday.headers[:user_agent]      = 'Footrest'
+        faraday.use Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
+        faraday.adapter Faraday.default_adapter
+        faraday.use Footrest::ParseJson, content_type: /\bjson$/
+        faraday.use Footrest::RaiseFootrestErrors
+        faraday.use Footrest::Pagination
+        faraday.headers[:accept]     = 'application/json'
+        faraday.headers[:user_agent] = 'Footrest'
         if config[:api_key] && config[:api_secret]
-          faraday.headers[:authorization] =   'Basic ' + Base64.strict_encode64("#{config[:api_key]}:#{config[:api_secret]}")
+          faraday.headers[:authorization] = 'Basic ' + Base64.strict_encode64("#{config[:api_key]}:#{config[:api_secret]}")
         elsif config[:token]
-          faraday.headers[:authorization] =   "Bearer #{config[:token]}"
+          faraday.headers[:authorization] = "Bearer #{config[:token]}"
         else
           raise 'No api authorization provided'
         end

data/lib/bridge_api/client/account.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module Account
-
       def create_account(params = {})
         post("#{API_PATH}#{ADMIN_PATH}/sub_accounts", params)
       end

data/lib/bridge_api/client/affiliation.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module BridgeAPI
-    class Client
-      module Affiliation
-        def list_affiliations(params = {})
-          get("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}", params)
-        end
+  class Client
+    module Affiliation
+      def list_affiliations(params = {})
+        get("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}", params)
+      end
 
-        def revoke_affiliations_batch(params = {})
-          put("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}/revoke_batch", params)
-        end
+      def revoke_affiliations_batch(params = {})
+        put("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}/revoke_batch", params)
+      end
 
-        def share_affiliations_batch(params = {})
-          put("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}/share_batch", params)
-        end
+      def share_affiliations_batch(params = {})
+        put("#{API_PATH}#{AUTHOR_PATH}#{AFFILIATED_SUBACCOUNTS}/share_batch", params)
       end
     end
   end
+  end

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

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeAPI
   class Client
     module SubAccount

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.55'.freeze unless defined?(BridgeAPI::VERSION)
+  VERSION = '0.1.60' 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

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

data/spec/support/fake_bridge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'tilt'
 
@@ -257,7 +259,7 @@ class FakeBridge < Sinatra::Base
     get_json_data 200, 'accounts.json'
   end
 
-  #Roles
+  # Roles
   get %r{/api/author/roles} do
     get_json_data 200, 'roles.json'
   end
@@ -274,7 +276,7 @@ class FakeBridge < Sinatra::Base
     get_json_data 204, 'roles.json'
   end
 
-  #Affiliations
+  # Affiliations
   get %r{/api/author/affiliated_sub_accounts} do
     get_json_data 204, 'affiliations.json'
   end

data/spec/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bridge_api'
 require 'rspec'
 require 'webmock/rspec'
@@ -9,7 +11,7 @@ RSpec.configure do |config|
 
   config.before(:each) do
     WebMock.disable_net_connect!
-    WebMock.stub_request(:any, /api\/.*/).to_rack(FakeBridge)
+    WebMock.stub_request(:any, %r{api/.*}).to_rack(FakeBridge)
   end
 end
 

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: bridge_api
 version: !ruby/object:Gem::Version
-  version: 0.1.55
+  version: 0.1.60
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -104,22 +104,22 @@ dependencies:
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -297,7 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Bridge API