bridge_api 0.1.66 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9ca9ab902293aba483f19e3672a1c0c60aa19c2aca4175bf34a2a4db7bae6d8
-  data.tar.gz: 004f3fee360e5c413572bf7f636ed75f8e765936668bf03a6fa7437e6b5b0441
+  metadata.gz: 2f7777215ef9e217d636798e5de92127e20b1506f37d7846d34cc7d435cc4ffe
+  data.tar.gz: 17c5e2693f9b6db371058568776c8b0c6efb09d214f694a93a19e502b5223960
 SHA512:
-  metadata.gz: 9c5475c3391696f44fc7564fe112bfb07c850bdd9ba4c8d29164f4db30ebbdd7d17f02a096a4dbcbc4b5193c57716d66f733f2ab6e913544216389f13a8c1871
-  data.tar.gz: 82a529c351861196e9a0cce6bcc0e581120af60cc709d75526ac8de6dd6c5f5c8b9ba20c9c4e15b00b646b8144a350f40fa5a1c91ec96b3d28644eb1dca3716a
+  metadata.gz: 8040ca103e5f27865337b03ceb8d761eff6b209f89c2405ec5bdcfaa842f8acc66cce2b365dfc9270b06e867c84d2dcc6a55dbd339314e8f87cf868d034860c6
+  data.tar.gz: cbb40a9001208af3be7056d95ad35696e682667acfcdb8dcd576a715099cca5091eb7725b3fdd85b386a896d34e6c01983e32351fa27f7d8b80fe87e9c934189

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Setup Ruby # Step 2 (we gave the name 'Setup Ruby' to this step)
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5.0
+          ruby-version: 2.7.0
       - name: Install bundle and gems # Step 4
         run: |
           gem install bundler

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    bridge_api (0.1.60)
-      faraday (~> 0.9.0)
+    bridge_api (0.2.0)
+      faraday (~> 0.17.3)
       faraday_middleware (>= 0.12.2)
       footrest (>= 0.5.1)
       paul_walker (>= 0.1.1)
@@ -10,35 +10,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     byebug (8.2.5)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.10)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (0.9.2)
+    faraday (0.17.5)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     footrest (0.5.3)
       activesupport (>= 3.0.0)
       faraday (>= 0.9.0, < 1)
       link_header (>= 0.0.7)
     hashdiff (0.3.7)
-    i18n (1.6.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     link_header (0.0.8)
     method_source (0.9.0)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    paul_walker (0.1.1)
+    minitest (5.15.0)
+    mock_redis (0.31.0)
+      ruby2_keywords
+    multipart-post (2.1.1)
+    paul_walker (0.1.2)
       redis (>= 4.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -48,7 +50,7 @@ GEM
     rack-protection (1.5.5)
       rack
     rake (0.9.6)
-    redis (4.1.0)
+    redis (4.6.0)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -57,15 +59,15 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
+    ruby2_keywords (0.0.5)
     safe_yaml (1.0.4)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    thread_safe (0.3.6)
     tilt (1.4.1)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     webmock (1.22.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -78,6 +80,7 @@ DEPENDENCIES
   bridge_api!
   bundler (~> 1.0, >= 1.0.0)
   byebug (~> 8.2.2)
+  mock_redis
   pry (~> 0)
   rake (~> 0)
   rspec (~> 2.6)

data/bridge_api.gemspec

@@ -26,8 +26,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'sinatra', '~> 1.0'
   gem.add_development_dependency 'tilt', '>= 1.3.4', '~> 1.3'
   gem.add_development_dependency 'webmock', '~>1.22.6'
+  gem.add_development_dependency 'mock_redis'
 
-  gem.add_dependency 'faraday', '~> 0.9.0'
+  gem.add_dependency 'faraday', '~> 0.17.3'
   gem.add_dependency 'faraday_middleware', '>= 0.12.2'
   gem.add_dependency 'footrest', '>= 0.5.1'
   gem.add_dependency 'paul_walker', '>= 0.1.1'

data/lib/bridge_api/client.rb

@@ -62,13 +62,6 @@ module BridgeAPI
 
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      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)
@@ -80,45 +73,47 @@ module BridgeAPI
         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
+    def convert_tokens(config)
+      return config unless config.has_key?(:api_tokens)
+      return config unless config[:api_tokens].is_a?(Array)
+      config[:api_keys] ||= {}
+      config[:api_tokens].each do |token|
+        decoded_token_array = Base64.strict_decode64(token).split(':')
+        config[:api_keys][decoded_token_array[0]] = decoded_token_array[1]
       end
+      config.delete(:api_tokens)
+      config
+    end
+
+    def initialize_from_token_pool(config)
+      config = convert_tokens(config)  
+      creds = config[:api_keys].first
+      config[:api_key]    ||= creds[0]
+      config[:api_secret] ||= creds[1]
       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
+    def rotate_token! 
+      return unless config[:api_keys].present?
+      old_api_key = config[:api_key]
+      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]
+      set_connection(config)
+      BridgeAPI.logger.debug("ROTATED TO KEY: #{config[:api_key]}")
     end
 
     def get_next_key(keys, current_key)
-      i = keys.index(current_key) || -1
-      i = (i + 2) > keys.count ? 0 : (i + 1)
-      keys[i]
+      keys.delete(current_key)
+      usable_key = keys.find do |key|
+        limit = rate_limit(key)
+        current_key_limit = limit.present? ? limit.fetch('current') : 0
+        BridgeAPI.beginning_rate_limit - current_key_limit > BridgeAPI.rate_limit_threshold
+      end
+      usable_key || keys[rand(keys.length)]
     end
 
     def rate_limit_reached?
@@ -130,14 +125,13 @@ module BridgeAPI
     def enforce_rate_limits
       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)
-      sleep(tts)
+      rotate_token! 
+      if rate_limit_reached?
+        sleep_time = rand(BridgeAPI.max_sleep_seconds)
+        sleep_time = BridgeAPI.min_sleep_seconds if sleep_time < BridgeAPI.min_sleep_seconds 
+        BridgeAPI.logger.debug("Rate limit reached sleeping for #{sleep_time}")
+        sleep(sleep_time)
+      end
     end
 
     def using_master_rate_limit?
@@ -148,20 +142,18 @@ module BridgeAPI
       limit = response.headers['x-rate-limit-remaining']
       return if limit.nil?
 
-      BridgeAPI.logger.debug("BRIDGE RATE LIMIT REMAINING: #{limit}")
+      BridgeAPI.logger.debug("BRIDGE RATE LIMIT REMAINING: #{limit} for key #{config[:api_key]}")
       self.limit_remaining = limit.to_i
     end
 
     def limit_remaining
       if using_master_rate_limit?
-        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.beginning_rate_limit)
-            limit = { current: 0 }.with_indifferent_access
-          end
-          limit['current']
+        limit = rate_limit(config[:api_key])
+        if limit.nil?
+          set_rate_limit(config[:api_key], 0)
+          limit = { current: 0 }.with_indifferent_access
         end
+        limit['current']
       else
         BridgeAPI.rate_limits[config[:api_key]]
       end
@@ -169,12 +161,37 @@ 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.beginning_rate_limit)
-        end
+        set_rate_limit(config[:api_key], value)
       else
         BridgeAPI.rate_limits[config[:api_key]] = value
       end
+      refresh_stale_tokens
+    end
+
+    def set_rate_limit(key, limit)
+      BridgeAPI.master_mutex.synchronize do
+        PaulWalker::RateLimit.add(key, key, limit, BridgeAPI.beginning_rate_limit)
+      end
+    end
+
+    def rate_limit(key)
+      BridgeAPI.master_mutex.synchronize do
+        PaulWalker::RateLimit.get(key, key)
+      end
+    end
+
+    def refresh_stale_tokens
+      return unless using_master_rate_limit?
+      return unless config[:api_keys].present?
+      api_keys = config[:api_keys].keys
+      api_keys.delete(config[:api_key])
+      api_keys.each do |key|
+        limit = rate_limit(key)
+        if limit['timestamp'].present? && DateTime.parse(limit['timestamp']) < 1.minute.ago
+          BridgeAPI.logger.debug("Refreshing: #{key}")
+          set_rate_limit(key, 0)
+        end
+      end
     end
 
     def set_connection(config)

data/lib/bridge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgeAPI
-  VERSION = '0.1.66' unless defined?(BridgeAPI::VERSION)
+  VERSION = '0.2.0' unless defined?(BridgeAPI::VERSION)
 end

data/lib/bridge_api.rb

@@ -26,7 +26,7 @@ module BridgeAPI
     end
 
     def max_sleep_seconds
-      @max_sleep_seconds ||= 60
+      @max_sleep_seconds ||= 30
     end
 
     def master_rate_limit

data/spec/bridge_api/client/enrollment_spec.rb

@@ -27,12 +27,6 @@ describe BridgeAPI::Client::Enrollment do
     expect(enrollments.length).to(eq(2))
   end
 
-  it 'should update due date for enrollments' do
-    enrollment = [{ end_at: nil }]
-    response = @client.update_enrollment_due_date(1, enrollment)
-    expect(response.status).to(eq(200))
-  end
-
   it 'should reset an enrollment for a course template' do
     response = @client.reset_enrollment(1)
     expect(response.status).to(eq(204))

data/spec/bridge_api/client_spec.rb

@@ -52,7 +52,7 @@ describe BridgeAPI::Client do
     end
 
     it 'should return true for tokens' do
-      config = { prefix: 'https://www.fake.com', api_tokens: %w[token1 token2] }
+      config = { prefix: 'https://www.fake.com', api_tokens: %w[dGVzdDE6dGVzdDE= dGVzdDI6dGVzdDI=] }
       client = BridgeAPI::Client.new(config)
       expect(client.has_token_pool?(config)).to be_truthy
     end
@@ -74,10 +74,10 @@ describe BridgeAPI::Client do
     end
 
     it 'should take first from tokens' do
-      config     = { prefix: 'https://www.fake.com', api_tokens: %w[token1 token2] }
+      config     = { prefix: 'https://www.fake.com', api_tokens: %w[dGVzdDE6dGVzdDE= dGVzdDI6dGVzdDI=] }
       client     = BridgeAPI::Client.new(config)
       new_config = client.initialize_from_token_pool(config)
-      expect(new_config[:token]).to eq('token1')
+      expect(new_config[:api_key]).to eq('test1')
     end
   end
 
@@ -111,15 +111,16 @@ describe BridgeAPI::Client do
 
     context 'with token pool' do
       it 'should rotate to the next key' do
-        keys   = %w[token1 token2]
+        keys   = %w[dGVzdDE6dGVzdDE= dGVzdDI6dGVzdDI=]
         config = { prefix: 'https://www.fake.com', api_tokens: keys }
         client = BridgeAPI::Client.new(config)
-        expect(client.config[:token]).to eq('token1')
+        expect(client.config[:api_key]).to eq('test1')
         client.rotate_token!
-        expect(client.config[:token]).to eq('token2')
+        expect(client.config[:api_key]).to eq('test2')
         client.rotate_token!
-        expect(client.config[:token]).to eq('token1')
+        expect(client.config[:api_key]).to eq('test1')
       end
     end
   end
 end
+

data/spec/test_helper.rb

@@ -5,6 +5,7 @@ require 'rspec'
 require 'webmock/rspec'
 require 'json'
 require 'pry'
+require 'mock_redis'
 
 RSpec.configure do |config|
   Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
@@ -12,6 +13,8 @@ RSpec.configure do |config|
   config.before(:each) do
     WebMock.disable_net_connect!
     WebMock.stub_request(:any, %r{api/.*}).to_rack(FakeBridge)
+    $redis = MockRedis.new
+    PaulWalker.redis = $redis
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridge_api
 version: !ruby/object:Gem::Version
-  version: 0.1.66
+  version: 0.2.0
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,20 +134,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.22.6
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement