sls_adf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 320145d0c458d8b27b4851cc1b483fbfa3cd89a6
+  data.tar.gz: d64bfb2d2dfabf65eee07566b1741dcacef22b2a
+SHA512:
+  metadata.gz: 339d93578a8a0e79043f27da8ca5056aa41c05062751431b17266309cd0e91505cd528b87df53e2233ddb2a368b4500478e05edad11734a75aabdd2b5aaff6ab
+  data.tar.gz: d3d42b2b1032839dc7aa3b93aab6b4aa96cffb71db70e5efa1772d9eda595da5cae313d4baf9338ac0f81eb5b2c671f9bacdbd72904b6a3c9419cd04676713cf

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+plugins:
+  bundler-audit:
+    enabled: true

data/.env.example

@@ -0,0 +1,4 @@
+GRAPHQL_URL=http://example.com/graphql
+GET_TOKEN_URL=https://example.com/token
+CLIENT_ID=test_client_id
+CLIENT_SECRET=test_client_secret

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore actual env file
+.env

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,32 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  only:
+    - master
+
+bundler_args: "--jobs=3 --retry=3"
+cache: bundler
+
+before_install:
+  - gem install bundler -v 1.16.0
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  disabled: true

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sls_adf.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    sls_adf (0.0.1)
+      graphql-client (~> 0.12)
+      typhoeus (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dotenv (2.2.1)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    graphql (1.7.7)
+    graphql-client (0.12.2)
+      activesupport (>= 3.0, < 6.0)
+      graphql (~> 1.6)
+    hashdiff (0.3.7)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.10.3)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rdoc (6.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv (~> 2.2)
+  rake (~> 10.0)
+  rdoc
+  rspec (~> 3.0)
+  simplecov
+  sls_adf!
+  webmock
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Experimental Systems and Technology Lab
+
+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,86 @@
+[![Build Status](https://travis-ci.org/moexmen/sls_adf.svg?branch=master)](https://travis-ci.org/moexmen/sls_adf) [![Maintainability](https://api.codeclimate.com/v1/badges/5d7c2801d4a37ecf8cdf/maintainability)](https://codeclimate.com/github/moexmen/sls_adf/maintainability)
+
+# SLS ADF - Ruby Client Library
+
+Ruby support for GraphQL API calls to MOE's Student Learning Space.
+This includes a few functionalities:
+  - Token management
+  - GraphQL Templates
+
+Requires Ruby 2.4+.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sls_adf'
+```
+
+Configure the gem in the following manner:
+(This can be placed in `config/initializers/` for Rails applications)
+
+```ruby
+SlsAdf.configure do |c|
+  c.graphql_url = 'https://example.com'
+  c.get_token_url = 'https://example.com/token'
+  c.client_id = 'Foo'
+  c.client_secret = 'Bar'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+`sls_adf` provides ruby methods which can be used to make GraphQL calls to SLS ADF.
+To use, follow the installation instructions above and configure the necessary details.
+
+```ruby
+# Queries
+response = SlsAdf::Query.user('id')
+response = SlsAdf::Query.context('uuid')
+response = SlsAdf::Query.subject_group('uuid')
+response = SlsAdf::Query.assignment('uuid')
+response = SlsAdf::Query.task('uuid')
+
+# Mutations
+response = SlsAdf::Mutation.create_assignment(assignment_input)
+response = SlsAdf::Mutation.update_assignment(uuid, assignment_input)
+response = SlsAdf::Mutation.delete_assignment(uuid)
+response = SlsAdf::Mutation.update_task(uuid, task_input)
+response = SlsAdf::Mutation.create_notification(notification_input)
+```
+
+## Customization
+
+`sls_adf` uses Github's [graphql-client](https://github.com/github/graphql-client) for
+graphql functionality, and [Typhoeus](https://github.com/typhoeus/typhoeus) to make
+http calls.
+
+Two classes, `Adapter` (`SlsAdf::Util::Adapter`) and `Token` (`SlsAdf::Util::Token`) are
+defined in this gem to support the most naive use case. These classes are designed to be
+extended or replaced to support different use cases.
+
+#### Customised GraphQL Calls
+
+`sls_adf` provides pre-defined GraphQL calls to ADF. Should you require a different call,
+you may define new GraphQL queries, mutations or fragments. Thereafter, you can construct
+your own class that uses these templates and inherits from `SlsAdf::Base`.
+
+## Development
+
+Key Commands:
+ - `bin/setup`: Install dependencies and copy `.env` file.
+ - `bin/console`: Run an interactive prompt (requires configuration on .`env` file)
+ - `rake spec` or `bundle exec rspec`: Run tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/moexmen/sls_adf).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'rdoc/task'
+desc 'Generate documentation for the SLS ADF gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SLS ADF'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md', 'LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+
+# Load environment variables for configuration
+require 'dotenv'
+Dotenv.load
+
+# Configure Gem
+require 'sls_adf'
+SlsAdf.configure do |config|
+  config.graphql_url = ENV['GRAPHQL_URL']
+  config.get_token_url = ENV['GET_TOKEN_URL']
+  config.client_id = ENV['CLIENT_ID']
+  config.client_secret = ENV['CLIENT_SECRET']
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
+cp .env.example .env

data/lib/sls_adf/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SlsAdf
+  # Base class used to build custom classes to make ADF API calls.
+  class Base
+    class << self
+      protected
+
+      # Helper method used to execute queries.
+      #
+      # @param [GraphQL::Client::Definition] template The template to be used.
+      # @param [Hash] vars Variables to be passed into the query.
+      def execute_query(template, vars = {})
+        SlsAdf.client.query(template, variables: vars)
+      end
+    end
+  end
+end

data/lib/sls_adf/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Provides configuration for the sls_adf gem.
+module SlsAdf
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Helper function to configure the sls_adf gem.
+  #
+  # @yield [configuration] Block to modify the configuration
+  # @yieldparam [SlsAdf::Configuration] The configuration object to be modified
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # Class to store sls_adf configuration.
+  class Configuration
+    attr_accessor :graphql_url, :get_token_url, :client_id, :client_secret
+
+    def initialize; end
+  end
+end

data/lib/sls_adf/mutation.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'sls_adf/template/mutation'
+
+module SlsAdf
+  # Make GraphQL mutation calls to SLS ADF through Ruby methods.
+  #
+  # Sample Usage:
+  #   response = SlsAdf::Mutation.delete_assignment('Assignment-1234')
+  class Mutation < Base
+    class << self
+      # Makes a call to create assignment. assignment_input has the following shape:
+      #
+      #   {
+      #     title: 'Test',
+      #     start: '2017-11-30T10:15:30+01:00', #ISO8601 format
+      #     end: '2017-12-30T12:15:30Z', #ISO8601 format
+      #     createdBy: 'MOE-1234',
+      #     type: 'QUIZ',
+      #     subjectGroupUuid: 'subject-group-uuid',
+      #     assignees: ['MOE-1235', 'MOE-1236', ...]
+      #   }
+      #
+      # @param[Hash] assignment_input
+      # @return [GraphQL::Client::Response] The response object
+      def create_assignment(assignment_input)
+        execute_query(SlsAdf::Template::Mutation::Assignment::Create,
+                      assignment_input: assignment_input)
+      end
+
+      # Makes a call to update assignment. See #create_assignment for assignment_input shape.
+      # If field is null, field will not be updated.
+      #
+      # @param[Hash] uuid UUID of the subject_group to be modified
+      # @param[Hash] assignment_input
+      # @return [GraphQL::Client::Response] The response object
+      def update_assignment(uuid, assignment_input)
+        execute_query(SlsAdf::Template::Mutation::Assignment::Update,
+                      uuid: uuid, assignment_input: assignment_input)
+      end
+
+      # Makes a call to delete the assignment with the given UUID
+      #
+      # @param[Hash] uuid UUID of the subject_group to be modified
+      # @return [GraphQL::Client::Response] The response object
+      def delete_assignment(uuid)
+        execute_query(SlsAdf::Template::Mutation::Assignment::Delete, uuid: uuid)
+      end
+
+      # Makes a call to update the task. Task status is one of the following:
+      #  'NEW', 'IN_PROGRESS', 'COMPLETED'
+      #
+      # @param[String] uuid UUID of task to be updated
+      # @param[String] status Status of the task to be updated
+      # @return [GraphQL::Client::Response] The response object
+      def update_task(uuid, status)
+        execute_query(SlsAdf::Template::Mutation::Task::Update,
+                      uuid: uuid, task_status: status)
+      end
+
+      # Makes a call to create a notification. notification_input has the following shape:
+      #
+      #   {
+      #     message: 'Assignment 1 has started!',
+      #     scope: 'SUBJECT_GROUP', #
+      #     scopeId: '', #
+      #     eventType: '', #
+      #     eventTypeId: '' # UUID,
+      #     receipient: ['', '', ...] # User ID.
+      #   }
+      #
+      # @param[Hash] notification_input
+      # @return [GraphQL::Client::Response] The response object
+      def create_notification(notification_input)
+        execute_query(SlsAdf::Template::Mutation::Notification::Add,
+                      notification_input: notification_input)
+      end
+    end
+  end
+end

data/lib/sls_adf/query.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'sls_adf/template/query'
+
+module SlsAdf
+  # Make GraphQL query calls to SLS ADF through Ruby methods.
+  #
+  # Sample Usage:
+  #   response = SlsAdf::Query.user('User-1234')
+  class Query < Base
+    class << self
+      # Query the information of the context token provided.
+      #
+      # @param [String] uuid Context token provided through loading of the application.
+      # @return [GraphQL::Client::Response] Response of GraphQL call.
+      def context(uuid)
+        execute_query(SlsAdf::Template::Query::Context, uuid: uuid)
+      end
+
+      # Query the information of the user with the given ID.
+      #
+      # @param [String] id ID of the given user.
+      # @return [GraphQL::Client::Response] Response of GraphQL call.
+      def user(id)
+        execute_query(SlsAdf::Template::Query::User, id: id, first: 10)
+      end
+
+      # Query the information of the subject group with the given UUID.
+      #
+      # @param [String] uuid UUID of the subject group.
+      # @return [GraphQL::Client::Response] Response of GraphQL call.
+      def subject_group(uuid)
+        execute_query(SlsAdf::Template::Query::SubjectGroup,
+                      uuid: uuid, first_student: 45, first_teacher: 30)
+      end
+
+      # Query the information of the assignment with the given UUID.
+      #
+      # @param [String] uuid UUID of the assignment.
+      # @return [GraphQL::Client::Response] Response of GraphQL call.
+      def assignment(uuid)
+        execute_query(SlsAdf::Template::Query::Assignment, uuid: uuid)
+      end
+
+      # Query the information of the task with the given UUID.
+      #
+      # @param [String] uuid UUID of the task.
+      # @return [GraphQL::Client::Response] Response of GraphQL call.
+      def task(uuid)
+        execute_query(SlsAdf::Template::Query::Task, uuid: uuid)
+      end
+    end
+  end
+end