lms-graphql-api 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a58ae9ee707b6d878e454edb4a68c965ce858c48ae0e3c262bb5ecf4e131853
+  data.tar.gz: 95198edf2ed4b0ba3b5dd255a243efdba923de6dad543c44bd3f90255d166cc4
+SHA512:
+  metadata.gz: 520f0a04ed182af8fd4efdea4c8416f7731027e0b4785c7af07abee26533aba5eb9777a817451383a92ffb05bd4a2b079f9e144f530d5fa33682183d87491a87
+  data.tar.gz: fc5af6de6a628fc675cfb574f29a4d2717571b1cfde0e5743c70a661add50ba8d36cf4cc7df4f25e2d38084563827e1c40b96e68831d017bd5186ea0b0ffd22a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016-2017 Atomic Jolt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# LMS API
+
+This project provides a graphql wrapper around the Instructure Canvas API.
+
+
+## Installation
+
+To install, add `lms-graphql-api` to your Gemfile:
+
+```ruby
+    gem "lms-graphql-api"
+```

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "LMS GraphQL API"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+end

data/lib/lms_graphql/canvas.rb

@@ -0,0 +1,8 @@
+require "graphql"
+require_relative "utils"
+require_relative "types/canvas_hacks"
+require_relative "types/canvas_forward_declarations"
+require_all(File.absolute_path(__FILE__), "types/canvas/")
+require_all(File.absolute_path(__FILE__), "resolvers/canvas/")
+#require_all(File.absolute_path(__FILE__), "mutations/canvas/")
+require_relative "canvas_schema"

data/lib/lms_graphql/canvas_schema.rb

@@ -0,0 +1,15 @@
+require "graphql"
+require_relative "types/canvas_forward_declarations"
+require_relative "mutations/canvas/mutations"
+require_relative "types/canvas/query_type"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class Schema < ::GraphQL::Schema
+        mutation LMSGraphQL::Mutations::Canvas::MutationType
+        query LMSGraphQL::Types::Canvas::QueryType
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/abort_all_pending_sis_imports.rb

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AbortAllPendingSisImport < BaseMutation
+        argument :account_id, ID, required: true
+        field :return_value, Boolean, null: false
+        def resolve(account_id:)
+          context[:canvas_api].call("ABORT_ALL_PENDING_SIS_IMPORTS").proxy(
+            "ABORT_ALL_PENDING_SIS_IMPORTS",
+            {
+              "account_id": account_id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/abort_generation_of_report_or_remove_previously_generated_one.rb

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AbortGenerationOfReportOrRemovePreviouslyGeneratedOne < BaseMutation
+        argument :course_id, ID, required: true
+        argument :quiz_id, ID, required: true
+        argument :id, ID, required: true
+        field :return_value, Boolean, null: false
+        def resolve(course_id:, quiz_id:, id:)
+          context[:canvas_api].call("ABORT_GENERATION_OF_REPORT_OR_REMOVE_PREVIOUSLY_GENERATED_ONE").proxy(
+            "ABORT_GENERATION_OF_REPORT_OR_REMOVE_PREVIOUSLY_GENERATED_ONE",
+            {
+              "course_id": course_id,
+              "quiz_id": quiz_id,
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/abort_sis_import.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/sis_import"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AbortSisImport < BaseMutation
+        argument :account_id, ID, required: true
+        argument :id, ID, required: true
+        field :sis_import, LMSGraphQL::Types::Canvas::CanvasSisImport, null: false
+        def resolve(account_id:, id:)
+          context[:canvas_api].call("ABORT_SIS_IMPORT").proxy(
+            "ABORT_SIS_IMPORT",
+            {
+              "account_id": account_id,
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/accept_course_invitation.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AcceptCourseInvitation < BaseMutation
+        argument :course_id, ID, required: true
+        argument :id, ID, required: true
+        field :return_value, Boolean, null: false
+        def resolve(course_id:, id:)
+          context[:canvas_api].call("ACCEPT_COURSE_INVITATION").proxy(
+            "ACCEPT_COURSE_INVITATION",
+            {
+              "course_id": course_id,
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/activate_role.rb

@@ -0,0 +1,28 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/role"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class ActivateRole < BaseMutation
+        argument :account_id, ID, required: true
+        argument :id, ID, required: true
+        argument :role_id, ID, required: true
+        argument :role, String, required: false
+        field :role, LMSGraphQL::Types::Canvas::CanvasRole, null: false
+        def resolve(account_id:, id:, role_id:, role: nil)
+          context[:canvas_api].call("ACTIVATE_ROLE").proxy(
+            "ACTIVATE_ROLE",
+            {
+              "account_id": account_id,
+              "id": id
+            },
+            {
+              "role_id": role_id,
+              "role": role
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_allowed_domain_to_account.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddAllowedDomainToAccount < BaseMutation
+        argument :account_id, ID, required: true
+        argument :domain, String, required: true
+        field :return_value, Boolean, null: false
+        def resolve(account_id:, domain:)
+          context[:canvas_api].call("ADD_ALLOWED_DOMAIN_TO_ACCOUNT").proxy(
+            "ADD_ALLOWED_DOMAIN_TO_ACCOUNT",
+            {
+              "account_id": account_id
+            },
+            {
+              "domain": domain
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_authentication_provider.rb

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/authentication_provider"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddAuthenticationProvider < BaseMutation
+        argument :account_id, ID, required: true
+        field :authentication_provider, LMSGraphQL::Types::Canvas::CanvasAuthenticationProvider, null: false
+        def resolve(account_id:)
+          context[:canvas_api].call("ADD_AUTHENTICATION_PROVIDER").proxy(
+            "ADD_AUTHENTICATION_PROVIDER",
+            {
+              "account_id": account_id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_course_to_favorites.rb

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/favorite"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddCourseToFavorite < BaseMutation
+        argument :id, ID, required: true
+        field :favorite, LMSGraphQL::Types::Canvas::CanvasFavorite, null: false
+        def resolve(id:)
+          context[:canvas_api].call("ADD_COURSE_TO_FAVORITES").proxy(
+            "ADD_COURSE_TO_FAVORITES",
+            {
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_domain_to_account_whitelist.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddDomainToAccountWhitelist < BaseMutation
+        argument :account_id, ID, required: true
+        argument :domain, String, required: true
+        field :return_value, Boolean, null: false
+        def resolve(account_id:, domain:)
+          context[:canvas_api].call("ADD_DOMAIN_TO_ACCOUNT_WHITELIST").proxy(
+            "ADD_DOMAIN_TO_ACCOUNT_WHITELIST",
+            {
+              "account_id": account_id
+            },
+            {
+              "domain": domain
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_group_to_favorites.rb

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/favorite"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddGroupToFavorite < BaseMutation
+        argument :id, ID, required: true
+        field :favorite, LMSGraphQL::Types::Canvas::CanvasFavorite, null: false
+        def resolve(id:)
+          context[:canvas_api].call("ADD_GROUP_TO_FAVORITES").proxy(
+            "ADD_GROUP_TO_FAVORITES",
+            {
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_message.rb

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddMessage < BaseMutation
+        argument :id, ID, required: true
+        argument :body, String, required: true
+        argument :attachment_ids, [ID], required: false
+        argument :media_comment_id, ID, required: false
+        argument :media_comment_type, String, required: false
+        argument :recipients, String, required: false
+        argument :included_messages, String, required: false
+        argument :user_note, Boolean, required: false
+        field :return_value, Boolean, null: false
+        def resolve(id:, body:, attachment_ids: nil, media_comment_id: nil, media_comment_type: nil, recipients: nil, included_messages: nil, user_note: nil)
+          context[:canvas_api].call("ADD_MESSAGE").proxy(
+            "ADD_MESSAGE",
+            {
+              "id": id
+            },
+            {
+              "body": body,
+              "attachment_ids": attachment_ids,
+              "media_comment_id": media_comment_id,
+              "media_comment_type": media_comment_type,
+              "recipients": recipients,
+              "included_messages": included_messages,
+              "user_note": user_note
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_multiple_allowed_domains_to_account.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddMultipleAllowedDomainsToAccount < BaseMutation
+        argument :account_id, ID, required: true
+        argument :domains, String, required: true
+        field :return_value, Boolean, null: false
+        def resolve(account_id:, domains:)
+          context[:canvas_api].call("ADD_MULTIPLE_ALLOWED_DOMAINS_TO_ACCOUNT").proxy(
+            "ADD_MULTIPLE_ALLOWED_DOMAINS_TO_ACCOUNT",
+            {
+              "account_id": account_id
+            },
+            {
+              "domains": domains
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_multiple_domains_to_account_whitelist.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddMultipleDomainsToAccountWhitelist < BaseMutation
+        argument :account_id, ID, required: true
+        argument :domains, String, required: true
+        field :return_value, Boolean, null: false
+        def resolve(account_id:, domains:)
+          context[:canvas_api].call("ADD_MULTIPLE_DOMAINS_TO_ACCOUNT_WHITELIST").proxy(
+            "ADD_MULTIPLE_DOMAINS_TO_ACCOUNT_WHITELIST",
+            {
+              "account_id": account_id
+            },
+            {
+              "domains": domains
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_observee.rb

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/user"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddObservee < BaseMutation
+        argument :user_id, ID, required: true
+        argument :observee_id, ID, required: true
+        argument :root_account_id, ID, required: false
+        field :user, LMSGraphQL::Types::Canvas::CanvasUser, null: false
+        def resolve(user_id:, observee_id:, root_account_id: nil)
+          context[:canvas_api].call("ADD_OBSERVEE").proxy(
+            "ADD_OBSERVEE",
+            {
+              "user_id": user_id,
+              "observee_id": observee_id
+            },
+            {
+              "root_account_id": root_account_id
+            },
+          ).parsed_response
+        end
+      end
+    end
+  end
+end