clever 1.2.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 bjulius
+
+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,105 @@
+# Clever
+
+This is a simple Ruby API wrapper for Clever.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clever'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clever
+
+## Usage
+
+### Configuration
+The gem can be initialized as follows:
+
+```ruby
+client = Clever::Client.configure do |config|
+  config.app_id        = 'app_id for district'
+  config.vendor_key    = 'vendor_key for tci'
+  config.vendor_secret = 'vendor_secret for tci'
+end
+```
+### Requests
+This gem support requesting:
+  - Students
+  - Teachers
+  - Courses
+  - Sections
+  - Classrooms
+  - Enrollments
+
+#### Students
+- Request all students:
+  ```ruby
+  client.students
+  ```
+- Request a subset of students, filtered by their `id`:
+  ```ruby
+  client.students([student_1['data']['id']], student_2['data']['id'], …])
+  ```
+#### Teachers
+- Request all teachers:
+  ```ruby
+  client.teachers
+  ```
+- Request a subset of teachers, filtered by their `id`:
+  ```ruby
+  client.teachers([teacher_1['data']['id']], teacher_2['data']['id'], …])
+  ```
+#### Courses
+- Request all courses:
+  ```ruby
+  client.teachers
+  ```
+- Request a subset of courses, filtered by their `id`:
+  ```ruby
+  client.courses([course_1['data']['id']], course_2['data']['id'], …])
+  ```
+#### Sections
+- Request all sections:
+  ```ruby
+  client.sections
+  ```
+- Request a subset of sections, filtered by their `id`:
+  ```ruby
+  client.sections([section_1['data']['id']], section_2['data']['id'], …])
+  ```
+#### Classrooms
+- Request all classrooms
+  ```ruby
+  client.classrooms
+  ```
+#### Enrollments
+- Request all enrollments
+  ```ruby
+  client.enrollments
+  ```
+- Request a subset of enrollments, filtered by their classroom's `id`:
+  ```ruby
+  client.enrollments([classroom_1['data']['id'], classroom_2['data']['id']], …)
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/clever.
+
+## 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,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'clever'
+
+# 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, 300) =~ /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/clever.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clever/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clever'
+  spec.version       = Clever::VERSION
+  spec.authors       = ['Robert Julius']
+  spec.email         = ['robertmjulius@gmail.com']
+
+  spec.summary       = 'Wrapper for the Clever API.'
+  spec.description   = 'Wrapper for the Clever API.'
+  spec.homepage      = 'https://github.com/tci/clever'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/clever.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'clever/client'
+require 'clever/connection'
+require 'clever/paginator'
+require 'clever/response'
+require 'clever/version'
+
+require 'clever/types/base'
+require 'clever/types/classroom'
+require 'clever/types/course'
+require 'clever/types/enrollment'
+require 'clever/types/event'
+require 'clever/types/student'
+require 'clever/types/section'
+require 'clever/types/teacher'
+require 'clever/types/token'
+
+module Clever
+  API_URL           = 'https://api.clever.com/v2.0'
+  TOKENS_ENDPOINT   = 'https://clever.com/oauth/tokens?owner_type=district'
+  STUDENTS_ENDPOINT = '/v2.0/students'
+  COURSES_ENDPOINT  = '/v2.0/courses'
+  SECTIONS_ENDPOINT = '/v2.0/sections'
+  TEACHERS_ENDPOINT = '/v2.0/teachers'
+  EVENTS_ENDPOINT   = '/v1.2/events'
+  GRADES_ENDPOINT   = 'https://grades-api.beta.clever.com/v1/grade'
+
+  class DistrictNotFound < StandardError; end
+  class ConnectionError < StandardError; end
+end

data/lib/clever/client.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Clever
+  class Client
+    attr_accessor :app_id, :app_token, :sync_id, :logger,
+                  :vendor_key, :vendor_secret, :username_source
+
+    attr_reader :api_url, :tokens_endpoint
+
+    def initialize
+      @api_url           = API_URL
+      @tokens_endpoint   = TOKENS_ENDPOINT
+    end
+
+    def self.configure
+      client = new
+      yield(client) if block_given?
+      client
+    end
+
+    def authenticate(app_id = @app_id)
+      return if @app_token
+
+      response = tokens
+
+      fail ConnectionError, response.raw_body unless response.success?
+
+      set_token(response, app_id)
+    end
+
+    def connection
+      @connection ||= Connection.new(self)
+    end
+
+    def tokens
+      response = connection.execute(@tokens_endpoint)
+      map_response!(response, Types::Token)
+      response
+    end
+
+    def most_recent_event
+      authenticate
+
+      endpoint = "#{Clever::EVENTS_ENDPOINT}?ending_before=last&limit=1"
+
+      event = @connection.execute(endpoint).body[0]
+      Types::Event.new(event['data']) if event
+    end
+
+    def events(starting_after)
+      authenticate
+
+      endpoint = "#{Clever::EVENTS_ENDPOINT}?starting_after=#{starting_after}"
+      Paginator.fetch(connection, endpoint, :get, Types::Event, client: self).force
+    end
+
+    %i(students courses teachers sections).each do |record_type|
+      define_method(record_type) do |record_uids = []|
+        authenticate
+
+        endpoint = Clever.const_get("#{record_type.upcase}_ENDPOINT")
+        type = Types.const_get(record_type.to_s.capitalize[0..-2])
+
+        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
+
+    # discard params to make the API behave the same as the one roster gem
+    def classrooms(*)
+      authenticate
+
+      fetched_courses = courses
+
+      sections.map do |section|
+        course = fetched_courses.find { |clever_course| clever_course.uid == section.course }
+        Types::Classroom.new(
+          'id' => section.uid,
+          'name' => section.name,
+          'period' => section.period,
+          'course_number' => course&.number,
+          'grades' => section.grades
+        )
+      end
+    end
+
+    def enrollments(classroom_uids = [])
+      authenticate
+
+      fetched_sections = sections
+
+      enrollments = parse_enrollments(classroom_uids, fetched_sections)
+
+      p "Found #{enrollments.values.flatten.length} enrollments."
+
+      enrollments
+    end
+
+    def send_grade(request_body)
+      authenticate
+
+      @connection.execute(GRADES_ENDPOINT, :post, nil, request_body)
+    end
+
+    private
+
+    def parse_enrollments(classroom_uids, sections)
+      sections.each_with_object(student: [], teacher: []) do |section, enrollments|
+        next if classroom_uids.any? && !classroom_uids.include?(section.uid)
+
+        parse_student_enrollments!(section, enrollments)
+        parse_teacher_enrollments!(section, enrollments)
+      end
+    end
+
+    def parse_student_enrollments!(section, enrollments)
+      section.students.each do |student_uid|
+        enrollments[:student] << Types::Enrollment.new(
+          'classroom_uid' => section.uid,
+          'user_uid' => student_uid
+        )
+      end
+    end
+
+    def parse_teacher_enrollments!(section, enrollments)
+      section.teachers.each do |teacher_uid|
+        enrollments[:teacher] << Types::Enrollment.new(
+          'classroom_uid' => section.uid,
+          'user_uid' => teacher_uid
+        )
+      end
+    end
+
+    def set_token(tokens, app_id)
+      district_token = tokens.body.find { |district| district.owner['id'] == app_id }
+
+      fail DistrictNotFound unless district_token
+
+      connection.set_token(district_token.access_token)
+
+      @app_token = district_token.access_token
+    end
+
+    def map_response!(response, type)
+      response.body = map_response(type, response.body) if response.success?
+    end
+
+    def map_response(type, data)
+      data.map { |item_data| type.new(item_data) }
+    end
+  end
+end

data/lib/clever/connection.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Clever
+  class Connection
+    OPEN_TIMEOUT = 60
+    TIMEOUT = 120
+
+    def initialize(client)
+      @client = client
+    end
+
+    def execute(path, method = :get, params = nil, body = nil)
+      Response.new(raw_request(path, method, params, body))
+    end
+
+    def set_token(token)
+      connection.authorization :Bearer, token
+    end
+
+    def connection
+      return @connection if @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.vendor_key, @client.vendor_secret)
+      @connection
+    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.body                     = body
+      end
+    end
+  end
+end