bearcat 1.4.13 → 1.5.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56127337ffe67a0c9a01aa12a8c7d858331c49a8c608c2ec7e82de2b10abaadc
-  data.tar.gz: ef63a06ce0fc281a255763afbd1d7e0d07e85b2d40bf2a45b01a4a41f21efb1b
+  metadata.gz: dfa0e208c1e9c27cf47f857f4830167fe833c966cb96eebfb3df5b9edcc1d407
+  data.tar.gz: 2a06fb44fbbf24b35be34943782aaedb6357d1a98b6031a9ce2cc24a8be91801
 SHA512:
-  metadata.gz: 9dee94f956ca584cc6c0d892277e424430f81c62074106f040fe92974d926b5df72dc8b57d7e3f84dff64d135ba274967da32110bb8201aee061715b331b4969
-  data.tar.gz: 114bbcc3a2374c8b8774da933c412ea73f57a9adb0273a5d1683ee4949fd077088bdb12ca91e430011cda1740023a4c9b480a45c573c9685ee30a9215488d2c0
+  metadata.gz: 9f78f3fe0c128b86553b7748e58fd17e4ccbe124709c6bf7d1446781f7fdb1f758577d181d4957925a7b006c6e09ec43ca7616bc6f696d5b678e7f8bd253505a
+  data.tar.gz: 736439d3fe242e26c77389230ab7e262c98de5b7f0802cd4a5bc061f178b4f24f90b342b339c5e5852eae75c462c799202b130d67f4d16c87045508593eb76c1

data/bearcat.gemspec

@@ -2,7 +2,13 @@
 # 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"]
@@ -16,15 +22,15 @@ Gem::Specification.new do |gem|
   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 "paul_walker", "~> 0.1.1"
 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,63 +1,27 @@
 module Bearcat
   class Client < Footrest::Client
     module Accounts
-
-      def list_accounts(params = {})
-        get("/api/v1/accounts", params)
-      end
-
-      def account(account)
-        get("/api/v1/accounts/#{account}")
-      end
-
-      def list_sub_accounts(account, params = {})
-        get("api/v1/accounts/#{account}/sub_accounts", params)
-      end
-
-      def terms(account, params = {})
-        get("/api/v1/accounts/#{account}/terms", params)
-      end
-
-      def account_admins(account, params = {})
-        get("/api/v1/accounts/#{account}/admins", params)
-      end
-
-      def create_account_admin(account, params = {})
-        post("/api/v1/accounts/#{account}/admins", params)
-      end
-
-      def delete_account_admin(account, user, params = {})
-        delete("/api/v1/accounts/#{account}/admins/#{user}", params)
-      end
-
-      def list_roles(account, params = {})
-        get("/api/v1/accounts/#{account}/roles", params)
-      end
-
-      def account_roles(account, params = {})
-        get("/api/v1/accounts/#{account}/roles", params)
-      end
-
-      def account_courses(account, params = {})
-        get("/api/v1/accounts/#{account}/courses", params)
-      end
-
-      def account_grading_standards(account, params={})
-        get("/api/v1/accounts/#{account}/grading_standards", params)
+      extend ClientModule
+
+      prefix "/api/v1/accounts/" do
+        get :list_accounts
+
+        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
-
-      def account_grading_standard(account, grading_standard_id, params={})
-        get("/api/v1/accounts/#{account}/grading_standards/#{grading_standard_id}", params)
-      end
-
-      def account_sis_imports(account, params={})
-        get("/api/v1/accounts/#{account}/sis_imports", params)
-      end
-
-      def enrollment(account, enrollment, params={})
-        get("/api/v1/accounts/#{account.to_s}/enrollments/#{enrollment.to_s}", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/analytics.rb

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

data/lib/bearcat/client/assignment_groups.rb

@@ -1,27 +1,15 @@
 module Bearcat
   class Client < Footrest::Client
     module AssignmentGroups
+      extend ClientModule
 
-      def list_assignment_groups(course, params={})
-        get("/api/v1/courses/#{course}/assignment_groups", params)
+      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
-
-      def assignment_group(course_id, assignment_group_id, params={})
-        get("/api/v1/courses/#{course_id}/assignment_groups/#{assignment_group_id}", params)
-      end
-
-      def create_assignment_group(course, params={})
-        post("/api/v1/courses/#{course}/assignment_groups", params)
-      end
-
-      def update_assignment_group(course, assignment_group_id, params={})
-        put("/api/v1/courses/#{course}/assignment_groups/#{assignment_group_id}", params)
-      end
-
-      def delete_assignment_group(course, assignment_group_id, params={})
-        delete("/api/v1/courses/#{course}/assignment_groups/#{assignment_group_id}", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/assignments.rb

@@ -1,49 +1,25 @@
 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 assignment(course, assignment, params={})
-        get("/api/v1/courses/#{course}/assignments/#{assignment}", params)
-      end
+        get :all_assignment_overrides, "overrides"
+        post :batch_create_assignment_overrides, "overrides"
+        put :batch_update_assignment_overrides, "overrides"
 
-      def assignment_overrides(course, assignment)
-        get("/api/v1/courses/#{course}/assignments/#{assignment}/overrides")
-      end
-
-      def all_assignment_overrides(course_id)
-        get("/api/v1/courses/#{course_id}/assignments/overrides")
-      end
-
-      def create_assignment_override(course, assignment, params)
-        post("api/v1/courses/#{course}/assignments/#{assignment}/overrides", params)
-      end
-
-      def delete_assignment_override(course_id, assignment_id, override_id, params={})
-        delete("api/v1/courses/#{course_id}/assignments/#{assignment_id}/overrides/#{override_id}", params)
-      end
-
-      def batch_create_assignment_overrides(course_id, params)
-        post("/api/v1/courses/#{course_id}/assignments/overrides", params)
-      end
-
-      def batch_update_assignment_overrides(course_id, params)
-        put("/api/v1/courses/#{course_id}/assignments/overrides", params)
-      end
-
-      def create_assignment(course, params={})
-        post("/api/v1/courses/#{course}/assignments", params)
-      end
-
-      def edit_assignment(course, assignment, params={})
-        put("/api/v1/courses/#{course}/assignments/#{assignment}", params)
-      end
+        prefix ":assignment/" do
+          get :assignment
+          put :edit_assignment
+          delete :delete_assignment
 
-      def delete_assignment(course, assignment)
-        delete("/api/v1/courses/#{course}/assignments/#{assignment}")
+          get :assignment_overrides, "overrides"
+          post :create_assignment_override, "overrides"
+          delete :delete_assignment_override, "overrides/:override"
+        end
       end
     end
   end

data/lib/bearcat/client/blueprint_courses.rb

@@ -1,31 +1,25 @@
 module Bearcat
   class Client < Footrest::Client
     module BlueprintCourses
+      extend ClientModule
 
-      # Get blueprint information
-      # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.show
-      def blueprint_template(course, template_id='default')
-        get("/api/v1/courses/#{course}/blueprint_templates/#{template_id}")
-      end
+      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
-      def blueprint_subscriptions(course)
-        get("/api/v1/courses/#{course}/blueprint_subscriptions")
-      end
+        # 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
-      def blueprint_update_associations(course, template_id='default', params={})
-        put("/api/v1/courses/#{course}/blueprint_templates/#{template_id}/update_associations", params)
-      end
+        # 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
-      def start_blueprint_migration(course, template_id='default', params={})
-        post("/api/v1/courses/#{course}/blueprint_templates/#{template_id}/migrations", params)
+        # 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

data/lib/bearcat/client/conferences.rb

@@ -1,15 +1,10 @@
 module Bearcat
   class Client < Footrest::Client
     module Conferences
+      extend ClientModule
 
-      def course_conferences(course)
-        get("/api/v1/courses/#{course.to_s}/conferences")
-      end
-
-      def group_conferences(section)
-        get("/api/v1/groups/#{section.to_s}/conferences")
-      end
-
+      get :course_conferences, "/api/v1/courses/:course/conferences"
+      get :group_conferences, "/api/v1/groups/:section/conferences"
     end
   end
 end

data/lib/bearcat/client/conversations.rb

@@ -1,15 +1,10 @@
 module Bearcat
   class Client < Footrest::Client
     module Conversations
+      extend ClientModule
 
-      def create_conversation(params = {})
-        post("/api/v1/conversations", params)
-      end
-
-      def delete_conversation(conversation)
-        delete("/api/v1/conversations/#{conversation.to_s}")
-      end
-
+      post :create_conversation, "/api/v1/conversations"
+      delete :delete_conversation, "/api/v1/conversations/:conversation"
     end
   end
 end

data/lib/bearcat/client/courses.rb

@@ -1,33 +1,25 @@
 module Bearcat
   class Client < Footrest::Client
     module Courses
+      extend ClientModule
 
-      def course(course, params={})
-        get("/api/v1/courses/#{course}", params)
-      end
-
-      def create_course(account_id, params={})
-        post("/api/v1/accounts/#{account_id}/courses", params)
-      end
-
-      def delete_course(course, params={event: :delete})
-        delete("/api/v1/courses/#{course}", params)
-      end
+      post :create_course, "/api/v1/accounts/:account_id/courses"
+      get :list_users_courses, "/api/v1/courses"
 
-      def update_course(course, params={})
-        put("/api/v1/courses/#{course}", params)
-      end
+      prefix "/api/v1/courses/:course/" do
+        get :course
+        put :update_course
+        delete :delete_course, defaults: { event: "delete" }
+        get :list_course_users, "users"
+        post :course_quiz_extensions, "quiz_extensions"
+        get :course_outcome_results, "outcome_results"
 
-      def list_course_users(course, params={})
-        get("/api/v1/courses/#{course}/users", params)
-      end
+        get :course_grading_standards, "grading_standards"
+        get :course_grading_standard, "grading_standards/:grading_standard_id"
+        get :course_gradebook_history, "gradebook_history/feed"
 
-      def course_quiz_extensions(course, params={})
-        post("/api/v1/courses/#{course}/quiz_extensions", params)
-      end
-
-      def course_outcome_results(course, params={})
-        get("/api/v1/courses/#{course}/outcome_results", params)
+        # Performs effectively the same operation as #create_content_migration, but without the need to specify a file to be uploaded
+        post :copy_course, "content_migrations"
       end
 
       def create_content_migration_with_both_responses(course, file_path, params={})
@@ -41,28 +33,6 @@ module Bearcat
         content_migration_response, file_upload_response = create_content_migration_with_both_responses(course, file_path, params)
         file_upload_response
       end
-
-      # Performs effectively the same operation as #create_content_migration, but without the need to specify a file to be uploaded
-      def copy_course(course, params = {})
-        post("/api/v1/courses/#{course}/content_migrations", params)
-      end
-
-      def list_users_courses(params)
-        get("api/v1/courses", params)
-      end
-
-      def course_grading_standards(course, params={})
-        get("/api/v1/courses/#{course}/grading_standards", params)
-      end
-
-      def course_grading_standard(course, grading_standard_id, params={})
-        get("/api/v1/courses/#{course}/grading_standards/#{grading_standard_id}", params)
-      end
-
-      def course_gradebook_history(course, params={})
-        get("api/v1/courses/#{course}/gradebook_history/feed", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/custom_gradebook_columns.rb

@@ -1,35 +1,21 @@
 module Bearcat
   class Client < Footrest::Client
     module CustomGradebookColumns
+      extend ClientModule
 
-      def custom_gradebook_columns(course, params={})
-        get("/api/v1/courses/#{course.to_s}/custom_gradebook_columns", params)
-      end
-
-      def create_gradebook_columns(course, params={})
-        post("/api/v1/courses/#{course.to_s}/custom_gradebook_columns", params)
-      end
+      put :bulk_update_gradebook_columns_data, "/api/v1/courses/:course/custom_gradebook_column_data"
 
-      def update_gradebook_columns(course, gradebook_column, params={})
-        put("/api/v1/courses/#{course.to_s}/custom_gradebook_columns/#{gradebook_column}", params)
-      end
-
-      def delete_gradebook_columns(course, gradebook_column, params={})
-        delete("/api/v1/courses/#{course.to_s}/custom_gradebook_columns/#{gradebook_column}", params)
-      end
+      prefix "/api/v1/courses/:course/custom_gradebook_columns/" do
+        get :custom_gradebook_columns
+        post :create_gradebook_columns
 
-      def gradebook_columns_data(course, gradebook_column, params={})
-        get("/api/v1/courses/#{course.to_s}/custom_gradebook_columns/#{gradebook_column}/data", params)
+        prefix ":gradebook_column/" do
+          put :update_gradebook_columns
+          delete :delete_gradebook_columns
+          get :gradebook_columns_data, "data"
+          put :update_gradebook_columns_data, "data/:student"
+        end
       end
-
-      def update_gradebook_columns_data(course, gradebook_column, student, params={})
-        put("/api/v1/courses/#{course.to_s}/custom_gradebook_columns/#{gradebook_column}/data/#{student}", params)
-      end
-
-      def bulk_update_gradebook_columns_data(course, params={})
-        put("/api/v1/courses/#{course.to_s}/custom_gradebook_column_data", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/discussions.rb

@@ -1,43 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module Discussions
-
-      def create_group_discussion(group_id, params = {})
-        post("/api/v1/groups/#{group_id}/discussion_topics", params)
-      end
-
-      def create_course_discussion(course_id, params= {})
-        post("/api/v1/courses/#{course_id}/discussion_topics", params)
-      end
-
-      def group_discussions(group_id, params = {})
-        get("/api/v1/groups/#{group_id}/discussion_topics", params)
-      end
-
-      def course_discussions(course_id, params= {})
-        get("/api/v1/courses/#{course_id}/discussion_topics", params)
-      end
-
-      def course_discussion(course_id, discussion_topic_id, params = {})
-        get("/api/v1/courses/#{course_id}/discussion_topics/#{discussion_topic_id}", params)
-      end
-
-      def group_discussion_entries(group_id, discussion_id, params = {})
-        get("/api/v1/groups/#{group_id}/discussion_topics/#{discussion_id}/entries", params)
-      end
-
-      def course_discussion_entries(course_id, discussion_id, params= {})
-        get("/api/v1/courses/#{course_id}/discussion_topics/#{discussion_id}/entries", params)
-      end
-
-      def group_discussion_entry_replies(group_id, discussion_id, entry_id, params = {})
-        get("/api/v1/groups/#{group_id}/discussion_topics/#{discussion_id}/entries/#{entry_id}/replies", params)
-      end
-
-      def course_discussion_entry_replies(course_id, discussion_id, entry_id, params= {})
-        get("/api/v1/courses/#{course_id}/discussion_topics/#{discussion_id}/entries/#{entry_id}/replies", params)
-      end
-
+      extend ClientModule
+
+      post :create_group_discussion, "/api/v1/groups/:group/discussion_topics"
+      post :create_course_discussion, "/api/v1/courses/:course/discussion_topics"
+      get :group_discussions, "/api/v1/groups/:group/discussion_topics"
+      get :course_discussions, "/api/v1/courses/:course/discussion_topics"
+      get :course_discussion, "/api/v1/courses/:course/discussion_topics/:discussion_topic"
+      get :group_discussion_entries, "/api/v1/groups/:group/discussion_topics/:discussion/entries"
+      get :course_discussion_entries, "/api/v1/courses/:course/discussion_topics/:discussion/entries"
+      get :group_discussion_entry_replies, "/api/v1/groups/:group/discussion_topics/:discussion/entries/:entry/replies"
+      get :course_discussion_entry_replies, "/api/v1/courses/:course/discussion_topics/:discussion/entries/:entry/replies"
     end
   end
 end

data/lib/bearcat/client/enrollments.rb

@@ -1,35 +1,15 @@
 module Bearcat
   class Client < Footrest::Client
     module Enrollments
-
-      def user_enrollments(user, params={})
-        get("/api/v1/users/#{user.to_s}/enrollments", params)
-      end
-
-      def course_enrollments(course, params={})
-        get("/api/v1/courses/#{course.to_s}/enrollments", params)
-      end
-
-      def section_enrollments(section, params={})
-        get("/api/v1/sections/#{section.to_s}/enrollments", params)
-      end
-
-      def enroll_in_section(section, params={})
-        post("/api/v1/sections/#{section.to_s}/enrollments", params)
-      end
-
-      def enroll_in_course(course, params={})
-        post("/api/v1/courses/#{course.to_s}/enrollments", params)
-      end
-
-      def conclude_enrollment(course, enrollment, params={})
-        delete("/api/v1/courses/#{course}/enrollments/#{enrollment}", params)
-      end
-
-      def reactivate_enrollment(course, enrollment, params={})
-        put("/api/v1/courses/#{course}/enrollments/#{enrollment}/reactivate", params)
-      end
-
+      extend ClientModule
+
+      get :user_enrollments, "/api/v1/users/:user/enrollments"
+      get :course_enrollments, "/api/v1/courses/:course/enrollments"
+      get :section_enrollments, "/api/v1/sections/:section/enrollments"
+      post :enroll_in_section, "/api/v1/sections/:section/enrollments"
+      post :enroll_in_course, "/api/v1/courses/:course/enrollments"
+      delete :conclude_enrollment, "/api/v1/courses/:course/enrollments/:enrollment"
+      put :reactivate_enrollment, "/api/v1/courses/:course/enrollments/:enrollment/reactivate"
     end
   end
 end