strongmind-platform-sdk 2.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a243823042f3dfa6eaa652a252e7451934b63ad347b4eb2afc2ef893d5cc4b1f
+  data.tar.gz: 895357021f6b8ba4645ed641626efb1a2c079e73e6eb7d48501fc6d74eed8147
+SHA512:
+  metadata.gz: f7bffcc7532752361f356f8a6db181e278bb9b5b4a7fc86854ea95ac38a468d678bf841e403b181755c9c39b3b0e45ea2660ca8585cc311e2e13f46bd9947499
+  data.tar.gz: 04251ddea5e958ef6208e939c7bddef8235ede1c5ed0d82742f35bc04759b27408cb33ca8d11154ab11c419bd42e618fbad5d2ae0db0027623ce00676629bb6b

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-13
+
+- Initial release

data/CODEOWNERS

@@ -0,0 +1,10 @@
+# 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
+
+# The following lines were originally made by pulling the teams
+# assigned to each repo and setting them as CodeOwner over the
+# entire repository
+
+* @StrongMind/horseshoes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ryan.wolfe@strongmind.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+source "https://rubygems.pkg.github.com/StrongMind" do
+  gem "oneroster_client", "~> 2.0.3"
+end
+
+# Specify your gem's dependencies in platform_sdk-ruby-sdk.gemspec
+gemspec
+
+gem "factory_bot"
+gem "faker"
+gem "jwt", "~> 1.5", ">= 1.5.4"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.6", ">= 3.6.0"
+gem "rubocop"

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    platform-sdk (2.12.0)
+      aws-sdk-secretsmanager (~> 1.66)
+      faraday (~> 2.5, >= 2.5.2)
+      oneroster_client (~> 2.0.1)
+      uri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.688.0)
+    aws-sdk-core (3.168.4)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-secretsmanager (1.70.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    faker (2.23.0)
+      i18n (>= 1.8.11, < 2)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.6.2)
+    json (2.6.2)
+    jwt (1.5.6)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.37.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.22.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    uri (0.12.0)
+
+GEM
+  remote: https://rubygems.pkg.github.com/StrongMind/
+  specs:
+    oneroster_client (2.0.3)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  factory_bot
+  faker
+  jwt (~> 1.5, >= 1.5.4)
+  oneroster_client (~> 2.0.3)!
+  platform-sdk!
+  rake (~> 13.0)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop
+
+BUNDLED WITH
+   2.3.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ryan Wolfe
+
+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/Makefile

@@ -0,0 +1,5 @@
+install:
+	bundle install
+
+test:
+	bundle exec rspec

data/README.md

@@ -0,0 +1,112 @@
+# Platform::Sdk
+
+This gem is intended to provide clients and models for accessing the Platform APIs.
+
+[![Ruby Gem](https://github.com/StrongMind/platform-ruby-sdk/actions/workflows/gem-push.yml/badge.svg)](https://github.com/StrongMind/platform-ruby-sdk/actions/workflows/gem-push.yml)
+
+## Installation
+
+First [configure your GitHub credentials](#configure-github-credentials)
+
+Install the gem and add to the application's Gemfile by executing:
+
+```
+gem "strongmind-platform-sdk", "~> 2.9.1"
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install strongmind-platform-sdk
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Configure GitHub credentials
+
+- Create a GitHub PAT (personal access token) with the following scopes:
+`delete:packages, write:packages, repo`
+
+- Edit (or create) a `~/.gem.credentials` file to include the following, replacing TOKEN with your PAT from GitHub
+```
+---
+:github: Bearer TOKEN
+```
+
+- Edit (or create) a `~/.gemrc` file and add the following:
+```
+—
+:backtrace: false
+:bulk_threshold: 1000
+:sources:
+- https://rubygems.org/
+- https://USERNAME:TOKEN@rubygems.pkg.github.com/StrongMind/
+:update_sources: true
+:verbose: true  
+```
+
+- You will also need to configure your bundler to use your GitHub credentials:
+```$ bundle config set —-global rubygems.pkg.github.com USERNAME:TOKEN```
+
+NOTE: If your username has an `@` symbol, edit your `~/.bundle/config` file and replace the `@` with `%40`
+```
+---
+BUNDLE_RUBYGEMS__PKG__GITHUB__COM: "USERNAME:TOKEN"
+```
+
+## Build/Publish Gem
+
+To publish the gem, update the `version.rb` file and push the update to the main branch.  The github actions will publish the gem automatically.
+
+If you would like to publish the gem from your local machine for development purposes, run the following commands:
+
+```
+gem build platform-sdk.gemspec
+gem push --key github --host https://rubygems.pkg.github.com/StrongMind platform-sdk-0.0.0.gem
+```
+
+## 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 the created tag, 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/StrongMind/platform-ruby-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/platform-ruby-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 Platform::Ruby::Sdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/platform-ruby-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## Setting up IRB for OneRoster Calls
+Require needed dependencies:
+`require 'platform_sdk'`
+
+Open IRB and initialize dependencies:
+* IDENTITY_CLIENT_ID
+* IDENTITY_CLIENT_SECRET
+* IDENTITY_BASE_URL
+* STRONGMIND_APP_BASE_URL
+* ONEROSTER_BASE_URL
+* ID_MAPPER_DOMAIN
+* ID_MAPPER_TOKEN
+
+Create Identity Auth Client: 
+`auth_client = PlatformSdk::Identity::AuthClient.new(IDENTITY_BASE_URL, IDENTITY_CLIENT_ID, IDENTITY_CLIENT_SECRET)`
+
+Create OneRoster Client:
+`one_roster_client = PlatformSdk::OneRoster::Client.new(ONEROSTER_BASE_URL, auth_client)`
+
+Create Aws Client:
+`aws_client = PlatformSdk::Aws::SecretsManagerClient.new(access_key_id: 'ACCESS_KEY_ID', secret_access_key: 'SECRET_ACCESS_KEY', region: 'REGION')`
+
+Create PowerSchool Client:
+`power_school_client = PlatformSdk::PowerSchool::Client.new(base_url: 'BASE_URL', bearer_token: 'BEARER_TOKEN')`
+
+Create IdMapper Client:
+`id_mapper_client = PlatformSdk::IdMapper::Client.new(domain: 'ID_MAPPER_DOMAIN', token: 'SECRET_TOKEN')`

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/platform_sdk/aws/secrets_manager_client.rb

@@ -0,0 +1,35 @@
+require "aws-sdk-secretsmanager"
+
+module PlatformSdk
+  module Aws
+    class SecretsManagerClient
+      attr_reader :client
+
+      def initialize(access_key_id:, secret_access_key:, region: "us-west-2")
+        @client = ::Aws::SecretsManager::Client.new(
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key,
+          region: region
+        )
+      end
+
+      def secret(secret_key:, arn: nil, secret_name: nil)
+        raise(ArgumentError, "Must provide either an arn or a secret name") if arn.nil? && secret_name.nil?
+
+        secret = secret_store(secret_name: (arn || secret_name))
+        secret[secret_key]
+      end
+
+      def powerschool_token(domain:, environment:)
+        secret(secret_name: "powerschool_token_#{domain}_#{environment}", secret_key: "access_token")
+      end
+
+      private
+
+      def secret_store(secret_name:)
+        store = @client.get_secret_value(secret_id: secret_name)
+        JSON.parse(store.secret_string)
+      end
+    end
+  end
+end

data/lib/platform_sdk/aws.rb

@@ -0,0 +1,7 @@
+require "platform_sdk/aws/secrets_manager_client"
+
+module PlatformSdk
+  module Aws
+    class Error < StandardError; end
+  end
+end

data/lib/platform_sdk/id_mapper/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module IdMapper
+    # IdMapper::Client
+    class Client
+      attr_reader :token, :domain, :conn
+
+      def initialize(secret)
+        @token = secret[:token]
+        @domain = secret[:domain]
+        @token ||= PlatformSdk::IdMapper.token
+        @domain ||= PlatformSdk::IdMapper.domain
+
+        @conn = Faraday.new("https://#{@domain}") do |faraday|
+          faraday.headers = headers
+          faraday.adapter Faraday.default_adapter
+          faraday.response :json, content_type: /\bjson$/
+          faraday.response :raise_error
+        end
+      end
+
+      def pairs(guid)
+        begin
+          response = @conn.get("api/v1/pairs/#{guid}")
+        rescue Faraday::ResourceNotFound
+          raise PlatformSdk::IdMapper::PairNotFoundError, msg = guid
+        end
+        response.body
+      end
+
+      private
+
+      def headers
+        { "Authorization" => "Token #{@token}" }
+      end
+    end
+  end
+end

data/lib/platform_sdk/id_mapper/constants.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module IdMapper
+    module Constants
+      module User
+        ONE_ROSTER_ID = "com.strongmind.user.id"
+        IDENTITY_ID = "com.strongmind.identity.user.id"
+        CLEVER_ID = "com.clever.user.id"
+        LEGACY_SIS_ID = "com.strongmind.sis.user.id"
+        LOUDMOUTH_ID = "com.strongmind.loudmouth.user.id"
+        POWERSCHOOL_NUMBERS = "com.powerschool.user.numbers"
+        POWERSCHOOL_DCIDS = "com.powerschool.user.dcids"
+        POWERSCHOOL_STAFF_NUMBERS = "com.powerschool.staff.numbers"
+        POWERSCHOOL_STAFF_IDS = "com.powerschool.staff.ids"
+        POWERSCHOOL_CONTACT_IDS = "com.powerschool.contact.ids"
+        CANVAS_IDS = "com.instructure.canvas.users"
+      end
+    end
+  end
+end

data/lib/platform_sdk/id_mapper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require 'platform_sdk/id_mapper/client'
+require 'platform_sdk/id_mapper/constants'
+
+module PlatformSdk
+  module IdMapper
+    class Error < StandardError; end
+
+    class TokenNotSet < Error; end
+
+    class DomainNotSet < Error; end
+
+    class PairNotFoundError < Error; end
+
+    def self.token
+      raise TokenNotSet if @token.nil?
+
+      @token
+    end
+
+    def self.token=(token)
+      @token = token
+    end
+
+    def self.domain
+      raise DomainNotSet if @domain.nil?
+
+      @domain
+    end
+
+    def self.domain=(domain)
+      @domain = domain
+    end
+  end
+end

data/lib/platform_sdk/identity/clients.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module Identity
+    # Client for making calls to the Identity Server API
+    class Client
+      def initialize(identity_base_url, client_id, client_secret, auth_client = nil)
+        @auth = auth_client.nil? ? AuthClient.new(identity_base_url, client_id, client_secret) : auth_client
+
+        @conn = Faraday.new(identity_base_url) do |conn|
+          conn.request :authorization, "Bearer", -> { @auth.auth_token }
+          conn.request :retry
+          conn.response :json
+          conn.adapter :net_http
+        end
+      end
+
+      def with_rescue
+        yield
+      rescue IdentityNotFoundError => e
+        puts e
+      end
+    end
+
+    # Client for getting auth tokens from identity server
+    class AuthClient
+      attr_accessor :conn, :token
+
+      def initialize(base_url, client_id, client_secret)
+        @client_id = client_id
+        @client_secret = client_secret
+        @conn = Faraday.new(base_url) do |conn|
+          conn.request :url_encoded
+          conn.response :raise_error
+          conn.response :json
+          conn.adapter :net_http
+        end
+      end
+
+      def auth_token
+        if expired?
+          response = @conn.post("/connect/token", request_body)
+          @token = response.body.transform_keys(&:to_sym)
+        end
+
+        @token[:access_token]
+      end
+
+      def expired?
+        return true if @token.nil?
+
+        token_expired?(@token[:access_token])
+      end
+
+      def token_expired?(jwt)
+        begin
+          expiry_time = Time.at(JWT.decode(jwt, nil, false)[0]["exp"])
+        rescue JWT::ExpiredSignature
+          return true
+        end
+        expiry_time <= Time.now.utc + 30
+      end
+
+      def refresh_token(jwt:, refresh_token:)
+        raise ArgumentError if refresh_token.nil? || jwt.nil?
+        return unless token_expired?(jwt)
+
+        response = @conn.post("/connect/token", request_body(
+          grant_type: "refresh_token", refresh_token:))
+        response.body.transform_keys!(&:to_sym)
+      end
+
+      def refresh_session(session: {})
+        raise ArgumentError if session[:id_token].nil? || session[:refresh_token].nil?
+
+        refreshed_tokens = refresh_token(jwt: session[:id_token], refresh_token: session[:refresh_token])
+
+        return if refreshed_tokens.nil?
+        
+        session[:id_token] = refreshed_tokens[:id_token]
+        session[:access_token] = refreshed_tokens[:access_token]
+        session[:refresh_token] = refreshed_tokens[:refresh_token]
+      end
+
+      private
+
+      def request_body(grant_type: "client_credentials", refresh_token: nil)
+        return { grant_type:, client_id: @client_id, client_secret: @client_secret } if refresh_token.nil?
+
+        { grant_type:, client_id: @client_id, client_secret: @client_secret, refresh_token: }
+      end
+    end
+  end
+end

data/lib/platform_sdk/identity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "date"
+require "faraday"
+require "faraday/net_http"
+require "json"
+
+require "platform_sdk/identity/clients"
+
+module PlatformSdk
+  module Identity
+    class IdentityNotFoundError < StandardError; end
+  end
+end

data/lib/platform_sdk/one_roster/client.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module OneRoster
+    # OneRoster Client which wraps the swagger generated OneRoster Management APIs
+    class Client
+      attr_accessor :users_api, :classes_api, :courses_api, :enrollments_api, :academic_sessions_api,
+                    :line_items_api, :results_api, :orgs_api, :demographics_api
+
+      def initialize(oneroster_base_url, auth_client)
+        @auth = auth_client
+
+        uri = URI.parse(oneroster_base_url)
+        ::OneRosterClient.configure do |config|
+          # Configure OAuth2 access token for authorization: OAuth2Security
+          config.scheme = uri.scheme
+          config.host = uri.host
+          config.base_path = uri.path
+        end
+
+        init_apis
+      end
+
+      def init_apis
+        @users_api = ::OneRosterClient::UsersManagementApi.new
+        @classes_api = ::OneRosterClient::ClassesManagementApi.new
+        @courses_api = ::OneRosterClient::CoursesManagementApi.new
+        @enrollments_api = ::OneRosterClient::EnrollmentsManagementApi.new
+        @academic_sessions_api = ::OneRosterClient::AcademicSessionsManagementApi.new
+        @line_items_api = ::OneRosterClient::LineItemsManagementApi.new
+        @results_api = ::OneRosterClient::ResultsManagementApi.new
+        @orgs_api = ::OneRosterClient::OrgsManagementApi.new
+        @demographics_api = ::OneRosterClient::DemographicsManagementApi.new
+      end
+
+      %i[user class course enrollment academic_session line_item result org demographic].each do |record_type|
+        define_method(record_type) do |sourced_id, include = {}|
+          api = management_api(record_type)
+          with_rescue_and_set_token do
+            record = one_roster_record(api, record_type, sourced_id)
+            record_with_included(include, record)
+          end
+        end
+      end
+
+      # @param [Hash] opts the optional parameters
+      # @option opts [Integer] :limit To define the download segmentation value i.e. the maximum number of records to be contained in the response.
+      # @option opts [Integer] :offset The number of the first record to be supplied in the segmented response message.
+      # @option opts [String] :continuation_token Allows the client to resume retrieving results from where the previous page left off
+      # @option opts [String] :sort Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
+      # @option opts [String] :order_by The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
+      # @option opts [String] :filter The filtering rules to be applied when identifying the records to be supplied in the response message.
+      # @option opts [Array<String>] :fields To identify the range of fields that should be supplied in the response message.
+      # @return [Array<(UsersType, Integer, Hash)>] UsersType data, response status code and response headers
+      %i[users classes courses enrollments demographics orgs line_items results].each do |records_type|
+        define_method(records_type) do |opts = {}|
+          api = instance_variable_get "@#{records_type}_api"
+          with_rescue_and_set_token do
+            one_roster_records(api, records_type, opts)
+          end
+        end
+      end
+
+      def pluralize_oneroster_type(record_type)
+        if record_type == :class
+          "#{record_type}es"
+        else
+          "#{record_type}s"
+        end
+      end
+
+      def with_rescue_and_set_token
+        ::OneRosterClient.configure.access_token = @auth.auth_token
+        yield
+      rescue ::OneRosterClient::Error => e
+        error(e)
+      end
+
+      def error(api_error)
+        case api_error.response[:status]
+        when 404
+          nil
+        else
+          puts "Exception when calling OneRoster resource: #{api_error}"
+          raise
+        end
+      end
+
+      def function_name(key)
+        {
+          student: "user",
+          agents: "user",
+          orgs: "org",
+          school: "org",
+          terms: "academic_session",
+          school_year: "academic_session",
+          grading_period: "academic_session",
+          parent: "academic_session"
+        }[key] || key
+      end
+
+      def key_map(key)
+        {
+          class: "_class",
+          demographic: "demographics"
+        }[key] || key
+      end
+
+      private
+
+      def management_api(record_type)
+        pluralized_record_type = pluralize_oneroster_type(record_type)
+        instance_variable_get "@#{pluralized_record_type}_api"
+      end
+
+      def one_roster_record(api, record_type, sourced_id)
+        single_type = api.send("get_#{record_type}", sourced_id)
+        single_type.send(key_map(record_type))
+      end
+
+      def one_roster_records(api, records_type, opts = {})
+        records_with_key = api.send("get_#{records_type}", opts)
+        records_with_key.send(records_type)
+      end
+
+      def record_with_included(include, record)
+        include ||= {}
+        include.each do |key, value|
+          ignore_invalid_includes do
+            attribute_name = key_map key
+            child = record.send(attribute_name)
+            child_as_record = child_record(child, key, value)
+            record.send("#{attribute_name}=", child_as_record)
+          end
+        end
+        record
+      end
+
+      def ignore_invalid_includes
+        yield
+      rescue NoMethodError
+        # Do nothing
+      end
+
+      def child_record(child, key, value)
+        function_name = function_name(key)
+        if child.is_a? Array
+          handle_child_as_array(child, function_name, value)
+        else
+          send(function_name, child.sourced_id, value)
+        end
+      end
+
+      def handle_child_as_array(child, function_name, value)
+        child_with_records = []
+        child.each do |item|
+          object = send(function_name, item.sourced_id, value)
+          child_with_records.append(object) unless object.nil?
+        end
+        child_with_records
+      end
+
+    end
+  end
+end

data/lib/platform_sdk/one_roster.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "uri"
+
+require "oneroster_client"
+require "platform_sdk/identity"
+require "platform_sdk/one_roster/client"
+
+module PlatformSdk
+  module OneRoster
+    class Error < StandardError; end
+  end
+end

data/lib/platform_sdk/power_school/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module PlatformSdk
+  module PowerSchool
+    # Powerschool::Client
+    class Client
+      attr_reader :bearer_token, :conn
+
+      def initialize(base_url:, bearer_token: nil, expansions: nil)
+        @bearer_token = bearer_token
+        @bearer_token ||= PlatformSdk::PowerSchool.bearer_token
+        @expansions = expansions || self.class.expansions
+
+        @conn = Faraday.new(base_url, headers:) do |conn|
+          conn.response :raise_error
+          conn.request :json
+          conn.response :json
+          conn.adapter :net_http
+        end
+      end
+
+      def headers
+        {
+          "Authorization" => "Bearer #{@bearer_token}",
+          "Content-Type" => "application/json",
+          "Accept" => "application/json"
+        }
+      end
+
+      def power_query(query_name)
+        scrub_query(query_name)
+        @conn.post("/ws/schema/query/com.strongmind.#{query_name}?pagesize=0").body["record"]
+      end
+
+      def special_programs
+        records_as_json = power_query("specialprograms")
+        records_as_json.map { |record| SpecialProgram.new(record) }
+      end
+
+      def self.expansions
+        {
+          STUDENTS: %w[demographics addresses alerts phones school_enrollment ethnicity_race contact contact_info
+                       initial_enrollment schedule_setup fees lunch],
+          SECTIONS: %w[term],
+          TEACHERS: %w[addresses emails phones school_affiliations]
+        }
+      end
+
+      def valid_power_query_names
+        %w[specialprograms]
+      end
+
+      def scrub_query(query_name)
+        raise PowerQueryNotValid unless valid_power_query_names.include?(query_name)
+      end
+    end
+  end
+end

data/lib/platform_sdk/power_school/special_program.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PlatformSdk
+  module PowerSchool
+    class SpecialProgram
+      attr_accessor :special_enrollments_dcid, :special_enrollments_id, :program_id, :enter_date, :exit_date,
+                    :code1, :code2, :exit_code, :special_comment, :school_id, :grade_level,
+                    :student_id, :program_name, :student_uuid, :special_enrollment_uuid, :enroll_status
+
+      def initialize(attributes = {})
+        attributes.each do |name, value|
+          send("#{self.class.attribute_map(name)}=", value)
+        end
+      end
+
+      def self.attribute_map(key)
+        {
+          spenrollments_dcid: "special_enrollments_dcid",
+          spenrollments_id: "special_enrollments_id",
+          programid: "program_id",
+          exitcode: "exit_code",
+          sp_comment: "special_comment",
+          schoolid: "school_id",
+          gradelevel: "grade_level",
+          studentid: "student_id",
+          spenrollment_uuid: "special_enrollment_uuid"
+        } [key.to_sym] || key
+      end
+    end
+  end
+end

data/lib/platform_sdk/power_school.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "uri"
+require "platform_sdk/power_school/client"
+require "platform_sdk/power_school/special_program"
+
+module PlatformSdk
+  # PowerSchool SDK for interacting with the PowerSchool API
+  module PowerSchool
+    class Error < StandardError; end
+
+    class BearerTokenNotSet < StandardError; end
+
+    class PowerQueryNotValid < StandardError; end
+
+    def self.bearer_token
+      raise BearerTokenNotSet if @bearer_token.nil?
+
+      @bearer_token
+    end
+
+    def self.bearer_token=(bearer_token)
+      @bearer_token = bearer_token
+    end
+  end
+end

data/lib/platform_sdk/version.rb

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

data/lib/platform_sdk.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "platform_sdk/version"
+require "platform_sdk/one_roster"
+require "platform_sdk/identity"
+require "platform_sdk/power_school"
+require "platform_sdk/aws"
+require "platform_sdk/id_mapper"
+
+module PlatformSdk
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/platform_sdk/identity/auth_client.rbs

@@ -0,0 +1,27 @@
+module PlatformSdk
+  module Identity
+    class AuthClient
+      @client_id: String
+      @client_secret: String
+      @conn: Object
+
+      attr_accessor conn: Object
+
+      attr_accessor token: String
+
+      def auth_token: -> String
+
+      def expired?: -> bool
+
+      def refresh_session: -> nil
+
+      def refresh_token: -> Hash[Symbol, String]
+
+      def token_expired?: -> bool
+
+      private
+
+      def request_body: -> Hash[Symbol, String]
+    end
+  end
+end

data/sig/platform_sdk/platform_sdk.rbs

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: strongmind-platform-sdk
+version: !ruby/object:Gem::Version
+  version: 2.12.0
+platform: ruby
+authors:
+- Platform Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: oneroster_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: uri
+  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: aws-sdk-secretsmanager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+description: Includes a wrapper for the swagger generated OneRoster management clients
+email:
+- horseshoes@strongmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/platform_sdk.rb
+- lib/platform_sdk/aws.rb
+- lib/platform_sdk/aws/secrets_manager_client.rb
+- lib/platform_sdk/id_mapper.rb
+- lib/platform_sdk/id_mapper/client.rb
+- lib/platform_sdk/id_mapper/constants.rb
+- lib/platform_sdk/identity.rb
+- lib/platform_sdk/identity/clients.rb
+- lib/platform_sdk/one_roster.rb
+- lib/platform_sdk/one_roster/client.rb
+- lib/platform_sdk/power_school.rb
+- lib/platform_sdk/power_school/client.rb
+- lib/platform_sdk/power_school/special_program.rb
+- lib/platform_sdk/version.rb
+- sig/platform_sdk/identity/auth_client.rbs
+- sig/platform_sdk/platform_sdk.rbs
+homepage: https://github.com/StrongMind/platform-ruby-sdk
+licenses:
+- MIT
+metadata:
+  github_repo: git@github.com:StrongMind/platform-ruby-sdk.git
+  homepage_uri: https://github.com/StrongMind/platform-ruby-sdk
+  source_code_uri: https://github.com/StrongMind/platform-ruby-sdk
+  changelog_uri: https://github.com/StrongMind/platform-ruby-sdk/blob/main/CHANGELOG.md
+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.26
+signing_key:
+specification_version: 4
+summary: This gem is intended to provide clients and models for accessing the Platform
+  APIs.
+test_files: []