strongmind-schoology-client 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/Gemfile +2 -0
- data/Gemfile.lock +3 -3
- data/README.md +17 -130
- data/lib/schoology_client/resource.rb +4 -0
- data/lib/schoology_client/resources/group.rb +4 -0
- data/lib/schoology_client/version.rb +1 -1
- metadata +19 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5a8b054bbe10861055ca0102df61c5bd6ccf0e6da5fdf6c3ee649bf10c4d7c0b
|
|
4
|
+
data.tar.gz: ac7642cd2fca0cfd334f34435a37ee600b9647796936e4b7161d21ef61a415c7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7a584941600d2195a0e8880dfdb409ddf430f1b42e69ed771121fc5626669a1b559db75056ad8e567c7d422513e7599782fbccd90342fcdaee08b6fd95a2bcb5
|
|
7
|
+
data.tar.gz: 290be694bcda76b9f754e12389dcb19a8e25fcd4cb68fe9d6d7cc676604244b4bec9ca6463d18813ae52eea5a6b7f98aebc8106b630754a0719985b7705d042c
|
data/CHANGELOG.md
CHANGED
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -1,146 +1,33 @@
|
|
|
1
|
+
# schoology-client
|
|
1
2
|
|
|
2
|
-
|
|
3
|
+
## What
|
|
3
4
|
|
|
4
|
-
|
|
5
|
+
schoology-client is a Schoology client library for learning management system integration and API interactions built with Ruby, YAML, JSON, Markdown using Ruby/Rails.
|
|
5
6
|
|
|
6
|
-
##
|
|
7
|
+
## Technology Stack
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
Delivery of Learnosity assessments to students and reporting student results to teachers.
|
|
9
|
+
**Languages:** Ruby, YAML, JSON, Markdown
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
**Frameworks/Tools:** Ruby/Rails
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
## Getting Started
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
* projects end users
|
|
17
|
-
* project outputs
|
|
18
|
-
* project data stores
|
|
15
|
+
### Prerequisites
|
|
19
16
|
|
|
20
|
-
|
|
17
|
+
[Add any prerequisites here]
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
### Installation
|
|
23
20
|
|
|
24
|
-
|
|
25
|
-
graph LR
|
|
26
|
-
subgraph project_components[Hypothetical Service]
|
|
21
|
+
[Add installation instructions here]
|
|
27
22
|
|
|
28
|
-
|
|
29
|
-
project_frontend[Hypothetical Service Frontend]
|
|
30
|
-
subgraph datastores[Data Stores]
|
|
31
|
-
postgres[PostgreSQL]
|
|
32
|
-
queue[SQS queue service]
|
|
33
|
-
end
|
|
34
|
-
end
|
|
23
|
+
### Usage
|
|
35
24
|
|
|
36
|
-
|
|
37
|
-
event_platform_input[Event Platform]
|
|
38
|
-
cloud_canvas[Cloud Canvas API]
|
|
39
|
-
identity[Identity Server]
|
|
40
|
-
end
|
|
25
|
+
[Add usage instructions here]
|
|
41
26
|
|
|
27
|
+
## Contributing
|
|
42
28
|
|
|
43
|
-
|
|
44
|
-
student[Student]
|
|
45
|
-
administrator[Administrator]
|
|
46
|
-
end
|
|
29
|
+
Please follow the team's coding standards and submit pull requests for any changes.
|
|
47
30
|
|
|
48
|
-
|
|
49
|
-
event_platform_out[Event Platform]
|
|
50
|
-
end
|
|
31
|
+
## Maintenance
|
|
51
32
|
|
|
52
|
-
|
|
53
|
-
cloud_canvas -->|Canvas User API get| project_api
|
|
54
|
-
identity -->|Authentication of users| project_frontend
|
|
55
|
-
|
|
56
|
-
project_frontend -->|Views a thing| student
|
|
57
|
-
administrator -->|Creates things| project_frontend
|
|
58
|
-
|
|
59
|
-
project_api -->|Sends create and view messages| event_platform_out
|
|
60
|
-
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Where?
|
|
64
|
-
|
|
65
|
-
### Links
|
|
66
|
-
|
|
67
|
-
A list of links to deployed software
|
|
68
|
-
For example:
|
|
69
|
-
|
|
70
|
-
* dev: [dev.strongmind.com](https://dev.strongmind.com)
|
|
71
|
-
* prod: [strongmind.com](https://strongmind.com)
|
|
72
|
-
|
|
73
|
-
### CI/CD
|
|
74
|
-
|
|
75
|
-
A link to CI/CD for this repository
|
|
76
|
-
For example:
|
|
77
|
-
|
|
78
|
-
* [https://github.com/StrongMind/culture/actions](https://github.com/StrongMind/culture/actions)
|
|
79
|
-
|
|
80
|
-
### Administration
|
|
81
|
-
|
|
82
|
-
A list of links to operational information, for example:
|
|
83
|
-
|
|
84
|
-
* [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)
|
|
85
|
-
* [Exception Tracking](https://sentry.io/organizations/strongmind-4j/projects/id-mapper/?project=6262579)
|
|
86
|
-
* [Monitoring & Metrics Dashboard](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=identifier-mapper-prod)
|
|
87
|
-
|
|
88
|
-
## Local Install
|
|
89
|
-
|
|
90
|
-
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:
|
|
91
|
-
|
|
92
|
-
### Mac
|
|
93
|
-
|
|
94
|
-
In this source directory:
|
|
95
|
-
|
|
96
|
-
1. Install homebrew
|
|
97
|
-
1. Install python 3.10 using homebrew `brew install python@3.10`
|
|
98
|
-
1. Install virtualenv and virtualenvwrapper `pip install virtualenv virtualenvwrapper`
|
|
99
|
-
1. Create virtual environment for project `mkvirtualenv project_name -p /opt/homebrew/opt/python@3.10/bin/python3`
|
|
100
|
-
1. Install project requirements `pip install -r requirements.txt`
|
|
101
|
-
|
|
102
|
-
#### Known Issues and Fixes
|
|
103
|
-
|
|
104
|
-
If your system python does not include pip, you will need to make sure pip is installed :
|
|
105
|
-
|
|
106
|
-
```console
|
|
107
|
-
python -m ensurepip # if your system python is at least 3.4
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
If your system python isn't at least 3.4, you will need to use your system package manager to install pip.
|
|
111
|
-
|
|
112
|
-
### Windows
|
|
113
|
-
|
|
114
|
-
In this source directory:
|
|
115
|
-
|
|
116
|
-
1. [Install python](https://www.python.org/downloads/release/python-3105/)
|
|
117
|
-
1. Open project in pycharm
|
|
118
|
-
1. Set interpreter installed python 3.10
|
|
119
|
-
1. Open shell
|
|
120
|
-
1. Install project requirements `pip install -r requirements.txt`
|
|
121
|
-
|
|
122
|
-
## Run tests locally
|
|
123
|
-
|
|
124
|
-
A set of instructions to run tests locally, for example:
|
|
125
|
-
|
|
126
|
-
```console
|
|
127
|
-
pytest
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
## Run service locally
|
|
131
|
-
|
|
132
|
-
A set of instructions to run service locally, for example:
|
|
133
|
-
|
|
134
|
-
### Mac (service)
|
|
135
|
-
|
|
136
|
-
```console
|
|
137
|
-
python manage.py runserver
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
### Windows (service)
|
|
141
|
-
|
|
142
|
-
```console
|
|
143
|
-
py manage.py runserver
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
> Code owners can be found in [CODEOWNERS file](./CODEOWNERS)
|
|
33
|
+
This repository is maintained by the StrongMind development team.
|
|
@@ -12,6 +12,10 @@ module SchoologyClient
|
|
|
12
12
|
handle_response @client.connection.post(url, body, headers)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
+
def put_request(url, body:, headers: {})
|
|
16
|
+
handle_response @client.connection.put(url, body, headers)
|
|
17
|
+
end
|
|
18
|
+
|
|
15
19
|
def handle_response(response)
|
|
16
20
|
case response.status
|
|
17
21
|
when 400
|
|
@@ -6,6 +6,10 @@ module SchoologyClient
|
|
|
6
6
|
def create(**attributes)
|
|
7
7
|
GroupResource.new post_request("groups", body: attributes.to_json).body
|
|
8
8
|
end
|
|
9
|
+
|
|
10
|
+
def update(id, **attributes)
|
|
11
|
+
GroupResource.new put_request("groups/#{id}", body: attributes.to_json).body
|
|
12
|
+
end
|
|
9
13
|
end
|
|
10
14
|
end
|
|
11
15
|
|
metadata
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: strongmind-schoology-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Strongmind
|
|
8
|
-
autorequire:
|
|
9
8
|
bindir: exe
|
|
10
9
|
cert_chain: []
|
|
11
|
-
date:
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
11
|
dependencies:
|
|
13
12
|
- !ruby/object:Gem::Dependency
|
|
14
13
|
name: faraday
|
|
@@ -42,31 +41,42 @@ dependencies:
|
|
|
42
41
|
name: rails
|
|
43
42
|
requirement: !ruby/object:Gem::Requirement
|
|
44
43
|
requirements:
|
|
45
|
-
- - "
|
|
44
|
+
- - ">="
|
|
46
45
|
- !ruby/object:Gem::Version
|
|
47
46
|
version: '7.0'
|
|
47
|
+
- - "<"
|
|
48
|
+
- !ruby/object:Gem::Version
|
|
49
|
+
version: '9'
|
|
48
50
|
type: :runtime
|
|
49
51
|
prerelease: false
|
|
50
52
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
53
|
requirements:
|
|
52
|
-
- - "
|
|
54
|
+
- - ">="
|
|
53
55
|
- !ruby/object:Gem::Version
|
|
54
56
|
version: '7.0'
|
|
57
|
+
- - "<"
|
|
58
|
+
- !ruby/object:Gem::Version
|
|
59
|
+
version: '9'
|
|
55
60
|
- !ruby/object:Gem::Dependency
|
|
56
61
|
name: railties
|
|
57
62
|
requirement: !ruby/object:Gem::Requirement
|
|
58
63
|
requirements:
|
|
59
|
-
- - "
|
|
64
|
+
- - ">="
|
|
60
65
|
- !ruby/object:Gem::Version
|
|
61
66
|
version: '7.0'
|
|
67
|
+
- - "<"
|
|
68
|
+
- !ruby/object:Gem::Version
|
|
69
|
+
version: '9'
|
|
62
70
|
type: :runtime
|
|
63
71
|
prerelease: false
|
|
64
72
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
73
|
requirements:
|
|
66
|
-
- - "
|
|
74
|
+
- - ">="
|
|
67
75
|
- !ruby/object:Gem::Version
|
|
68
76
|
version: '7.0'
|
|
69
|
-
|
|
77
|
+
- - "<"
|
|
78
|
+
- !ruby/object:Gem::Version
|
|
79
|
+
version: '9'
|
|
70
80
|
email:
|
|
71
81
|
- qwertytalk@strongmind.com
|
|
72
82
|
executables: []
|
|
@@ -102,7 +112,6 @@ metadata:
|
|
|
102
112
|
homepage_uri: https://github.com/Strongmind/schoology-client
|
|
103
113
|
source_code_uri: https://github.com/Strongmind/schoology-client
|
|
104
114
|
changelog_uri: https://github.com/Strongmind/schoology-client
|
|
105
|
-
post_install_message:
|
|
106
115
|
rdoc_options: []
|
|
107
116
|
require_paths:
|
|
108
117
|
- lib
|
|
@@ -117,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
117
126
|
- !ruby/object:Gem::Version
|
|
118
127
|
version: '0'
|
|
119
128
|
requirements: []
|
|
120
|
-
rubygems_version: 3.
|
|
121
|
-
signing_key:
|
|
129
|
+
rubygems_version: 3.6.7
|
|
122
130
|
specification_version: 4
|
|
123
131
|
summary: API wrapper for Schoology LMS API
|
|
124
132
|
test_files: []
|