bearcat 1.0.0 → 1.5.24

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/content_exports.rb

@@ -0,0 +1,39 @@
+module Bearcat
+  class Client < Footrest::Client
+    module ContentExports
+
+      def create_content_export(id, type, params = {})
+        post("/api/v1/#{type}/#{id}/content_exports", params)
+      end
+
+      def create_course_export(id, params = {})
+        create_content_export(id, 'courses', params)
+      end
+
+      def create_group_export(id, params = {})
+        create_content_export(id, 'groups', params)
+      end
+
+      def create_user_export(id, params = {})
+        create_content_export(id, 'users', params)
+      end
+
+      def get_content_export(id, export_id, type, params = {})
+        get("/api/v1/#{type}/#{id}/content_exports/#{export_id}", params)
+      end
+
+      def get_course_export(course_id, export_id, params = {})
+        get_content_export(course_id, export_id, 'courses', params)
+      end
+
+      def get_group_export(group_id, export_id, params = {})
+        get_content_export(group_id, export_id, 'groups', params)
+      end
+
+      def get_user_export(user_id, export_id, params = {})
+        get_content_export(user_id, export_id, 'users', params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/content_migrations.rb

@@ -0,0 +1,54 @@
+module Bearcat
+  class Client < Footrest::Client
+    module ContentMigrations
+
+      def upload_content_package(api_path, file_path, params = {})
+        response = post(api_path, params)
+        pre_attachment = response['pre_attachment']
+        confirmation_url = post_file(pre_attachment['upload_url'], pre_attachment['upload_params'], file_path)
+        confirm_file_upload(confirmation_url)
+      end
+
+      def get_content_migration(id, migration_id, type, params = {})
+        get("/api/v1/#{type}/#{id}/content_migrations/#{migration_id}", params)
+      end
+
+      def get_account_content_migration(account_id, migration_id, params = {})
+        get_content_migration(account_id, migration_id, 'accounts', params = {})
+      end
+
+      def get_course_content_migration(course_id, migration_id, params = {})
+        get_content_migration(course_id, migration_id, 'courses', params = {})
+      end
+
+      def get_group_content_migration(group_id, migration_id, params = {})
+        get_content_migration(group_id, migration_id, 'groups', params = {})
+      end
+
+      def get_user_content_migration(user_id, migration_id, params = {})
+        get_content_migration(user_id, migration_id, 'users', params = {})
+      end
+
+      def create_content_migration_with_type(id, type, params = {})
+        post("/api/v1/#{type}/#{id}/content_migrations", params)
+      end
+
+      def create_account_content_migration(account_id, params = {})
+        create_content_migration_with_type(account_id, 'accounts', params)
+      end
+
+      def create_course_content_migration(course_id, params = {})
+        create_content_migration_with_type(course_id, 'courses', params)
+      end
+
+      def create_group_content_migration(group_id, params = {})
+        create_content_migration_with_type(group_id, 'groups', params)
+      end
+
+      def create_user_content_migration(user_id, params = {})
+        create_content_migration_with_type(user_id, 'users', params)
+      end
+
+    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,28 +1,39 @@
 module Bearcat
   class Client < Footrest::Client
     module Courses
+      extend ClientModule
 
-      def course(course, params={})
-        get("/api/v1/courses/#{course}", params)
-      end
+      post :create_course, "/api/v1/accounts/:account_id/courses"
+      get :list_users_courses, "/api/v1/courses"
 
-      def create_course(account_id, params={})
-        post("/api/v1/accounts/#{account_id}/courses", 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"
+
+        get :course_grading_standards, "grading_standards"
+        get :course_grading_standard, "grading_standards/:grading_standard_id"
+        get :course_gradebook_history, "gradebook_history/feed"
 
-      def update_course(course, params={})
-        put("/api/v1/courses/#{course}", 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"
+
+        get :course_settings, 'settings'
       end
 
-      def list_course_users(course, params={})
-        get("/api/v1/courses/#{course}/users", params)
+      def create_content_migration_with_both_responses(course, file_path, params={})
+        content_migration_response = post("/api/v1/courses/#{course}/content_migrations", params)
+        pre_attachment = content_migration_response['pre_attachment']
+        confirmation_url = post_file(pre_attachment['upload_url'], pre_attachment['upload_params'], file_path)
+        [content_migration_response, confirm_file_upload(confirmation_url)]
       end
 
       def create_content_migration(course, file_path, params={})
-        response = post("/api/v1/courses/#{course}/content_migrations", params)
-        pre_attachment = response['pre_attachment']
-        confirmation_url = post_file(pre_attachment['upload_url'], pre_attachment['upload_params'], file_path)
-        confirm_file_upload(confirmation_url)
+        content_migration_response, file_upload_response = create_content_migration_with_both_responses(course, file_path, params)
+        file_upload_response
       end
     end
   end

data/lib/bearcat/client/custom_gradebook_columns.rb

@@ -0,0 +1,21 @@
+module Bearcat
+  class Client < Footrest::Client
+    module CustomGradebookColumns
+      extend ClientModule
+
+      put :bulk_update_gradebook_columns_data, "/api/v1/courses/:course/custom_gradebook_column_data"
+
+      prefix "/api/v1/courses/:course/custom_gradebook_columns/" do
+        get :custom_gradebook_columns
+        post :create_gradebook_columns
+
+        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
+    end
+  end
+end

data/lib/bearcat/client/discussions.rb

@@ -1,11 +1,17 @@
 module Bearcat
   class Client < Footrest::Client
     module Discussions
+      extend ClientModule
 
-      def create_group_discussion(group_id, params = {})
-        post("/api/v1/groups/#{group_id}/discussion_topics", params)
-      end
-
+      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,31 +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
-
+      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

@@ -0,0 +1,18 @@
+module Bearcat
+  class Client < Footrest::Client
+    module ExternalTools
+      extend ClientModule
+
+      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"
+
+          get :"#{ct}_external_tool", ":tool"
+          put :"edit_#{ct}_external_tool", ":tool"
+          delete :"delete_#{ct}_external_tool", ":tool"
+        end
+      end
+    end
+  end
+end

data/lib/bearcat/client/file_helper.rb

@@ -1,37 +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)
+        }.with_indifferent_access
+      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 [302, 303].include? response.status #success if it is a redirect
-      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)
-    post(uri.path, CGI::parse(uri.query))
-  end
+      def confirm_file_upload(url)
+        uri = URI(url)
+        uri.scheme = uri.host = uri.port = nil
+        get(uri.to_s)
+      end
 
-  def upload_connection
-    Faraday.new do |f|
-      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/files.rb

@@ -0,0 +1,9 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Files
+      extend ClientModule
+
+      get :list_course_files, "/api/v1/courses/:course/files"
+    end
+  end
+end

data/lib/bearcat/client/folders.rb

@@ -0,0 +1,24 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Folders
+      extend ClientModule
+
+      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
+
+      prefix "/api/v1/folders/:folder/" do
+        put :update_folder
+        delete :delete_folder
+      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/graph_ql.rb

@@ -0,0 +1,17 @@
+module Bearcat
+  class Client < Footrest::Client
+    # Request body format should be: { query: "query string" }. More info in README.md
+    module GraphQL
+
+      def graphql_query(query)
+        if query.is_a?(String)
+          query = {
+            query: query
+          }
+        end
+        post('/api/graphql', query)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/group_categories.rb

@@ -0,0 +1,18 @@
+module Bearcat
+  class Client < Footrest::Client
+    module GroupCategories
+      extend ClientModule
+
+      prefix "/api/v1/:context/:id/group_categories/" do
+        get :list_group_categories
+        post :create_group_category
+      end
+
+      prefix "/api/v1/group_categories/:id/" do
+        get :group_category
+        put :edit_group_category
+        delete :delete_group_category
+      end
+    end
+  end
+end

data/lib/bearcat/client/group_memberships.rb

@@ -0,0 +1,14 @@
+module Bearcat
+  class Client < Footrest::Client
+    module GroupMemberships
+      extend ClientModule
+
+      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
+end

data/lib/bearcat/client/groups.rb

@@ -1,11 +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
 
+      get :course_groups, "/api/v1/courses/:course/groups"
+      get :account_groups, "/api/v1/accounts/:account/groups"
+
+      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/learning_outcomes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bearcat
+  class Client < Footrest::Client
+    module LearningOutcomes
+
+      def learning_outcome(outcome, params={})
+        get("/api/v1/outcomes/#{outcome}", params)
+      end
+
+      def update_learning_outcome(outcome, params={})
+        put("/api/v1/outcomes/#{outcome}", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/logins.rb

@@ -0,0 +1,20 @@
+module Bearcat
+  class Client < Footrest::Client
+    module Logins
+      extend ClientModule
+
+      post :reset_password, "/api/v1/users/reset_password"
+
+      prefix "/api/v1/accounts/:account/logins/" do
+        get :account_logins
+        post :create_login
+        put :update_login, ":id"
+      end
+
+      prefix "/api/v1/users/:user/logins/" do
+        get :user_logins
+        delete :delete_login, ":id"
+      end
+    end
+  end
+end

data/lib/bearcat/client/module_items.rb

@@ -0,0 +1,18 @@
+module Bearcat
+  class Client < Footrest::Client
+    module ModuleItems
+      extend ClientModule
+
+      prefix "/api/v1/courses/:course/modules/:module/items/" do
+        get :list_module_items
+        post :create_module_item
+
+        prefix ":module_item/" do
+          get :module_item
+          put :update_module_item
+          delete :delete_module_item
+        end
+      end
+    end
+  end
+end

data/lib/bearcat/client/modules.rb

@@ -1,15 +1,20 @@
 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
+      prefix "/api/v1/courses/:course/" do
+        prefix "modules/" do
+          get :course_modules
+          post :create_module
 
-      def course_module_item_sequence(course, params = {})
-        get("/api/v1/courses/#{course}/module_item_sequence", params)
-      end
+          get :course_module, ":context_module_id"
+          put :update_module, ":module_id"
+          delete :delete_module, ":module_id"
+        end
 
+        get :course_module_item_sequence, "module_item_sequence"
+      end
     end
   end
-end
+end

data/lib/bearcat/client/o_auth2.rb

@@ -2,31 +2,40 @@ module Bearcat
   class Client < Footrest::Client
     module OAuth2
 
-      def auth_redirect_url(client_id, redirect_uri, scopes = nil, response_type='code')
+      def auth_redirect_url(client_id, redirect_uri, opts = {})
+        opts[:response_type] ||= 'code'
+
         fullpath('login/oauth2/auth')
         uri = URI.parse(fullpath('login/oauth2/auth'))
         query = [
           ['client_id', client_id],
           ['redirect_uri', redirect_uri],
-          ['response_type', response_type]
+          ['response_type', opts[:response_type]]
         ]
-        query << ['scopes', scopes] if scopes
+        query << ['state', opts[:state]] if opts[:state]
+        query << ['scopes', opts[:scope]] if opts[:scope]
         uri.query = URI.encode_www_form(query)
         uri.to_s
       end
 
-      def retrieve_token(client_id, redirect_url, client_secret, code)
-        body = post('/login/oauth2/token', {
+      def retrieve_token(client_id, redirect_url, client_secret, code, grant_type = 'authorization_code')
+        token_params = {
           client_id: client_id,
           redirect_url: redirect_url,
           client_secret: client_secret,
-          code: code
-        })
+          grant_type: grant_type
+        }
+        if grant_type == 'authorization_code'
+          token_params[:code] = code
+        elsif grant_type == 'refresh_token'
+          token_params[:refresh_token] = code
+        end
+        body = post('/login/oauth2/token', token_params)
         config[:token] = body['access_token']
         set_connection(config)
-        config[:token]
+        body
       end
 
     end
   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