lms-graphql-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c12f95e7af09d2c524298e6acff5c06773fcd6f20afd78f993a27b13eb54037f
+  data.tar.gz: 5710ff782e400c2f788e4b4202a7c389f176cfd9083a16d175cf237051dab077
+SHA512:
+  metadata.gz: 455dbabb866491b214724958d74a88fb6780d40fd0cd2021192b61d702b372ddad57a50c12c8e7290ce4ce4045f4c24c1c9d5f2dde2163ba308a019534b5d118
+  data.tar.gz: 783f76563f78be9e1f9e5e380ed6ad2d463364570ed48ec8cd41eebc983b7716ca4945a50d9244c89be2e776822b1b4e9b5a6621dfb030e52a16529a038aada0

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

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

data/lib/lms/graphql/canvas_schema.rb

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

data/lib/lms/graphql/mutations/canvas/abort_all_pending_sis_imports.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_mutation"
+
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AbortAllPendingSisImport < CanvasBaseMutation
+          argument :account_id, ID, required: true
+          field :return_value, Boolean, null: false
+          def resolve(account_id:)
+            ctx[:canvas_api].proxy(
+              "ABORT_ALL_PENDING_SIS_IMPORTS",
+              {
+                "account_id": account_id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/abort_generation_of_report_or_remove_previously_generated_one.rb

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_mutation"
+
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AbortGenerationOfReportOrRemovePreviouslyGeneratedOne < CanvasBaseMutation
+          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:)
+            ctx[:canvas_api].proxy(
+              "ABORT_GENERATION_OF_REPORT_OR_REMOVE_PREVIOUSLY_GENERATED_ONE",
+              {
+                "course_id": course_id,
+                "quiz_id": quiz_id,
+                "id": id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/abort_sis_import.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/sis_import"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AbortSisImport < CanvasBaseMutation
+          argument :account_id, ID, required: true
+          argument :id, ID, required: true
+          field :sis_import, LMS::GraphQL::Types::Canvas::SisImport, null: false
+          def resolve(account_id:, id:)
+            ctx[:canvas_api].proxy(
+              "ABORT_SIS_IMPORT",
+              {
+                "account_id": account_id,
+                "id": id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/accept_course_invitation.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AcceptCourseInvitation < CanvasBaseMutation
+          argument :course_id, ID, required: true
+          argument :id, ID, required: true
+          field :return_value, Boolean, null: false
+          def resolve(course_id:, id:)
+            ctx[:canvas_api].proxy(
+              "ACCEPT_COURSE_INVITATION",
+              {
+                "course_id": course_id,
+                "id": id              },
+              nil,
+            ).parsed_response
+          end
+        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 LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class ActivateRole < CanvasBaseMutation
+          argument :account_id, ID, required: true
+          argument :id, ID, required: true
+          argument :role_id, ID, required: true
+          argument :role, String, required: false
+          field :role, LMS::GraphQL::Types::Canvas::Role, null: false
+          def resolve(account_id:, id:, role_id:, role: nil)
+            ctx[:canvas_api].proxy(
+              "ACTIVATE_ROLE",
+              {
+                "account_id": account_id,
+                "id": id,
+                "role_id": role_id,
+                "role": role              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_authentication_provider.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/authentication_provider"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddAuthenticationProvider < CanvasBaseMutation
+          argument :account_id, ID, required: true
+          field :authentication_provider, LMS::GraphQL::Types::Canvas::AuthenticationProvider, null: false
+          def resolve(account_id:)
+            ctx[:canvas_api].proxy(
+              "ADD_AUTHENTICATION_PROVIDER",
+              {
+                "account_id": account_id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_course_to_favorites.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/favorite"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddCourseToFavorite < CanvasBaseMutation
+          argument :id, ID, required: true
+          field :favorite, LMS::GraphQL::Types::Canvas::Favorite, null: false
+          def resolve(id:)
+            ctx[:canvas_api].proxy(
+              "ADD_COURSE_TO_FAVORITES",
+              {
+                "id": id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_group_to_favorites.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/favorite"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddGroupToFavorite < CanvasBaseMutation
+          argument :id, ID, required: true
+          field :favorite, LMS::GraphQL::Types::Canvas::Favorite, null: false
+          def resolve(id:)
+            ctx[:canvas_api].proxy(
+              "ADD_GROUP_TO_FAVORITES",
+              {
+                "id": id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_message.rb

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_mutation"
+
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddMessage < CanvasBaseMutation
+          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)
+            ctx[:canvas_api].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              },
+              nil,
+            ).parsed_response
+          end
+        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 LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddObservee < CanvasBaseMutation
+          argument :user_id, ID, required: true
+          argument :observee_id, ID, required: true
+          argument :root_account_id, ID, required: false
+          field :user, LMS::GraphQL::Types::Canvas::User, null: false
+          def resolve(user_id:, observee_id:, root_account_id: nil)
+            ctx[:canvas_api].proxy(
+              "ADD_OBSERVEE",
+              {
+                "user_id": user_id,
+                "observee_id": observee_id,
+                "root_account_id": root_account_id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_observee_with_credentials.rb

@@ -0,0 +1,30 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/user"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddObserveeWithCredential < CanvasBaseMutation
+          argument :user_id, ID, required: true
+          argument :observee_unique_id, String, required: false
+          argument :observee_password, String, required: false
+          argument :access_token, String, required: false
+          argument :root_account_id, ID, required: false
+          field :user, LMS::GraphQL::Types::Canvas::User, null: false
+          def resolve(user_id:, observee_unique_id: nil, observee_password: nil, access_token: nil, root_account_id: nil)
+            ctx[:canvas_api].proxy(
+              "ADD_OBSERVEE_WITH_CREDENTIALS",
+              {
+                "user_id": user_id,
+                "observee[unique_id]": observee_unique_id,
+                "observee[password]": observee_password,
+                "access_token": access_token,
+                "root_account_id": root_account_id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/add_recipients.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddRecipient < CanvasBaseMutation
+          argument :id, ID, required: true
+          argument :recipients, String, required: true
+          field :return_value, Boolean, null: false
+          def resolve(id:, recipients:)
+            ctx[:canvas_api].proxy(
+              "ADD_RECIPIENTS",
+              {
+                "id": id,
+                "recipients": recipients              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/mutations/canvas/adds_last_attended_date_to_student_enrollment_in_course.rb

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_mutation"
+require_relative "../../types/canvas/enrollment"
+module LMS
+  module GraphQL
+    module Mutations
+      module Canvas
+        class AddsLastAttendedDateToStudentEnrollmentInCourse < CanvasBaseMutation
+          argument :course_id, ID, required: true
+          argument :user_id, ID, required: true
+          field :enrollment, LMS::GraphQL::Types::Canvas::Enrollment, null: false
+          def resolve(course_id:, user_id:)
+            ctx[:canvas_api].proxy(
+              "ADDS_LAST_ATTENDED_DATE_TO_STUDENT_ENROLLMENT_IN_COURSE",
+              {
+                "course_id": course_id,
+                "user_id": user_id              },
+              nil,
+            ).parsed_response
+          end
+        end
+      end
+    end
+  end
+end