bearcat 1.5.39 → 1.6.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 162fc05f04d1d475f69cdd6cab1d449539d288284cb89868487be991922da485
-  data.tar.gz: 936bfa6f545ce8bd7f0fe81c15f938d1232fcbdd3685869caae7e8c47ca7aba0
+  metadata.gz: 88b94b32414c5a59f1fd3be18678f529de9bef97ee3e10116db68062edeebad2
+  data.tar.gz: 62e2edd04e91abc3c4b328e81e54e2f9545be448c62497d01e509c54fd6aeb27
 SHA512:
-  metadata.gz: 63da23efc98f40c13824887429bd5df839054a6d0c28f14ce213745ad7811b2c453f34a9ee1e31871c42928017f9f1fee2d7a02744dc8880c621ba25a3efb6b1
-  data.tar.gz: 77094d36014b3ffded25baf37d58647877ae7689691f673bc2606407be493e1120f388437172ff43ebc2ccce0e55f20d32aeaa576b6ef49e239b4e2add0ca225
+  metadata.gz: 374c77ba34fcc3583710cdf54984a5806d328ed0cc1d23edfed8c90051ab4a1225c079243c50497edeeaeb4eac11979aa794403550d33312a5906ab33f5d1cc2
+  data.tar.gz: cc6690b3e892cafa054c1a4f775d0ee39c3bcf7f8ea0834f023c345c8e6416e22c03aa40f2bb1dbd9605f91ef6d48db3a7a2fd811b70b24913b6bc254d1cd4ed

data/lib/badgrcat/client/methods.rb

@@ -71,18 +71,6 @@ module Badgrcat
           delete :delete_assertion
         end
       end
-
-      prefix "v2/backpack" do
-        prefix "/assertions" do
-          get :backpack_assertions
-        end
-      end
-
-      prefix "v2/users" do
-        prefix "/self" do
-          get :get_user_profile
-        end
-      end
     end
   end
 end

data/lib/bearcat/api_array.rb

@@ -198,7 +198,7 @@ module Bearcat
         path = response.env[:url].path
         if path.match(/.*\/(courses||groups)\/\d+\/conferences/)
           key = 'conferences'
-        elsif path.match(/.*\/accounts\/[^\/]+\/terms/)
+        elsif path.match(/.*\/accounts\/(?:(?:\d+~)?\d+|self)\/terms/)
           key = 'enrollment_terms'
         end
       end

data/lib/bearcat/client/graph_ql.rb

@@ -1,67 +1,17 @@
 module Bearcat
-  class GraphqlError < StandardError
-    attr_reader :response
-
-    def initialize(message, response: nil)
-      super(message)
-      @response = response
-    end
-  end
-
   class Client < Footrest::Client
-    # Request body format should be:
-    #  - { query: "query string" }
-    #  - "query string"
-    #  - "path/to/gql/file", may be absolute, relative to application root, or relative to `app/graphql`. `.gql` extension is optional.
+    # Request body format should be: { query: "query string" }. More info in README.md
     module GraphQL
-      def graphql_query(query, args = {})
-        if query.is_a?(String)
-          if /\A\w+\Z/.match?(query) && !query.include?("{")
-            query = query.underscore
-            @@gql_cache ||= {}
-
-            query = cache_on_class("gql:#{query}") do
-              paths = []
-
-              pn = Pathname.new(query)
-              if pn.absolute?
-                paths << query
-              else
-                paths << Rails.root.join("app", "graphql", query)
-                paths << Rails.root.join(query)
-              end
-
-              paths = paths.flat_map do |path|
-                [path, "#{path}.gql"]
-              end
-
-              query = paths.find do |path|
-                File.exist?(path)
-              end
-
-              File.read(query)
-            end
-          end
-
-          args.symbolize_keys!
-
-          query = query.gsub(/\{\{(.*?)\}\}/) do |_m|
-            match = Regexp.last_match
-            key = match[1].strip.to_sym
-            args[key]
-          end
 
+      def graphql_query(query)
+        if query.is_a?(String)
           query = {
             query: query
           }
         end
-
-        result = post('/api/graphql', query)
-        raise GraphqlError.new("Error running GraphQL query:\n#{result["errors"].to_json}", response: result) if result["errors"].present?
-
-        # TODO: It'd be nice to unwrap and return result["data"] directly, but we want to keep backwards compatibility
-        result
+        post('/api/graphql', query)
       end
+
     end
   end
 end

data/lib/bearcat/client/reports.rb

@@ -5,29 +5,50 @@ module Bearcat
     module Reports
       extend ClientModule
 
-      prefix "/api/v1/accounts/:account/reports/" do
+      PREFIX = "/api/v1/accounts"
+
+      prefix "#{PREFIX}/:account/reports/" do
         get :report_list
-        post :start_report, ":report_name"
         get :report_history, ":report_name"
         get :report_status, ":report_name/:report_id"
         delete :delete_report, ":report_name/:report_id"
       end
 
-      def download_report(url, save_location=nil)
-        require 'open-uri'
-        open_uri_stream = URI.open(url, {
-          'User-Agent' => "Bearcat/#{Bearcat::VERSION} (#{RUBY_PLATFORM})",
-          'Authorization' => "Bearer #{config[:token]}"
-        })
+      def start_report(canvas_account_id, report_name, payload)
+        post("#{PREFIX}/#{canvas_account_id}/reports/#{report_name}", payload)
+      rescue Bearcat::MiscExceptions::Conflict => e
+        JSON.parse(e.response.response_body)
+      end
 
+      def download_report(url, save_location=nil)
+        #This method takes the verified URL returned in a Canvas report (attachment['url']), and if
+        #a save_location is included, it will download it in chunks to the disk to save memory.  You
+        #can also download the report to memory if you do not include a save location.
+        attempts = 0
+        begin
+          uri = URI.parse(url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true if url.start_with?('https')
+          response = http.head(uri.to_s)
+          url = response['Location']
+          attempts += 1
+        end while attempts <= 5 && (response.code == '301' || response.code == '302' || response.code == '307')
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.to_s.start_with?('https')
         if save_location
-          save_location = save_location.path if save_location.respond_to?(:path)
-          IO.copy_stream(open_uri_stream, save_location)
-          save_location
+          File.open(save_location, 'wb') do |file|
+            http.request_get(uri.to_s) do |resp|
+              resp.read_body do |segment|
+                file.write(segment)
+              end
+            end
+          end
         else
-          CSV.parse(open_uri_stream.read, headers: true)
+          response = http.request_get(uri.to_s)
+          CSV.parse(response.read_body, headers: true)
         end
       end
+
     end
   end
 end

data/lib/bearcat/client.rb

@@ -37,19 +37,9 @@ module Bearcat
       super
       connection.builder.insert(Footrest::RaiseFootrestErrors, ExtendedRaiseFootrestErrors)
       connection.builder.delete(Footrest::RaiseFootrestErrors)
-    end
-
-    def self.cache_on_self(key, &block)
-      @cache ||= {}
-      if Rails.env.development? || Rails.env.test?
-        block.call
-      else
-        @cache[key] ||= block.call
-      end
-    end
 
-    def cache_on_class(key, &block)
-      self.class.cache_on_self(key, &block)
+      connection.builder.insert(Faraday::Request::UrlEncoded, Faraday::Request::JSON)
+      connection.builder.delete(Faraday::Request::UrlEncoded)
     end
 
     protected

data/lib/bearcat/misc_exceptions/conflict.rb

@@ -0,0 +1,10 @@
+module Bearcat
+  module MiscExceptions
+    # This exception is not part of the Footrest::HttpError module
+    class Conflict < Footrest::HttpError::BadRequest
+      def self.===(exception)
+        exception.status == 409
+      end
+    end
+  end
+end

data/lib/bearcat/redis_connection.rb

@@ -11,8 +11,8 @@ module Bearcat
     KNOWN_REDIS_URL_ENVS = %w[REDIS_URL REDISTOGO_URL REDISCLOUD_URL].freeze
 
     class << self
-      def configured?(prefix, explicit: true)
-        determine_redis_provider(prefix: prefix, explicit: explicit).present?
+      def configured?(prefix, explicit: false)
+        determine_redis_provider(prefix: prefix, explicit: true)
       end
 
       def create(options = {})

data/lib/bearcat/spec_helpers.rb

@@ -97,13 +97,10 @@ module Bearcat::SpecHelpers
       end
     when String
       raise "Cannot use method :auto when passing string endpoint" if method == :auto
-      endpoint = Regexp.escape(endpoint)
-      endpoint = endpoint.gsub("\\*\\*", ".+")
-      endpoint = endpoint.gsub("\\*", "[^/]+")
-      { method: method, url: endpoint }
+      { method: method, url: Regexp.escape(endpoint) }
     when Regexp
       raise "Cannot use method :auto when passing regex endpoint" if method == :auto
-      { method: method, url: endpoint.to_s }
+      { method: method, url: Regexp.escape(endpoint) }
     end
   end
 

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.5.39' unless defined?(Bearcat::VERSION)
+  VERSION = '1.6.0.beta1' unless defined?(Bearcat::VERSION)
 end

data/lib/bearcat.rb

@@ -1,21 +1,18 @@
 require 'bearcat/version'
 require 'bearcat/client'
-require 'bearcat/redis_connection'
+require 'bearcat/misc_exceptions/conflict'
 
 module Bearcat
   class << self
     require 'logger'
     attr_accessor :master_rate_limit
-    attr_writer :rate_limit_min, :rate_limits, :max_sleep_seconds,
-                :min_sleep_seconds, :logger, :rate_limiter
+    attr_writer :rate_limit_min, :rate_limits, :max_sleep_seconds, :min_sleep_seconds, :logger
 
     def configure
       yield self if block_given?
     end
 
-    def rate_limiter
-      @rate_limiter
-    end
+    attr_accessor :rate_limiter
 
     def rate_limit_min
       @rate_limit_min ||= 175
@@ -31,6 +28,7 @@ module Bearcat
 
     def logger
       return @logger if defined? @logger
+
       @logger = Logger.new(STDOUT)
       @logger.level = Logger::DEBUG
       @logger
@@ -38,14 +36,13 @@ module Bearcat
 
     def redis_pool
       require 'bearcat/redis_connection'
-      @redis_pool ||= Bearcat::RedisConnection.create(env_prefix: "BEARCAT")
+      @redis_pool ||= Bearcat::RedisConnection.create(env_prefix: 'BEARCAT')
     end
 
-    def redis
-      raise ArgumentError, "requires a block" unless block_given?
-      redis_pool.with do |conn|
-        yield conn
-      end
+    def redis(&block)
+      raise ArgumentError, 'requires a block' unless block_given?
+
+      redis_pool.with(&block)
     end
   end
 end

data/spec/bearcat/client/reports_spec.rb

@@ -48,6 +48,7 @@ describe Bearcat::Client::Reports do
     it 'downloads a report to disk' do
       report = IO.read(fixture('file.csv'))
       tempfile = Tempfile.new('report')
+      stub_request(:head, 'https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string').to_return(status: 200, body: report)
       stub_request(:get,'https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string').to_return(status: 200, body: report)
       @client.download_report('https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string', tempfile)
       csv = CSV.read(tempfile, headers: true)
@@ -58,10 +59,12 @@ describe Bearcat::Client::Reports do
     it 'follows redirects' do
       report = IO.read(fixture('file.csv'))
       tempfile = Tempfile.new('report')
-      stub_request(:get, 'https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string')
+      stub_request(:head, 'https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string')
         .to_return(status: 302, body: 'You are being redirected',headers: {'Location' => 'https://cluster1-files.instructure.com/files/1/download?download_frd=1&sf_verifier=verifier=1478139862&user_id=1&verifier=verifier'})
-      stub_request(:get, 'https://cluster1-files.instructure.com/files/1/download?download_frd=1&sf_verifier=verifier=1478139862&user_id=1&verifier=verifier')
+      stub_request(:head, 'https://cluster1-files.instructure.com/files/1/download?download_frd=1&sf_verifier=verifier=1478139862&user_id=1&verifier=verifier')
         .to_return(status: 302, body: 'You are being redirected', headers: {'Location' => 'https://instructure-uploads.s3.amazonaws.com/account_1/attachments/1/assignment_submission.csv'})
+      stub_request(:head, 'https://instructure-uploads.s3.amazonaws.com/account_1/attachments/1/assignment_submission.csv')
+        .to_return(status: 200)
       stub_request(:get, 'https://instructure-uploads.s3.amazonaws.com/account_1/attachments/1/assignment_submission.csv')
         .to_return(status: 200, body: report)
       @client.download_report('https://canvas.instructure.com/files/1/download?download_frd=1&verifier=string', tempfile)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.5.39
+  version: 1.6.0.beta1
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -219,6 +219,7 @@ files:
 - lib/bearcat/client/tabs.rb
 - lib/bearcat/client/users.rb
 - lib/bearcat/client_module.rb
+- lib/bearcat/misc_exceptions/conflict.rb
 - lib/bearcat/rate_limiting.rb
 - lib/bearcat/rate_limiting/functions.lua
 - lib/bearcat/rate_limiting/increment_bucket.lua
@@ -444,7 +445,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Canvas API
 test_files: