bearcat 1.4.12 → 1.5.0.beta1

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

data/lib/bearcat/client/external_tools.rb

@@ -1,44 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module ExternalTools
-      def course_external_tools(course_id, params={})
-        get("/api/v1/courses/#{course_id}/external_tools", params)
-      end
-
-      def account_external_tools(account_id, params={})
-        get("/api/v1/accounts/#{account_id}/external_tools", params)
-      end
-
-      def course_external_tool(course_id, tool_id, params={})
-        get("/api/v1/courses/#{course_id}/external_tools/#{tool_id}", params)
-      end
-
-      def account_external_tool(account_id, tool_id, params={})
-        get("/api/v1/accounts/#{account_id}/external_tools/#{tool_id}", params)
-      end
-
-      def create_course_external_tool(course_id, params={})
-        post("/api/v1/courses/#{course_id}/external_tools", params)
-      end
-
-      def create_account_external_tool(account_id, params={})
-        post("/api/v1/accounts/#{account_id}/external_tools", params)
-      end
-
-      def edit_course_external_tool(course_id, tool_id, params={})
-        put("/api/v1/courses/#{course_id}/external_tools/#{tool_id}", params)
-      end
-
-      def edit_account_external_tool(account_id, tool_id, params={})
-        put("/api/v1/accounts/#{account_id}/external_tools/#{tool_id}", params)
-      end
+      extend ClientModule
 
-      def delete_course_external_tool(course_id, tool_id, params={})
-        delete("/api/v1/courses/#{course_id}/external_tools/#{tool_id}", params)
-      end
+      context_types %i[course account] do |ct|
+        prefix "/api/v1/#{ct}s/:#{ct}/external_tools/" do
+          get :"#{ct}_external_tools"
+          post :"create_#{ct}_external_tool"
 
-      def delete_account_external_tool(account_id, tool_id, params={})
-        delete("/api/v1/accounts/#{account_id}/external_tools/#{tool_id}", params)
+          get :"#{ct}_external_tool", ":tool"
+          put :"edit_#{ct}_external_tool", ":tool"
+          delete :"delete_#{ct}_external_tool", ":tool"
+        end
       end
     end
   end

data/lib/bearcat/client/file_helper.rb

@@ -5,7 +5,7 @@ module Bearcat
         {
           size: File.open(file_path).size,
           name: File.basename(file_path)
-        }
+        }.with_indifferent_access
       end
 
       def declare_file(api_path, params)
@@ -25,8 +25,8 @@ module Bearcat
 
       def confirm_file_upload(url)
         uri = URI(url)
-        query = uri.query
-        query.blank? ? get(uri.path) : get(uri.path, CGI::parse(query))
+        uri.scheme = uri.host = uri.port = nil
+        get(uri.to_s)
       end
 
       def upload_connection

data/lib/bearcat/client/files.rb

@@ -1,11 +1,9 @@
 module Bearcat
   class Client < Footrest::Client
     module Files
+      extend ClientModule
 
-      def list_course_files(course, params = {})
-        get("/api/v1/courses/#{course}/files", params)
-      end
-
+      get :list_course_files, "/api/v1/courses/:course/files"
     end
   end
 end

data/lib/bearcat/client/folders.rb

@@ -1,70 +1,24 @@
 module Bearcat
   class Client < Footrest::Client
     module Folders
+      extend ClientModule
 
-      def get_course_folder(course, folder, params = {})
-        get("/api/v1/courses/#{course}/folders/#{folder}", params)
+      context_types %i[course user group] do |ct|
+        prefix "/api/v1/#{ct}s/:#{ct}/folders/" do
+          get :"list_#{ct}_folders"
+          post :"create_#{ct}_folder"
+          get :"get_#{ct}_folder", ":folder"
+          get :"resolve_path_for_#{ct}", "by_path/:full_path"
+        end
       end
 
-      def list_course_folders(course, params = {})
-        get("/api/v1/courses/#{course}/folders", params)
+      prefix "/api/v1/folders/:folder/" do
+        put :update_folder
+        delete :delete_folder
       end
 
-      def resolve_path_for_course(course, full_path = nil, params)
-        get("/api/v1/courses/#{course}/folders/by_path#{full_path == nil ? "" : "/#{full_path}"}", params)
-      end
-
-      def create_course_folder(course, params = {})
-        post("/api/v1/courses/#{course}/folders", params)
-      end
-
-      def get_user_folder(user, folder, params = {})
-        get("/api/v1/users/#{user}/folders/#{folder}", params)
-      end
-
-      def list_user_folders(user, params = {})
-        get("/api/v1/users/#{user}/folders", params)
-      end
-
-      def resolve_path_for_user(user, full_path = nil, params = {})
-        get("/api/v1/users/#{user}/folders/by_path#{full_path == nil ? "" : "/#{full_path}"}", params)
-      end
-
-      def create_user_folder(user, params = {})
-        post("/api/v1/users/#{user}/folders", params)
-      end
-
-      def get_group_folder(group, folder, params = {})
-        get("/api/v1/groups/#{group}/folders/#{folder}", params)
-      end
-
-      def list_group_folders(group, params = {})
-        get("/api/v1/groups/#{group}/folders", params)
-      end
-
-      def resolve_path_for_group(group, full_path = nil, params = {})
-        get("/api/v1/groups/#{group}/folders/by_path#{full_path == nil ? "" : "/#{full_path}"}", params)
-      end
-
-      def create_group_folder(group, params = {})
-        post("/api/v1/groups/#{group}/folders", params)
-      end
-
-      def update_folder(folder, params = {})
-        put("/api/v1/folders/#{folder}", params)
-      end
-
-      def delete_folder(folder, params = {})
-        delete("/api/v1/folders/#{folder}", params)
-      end
-
-      def copy_folder(destination_folder, params = {})
-        post("/api/v1/folders/#{destination_folder}/copy_folder", params)
-      end
-
-      def copy_file_to_folder(destination_folder, params = {})
-        post("/api/v1/folders/#{destination_folder}/copy_file", params)
-      end
+      post :copy_folder, "/api/v1/folders/:destination_folder/copy_folder"
+      post :copy_file_to_folder, "/api/v1/folders/:destination_folder/copy_file"
     end
   end
 end

data/lib/bearcat/client/group_categories.rb

@@ -1,27 +1,18 @@
 module Bearcat
   class Client < Footrest::Client
     module GroupCategories
+      extend ClientModule
 
-      def list_group_categories(context, id)
-        get("/api/v1/#{context}/#{id}/group_categories")
+      prefix "/api/v1/:context/:id/group_categories/" do
+        get :list_group_categories
+        post :create_group_category
       end
 
-      def group_category(id)
-        get("/api/v1/group_categories/#{id}")
+      prefix "/api/v1/group_categories/:id/" do
+        get :group_category
+        put :edit_group_category
+        delete :delete_group_category
       end
-
-      def edit_group_category(id, params={})
-        put("/api/v1/group_categories/#{id}", params)
-      end
-
-      def create_group_category(context, id, params={})
-        post("/api/v1/#{context}/#{id}/group_categories", params)
-      end
-
-      def delete_group_category(id, params={})
-        delete("/api/v1/group_categories/#{id}/", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/group_memberships.rb

@@ -1,21 +1,13 @@
 module Bearcat
   class Client < Footrest::Client
     module GroupMemberships
+      extend ClientModule
 
-      def group_membership(group, group_membership)
-        get("/api/v1/groups/#{group}/memberships/#{group_membership}")
-      end
-
-      def list_group_memberships(group)
-        get("/api/v1/groups/#{group.to_s}/memberships")
-      end
-
-      def create_group_membership(group_id, params={})
-        post("/api/v1/groups/#{group_id}/memberships", params)
-      end
-
-      def delete_group_membership(group_id, context, context_id)
-        delete("/api/v1/groups/#{group_id}/#{context}/#{context_id}")
+      prefix "/api/v1/groups/:group/" do
+        get :group_membership, "memberships/:group_membership"
+        get :list_group_memberships, "memberships"
+        post :create_group_membership, "memberships"
+        delete :delete_group_membership, ":context/:context_id"
       end
     end
   end

data/lib/bearcat/client/groups.rb

@@ -1,34 +1,19 @@
 module Bearcat
   class Client < Footrest::Client
     module Groups
+      extend ClientModule
 
-      def course_groups(course)
-        get("/api/v1/courses/#{course.to_s}/groups")
+      prefix "/api/v1/groups/:group/" do
+        get :group
+        put :edit_group
+        delete :delete_group
       end
 
-      def account_groups(account_id)
-        get("/api/v1/accounts/#{account_id}/groups")
-      end
-
-      def category_groups(group_category_id)
-        get("/api/v1/group_categories/#{group_category_id}/groups")
-      end
-
-      def group(id)
-        get("/api/v1/groups/#{id}")
-      end
+      get :course_groups, "/api/v1/courses/:course/groups"
+      get :account_groups, "/api/v1/accounts/:account/groups"
 
-      def create_group(group_category_id, params={})
-        post("/api/v1/group_categories/#{group_category_id}/groups", params)
-      end
-
-      def edit_group(group_id, params={})
-        put("/api/v1/groups/#{group_id}", params)
-      end
-
-      def delete_group(group_id)
-        delete("/api/v1/groups/#{group_id}")
-      end
+      get :category_groups, "/api/v1/group_categories/:group_category/groups"
+      post :create_group, "/api/v1/group_categories/:group_category/groups"
     end
   end
 end

data/lib/bearcat/client/module_items.rb

@@ -1,25 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module ModuleItems
+      extend ClientModule
 
-      def list_module_items(course, mod, params = {})
-        get("/api/v1/courses/#{course}/modules/#{mod}/items", params)
-      end
-
-      def module_item(course_id, module_id, module_item_id, params = {})
-        get("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}", params)
-      end
-
-      def create_module_item(course_id, module_id, params={})
-        post("/api/v1/courses/#{course_id}/modules/#{module_id}/items", params)
-      end
-
-      def update_module_item(course_id, module_id, module_item_id, params={})
-        put("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}", params)
-      end
+      prefix "/api/v1/courses/:course/modules/:module/items/" do
+        get :list_module_items
+        post :create_module_item
 
-      def delete_module_item(course_id, module_id, module_item_id, params={})
-        delete("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}", params)
+        prefix ":module_item/" do
+          get :module_item
+          put :update_module_item
+          delete :delete_module_item
+        end
       end
     end
   end

data/lib/bearcat/client/modules.rb

@@ -1,29 +1,19 @@
 module Bearcat
   class Client < Footrest::Client
     module Modules
+      extend ClientModule
 
-      def course_modules(course, params = {})
-        get("/api/v1/courses/#{course.to_s}/modules", params)
-      end
-
-      def course_module_item_sequence(course, params = {})
-        get("/api/v1/courses/#{course}/module_item_sequence", params)
-      end
-
-      def course_module(course_id, context_module_id, params={})
-        get("/api/v1/courses/#{course_id}/modules/#{context_module_id}", params)
-      end
-
-      def create_module(course, params={})
-        post("/api/v1/courses/#{course}/modules", params)
-      end
+      prefix "/api/v1/courses/:course/" do
+        prefix "modules/" do
+          get :course_modules
+          post :create_module
 
-      def update_module(course, module_id, params={})
-        put("/api/v1/courses/#{course}/modules/#{module_id}", params)
-      end
+          get :course_module, ":context_module_id"
+          put :update_module, ":module_id"
+          delete :delete_module, ":module_id"
+        end
 
-      def delete_module(course, module_id, params={})
-        delete("/api/v1/courses/#{course}/modules/#{module_id}", params)
+        get :course_module_item_sequence, "module_item_sequence"
       end
     end
   end

data/lib/bearcat/client/outcome_groups.rb

@@ -1,6 +1,7 @@
 module Bearcat
   class Client < Footrest::Client
     module OutcomeGroups
+      extend ClientModule
 
       def show_outcome_group(outcome_group_id, params={})
         get("#{outcomes_context_slug(params)}#{outcome_group_id}")
@@ -61,21 +62,18 @@ module Bearcat
       end
 
       private
+
       def account_slug(account_id)
         "accounts/#{account_id}/outcome_groups/"
       end
 
-
-      private
       def course_slug(course_id)
         "courses/#{course_id}/outcome_groups/"
       end
 
-      private
       def global_slug
         "global/outcome_groups/"
       end
-
     end
   end
 end

data/lib/bearcat/client/outcomes.rb

@@ -1,15 +1,12 @@
 module Bearcat
   class Client < Footrest::Client
     module Outcomes
+      extend ClientModule
 
-      def show_outcome(id)
-        get("/api/v1/outcomes/#{id}")
+      prefix "/api/v1/outcomes/:outcome/" do
+        get :show_outcome
+        put :update_outcome
       end
-
-      def update_outcome(id, params={})
-        put("/api/v1/outcomes/#{id}", params)
-      end
-
     end
   end
 end

data/lib/bearcat/client/pages.rb

@@ -1,29 +1,14 @@
 module Bearcat
   class Client < Footrest::Client
     module Pages
-
-      def list_course_pages(course, params={})
-        get("/api/v1/courses/#{course}/pages", params)
-      end
-
-      def list_group_pages(group, params={})
-        get("/api/v1/groups/#{group}/pages", params)
-      end
-
-      def show_course_page(course, url, params={})
-        get("/api/v1/courses/#{course}/pages/#{url}", params)
-      end
-
-      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)
+      extend ClientModule
+
+      context_types %i[course group] do |ct|
+        prefix "/api/v1/#{ct}s/:#{ct}/pages/" do
+          get :"list_#{ct}_pages"
+          post :"add_#{ct}_page"
+          get :"show_#{ct}_page", ":url"
+        end
       end
     end
   end

data/lib/bearcat/client/progresses.rb

@@ -1,10 +1,9 @@
 module Bearcat
   class Client < Footrest::Client
     module Progresses
+      extend ClientModule
 
-      def progress(progress, params={})
-        get("/api/v1/progress/#{progress}", params)
-      end
+      get :progress, "/api//v1/progress/:progress"
     end
   end
 end

data/lib/bearcat/client/quizzes.rb

@@ -1,41 +1,21 @@
 module Bearcat
   class Client < Footrest::Client
     module Quizzes
-
-      def list_course_quizzes(course, params={})
-        get("/api/v1/courses/#{course}/quizzes", params)
-      end
-
-      def quiz(course, quiz, params={})
-        get("/api/v1/courses/#{course}/quizzes/#{quiz}", params)
-      end
-
-      def edit_quiz(course, quiz, params={})
-        put("/api/v1/courses/#{course}/quizzes/#{quiz}", params)
-      end
-
-      def quiz_extensions(course, quiz, params={})
-        post("/api/v1/courses/#{course}/quizzes/#{quiz}/extensions", params)
-      end
-
-      def quiz_assignment_overrides(course, params={})
-        get("/api/v1/courses/#{course}/quizzes/assignment_overrides", params)
-      end
-
-      def quiz_questions(course, quiz, params={})
-        get("/api/v1/courses/#{course}/quizzes/#{quiz}/questions", params)
-      end
-
-      def create_quiz(course, params={})
-        post("/api/v1/courses/#{course}/quizzes", params)
-      end
-
-      def create_quiz_report(course, quiz, params={})
-        post("/api/v1/courses/#{course}/quizzes/#{quiz}/reports", params)
-      end
-
-      def get_quiz_report(course, quiz, report, params)
-        get("/api/v1/courses/#{course}/quizzes/#{quiz}/reports/#{report}", params)
+      extend ClientModule
+
+      prefix "/api/v1/courses/:course/" do
+        get :list_course_quizzes, "quizzes"
+        post :create_quiz, "quizzes"
+        get :quiz_assignment_overrides, "quizzes/assignment_overrides"
+
+        prefix "quizzes/:quiz/" do
+          get :quiz
+          put :edit_quiz
+          post :quiz_extensions, "extensions"
+          get :quiz_questions, "questions"
+          post :create_quiz_report, "reports"
+          get :get_quiz_report, "reports/:report"
+        end
       end
     end
   end

data/lib/bearcat/client/reports.rb

@@ -3,25 +3,14 @@ require 'csv'
 module Bearcat
   class Client < Footrest::Client
     module Reports
-
-      def report_list(account)
-        get("/api/v1/accounts/#{account}/reports")
-      end
-
-      def start_report(account, report_name, params = {})
-        post("/api/v1/accounts/#{account}/reports/#{report_name}", params)
-      end
-
-      def report_history(account, report_name)
-        get("/api/v1/accounts/#{account}/reports/#{report_name}")
-      end
-
-      def report_status(account, report_name, report_id)
-        get("/api/v1/accounts/#{account}/reports/#{report_name}/#{report_id}")
-      end
-
-      def delete_report(account, report_name, report_id)
-        delete("/api/v1/accounts/#{account}/reports/#{report_name}/#{report_id}")
+      extend ClientModule
+
+      prefix "/api/v1/accounts/: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)

data/lib/bearcat/client/roles.rb

@@ -1,6 +1,7 @@
 module Bearcat
   class Client < Footrest::Client
     module Roles
+      extend ClientModule
 
       def roles(account_id='self', params={})
         get("/api/v1/accounts/#{account_id}/roles", params)
@@ -9,7 +10,6 @@ module Bearcat
       def role(role_id, account_id='self', params={})
         get("/api/v1/accounts/#{account_id}/roles/#{role_id}", params)
       end
-
     end
   end
 end

data/lib/bearcat/client/rubric.rb

@@ -1,29 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module Rubric
-      def course_rubric(course, rubric)
-        get("api/v1/courses/#{course}/rubrics/#{rubric}")
-      end
-
-      def course_rubrics(course, params={})
-        get("api/v1/courses/#{course}/rubrics", params)
-      end
-
-      def create_course_rubric(course, params={})
-        post("api/v1/courses/#{course}/rubrics/", params)
-      end
-
-      def update_course_rubric(course, rubric, params={})
-        put("api/v1/courses/#{course}/rubrics/#{rubric}", params)
-      end
+      extend ClientModule
 
-      def delete_course_rubric(course, rubric)
-        delete("api/v1/courses/#{course}/rubrics/#{rubric}")
+      prefix "/api/v1/courses/:course/rubrics/" do
+        get :course_rubric, ":rubric"
+        get :course_rubrics
+        post :create_course_rubric
+        put :update_course_rubric, ":rubric"
+        delete :delete_course_rubric, ":rubric"
       end
 
-      def account_rubrics(account, params={})
-        get("api/v1/accounts/#{account}/rubrics", params={})
-      end
+      get :account_rubrics, "api/v1/accounts/:account/rubrics"
     end
   end
 end