oneroster 1.3.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Bobby Julius
+
+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,110 @@
+# OneRoster
+
+This is a simple Ruby API wrapper for OneRoster.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'one_roster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install one_roster
+
+## Usage
+
+### Configuration
+The gem can be initialized as follows:
+
+```ruby
+client = OneRoster::Client.configure do |config|
+  config.app_id     = 'app_id for district'
+  config.app_secret = 'app_secret for district'
+  config.api_url    = 'api_url for district'
+end
+```
+
+### Requests
+This gem supports requesting:
+  - Students 
+  - Teachers
+  - Classes
+  - Classrooms 
+  - Courses 
+  - Enrollments
+  
+#### Students
+- Request all students: 
+  ```ruby
+    client.students
+  ```
+- Request a subset of students filtered by their `sourcedId`:
+  ```ruby
+    client.students([student_1['sourcedId']], student_2['sourcedId'], …])
+  ``` 
+#### Teachers
+- Request all students: 
+  ```ruby
+  client.teachers
+  ```
+- Request a subset of teachers filtered by their `sourcedId`:
+  ```ruby
+  client.teachers([teacher_1['sourcedId']], teacher_2['sourcedId'], …])
+  ``` 
+#### Classes
+- Request all classes: 
+  ```ruby
+  client.classes
+  ```
+- Request a subset of classes filtered by their `sourcedId`:
+  ```ruby
+  client.classes([class_1['sourcedId']], class_2['sourcedId'], …])
+  ``` 
+#### Classrooms
+- Request all classrooms: 
+  ```ruby
+  client.classrooms
+  ```
+- Request a subset of active classrooms whose UIDs are found in OneRoster's classes, filtered by their course's `sourcedId`:
+  ```ruby
+  client.classes([enrollment_1['course']['sourcedId'], enrollment_2['course']['sourcedId'], …])
+  ``` 
+#### Courses
+- Request all courses: 
+  ```ruby
+  client.courses
+  ```
+- Request a subset of active courses whose UIDs are found in OneRoster's classes, filtered by their `sourcedId`:
+  ```ruby
+  client.classes([course_1['sourcedId'], course_2['sourcedId'], …])
+  ``` 
+#### Enrollments
+- Request all enrollments
+  ```ruby
+    client.enrollments
+  ```
+- Request a subset of active enrollments filtered by their class's `sourcedID`: 
+  ```ruby
+  client.enrollments([class_1['sourcedId'], class_2['sourcedId']])
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tci/oneroster.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'one_roster'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/lib/one_roster.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+require 'dry/inflector'
+require 'faraday'
+require 'faraday_middleware'
+require 'oauth'
+require 'simple_oauth'
+
+require 'one_roster/client'
+require 'one_roster/connection'
+require 'one_roster/paginator'
+require 'one_roster/response'
+require 'one_roster/version'
+
+require 'types/base'
+require 'types/course'
+require 'types/class'
+require 'types/classroom'
+require 'types/enrollment'
+require 'types/student'
+require 'types/teacher'
+
+module OneRoster
+  class DistrictNotFound < StandardError; end
+  class ConnectionError < StandardError; end
+
+  STUDENTS_ENDPOINT    = 'ims/oneroster/v1p1/students'
+  TEACHERS_ENDPOINT    = 'ims/oneroster/v1p1/teachers'
+  COURSES_ENDPOINT     = 'ims/oneroster/v1p1/courses'
+  CLASSES_ENDPOINT     = 'ims/oneroster/v1p1/classes'
+  ENROLLMENTS_ENDPOINT = 'ims/oneroster/v1p1/enrollments'
+
+  RESPONSE_TYPE_MAP = {
+    'teachers'     => 'users',
+    'students'     => 'users',
+    'courses'      => 'courses',
+    'classes'      => 'classes',
+    'enrollments'  => 'enrollments'
+  }.freeze
+end

data/lib/one_roster/client.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module OneRoster
+  class Client
+    attr_accessor :app_id, :app_token, :api_url,
+                  :app_secret, :logger, :vendor_key,
+                  :username_source, :oauth_strategy
+
+    attr_reader :authenticated
+
+    def initialize(oauth_strategy = 'oauth')
+      @authenticated = false
+      @oauth_strategy = oauth_strategy
+    end
+
+    def self.configure
+      client = new
+      yield(client) if block_given?
+      client
+    end
+
+    %i(students teachers classes).each do |record_type|
+      define_method(record_type) do |record_uids = []|
+        authenticate
+
+        endpoint = OneRoster.const_get("#{record_type.upcase}_ENDPOINT")
+
+        type = Types.const_get(Dry::Inflector.new.singularize(record_type.to_s.capitalize))
+
+        records = Paginator.fetch(connection, endpoint, :get, type, client: self).force
+
+        return records if record_uids.empty?
+
+        records.select { |record| record_uids.to_set.include?(record.uid) }
+      end
+    end
+
+    def classrooms(course_codes = [])
+      authenticate
+
+      oneroster_classes = classes
+
+      courses = courses(course_codes, oneroster_classes)
+
+      oneroster_classes.each_with_object([]) do |oneroster_class, oneroster_classes|
+        course = courses.find { |course| course.uid == oneroster_class.course_uid }
+        next unless course
+
+        oneroster_classes << Types::Classroom.new(
+          'id' => oneroster_class.uid,
+          'name' => oneroster_class.title,
+          'course_number' => course.course_code,
+          'period' => oneroster_class.period,
+          'grades' => oneroster_class.grades
+        )
+      end
+    end
+
+    def courses(course_codes = [], oneroster_classes = classes)
+      authenticate
+
+      class_course_numbers = oneroster_classes.map(&:course_uid)
+
+      courses = Paginator.fetch(
+        connection,
+        COURSES_ENDPOINT,
+        :get,
+        Types::Course,
+        client: self
+      ).force
+
+      parse_courses(courses, course_codes, class_course_numbers)
+    end
+
+    def enrollments(classroom_uids = [])
+      authenticate
+
+      enrollments = parse_enrollments(classroom_uids)
+
+      p "Found #{enrollments.values.flatten.length} enrollments."
+
+      enrollments
+    end
+
+    def authenticate
+      return if authenticated?
+
+      if oauth_strategy == 'oauth2'
+        response = token
+
+        fail ConnectionError, response.raw_body unless response.success?
+
+        set_auth_headers(response.raw_body, response.headers['set-cookie'])
+      else
+        response = connection.execute(TEACHERS_ENDPOINT, :get, limit: 1)
+
+        fail ConnectionError, response.raw_body unless response.success?
+      end
+
+      @authenticated = true
+    end
+
+    def authenticated?
+      @authenticated
+    end
+
+    def connection
+      @connection ||= Connection.new(self, oauth_strategy)
+    end
+
+    def token
+      connection.execute("#{api_url}/token", :post)
+    end
+
+    def set_auth_headers(token, cookie)
+      connection.set_auth_headers(token['access_token'], cookie)
+    end
+
+    private
+
+    def parse_enrollments(classroom_uids = [])
+      enrollments = Paginator.fetch(
+        connection,
+        ENROLLMENTS_ENDPOINT,
+        :get,
+        Types::Enrollment,
+        client: self
+      ).force
+
+      enrollments.each_with_object(teacher: [], student: []) do |enrollment, enrollments|
+        next if classroom_uids.any? && !classroom_uids.include?(enrollment.classroom_uid)
+
+        enrollments[enrollment.role.to_sym] << enrollment if enrollment.valid?
+      end
+    end
+
+    def parse_courses(courses, course_codes, course_numbers)
+      courses.select do |course|
+        in_course_numbers = course_numbers.include?(course.uid)
+
+        if course_codes.any?
+          course_codes.include?(course.course_code) && in_course_numbers
+        else
+          in_course_numbers
+        end
+      end
+    end
+  end
+end

data/lib/one_roster/connection.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OneRoster
+  class Connection
+    OPEN_TIMEOUT = 60
+    TIMEOUT = 120
+
+    def initialize(client, oauth_strategy = 'oauth')
+      @client = client
+      @oauth_strategy = oauth_strategy
+    end
+
+    def execute(path, method = :get, params = nil, body = nil)
+      Response.new(raw_request(path, method, params, body))
+    end
+
+    def set_auth_headers(token, cookie)
+      connection.authorization :Bearer, token
+      @cookie = cookie
+    end
+
+    def connection
+      return @connection if @connection
+
+      @connection = if @oauth_strategy == 'oauth2'
+                      oauth2_connection
+                    else
+                      oauth_connection
+                    end
+    end
+
+    def log(message = '')
+      return unless @client.logger
+
+      @client.logger.info message
+    end
+
+    private
+
+    def raw_request(path, method, params, body)
+      p "request #{path} #{params}"
+
+      connection.public_send(method) do |request|
+        request.options.open_timeout     = OPEN_TIMEOUT
+        request.options.timeout          = TIMEOUT
+        request.url path, params
+        request.headers['Accept-Header'] = 'application/json'
+        request.headers['Cookie']        = @cookie
+        request.body                     = body
+      end
+    end
+
+    def oauth_connection
+      Faraday.new(@client.api_url) do |connection|
+        connection.request :oauth,
+                           consumer_key: @client.app_id,
+                           consumer_secret: @client.app_secret
+        connection.response :logger, @client.logger if @client.logger
+        connection.response :json, content_type: /\bjson$/
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def oauth2_connection
+      connection = Faraday.new(@client.api_url) do |connection|
+        connection.request :json
+        connection.response :logger, @client.logger if @client.logger
+        connection.response :json, content_type: /\bjson$/
+        connection.adapter Faraday.default_adapter
+      end
+      connection.basic_auth(@client.app_id, @client.app_secret)
+      connection
+    end
+  end
+end