bearcat 1.4.8 → 1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9b90ec8e90ea31d17bebe5b08edbb4af296b201af79c052250c2655dedf734e6
-  data.tar.gz: db220f338bdcd6ad166fed415080eb7f65367c6db99e13781ad3b1cc1335be2e
+SHA1:
+  metadata.gz: 65992dcbb43af93a7a7f34bdf322bd82dd7ee45c
+  data.tar.gz: 3bf3d5f3e0849977b01b64df3c544519c2da928c
 SHA512:
-  metadata.gz: 6c3ada3e912c59d97757232c5451cc5ffc5fc1f289d3009d8a1e71cc24e556d0529b43742778b94ded2a73294a7bae7043dd302720e82f755cdbd2e5e930c10f
-  data.tar.gz: 6cbe47361dbfcb48cefc96353cf2cd34fc5e6974cbbaa673dc04b4363ed0d14669b3ed6c02b567a5266e08fdb1ede99402a498c7630b0a0ba38f2976cb96a40c
+  metadata.gz: 2936b59a7848832d98927f55e16abcce88f975a48319acaa2d8888ac5fe0ddb3e824f2eb1b638c44e0adeb0e5269eb6dd1304b0866feefca1714ce4c2c58565e
+  data.tar.gz: 1f176cce865ed38077e99e8a4960a09953d9c62bc0dbf7e0353caf8d1fc281152764ffbe05321ad13c01986b148c7f5154c20dee1096ab44ec444692cbb360c8

data/lib/bearcat/client/file_helper.rb

@@ -1,40 +1,43 @@
-module FileHelper
+module Bearcat
+  class Client < Footrest::Client
+    module FileHelper
+      def file_params(file_path)
+        {
+          size: File.open(file_path).size,
+          name: File.basename(file_path)
+        }
+      end
 
-  def file_params(file_path)
-    {
-      size: File.open(file_path).size,
-      name: File.basename(file_path)
-    }
-  end
-
-  def declare_file(api_path, params)
-    post(api_path, params)
-  end
+      def declare_file(api_path, params)
+        post(api_path, params)
+      end
 
-  def post_file(url, params, file_path)
-    params['Filename'] = File.basename(file_path)
-    params['file'] = Faraday::UploadIO.new(file_path, params['content-type'])
-    response = upload_connection.post(url, params)
-    if [201, 302, 303].include? response.status #success if it is a redirect or 201
-      response.headers['Location']
-    else
-      raise 'FailedFileUpload'
-    end
-  end
+      def post_file(url, params, file_path)
+        params['Filename'] = File.basename(file_path)
+        params['file'] = Faraday::UploadIO.new(file_path, params['content-type'])
+        response = upload_connection.post(url, params)
+        if [201, 302, 303].include? response.status #success if it is a redirect or 201
+          response.headers['Location']
+        else
+          raise 'FailedFileUpload'
+        end
+      end
 
-  def confirm_file_upload(url)
-    uri = URI(url)
-    query = uri.query
-    query.blank? ? get(uri.path) : get(uri.path, CGI::parse(query))
-  end
+      def confirm_file_upload(url)
+        uri = URI(url)
+        query = uri.query
+        query.blank? ? get(uri.path) : get(uri.path, CGI::parse(query))
+      end
 
-  def upload_connection
-    Faraday.new do |f|
-      f.options[:open_timeout] = ENV.fetch('FARADAY_OPEN_TIMEOUT', 60).to_i
-      f.options[:timeout] = ENV.fetch('FARADAY_TIMEOUT', 60).to_i
-      f.request :multipart
-      f.request :url_encoded
-      f.adapter :net_http
+      def upload_connection
+        Faraday.new do |f|
+          f.options[:open_timeout] = ENV.fetch('FARADAY_OPEN_TIMEOUT', 60).to_i
+          f.options[:timeout] = ENV.fetch('FARADAY_TIMEOUT', 60).to_i
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter :net_http
+        end
+      end
     end
   end
 end

data/lib/bearcat/client/outcome_imports.rb

@@ -0,0 +1,48 @@
+module Bearcat
+  class Client < Footrest::Client
+    module OutcomeImports
+
+      def import_outcomes(file_path, params={})
+        params = params.with_indifferent_access
+        params['attachment'] = Faraday::UploadIO.new(file_path, 'text/csv')
+        url = "api/v1/#{outcome_import_context_slug(params)}"
+        url += "group/#{params[:group]}/" if params[:group].present?
+        params.delete(:group)
+        post(url, params)
+      end
+
+      def outcome_import_status(id, params={})
+        params = params.with_indifferent_access
+        get("api/v1/#{outcome_import_context_slug(params)}#{id}", params)
+      end
+
+      def outcome_import_created_group_ids(id, params={})
+        params = params.with_indifferent_access
+        get("api/v1/#{outcome_import_context_slug(params)}#{id}/created_group_ids", params)
+      end
+
+      protected
+
+      def outcome_import_context_slug(params)
+        context_hash = params.select { |k, _| k == "account" || k == "course" }
+
+        if context_hash.keys.count > 1
+          raise ArgumentError, "cannot have account and course in params"
+        elsif context_hash.empty?
+          "accounts/self/outcome_imports/"
+        else
+          context_hash_key = context_hash.keys.first
+          case context_hash_key
+            when 'account'
+              params.delete(:account)
+              "accounts/#{context_hash[context_hash_key]}/outcome_imports/"
+            when 'course'
+              params.delete(:course)
+              "courses/#{context_hash[context_hash_key]}/outcome_imports/"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/pages.rb

@@ -17,7 +17,14 @@ module Bearcat
       def show_group_page(group, url, params={})
         get("/api/v1/groups/#{group}/pages/#{url}", params)
       end
-      
+
+      def add_course_page(course, params={})
+        post("api/v1/courses/#{course}/pages", params)
+      end
+
+      def add_group_page(group, params={})
+        post("/api/v1/groups/#{group}/pages", params)
+      end
     end
   end
 end

data/lib/bearcat/client.rb

@@ -5,89 +5,13 @@ require 'paul_walker'
 module Bearcat
   class Client < Footrest::Client
     require 'bearcat/api_array'
-    require 'bearcat/client/file_helper'
-    require 'bearcat/client/assignments'
-    require 'bearcat/client/blueprint_courses'
-    require 'bearcat/client/courses'
-    require 'bearcat/client/enrollments'
-    require 'bearcat/client/outcome_groups'
-    require 'bearcat/client/outcomes'
-    require 'bearcat/client/sections'
-    require 'bearcat/client/o_auth2'
-    require 'bearcat/client/groups'
-    require 'bearcat/client/group_categories'
-    require 'bearcat/client/group_memberships'
-    require 'bearcat/client/conferences'
-    require 'bearcat/client/users'
-    require 'bearcat/client/reports'
-    require 'bearcat/client/accounts'
-    require 'bearcat/client/submissions'
-    require 'bearcat/client/conversations'
-    require 'bearcat/client/modules'
-    require 'bearcat/client/canvas_files'
-    require 'bearcat/client/calendar_events'
-    require 'bearcat/client/discussions'
-    require 'bearcat/client/search'
-    require 'bearcat/client/quizzes'
-    require 'bearcat/client/assignment_groups'
-    require 'bearcat/client/pages'
-    require 'bearcat/client/files'
-    require 'bearcat/client/folders'
-    require 'bearcat/client/graph_ql'
-    require 'bearcat/client/analytics'
-    require 'bearcat/client/module_items'
-    require 'bearcat/client/content_migrations'
-    require 'bearcat/client/content_exports'
-    require 'bearcat/client/custom_gradebook_columns'
-    require 'bearcat/client/external_tools'
-    require 'bearcat/client/roles'
-    require 'bearcat/client/rubric'
-    require 'bearcat/client/rubric_assessment'
-    require 'bearcat/client/rubric_association'
-    require 'bearcat/client/progresses'
-    require 'bearcat/client/tabs'
 
-    include Assignments
-    include Accounts
-    include Analytics
-    include BlueprintCourses
-    include Courses
-    include Enrollments
-    include OutcomeGroups
-    include Outcomes
-    include Sections
-    include OAuth2
-    include Groups
-    include GroupCategories
-    include GroupMemberships
-    include Conferences
-    include Users
-    include Reports
-    include Submissions
-    include Conversations
-    include Modules
-    include CanvasFiles
-    include CalendarEvents
-    include Discussions
-    include FileHelper
-    include Search
-    include Quizzes
-    include AssignmentGroups
-    include Pages
-    include Files
-    include Folders
-    include GraphQL
-    include ModuleItems
-    include ContentMigrations
-    include ContentExports
-    include CustomGradebookColumns
-    include ExternalTools
-    include Roles
-    include Rubric
-    include RubricAssessment
-    include RubricAssociation
-    include Progresses
-    include Tabs
+    Dir[File.join(__dir__, 'client', '*.rb')].each do |mod|
+      mname = File.basename(mod, '.*').camelize
+      mname = 'GraphQL' if mname == 'GraphQl'
+      require mod
+      include "Bearcat::Client::#{mname}".constantize
+    end
 
     # Override Footrest request for ApiArray support
     def request(method, &block)

data/lib/bearcat/spec_helpers.rb

@@ -7,13 +7,15 @@ require 'bearcat'
 # - `config.include Bearcat::SpecHelpers`
 # This helper requires `gem 'method_source'` in your test group
 module Bearcat::SpecHelpers
+  extend ActiveSupport::Concern
+
   SOURCE_REGEX = /(?<method>get|post|delete|put)\((?<quote>\\?('|"))(?<url>.*)\k<quote>/
 
   # Helper method to Stub Bearcat requests.
   # Automagically parses the Bearcat method source to determine the correct URL to stub.
   # Accepts optional keyword parameters to interpolate specific values into the URL.
   # Returns a mostly-normal Webmock stub (:to_return has been overridden to allow :body to be set to a Hash)
-  def stub_bearcat(endpoint, prefix: nil, **kwargs)
+  def stub_bearcat(endpoint, prefix: nil, method: :auto, **kwargs)
     url = case endpoint
     when Symbol
       ruby_method = Bearcat::Client.instance_method(endpoint)
@@ -43,16 +45,26 @@ module Bearcat::SpecHelpers
     end
 
     url = Regexp.escape(resolve_prefix(prefix)) + url
-    stub = stub_request(match[:method].to_sym, Regexp.new(url))
+    stub = stub_request(method == :auto ? (match ? match[:method].to_sym : :get) : method, Regexp.new(url))
 
     # Override the to_return method to accept a Hash as body:
-    stub.define_singleton_method(:to_return, ->(*resps) {
-      resps.map do |resp|
-        resp[:headers] ||= {}
-        resp[:headers]["Content-Type"] ||= "application/json"
-        resp[:body] = resp[:body].to_json
+    stub.define_singleton_method(:to_return, ->(*resps, &blk) {
+      if blk
+        super do |*args|
+          resp = blk.call(*args)
+          resp[:headers] ||= {}
+          resp[:headers]["Content-Type"] ||= "application/json"
+          resp[:body] = resp[:body].to_json
+          resp
+        end
+      else
+        resps.map do |resp|
+          resp[:headers] ||= {}
+          resp[:headers]["Content-Type"] ||= "application/json"
+          resp[:body] = resp[:body].to_json
+        end
+        super(*resps)
       end
-      super(*resps)
     })
 
     stub

data/lib/bearcat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.4.11
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -162,6 +162,7 @@ files:
 - lib/bearcat/client/modules.rb
 - lib/bearcat/client/o_auth2.rb
 - lib/bearcat/client/outcome_groups.rb
+- lib/bearcat/client/outcome_imports.rb
 - lib/bearcat/client/outcomes.rb
 - lib/bearcat/client/pages.rb
 - lib/bearcat/client/progresses.rb
@@ -382,7 +383,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project:
+rubygems_version: 2.4.5.1
 signing_key:
 specification_version: 4
 summary: Canvas API