bearcat 1.0.0 → 1.5.24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8dfc188f90b9e9ecbb6dca39381af0881c04279c2e28a51dc37155e396411589
+  data.tar.gz: e315e2df134089927326d0a36654fee28b01d85c8c556c1dfe33992e4c5a9924
+SHA512:
+  metadata.gz: 40722c095a27ed44dbd42e9a0152a4791d6f8d3e3e045762085f59fc0dba02cc487ba43f534cccc4d703a6a85cb1b6ad4e1ca32c45205a0c579589b65dfb4047
+  data.tar.gz: a0593f571e593bfe1faa313ccc4692900e693377a31d8c292f44dca68d0141ea0411554b3232dbb48aa06d52f9a2cc4730135188e99b7eef0ce632b93495722b

data/bearcat.gemspec

@@ -2,27 +2,37 @@
 # spec/fixtures/bearcat.jpg Attribution: TassiloRau at the German language Wikipedia
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bearcat/version'
+
+begin
+  require 'bearcat/version'
+  version = Bearcat::VERSION
+rescue LoadError
+  version = "0.0.0.docker"
+end
 
 Gem::Specification.new do |gem|
-  gem.authors =       ["Nathan Mills, Jake Sorce"]
-  gem.email =         ["nathanm@instructure.com, jake@instructure.com"]
+  gem.authors =       ["Instructure CustomDev"]
+  gem.email =         ["pseng@instructure.com"]
   gem.description =   %q{Ruby interface for interacting with the canvas API}
   gem.summary =       %q{Canvas API}
 
   gem.files = %w[Rakefile bearcat.gemspec]
-  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("lib/**/*")
   gem.files += Dir.glob("spec/**/*")
   gem.test_files    = Dir.glob("spec/**/*")
   gem.name          = "bearcat"
   gem.require_paths = ["lib"]
-  gem.version       = Bearcat::VERSION
+  gem.version       = version
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "bundler", ">= 1.0.0"
   gem.add_development_dependency "rspec", "~> 2.6"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'sidekiq', "< 7.0"
 
+  gem.add_dependency "activesupport"
   gem.add_dependency "footrest", ">= 0.2.2"
+  gem.add_dependency "connection_pool", ">= 2.2.0", "< 3.0"
+  gem.add_dependency "ffi", "~> 1.16.3"
 end

data/lib/badgrcat/api_array.rb

@@ -0,0 +1,25 @@
+require 'bearcat/api_array'
+
+module Badgrcat
+  class ApiArray < Bearcat::ApiArray
+    def [](key)
+      if key.is_a?(Numeric)
+        super
+      else
+        @raw_response.body[key]
+      end
+    end
+
+    def status
+      self["status"]
+    end
+
+    def self.array_key(response)
+      if response.body.is_a?(Hash) && response.body.key?("result")
+        "result"
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/badgrcat/client/methods.rb

@@ -0,0 +1,54 @@
+module Badgrcat
+  class Client < Footrest::Client
+    module Methods
+      extend Bearcat::Client::ClientModule
+
+      prefix "/v2/issuers" do
+        get :issuers
+        post :create_issuer
+
+        prefix "/:issuer" do
+          get :issuer
+          put :update_issuer
+          delete :delete_issuer
+
+          prefix "/assertions" do
+            get :issuer_assertions
+            post :create_issuer_assertion
+          end
+
+          prefix "/badgeclasses" do
+            get :issuer_badgeclasses
+            post :create_issuer_badgeclass
+          end
+        end
+      end
+
+      prefix "/v2/badgeclasses" do
+        get :badgeclasses
+        post :create_badgeclass
+
+        prefix "/:badgeclass" do
+          get :badgeclass
+          put :update_badgeclass
+          delete :delete_badgeclass
+
+          prefix "/assertions" do
+            get :badgeclass_assertions
+            post :create_badgeclass_assertion
+          end
+        end
+      end
+
+      prefix "/v2/assertions" do
+        post :revoke_assertions, "/revoke"
+
+        prefix "/v2/assertions/:assertion" do
+          get :assertion
+          put :update_assertion
+          delete :delete_assertion
+        end
+      end
+    end
+  end
+end

data/lib/badgrcat/client.rb

@@ -0,0 +1,53 @@
+require 'footrest/client'
+
+module Badgrcat
+  class Client < Footrest::Client
+    require 'badgrcat/api_array' # monkey patch
+
+    Dir[File.join(__dir__, 'client', '*.rb')].each do |mod|
+      mname = File.basename(mod, '.*').camelize
+      require mod
+      include "Badgrcat::Client::#{mname}".constantize
+    end
+
+    # Override Footrest request for ApiArray support
+    def request(method, &block)
+      begin
+        response = connection.send(method, &block)
+      rescue Footrest::HttpError::Unauthorized
+        # Reauthenticate and retry
+        authenticate!
+        response = connection.send(method, &block)
+      end
+
+      Badgrcat::ApiArray.process_response(response, self)
+    end
+
+    def authenticate!
+      connection.headers[:authorization] = nil
+
+      tok_params = {
+        scope: config[:scope],
+        client_id: config[:client_id],
+      }
+
+      if @refresh_token
+        tok_params.merge!({
+          grant_type: "refresh_token",
+          refresh_token: @refresh_token,
+        })
+      else
+        tok_params.merge!({
+          username: config[:username],
+          password: config[:password],
+        })
+      end
+
+      authresp = connection.send(:post, "o/token", tok_params)
+      authdata = authresp.body
+
+      @refresh_token = authdata["refresh_token"].presence || @refresh_token
+      connection.headers[:authorization] = "#{authdata['token_type']} #{authdata['access_token']}"
+    end
+  end
+end

data/lib/badgrcat/version.rb

@@ -0,0 +1,3 @@
+module Badgrcat
+  VERSION = 'bearcat' unless defined?(Badgrcat::VERSION)
+end

data/lib/bearcat/api_array.rb

@@ -1,35 +1,56 @@
+require 'active_support/core_ext/module'
+
 module Bearcat
   class ApiArray
     include Enumerable
 
-    attr_reader :status, :headers, :members
+    attr_reader :raw_response, :members
 
     def self.process_response(response, api_client)
       if response.body.is_a?(Array)
-        ApiArray.new(response, api_client)
+        self.new(response, api_client)
       elsif key = array_key(response)
-        ApiArray.new(response, api_client, key)
+        self.new(response, api_client, key)
+      else
+        make_indifferent(response.body)
+      end
+    end
+
+    def self.make_indifferent(thing)
+      if thing.is_a?(Array)
+        thing.map { |v| make_indifferent(v) }
+      elsif thing.is_a?(Hash)
+        thing.with_indifferent_access
       else
-        response.body
+        thing
       end
     end
 
     def initialize(response, api_client, array_key = nil)
       @api_client = api_client
+      @raw_response = response
       @array_key = array_key
-      @page_count = 100
+      @page_count = nil
+
       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)
+        init_pages
       end
     end
 
-    def [](i)
-      @members[i]
+    delegate :status, :headers, to: :raw_response
+
+    def method
+      raw_response.env[:method]
+    end
+
+    def [](key)
+      if key.is_a?(Numeric)
+        @members[key]
+      else
+        @raw_response.body[key]
+      end
     end
 
     def last
@@ -44,64 +65,61 @@ module Bearcat
       @link_hash['next'] || @link_hash['prev']
     end
 
-    def next_page
-      load_page('next')
-    end
+    def page_count
+      return nil unless @link_hash['last']
 
-    def prev_page
-      load_page('prev')
+      uri = URI.parse(@link_hash['last'])
+      params = CGI.parse(uri.query)
+      params.dig('page', 0)&.to_i || 1
     end
 
-    def first_page
-      load_page('first')
+    %w[next prev first last].each do |rel|
+      define_method :"#{rel}_page" do
+        load_page(rel)
+      end
     end
 
-    def last_page
-      load_page('last')
-    end
+    def each_page(page_count = nil, &block)
+      return to_enum(:each_page, page_count) unless block_given?
 
-    def each_page(page_count = 50, &block)
-      @page_count = page_count
-      block.call(@members)
-      while @link_hash['next']
-        response = get_page(@link_hash['next'])
-        @headers = response.headers
-        @status = response.status
-        @method = response.env[:method]
-        @members = process_body(response)
-        init_pages(@headers[:link])
+      if pages?
+        iterate_pages(page_count) do |page_response|
+          @members = process_body(page_response)
+          break unless @members.present?
+          block.call(@members)
+        end
+      else
         block.call(@members)
       end
-      @link_hash = {}
     end
 
-    def all_pages!(page_count = 50)
+    def all_pages_each(page_count = nil, &block)
+      return to_enum(:all_pages_each, page_count) unless block_given?
+
+      each_page(page_count) do |page|
+        page.each &block
+      end
+    end
+
+    def all_pages!(page_count = nil)
       if pages?
-        @page_count = page_count
-        response = get_page(@link_hash['first'])
-        @headers = response.headers
-        @status = response.status
-        @method = response.env[:method]
-        init_pages(@headers[:link])
-        @members = process_body(response)
-        while @link_hash['next']
-          response = get_page(@link_hash['next'])
-          @headers = response.headers
-          @status = response.status
-          @method = response.env[:method]
-          @members.concat(process_body(response))
-          init_pages(@headers[:link])
+        @members = []
+        iterate_pages(page_count) do |page_response|
+          page_members = process_body(page_response)
+          break unless page_members.present?
+          @members.concat(page_members)
         end
         @link_hash = {}
       end
       self
     end
 
-    private
+    protected
 
-    def init_pages(link_header)
+    def init_pages(link_header = headers[:link])
       @link_hash = {}
-      if @headers.has_key? 'Link'
+      if headers.has_key? 'Link'
+
         links = link_header.split(/,\s?/)
 
         links.each do |link|
@@ -113,12 +131,16 @@ module Bearcat
       end
     end
 
-    def get_page(url, params = {})
-      params['per_page'] = @page_count unless params.has_key? 'per_page' || !@page_count
-      query = URI.parse(url).query
-      p = CGI.parse(query).merge(params)
-      u = url.gsub("?#{query}", '')
-      p.each { |k, v| p[k] = v.first if v.is_a?(Array) }
+    def get_page(url, params = {}, page_size_param: 'per_page')
+      params[page_size_param] = @page_count unless params.key?(page_size_param) || !@page_count
+
+      parsed_url = URI.parse(url)
+      p = parse_url_params(parsed_url)
+      u = url.gsub("?#{parsed_url.query}", '')
+
+      # merge params
+      p.merge!(params)
+
       @api_client.connection.send(:get) do |r|
         r.url(u, p)
       end
@@ -127,10 +149,48 @@ module Bearcat
     def load_page(rel)
       if @link_hash.has_key? rel
         response = get_page(@link_hash[rel])
-        ApiArray.process_response(response, @api_client)
+        self.class.process_response(response, @api_client)
+      end
+    end
+
+    def iterate_pages(per_page = @page_count)
+      return to_enum(:iterate_pages, per_page) unless block_given?
+
+      if per_page.present? && per_page != per_page_count && @link_hash['first']
+        @page_count = per_page
+        @raw_response = response = get_page(@link_hash['first'])
+        yield response
+        init_pages
+      else
+        yield @raw_response
+      end
+
+      while @link_hash['next']
+        @raw_response = response = get_page(@link_hash['next'])
+        yield response
+        init_pages
       end
     end
 
+    def per_page_count
+      url = raw_response.env[:url]
+      query_params = parse_url_params(url)
+      query_params[:per_page]&.to_i
+    end
+
+    def parse_url_params(url)
+      url = URI.parse(url) if url.is_a?(String)
+      p = CGI.parse(url.query || '')
+      p.default = nil
+
+      # strip value out of array if value is an array and key doesn't have [] (parameter is not an array parameter)
+      p.each { |k, v| p[k] = v.first if v.is_a?(Array) && k !~ /\[\]$/ }
+      # remove [] from key names, this is copied from rails' {}.transform_keys!
+      p.keys.each { |k| p[k.delete('[]')] = p.delete(k) }
+
+      p.with_indifferent_access
+    end
+
     #TODO: This is a quick fix for JSONAPI responses if we need to do this for anything else we need to do this a better way
     def self.array_key(response)
       key = nil
@@ -138,7 +198,7 @@ module Bearcat
         path = response.env[:url].path
         if path.match(/.*\/(courses||groups)\/\d+\/conferences/)
           key = 'conferences'
-        elsif path.match(/.*\/accounts\/d+\/terms/)
+        elsif path.match(/.*\/accounts\/(?:(?:\d+~)?\d+|self)\/terms/)
           key = 'enrollment_terms'
         end
       end
@@ -146,12 +206,19 @@ module Bearcat
     end
 
     def process_body(response)
-      if response.body.is_a?(Array)
-        response.body
-      elsif response.body.is_a?(Hash) && @array_key
-        response.body[@array_key]
+      data = response.body
+      if @array_key.is_a?(Proc)
+        data = @array_key.call(data, response)
+      elsif @array_key.present?
+        ak = @array_key
+        ak = ak.split('.') if ak.is_a?(String)
+        ak = Array(ak)
+        data = data.dig(*ak)
       end
-    end
 
+      raise "Response could not be mapped to items" unless data.is_a?(Array)
+
+      self.class.make_indifferent(data)
+    end
   end
 end

data/lib/bearcat/client/account_reports.rb

@@ -1,21 +1,13 @@
 module Bearcat
   class Client
     module AccountReports
+      extend ClientModule
 
-      def available_reports(account, params={})
-        get("/api/v1/accounts/#{account}/reports", params)
-      end
-
-      def start_report(account, report, params)
-        post("api/v1/accounts/#{account}/reports/#{report}", params)
-      end
-
-      def report_index(account, report, params={})
-        get("/api/v1/accounts/#{account}/reports/#{report}", params)
-      end
-
-      def report_status(account, report, report_id)
-        get("/api/v1/accounts/#{account}/reports/#{report}/#{report_id}")
+      prefix "/api/v1/accounts/:account/reports/" do
+        get :available_reports
+        post :start_report, ":report"
+        get :report_index, ":report"
+        get :report_status, ":report/:report_id"
       end
     end
   end

data/lib/bearcat/client/accounts.rb

@@ -1,15 +1,27 @@
 module Bearcat
   class Client < Footrest::Client
     module Accounts
+      extend ClientModule
 
-      def account(account)
-        get("/api/v1/accounts/#{account}")
-      end
+      prefix "/api/v1/accounts/" do
+        get :list_accounts
 
-      def terms(account, params = {})
-        get("/api/v1/accounts/#{account}/terms")
+        prefix ":account/" do
+          get :account
+          get :list_sub_accounts, "sub_accounts"
+          get :terms, "terms"
+          get :account_admins, "admins"
+          post :create_account_admin, "admins"
+          delete :delete_account_admin, "admins/:user"
+          get :list_roles, "roles"
+          get :account_roles, "roles"
+          get :account_courses, "courses"
+          get :account_grading_standards, "grading_standards"
+          get :account_grading_standard, "grading_standards/:grading_standard_id"
+          get :account_sis_imports, "sis_imports"
+          get :enrollment, "enrollments/:enrollment"
+        end
       end
-
     end
   end
 end

data/lib/bearcat/client/analytics.rb

@@ -0,0 +1,12 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Analytics
+      extend ClientModule
+
+      prefix "/api/v1/accounts/:account/analytics/terms/:term/" do
+        get :department_level_participation, "activity"
+        get :department_level_statistics, "statistics"
+      end
+    end
+  end
+end

data/lib/bearcat/client/assignment_groups.rb

@@ -0,0 +1,15 @@
+module Bearcat
+  class Client < Footrest::Client
+    module AssignmentGroups
+      extend ClientModule
+
+      prefix "/api/v1/courses/:course/assignment_groups/" do
+        get :list_assignment_groups
+        post :create_assignment_group
+        get :assignment_group, ":assignment_group_id"
+        put :update_assignment_group, ":assignment_group_id"
+        delete :delete_assignment_group, ":assignment_group_id"
+      end
+    end
+  end
+end

data/lib/bearcat/client/assignments.rb

@@ -1,18 +1,26 @@
 module Bearcat
   class Client < Footrest::Client
     module Assignments
+      extend ClientModule
 
-      def assignments(course, params={})
-        get("/api/v1/courses/#{course}/assignments", params)
-      end
+      prefix "/api/v1/courses/:course/assignments/" do
+        get :assignments, ""
+        post :create_assignment, ""
 
-      def create_assignment_override(course, assignment, params)
-        post("api/v1/courses/#{course}/assignments/#{assignment}/overrides", params)
-      end
+        get :all_assignment_overrides, "overrides"
+        post :batch_create_assignment_overrides, "overrides"
+        put :batch_update_assignment_overrides, "overrides"
+
+        prefix ":assignment/" do
+          get :assignment
+          put :edit_assignment
+          delete :delete_assignment
 
-      def create_assignment(course, params={})
-        post("/api/v1/courses/#{course}/assignments", params)
+          get :assignment_overrides, "overrides"
+          post :create_assignment_override, "overrides"
+          delete :delete_assignment_override, "overrides/:override"
+        end
       end
     end
   end
-end
+end

data/lib/bearcat/client/blueprint_courses.rb

@@ -0,0 +1,25 @@
+module Bearcat
+  class Client < Footrest::Client
+    module BlueprintCourses
+      extend ClientModule
+
+      prefix "/api/v1/courses/:course/" do
+        # Get blueprint information
+        # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.show
+        get :blueprint_template, "blueprint_templates/:template_id", defaults: { template_id: 'default' }
+
+        # List blueprint subscriptions
+        # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.subscriptions_index
+        get :blueprint_subscriptions, "blueprint_subscriptions"
+
+        # Update associated courses
+        # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.update_associations
+        put :blueprint_update_associations, "blueprint_templates/:template_id/update_associations", defaults: { template_id: 'default' }
+
+        # Begin a migration to push to associated courses
+        # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.queue_migration
+        post :start_blueprint_migration, "blueprint_templates/:template_id/migrations", defaults: { template_id: 'default' }
+      end
+    end
+  end
+end

data/lib/bearcat/client/calendar_events.rb

@@ -1,25 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module CalendarEvents
+      extend ClientModule
 
-      def calendar_events(params = {})
-        get("/api/v1/calendar_events", params)
-      end
-
-      def calendar_event(event, params = {})
-        get("/api/v1/calendar_events/#{event}", params)
-      end
-
-      def create_calendar_event(params = {})
-        post("/api/v1/calendar_events", params)
-      end
-
-      def update_calendar_event(event, params = {})
-        put("/api/v1/calendar_events/#{event}", params)
-      end
+      prefix "/api/v1/calendar_events/" do
+        get :calendar_events
+        post :create_calendar_event
 
-      def delete_calendar_event(event, params = {})
-        delete("/api/v1/calendar_events/#{event}", params)
+        prefix ":event/" do
+          get :calendar_event
+          put :update_calendar_event
+          delete :delete_calendar_event
+        end
       end
     end
   end

data/lib/bearcat/client/canvas_files.rb

@@ -1,13 +1,11 @@
 module Bearcat
   class Client < Footrest::Client
     module CanvasFiles
-
       def upload_file(api_path, file_path, params = {})
         declare_response = declare_file(api_path, file_params(file_path).merge(params))
         confirmation_url = post_file(declare_response['upload_url'], declare_response['upload_params'], file_path)
         confirm_file_upload(confirmation_url)
       end
-
     end
   end
 end