clever_sdk 0.9.0.pre.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa4e893dcb0810db98da38767e7ae10b20bbdf416b775e702c8fc15111a2a510
+  data.tar.gz: 9251372d6e35e0089f16d9902d05f9f13f07afa7f69d077504f7a09d0af5f2b3
+SHA512:
+  metadata.gz: a1b8c193349e6f97a81deb1e4bc54c1f7978c6e78330b1536dd5e3f814384db888375321f2ea1bc6be4d583dcb15195a249794bb19c55f253fbc6216e1ae9bcd
+  data.tar.gz: 9f546efcebd9c955dc9d34fe18b5e92267c079b31ee94faecc5cd3bf57dbf6a639768492186483102972c62ad0fb3e24c5a8f68cca14549a8f237ddd932f4c45

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+version: 2.1
+
+# Define a job to be invoked later in a workflow.
+# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
+jobs:
+  say-hello:
+    # Specify the execution environment. You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
+    # See: https://circleci.com/docs/2.0/configuration-reference/#docker-machine-macos-windows-executor
+    docker:
+      - image: cimg/base:stable
+    # Add steps to the job
+    # See: https://circleci.com/docs/2.0/configuration-reference/#steps
+    steps:
+      - checkout
+      - run:
+          name: "Say hello"
+          command: "echo Hello, World!"
+
+# Invoke jobs via workflows
+# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
+workflows:
+  say-hello-workflow:
+    jobs:
+      - say-hello

data/.env.sample

@@ -0,0 +1,20 @@
+CLEVER_ID:            "095b82cbbd8c68714d1c"
+CLEVER_SECRET:        "4b338489ceb4bec362461a7c96e3aa609efff049"
+CLEVER_REDIRECT_URI:  "http://localhost:3000/auth/clever"
+
+# Test Credentials from https://dev.clever.com/reference/schema#schema
+# CleverSDK.configuration.client_id = "095b82cbbd8c68714d1c"
+# CleverSDK.configuration.client_secret = "4b338489ceb4bec362461a7c96e3aa609efff049"
+# Authorization: "Basic: MDk1YjgyY2JiZDhjNjg3MTRkMWM6NGIzMzg0ODljZWI0YmVjMzYyNDYxYTdjOTZlM2FhNjA5ZWZmZjA0OQ=="
+
+# Identity API Test tokens: 
+# ilc_DEMO_STUDENT_TOKEN
+# ilc_DEMO_TEACHER_TOKEN
+# ilc_DEMO_SCHOOL_ADMIN_TOKEN
+# ilc_DEMO_DISTRICT_ADMIN_TOKEN
+
+# Data API test tokens:
+# TEST_TOKEN
+
+# Events API test tokens:
+# TEST_TOKEN

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+coverage/*
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sublime-project
+*.sublime-workspace
+
+.DS_Store
+.env
+.ruby-version
+.ruby-gemset
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at beneggett@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 clever_sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ben Eggett
+
+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,65 @@
+[![Gem Version](https://badge.fury.io/rb/clever_sdk.svg)](https://badge.fury.io/rb/clever_sdk)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/beneggett/clever_sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/beneggett/clever_sdk/tree/main)
+
+# CleverSDK
+
+Fully Implements the Clever API in a simple to use SDK in Ruby
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clever_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clever_sdk
+
+Be sure to define your Clever credentials by setting up environment variables in your application appropriately. Refer to the .env.sample file for details.
+```
+CLEVER_ID =     'my-clever-id'
+CLEVER_SECRET = 'my-clever-key'
+```
+
+
+## Usage
+
+There are many primary APIs that are wrapped. Below you will see basic examples of how to use them. For more information about what optional query parameters are available, please consult the [Clever API Docs](https://dev.clever.com/docs)
+
+## Configuration
+
+Place the following configuration in your apps initializer
+
+
+```ruby
+CleverSDK.configure do |config|
+  config.clever_id     = "your-value"
+  config.clever_secret = "your-value"
+  config.redirect_uri  = "your-value"  
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/beneggett/clever_sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CleverSDK project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beneggett/clever_sdk/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require "dotenv"
+Dotenv.load
+require "bundler/setup"
+require "clever_sdk"
+
+# 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"
+
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

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/bin/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rake test

data/clever_sdk.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clever_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "clever_sdk"
+  spec.version = CleverSDK::VERSION
+  spec.authors = ["Ben Eggett", "Mike Moore"]
+  spec.email = ["beneggett@gmail.com"]
+
+  spec.summary = "Clever API ruby wrapper"
+  spec.description = "Provides an SDK for interacting wth the Clever API in Ruby"
+  spec.homepage = "https://github.com/beneggett/clever_sdk"
+  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
+    raise "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_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_dependency "typhoeus"
+end

data/lib/clever_sdk/api/authentication.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Authentication
+      # district - the district's token
+      def tokens(client_id:, client_secret:, district: nil)
+        get(
+          "https://clever.com/oauth/tokens",
+          params: params(owner_type: :district, district: district),
+          headers: basic_auth_headers(client_id, client_secret)
+        )
+      end
+
+      def tokens!(client_id:, client_secret:, code: nil, grant_type: nil, redirect_uri: nil)
+        post(
+          "https://clever.com/oauth/tokens",
+          body: JSON.dump(params(code: code, grant_type: grant_type, redirect_uri: redirect_uri)),
+          headers: basic_auth_headers(client_id, client_secret).merge({"Content-Type" => "application/json"})
+        )
+      end
+
+      def tokeninfo(access_token:)
+        get(
+          "https://clever.com/oauth/tokeninfo",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def me(access_token:)
+        get(
+          "https://api.clever.com/v3.0/me",
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api/courses.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Courses
+      # count - acceptable values are nil, :true, :false, :undefined
+      def courses(access_token:, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        get(
+          "https://api.clever.com/v3.0/courses",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before, count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def course(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/courses/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def course_district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/courses/#{id}/district",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def course_resources(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/courses/#{id}/resources",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def course_schools(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/courses/#{id}/schools",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def course_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/courses/#{id}/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api/districts.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Districts
+      # count - acceptable values are nil, :true, :false, :undefined
+      def districts(access_token:, count: nil)
+        get(
+          "https://api.clever.com/v3.0/districts",
+          params: params(count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/districts/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api/events.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Events
+      def events(access_token:, limit: nil, starting_after: nil, ending_before: nil, school: nil, record_type: nil)
+        record_type = Array(record_type).flatten.compact
+        record_type = nil if record_type.empty?
+
+        get(
+          "https://api.clever.com/v3.0/events",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before,
+            school: school, record_type: record_type),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def event(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/events/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api/resources.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Resources
+      def resources(access_token:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/resources",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def resource(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/resources/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def resource_courses(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/resources/#{id}/courses",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def resource_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/resources/#{id}/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      # role - acceptable values are nil, :student, :teacher
+      def resource_users(access_token:, id:, role: nil, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/resources/#{id}/users",
+          params: params(role: role, limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+      # def resource_students(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+      # def resource_teachers(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+    end
+  end
+end

data/lib/clever_sdk/api/response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    class Response
+      def self.handle(typhoeus_response)
+        return CleverSDK::Api::Response.new(typhoeus_response) if typhoeus_response.success?
+
+        raise CleverSDK::Error.handle(typhoeus_response)
+      end
+
+      def self.status_code_explanations
+        # from https://dev.clever.com/reference/responses-errors
+        @status_code_explanations ||= {
+          200	=> {meaning: "Success", action_to_take:	"Process the response."},
+          400	=> {meaning: "Bad request",	action_to_take: "Check your API token and request body. Do not retry request. The troubleshooting pages for each API also have tips for what to look for!"},
+          401	=> {meaning: "Invalid auth", action_to_take:	"Check your API token and request body. Do not retry request. The troubleshooting pages for each API also have tips for what to look for!"},
+          404	=> {meaning: "Resource not available", action_to_take: "Check your API token and request URL - you may be using the wrong token or the resource may have been unshared with your application or deleted."},
+          413	=> {meaning: "Request entity too large", action_to_take: "Your limit parameter may be over 10000; reduce accordingly."},
+          429	=> {meaning: "Rate limit exceeded", action_to_take: "Try again after rate limit period expires."},
+          500 => {meaning: "Clever API failure", action_to_take: "Wait and retry request. If you see these regularly, reach out to integrations@clever.com."},
+          502 => {meaning: "Clever API failure", action_to_take: "Wait and retry request. If you see these regularly, reach out to integrations@clever.com."},
+          503 => {meaning: "Clever API failure", action_to_take: "Wait and retry request. If you see these regularly, reach out to integrations@clever.com."},
+          501	=> {meaning: "Not implemented", action_to_take: "Your client is attempting an unsupported request. Try an alternative request. Do not retry request."}
+        }
+      end
+
+      def initialize(typhoeus_response)
+        @_response = typhoeus_response
+      end
+
+      def raw_request
+        @_response.request
+      end
+
+      def raw_response
+        @_response
+      end
+
+      def code
+        @_response.code
+      end
+
+      def headers
+        @_response.headers
+      end
+
+      def body
+        # Any response that does not return JSON is handled as an error.
+        @body ||= JSON.parse(@_response.body)
+      end
+
+      def access_token
+        # Dig the access token out of the response object.
+        @_response.request.options.dig(:headers, "Authorization").split(" ").last
+      end
+    end
+  end
+end