bearcat 1.3.28 → 1.3.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f647eb5f21166dc1aa4383ff33184be11d127b60
-  data.tar.gz: ce49a99cbdb58e448c2738696a8aea07a2cc441d
+  metadata.gz: 5c8d7f5a1481dd58f3e09d2f0be117afb259ab7a
+  data.tar.gz: f1ee6a16c5616fe354a5f0ec7654166531d64663
 SHA512:
-  metadata.gz: 78df1f29163a3d1aa42a1dfdb2801ba5c623000d3e2c3ed644ec2c41fca00ebe3fcc4048c62217a584600fc6952ba5d70adfc51512a3bba836e80a5aa485d535
-  data.tar.gz: a128860bd32263d21ddceee32fced977f3b86016609022dc3b3757d8a2a3ef6592398ded9d6c4215ded32d2fb3be394c76100a531738d3ec7bc9b92fe02351c4
+  metadata.gz: 1c5567c4f30375c5ab1db0a9f1f36d48e81beffcf28caccfb267344ee2ccd0376fe4643dc0341cf7b9d46f1e8ef005b92c88961b614139321194e102d68d5eef
+  data.tar.gz: 02abd72f687e7ac98b4b3fd1c6e8544fdbd16a0aec704cfa0816e185c3902bc5b8e733153bbc95971d4f64d800c178926ff88e5631cae52df578c4a80045de02

data/bearcat.gemspec

@@ -24,5 +24,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "webmock"
   gem.add_development_dependency 'pry'
 
+  gem.add_dependency "activesupport"
   gem.add_dependency "footrest", ">= 0.2.2"
+  gem.add_dependency "logging", ">= 2.2.2"
+  gem.add_dependency "paul_walker", "~> 0.1.1"
 end

data/lib/bearcat.rb

@@ -1,2 +1,54 @@
 require 'bearcat/version'
 require 'bearcat/client'
+
+module Bearcat
+  class << self
+    require 'logging'
+    attr_writer :enforce_rate_limits, :rate_limit_min, :rate_limits, :max_sleep_seconds,
+                :min_sleep_seconds, :logger, :master_rate_limit, :master_mutex,
+                :rate_limit_threshold
+
+    def configure
+      yield self if block_given?
+    end
+
+    def rate_limit_min
+      @rate_limit_min ||= 175
+    end
+
+    def enforce_rate_limits
+      @enforce_rate_limits ||= false
+    end
+
+    def rate_limits
+      @rate_limits ||= {}
+    end
+
+    def max_sleep_seconds
+      @max_sleep_seconds ||= 60
+    end
+
+    def master_rate_limit
+      @master_rate_limit ||= false
+    end
+
+    def master_mutex
+      @master_mutex ||= Mutex.new
+    end
+
+    def rate_limit_threshold
+      @rate_limit_threshold ||= 125
+    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/bearcat/api_array.rb

@@ -19,12 +19,12 @@ module Bearcat
       @array_key = array_key
       @page_count = 100
       case response.status
-        when 200..206
-          @members = process_body(response)
-          @status = response.status
-          @headers = response.headers
-          @method = response.env[:method]
-          init_pages(@headers['Link'])
+      when 200..206
+        @members = process_body(response)
+        @status = response.status
+        @headers = response.headers
+        @method = response.env[:method]
+        init_pages(@headers['Link'])
       end
     end
 

data/lib/bearcat/client.rb

@@ -1,4 +1,7 @@
+require 'active_support/core_ext/hash'
 require 'footrest/client'
+require 'paul_walker'
+
 module Bearcat
   class Client < Footrest::Client
     require 'bearcat/api_array'
@@ -70,11 +73,64 @@ module Bearcat
     include CustomGradebookColumns
     include ExternalTools
 
-
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      ApiArray::process_response(connection.send(method, &block), self)
+      enforce_rate_limits
+      response = connection.send(method, &block)
+      apply_rate_limits(response.headers['x-rate-limit-remaining'])
+      ApiArray.process_response(response, self)
+    end
+
+    def enforce_rate_limits
+      return unless limit_remaining.present?
+      return unless limit_remaining < Bearcat.rate_limit_min
+
+      tts = ((Bearcat.rate_limit_min - limit_remaining) / 5).ceil
+      tts = Bearcat.min_sleep_seconds if tts < Bearcat.min_sleep_seconds
+      tts = Bearcat.max_sleep_seconds if tts > Bearcat.max_sleep_seconds
+
+
+      message = "Canvas API rate limit minimum #{Bearcat.rate_limit_min} reached. "\
+        "Sleeping for #{tts} second(s) to catch up ~zzZZ~. "\
+        "Limit Remaining: #{limit_remaining}"
+      Bearcat.logger.debug(message)
+
+      sleep(tts)
     end
-  end
 
+    def apply_rate_limits(limit)
+      return if limit.nil?
+      self.limit_remaining = limit.to_i
+    end
+
+    def using_master_rate_limit?
+      config[:master_rate_limit].present? || Bearcat.master_rate_limit.present?
+    end
+
+    def limit_remaining
+      if using_master_rate_limit?
+        Bearcat.master_mutex.synchronize do
+          limit = PaulWalker::RateLimit.get(config[:token], config[:token])
+          if limit.nil?
+            PaulWalker::RateLimit.add(config[:token], config[:token], 0, Bearcat::rate_limit_min)
+            limit = { current: 0 }.with_indifferent_access
+          end
+          Bearcat.logger.debug limit['current'].to_s
+          limit['current']
+        end
+      else
+        Bearcat.rate_limits[config[:token]]
+      end
+    end
+
+    def limit_remaining=(value)
+      if using_master_rate_limit?
+        Bearcat.master_mutex.synchronize do
+          PaulWalker::RateLimit.add(config[:token], config[:token], value, Bearcat::rate_limit_min)
+        end
+      else
+        Bearcat.rate_limits[config[:token]] = value
+      end
+    end
+  end
 end

data/lib/bearcat/client/folders.rb

@@ -5,6 +5,10 @@ module Bearcat
       def list_course_folders(course, params = {})
         get("/api/v1/courses/#{course}/folders", params)
       end
+
+      def create_course_folder(course, params = {})
+        post("/api/v1/courses/#{course}/folders", params)
+      end
     end
   end
 end

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.3.28' unless defined?(Bearcat::VERSION)
+  VERSION = '1.3.30' unless defined?(Bearcat::VERSION)
 end

data/spec/bearcat/client/folders_spec.rb

@@ -9,4 +9,10 @@ describe Bearcat::Client::Folders do
     expect(folders.map { |f| f['id'] }).to eql [1, 593]
     expect(folders.map { |f| f['full_name'] }).to eql ['course files', 'course files/folder1']
   end
+
+  it 'creates a new folder in a course' do
+    resp = stub_post(client, '/api/v1/courses/7/folders').to_return(json_response('course_folder.json'))
+    folder = client.create_course_folder(7, {name: 'new folder'})
+    expect(folder['name']).to eql('new folder')
+  end
 end

data/spec/fixtures/course_folder.json

@@ -0,0 +1,21 @@
+{
+  "context_id": 1,
+  "context_type": "Course",
+  "created_at": "2015-04-28T19:14:58Z",
+  "full_name": "new folder",
+  "id": 3,
+  "lock_at": null,
+  "name": "new folder",
+  "parent_folder_id": null,
+  "position": null,
+  "unlock_at": null,
+  "updated_at": "2015-04-28T19:14:58Z",
+  "locked": false,
+  "folders_url": "http://localhost:3000/api/v1/folders/1/folders",
+  "files_url": "http://localhost:3000/api/v1/folders/1/files",
+  "files_count": 2,
+  "folders_count": 1,
+  "hidden": null,
+  "locked_for_user": false,
+  "hidden_for_user": false
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.3.28
+  version: 1.3.30
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: footrest
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !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
+- !ruby/object:Gem::Dependency
+  name: paul_walker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 description: Ruby interface for interacting with the canvas API
 email:
 - nathanm@instructure.com, jake@instructure.com
@@ -219,6 +261,7 @@ files:
 - spec/fixtures/course_copy.json
 - spec/fixtures/course_enrollments.json
 - spec/fixtures/course_files.json
+- spec/fixtures/course_folder.json
 - spec/fixtures/course_folders.json
 - spec/fixtures/course_grading_standards.json
 - spec/fixtures/course_groups.json
@@ -380,6 +423,7 @@ test_files:
 - spec/fixtures/course_files.json
 - spec/fixtures/assignment_section_override.json
 - spec/fixtures/delete_course.json
+- spec/fixtures/course_folder.json
 - spec/fixtures/ok.json
 - spec/fixtures/account_sub_accounts.json
 - spec/fixtures/course_sections.json