strongmind-schoology-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 159bb005234f79cb05952d04e5c8df61ea13c93d39947bf324803faf291a3f43
+  data.tar.gz: '06921f258d447fa3c5a11eddba6887b3edceb52c009af251773d908954de0796'
+SHA512:
+  metadata.gz: 32eba4f569170e2e4ab5046b933a83e4f03caa3c5ce787f05d1a69772e1ae8c2f9bbca039dc5378c82d43a29d3f0830bce661806a54bc48b3ae7054fd9e96f43
+  data.tar.gz: 7ce82c65442e995394e9b006d12b57f14b5e08769c129f0b29ab5f66311eefda5bfd351ee776abfbb883730dd079c575638d8937cb54e679da1ee102f7a5aad8

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-28
+
+- Initial release

data/CODEOWNERS

@@ -0,0 +1,6 @@
+# This File was Automatically generated by Devops
+# The first few lines should be consistant across all repos
+/.github/* @StrongMind/binary-ops
+/infrastructure/* @StrongMind/binary-ops
+
+* @StrongMind/qwerty-talkers

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in schoology.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    schoology (0.1.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  schoology!
+
+BUNDLED WITH
+   2.3.6

data/README.md

@@ -0,0 +1,146 @@
+
+# Example README
+
+This is an example of what we expect in a README.
+
+## What?
+
+A summary of the purpose of this piece of software, for example:
+Delivery of Learnosity assessments to students and reporting student results to teachers.
+
+### Diagram
+
+A diagram showing all of the following:
+
+* project inputs
+* projects end users
+* project outputs
+* project data stores
+
+([see mermaid documentation on how to create these diagrams](https://mermaid-js.github.io/mermaid/#/./flowchart?id=flowcharts-basic-syntax))
+
+For example:
+
+```mermaid
+graph LR
+    subgraph project_components[Hypothetical Service]
+
+        project_api[Hypothetical Service API]
+        project_frontend[Hypothetical Service Frontend]
+        subgraph datastores[Data Stores]
+        postgres[PostgreSQL]
+            queue[SQS queue service]
+        end
+    end
+
+    subgraph inputs[Inputs]
+        event_platform_input[Event Platform]
+            cloud_canvas[Cloud Canvas API]
+            identity[Identity Server]
+    end
+
+
+    subgraph end_users[End Users]
+        student[Student]
+            administrator[Administrator]
+    end
+
+    subgraph outputs[Outputs]
+        event_platform_out[Event Platform]
+    end
+
+    event_platform_input -->|Canvas Change Events| project_api
+    cloud_canvas -->|Canvas User API get| project_api
+    identity -->|Authentication of users| project_frontend
+
+    project_frontend -->|Views a thing| student
+    administrator -->|Creates things| project_frontend
+
+    project_api -->|Sends create and view messages| event_platform_out
+
+```
+
+## Where?
+
+### Links
+
+A list of links to deployed software
+For example:
+
+* dev: [dev.strongmind.com](https://dev.strongmind.com)
+* prod: [strongmind.com](https://strongmind.com)
+
+### CI/CD
+
+A link to CI/CD for this repository
+For example:
+
+* [https://github.com/StrongMind/culture/actions](https://github.com/StrongMind/culture/actions)
+
+### Administration
+
+A list of links to operational information, for example:
+
+* [Logs](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#logsV2:logs-insights$3FqueryDetail$%5B%E2%80%A6%5D*2flambda*2fid-mapper-prod$2529$2529)
+* [Exception Tracking](https://sentry.io/organizations/strongmind-4j/projects/id-mapper/?project=6262579)
+* [Monitoring & Metrics Dashboard](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=identifier-mapper-prod)
+
+## Local Install
+
+A set of comprehensive instructions to install from scratch on a developer workstation. We suggest you test these with a member from another team. For example:
+
+### Mac
+
+In this source directory:
+
+1. Install homebrew
+1. Install python 3.10 using homebrew `brew install python@3.10`
+1. Install virtualenv and virtualenvwrapper `pip install virtualenv virtualenvwrapper`
+1. Create virtual environment for project `mkvirtualenv project_name -p /opt/homebrew/opt/python@3.10/bin/python3`
+1. Install project requirements `pip install -r requirements.txt`
+
+#### Known Issues and Fixes
+
+If your system python does not include pip, you will need to make sure pip is installed :
+
+```console
+python -m ensurepip # if your system python is at least 3.4
+```
+
+If your system python isn't at least 3.4, you will need to use your system package manager to install pip.
+
+### Windows
+
+In this source directory:
+
+1. [Install python](https://www.python.org/downloads/release/python-3105/)
+1. Open project in pycharm
+1. Set interpreter installed python 3.10
+1. Open shell
+1. Install project requirements `pip install -r requirements.txt`
+
+## Run tests locally
+
+A set of instructions to run tests locally, for example:
+
+```console
+pytest
+```
+
+## Run service locally
+
+A set of instructions to run service locally, for example:
+
+### Mac (service)
+
+```console
+python manage.py runserver
+```
+
+### Windows (service)
+
+```console
+py manage.py runserver
+```
+
+> Code owners can be found in [CODEOWNERS file](./CODEOWNERS)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/schoology-client/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SchoologyClient
+  class Client
+    BASE_URL = "https://schoologysandbox.schoology.com/v1"
+
+    attr_reader :oauth_token, :adapter
+
+    def initialize(oauth_token:, adapter: Faraday.default_adapter, stubs: nil)
+      @oauth_token = oauth_token
+      @adapter = adapter
+      #used for tests
+      @stubs = stubs
+    end
+
+    def group
+      GroupResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, oauth_token
+        conn.request :json
+
+        conn.response :dates
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end
+

data/lib/schoology-client/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module SchoologyClient
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/schoology-client/objects/group.rb

@@ -0,0 +1,4 @@
+module SchoologyClient
+  class Group < Object
+  end
+end

data/lib/schoology-client/resource.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SchoologyClient
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body["error"]}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body["error"]}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body["error"]}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body["error"]}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body["error"]}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body["error"]}"
+      when 503
+        raise Error, "You have been rate limited for sending more than 20 requests per second. #{response.body["error"]}"
+      end
+
+      response
+    end
+  end
+end

data/lib/schoology-client/resources/group.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SchoologyClient
+  class GroupResource < Resource
+    def create(**attributes)
+      GroupResource.new post_request("groups", body: attributes).body
+    end
+  end
+end
+

data/lib/schoology-client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SchoologyClient
+  VERSION = "0.1.0"
+end

data/lib/schoology-client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require_relative "schoology-client/version"
+
+module SchoologyClient
+  autoload :Client, "schoology-client/client"
+  autoload :Object, "schoology-client/object"
+  autoload :Resource, "schoology-client/resource"
+
+  # High-level categories of Schoology API calls
+  autoload :GroupResource, "schoology-client/resources/group"
+
+  # Classes used to return a nicer object wrapping the response data
+  autoload :Group, "schoology/objects/group"
+end

data/sig/schoology.rbs

@@ -0,0 +1,4 @@
+module Schoology
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: strongmind-schoology-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Strongmind
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- qwertytalk@strongmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/schoology-client.rb
+- lib/schoology-client/client.rb
+- lib/schoology-client/object.rb
+- lib/schoology-client/objects/group.rb
+- lib/schoology-client/resource.rb
+- lib/schoology-client/resources/group.rb
+- lib/schoology-client/version.rb
+- sig/schoology.rbs
+homepage: https://github.com/Strongmind/schoology-client
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Strongmind/schoology-client
+  source_code_uri: https://github.com/Strongmind/schoology-client
+  changelog_uri: https://github.com/Strongmind/schoology-client
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: API wrapper for Schoology LMS API
+test_files: []