bridge_api 0.1.34 → 0.1.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f7fcc7455da9e499a9871e101189b7ea3b0c23
-  data.tar.gz: 750551323fc36f2bcf00e5e598669a08fbc5e3c3
+  metadata.gz: 4a41802c8c2826165bac75b6823b387e790d352a
+  data.tar.gz: 0f39093c175f81d1b7bc083806e60d698ff19383
 SHA512:
-  metadata.gz: 433c03fcac14ac9d7bbbc57ed8529e692eeac165c4ec4b3eddedb0c13131a173b8b4cf69df4687b411efb9a44dd5465b233bfe6180358ef1ef8165a8a9156430
-  data.tar.gz: 7b89243ad24cc1a64ca94ba6417ff71fb6d017b0c077ceaa9f0c868de92500ddc77b81d1c77899c181465b59665dad9c5c48984d3f872074af8be15643b9cb09
+  metadata.gz: 9277801e0dd1ed753a207bd6897b45a1029ab0a726668ef9dac3b74be5755d3c011d6af48fd57bce706ca8addbba6fd444d21d648c7b9f111776bf40a1b2657f
+  data.tar.gz: 40f2dd4bfe666f316e34528d82a2c504373c131e5f605bf7bd08a7e9bfd5611f619503cb2e2d73c9fe5cd641dd0155edd23ef3c394034893ba3ab970012cb74e

data/.byebug_history

@@ -0,0 +1,33 @@
+step 200000000
+exit
+(BridgeAPI.rate_limit_min - current_limit)
+((BridgeAPI.rate_limit_min - current_limit) / 5)
+((BridgeAPI.rate_limit_min - current_limit) / 5).ceil
+step 200000000
+((BridgeAPI.rate_limit_min - current_limit) / 5).ceil
+((BridgeAPI.rate_limit_min - current_limit) / 5)
+step 20000000
+exit
+config
+step 20000000
+step 20000000\
+step 20000000
+exit
+current_limit
+step 20000000
+n
+step 20000000
+n
+exit
+BridgeAPI.methods
+self.class.parent
+self.class.superclass
+self.class.base
+self.class.super
+self.class
+self.methods
+self.class::enforce_rate_limits
+self.class::@enforce_rate_limits
+self.class::enforce_rate_limits
+self.class.methods
+self.class

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    bridge_api (0.1.31)
+    bridge_api (0.1.35)
       faraday (~> 0.9.0)
       faraday_middleware (~> 0.9.0)
       footrest (>= 0.5.1)
+      logging (>= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -34,8 +35,13 @@ GEM
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     link_header (0.0.8)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
     method_source (0.9.0)
     minitest (5.11.3)
+    multi_json (1.13.1)
     multipart-post (2.0.0)
     pry (0.11.3)
       coderay (~> 1.1.0)

data/bridge_api.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '~> 0.9.0'
   gem.add_dependency 'footrest', '>= 0.5.1'
+  gem.add_dependency 'logging', '>= 2.2.2'
 end

data/lib/bridge_api.rb

@@ -1,2 +1,40 @@
 require 'bridge_api/version'
 require 'bridge_api/client'
+
+module BridgeAPI
+  class << self
+    require 'logging'
+    attr_writer :enforce_rate_limits, :rate_limit_min, :rate_limits, :max_sleep_seconds, :min_sleep_seconds, :logger
+
+    def configure
+      yield self if block_given?
+    end
+
+    def enforce_rate_limits
+      @enforce_rate_limits ||= false
+    end
+
+    def rate_limit_min
+      @rate_limit_min ||= 30
+    end
+
+    def rate_limits
+      @rate_limits ||= {}
+    end
+
+    def max_sleep_seconds
+      @max_sleep_seconds ||= 60
+    end
+
+    def logger
+      return @logger if defined? @logger
+      @logger = Logging.logger(STDOUT)
+      @logger.level = :debug
+      @logger
+    end
+
+    def min_sleep_seconds
+      @min_sleep_seconds ||= 5
+    end
+  end
+end

data/lib/bridge_api/client.rb

@@ -9,6 +9,10 @@ require 'base64'
 
 module BridgeAPI
   class Client < Footrest::Client
+    require 'bridge_api/api_array'
+
+    attr_accessor :rate_limit_remaining
+
     DATA_DUMP_DOWNLOAD_PATH = '/data_dumps/download'.freeze
     DATA_DUMP_PATH = '/data_dumps'.freeze
     COURSE_TEMPLATE_PATH = '/course_templates'.freeze
@@ -26,16 +30,14 @@ module BridgeAPI
     SUB_ACCOUNT_PATH = '/sub_accounts'.freeze
     SUPPORT_PATH = '/support'.freeze
     ACCOUNT_PATH = '/accounts'.freeze
-    CLONE_OBJECTS_PATH = '/clone_objects'
+    CLONE_OBJECTS_PATH = '/clone_objects'.freeze
     API_VERSION = 1
     API_PATH = '/api'.freeze
     ROLE_PATH = '/roles'.freeze
-    AFFILIATED_SUBACCOUNTS = '/affiliated_sub_accounts'
-    BATCH_PATH = '/batch'
+    AFFILIATED_SUBACCOUNTS = '/affiliated_sub_accounts'.freeze
+    BATCH_PATH = '/batch'.freeze
     RESULT_MAPPING = {}
 
-    require 'bridge_api/api_array'
-
     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)
@@ -43,7 +45,35 @@ module BridgeAPI
 
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      ApiArray.process_response(connection.send(method, &block), self, RESULT_MAPPING)
+      enforce_rate_limits
+      response = connection.send(method, &block)
+      apply_rate_limits(response)
+      ApiArray.process_response(response, self, RESULT_MAPPING)
+    end
+
+    def enforce_rate_limits
+      return unless BridgeAPI.enforce_rate_limits && current_limit
+      return unless current_limit < BridgeAPI::rate_limit_min
+      tts = ((BridgeAPI.rate_limit_min - current_limit) / 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]}'. "\
+        "Sleeping for #{tts} second(s) to catch up ~zzZZ~. "\
+        "Limit Remaining: #{current_limit}"
+      BridgeAPI.logger.debug(message)
+      sleep(tts)
+    end
+
+    def apply_rate_limits(response)
+      self.current_limit = response.headers['x-rate-limit-remaining'].to_i
+    end
+
+    def current_limit
+      BridgeAPI.rate_limits[config[:api_key]]
+    end
+
+    def current_limit=(value)
+      BridgeAPI.rate_limits[config[:api_key]] = value
     end
 
     def set_connection(config)

data/lib/bridge_api/version.rb

@@ -1,3 +1,3 @@
 module BridgeAPI
-  VERSION = '0.1.34'.freeze unless defined?(BridgeAPI::VERSION)
+  VERSION = '0.1.35'.freeze unless defined?(BridgeAPI::VERSION)
 end

data/spec/bridge_api/client_spec.rb

@@ -21,4 +21,11 @@ describe BridgeAPI::Client do
     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')
+    BridgeAPI.enforce_rate_limits = true
+    users = client.get_all_users
+    users = client.get_all_users
+  end
 end

data/spec/support/fake_bridge.rb

@@ -61,6 +61,7 @@ class FakeBridge < Sinatra::Base
   ## Users
 
   get %r{/api/author/users$} do
+    response.headers['x-rate-limit-remaining'] = 29
     get_json_data 200, 'users.json'
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridge_api
 version: !ruby/object:Gem::Version
-  version: 0.1.34
+  version: 0.1.35
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: Ruby gem for interacting with the bridge API
 email:
 - jshaffer@instructure.com
@@ -183,6 +197,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - Dockerfile
 - Gemfile
@@ -321,3 +336,4 @@ test_files:
 - spec/fixtures/users.json
 - spec/support/fake_bridge.rb
 - spec/test_helper.rb
+has_rdoc: