classlink_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6c3a2602b4e9e440690d0b50383257218022c4713a7f2c3e5fa4645fafab35e
+  data.tar.gz: 21e291e3ff6ec97970880e0ced7619a5d402e5eb46d68f14794a8c8d336346b2
+SHA512:
+  metadata.gz: be2a529532a515dfc506c336769314bc103e4b8df7b66725bfa6eba6f2de1155481666dc8e97a762189c3331d4f72c8e2747f10e231141cb3c94a2554bccf22a
+  data.tar.gz: 1b578db8f149324c9e03a295f2a1b9024b03f0703317b50181200508af667f2c44c153f86b182a23ec40b1308121b73fd02d91d681ae20a4fa2ec77054979f45

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:3.0.0
+
+before_script:
+  - gem install bundler -v 2.2.3
+  - bundle install
+
+example_job:
+  script:
+    - bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in classlink_client.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 0.80"
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    classlink_client (0.1.0)
+      activesupport (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  classlink_client!
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Raptor Technologies
+
+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,68 @@
+# ClassLink Ruby Client
+
+This is a simple client library for the ClassLink OneRoster API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "classlink_client"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install classlink_client
+
+## Usage
+
+### Authentication
+
+Initialize the client using either the Direct, or Proxy Authentication.
+
+#### Direct
+
+For direct access, pass `endpoint`, `client_id`, and `client_secret`:
+
+```ruby
+client = ClassLink::Client.new(
+  endpoint: "https://sandbox-vn-v2.oneroster.com",
+  client_id: "some_client_id",
+  client_secret: "some_client_secret"
+)
+```
+
+#### Proxy
+
+For proxy access, pass `app_id` and `access_token`:
+
+```ruby
+client = ClassLink::Client.new(
+  app_id: "some_app_id",
+  access_token: "some_access_token"
+)
+```
+
+The resources described in [`lib/classlink_client/interface.rb`](lib/classlink_client/interface.rb) are available as methods on the client. Call them singular with an ID to fetch an individual resource (`client.student(client_id)`), or plural to fetch the index (`client.students`).
+
+### Lazy loading
+
+Resources are lazy loaded; `client.students` doesn't actually make any API requests, but `client.students.first` will.
+
+## 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 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/cpoms/classlink_client.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "classlink_client"
+
+# 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/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/classlink_client.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/classlink_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "classlink_client"
+  spec.version       = ClasslinkClient::VERSION
+  spec.authors       = ["Mike Campbell"]
+  spec.email         = ["mike.campbell@cpoms.co.uk"]
+
+  spec.summary       = "Client library for ClassLink's OneRoster API"
+  spec.homepage      = "https://github.com/cpoms/classlink_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cpoms/classlink_client"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0.0"
+end

data/lib/classlink_client/client.rb

@@ -0,0 +1,44 @@
+require "uri"
+require_relative "request_signing"
+require_relative "interface"
+require_relative "request_builder"
+
+module ClassLink
+  class Client
+    include Interface
+
+    DIRECT_OPTIONS = %i(client_id client_secret endpoint)
+    PROXY_OPTIONS = %i(access_token app_id)
+
+    (DIRECT_OPTIONS + PROXY_OPTIONS).each do |opt|
+      attr_reader opt
+    end
+
+    attr_reader :base_url, :proxy_api
+
+    def initialize(options)
+      handle_options!(options)
+
+      # if an endpoint hasn't been supplied, then we're using the proxy
+      @proxy_api = !endpoint
+      @base_url = endpoint || "https://oneroster-proxy.classlink.io/#{app_id}"
+      @base_url << "/ims/oneroster/v1p1/"
+    end
+
+    private
+      def handle_options!(options)
+        sorted_options = options.keys.sort
+
+        if sorted_options != DIRECT_OPTIONS && sorted_options != PROXY_OPTIONS
+          raise ArgumentError, <<~MSG.squish
+            must pass options for direct access (#{DIRECT_OPTIONS}),
+            or options for proxy access (#{PROXY_OPTIONS})
+          MSG
+        end
+
+        options.each do |opt, value|
+          instance_variable_set("@#{opt}", value)
+        end
+      end
+  end
+end

data/lib/classlink_client/interface.rb

@@ -0,0 +1,40 @@
+module ClassLink
+  module Interface
+    include RequestSigning
+
+    RESOURCES = %w(
+      demographics
+      resources
+      academic_sessions
+      classes
+      courses
+      enrollments
+      orgs
+      users
+      grading_periods
+      schools
+      students
+      teachers
+      terms
+    )
+
+    METHOD_NAME_PROXY = Hash.new{ |h, k| h[k] = k }.merge(
+      "classes" => "klasses"
+    )
+
+    RESOURCES.each do |resource|
+      define_method METHOD_NAME_PROXY[resource] do |options = {}|
+        builder.chain(resource, options)
+      end
+
+      define_method METHOD_NAME_PROXY[resource].singularize do |id|
+        builder.chain(resource, { segments: [id] })
+      end
+    end
+
+    private
+      def builder
+        RequestBuilder === self ? self : RequestBuilder.new(self)
+      end
+  end
+end

data/lib/classlink_client/request_builder.rb

@@ -0,0 +1,73 @@
+# require "rack"
+
+module ClassLink
+  class RequestBuilder
+    include Interface
+    extend Forwardable
+
+    TEST_ARRAY = [].freeze
+    TEST_HASH = {}.freeze
+
+    def_delegators :@client,
+      :base_url,
+      :access_token,
+      :client_id,
+      :client_secret,
+      :proxy_api
+
+    def initialize(client)
+      @client = client
+
+      @path_parts = []
+      @query = {}
+      @last_request_call = nil
+    end
+
+    def chain(request, options)
+      @last_request_call = request
+      @query.merge!(options[:query]) if options[:query]
+      @path_parts += [request, *options[:segments]].map{ |s| "#{s}/" }
+
+      self
+    end
+
+    def result
+      @result ||= execute
+    end
+
+    def execute
+      request(build_url)
+    end
+
+    def build_url
+      URI.join(base_url, *@path_parts).tap do |url|
+        url.query = @query.to_query
+      end
+    end
+
+    def method_missing(method_name, *args, &block)
+      # prevent accidental method_missing recursion in development
+      # which can make things hard to debug.
+      super if @in_method_missing
+      @in_method_missing = true
+
+      if result.respond_to?(method_name)
+        result.public_send(method_name, *args, &block)
+      else
+        super
+      end
+    ensure
+      @in_method_missing = false
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      if RESOURCES.include?(@last_request_call)
+        TEST_ARRAY.respond_to?(method_name)
+      elsif RESOURCES.map(&:singularize).include?(@last_request_call)
+        TEST_HASH.respond_to?(method_name)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/classlink_client/request_signing.rb

@@ -0,0 +1,88 @@
+require "net/https"
+require "base64"
+require_relative "response"
+
+module ClassLink
+  module RequestSigning
+    def request(url)
+      if proxy_api
+        get(url, "Bearer #{access_token}")
+      else
+        get(url, auth_header(url))
+      end
+    end
+
+    private
+      def auth_header(url)
+        # Generate timestamp and nonce
+        timestamp = Time.now.to_i.to_s
+        nonce = ('A'..'Z').to_a.sample(8).join
+
+        oauth = {
+          "oauth_consumer_key" => client_id,
+          "oauth_signature_method" => "HMAC-SHA256",
+          "oauth_timestamp" => timestamp,
+          "oauth_nonce" => nonce,
+        }
+
+        # Combine oauth params and url params
+        params = url.query ? CGI.parse(url.query).transform_values(&:first) : {}
+        params.merge!(oauth)
+
+        # Generate the auth signature
+        base_info = build_base_string(url.to_s.split("?")[0], "GET", params)
+        composite_key = CGI.escape(client_secret) + "&"
+        auth_signature = generate_auth_signature(base_info, composite_key)
+        oauth["oauth_signature"] = auth_signature
+
+        # Generate auth header
+        build_auth_header(oauth)
+      end
+
+      def build_base_string(base_url, http_method, params)
+        param_string = params.to_query.gsub("+", "%20")
+
+        http_method + "&" + CGI.escape(base_url) + "&" + CGI.escape(param_string)
+      end
+
+      def generate_auth_signature(base_info, composite_key)
+        Base64.encode64(OpenSSL::HMAC::digest(
+          OpenSSL::Digest.new("sha256"),
+          composite_key,
+          base_info
+        ))
+      end
+
+      def build_auth_header(oauth)
+        values = oauth.map{ |k, v| "#{k}=\"#{CGI.escape(v)}\"" }
+        values << values.pop[0..-5] + "\""
+        result = "OAuth #{values.join(",")}"
+      end
+
+      def get(url, header)
+        all = []
+        offset = 0
+        limit = 200
+        response_size = nil
+
+        until response_size&.< limit
+          url.query = "limit=#{limit}&offset=#{offset}"
+          req = Net::HTTP::Get.new(url.request_uri)
+          req["Authorization"] = header
+          http = Net::HTTP.new(url.hostname, url.port)
+          http.use_ssl = true
+
+          response = Response.new(http.request(req))
+
+          response_size = response.size
+
+          if response_size.positive?
+            all.concat(response)
+            offset += limit
+          end
+        end
+
+        all
+      end
+  end
+end

data/lib/classlink_client/response.rb

@@ -0,0 +1,38 @@
+require "json"
+
+module ClassLink
+  class Response
+    extend Forwardable
+
+    def_delegators :@net_http_response, :code, :message, :uri, :body
+
+    def initialize(net_http_response)
+      @net_http_response = net_http_response
+
+      raise RequestError unless code.start_with?("2")
+    end
+
+    def parsed
+      @parsed ||= JSON.parse(body).then do |res|
+        # API responses are keyed (somewhat randomly)
+        res.is_a?(Hash) ? res.values[0] : res
+      end
+    rescue JSON::ParserError
+      warn "Error parsing response as JSON, returning raw body instead."
+
+      body
+    end
+
+    def method_missing(method_name, *args, &block)
+      if parsed.respond_to?(method_name)
+        parsed.public_send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      parsed.respond_to?(method_name) || super
+    end
+  end
+end

data/lib/classlink_client/version.rb

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

data/lib/classlink_client.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+require_relative "classlink_client/version"
+require_relative "classlink_client/client"
+
+module ClassLink
+  class RequestError < StandardError; end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: classlink_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mike Campbell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description:
+email:
+- mike.campbell@cpoms.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- classlink_client.gemspec
+- lib/classlink_client.rb
+- lib/classlink_client/client.rb
+- lib/classlink_client/interface.rb
+- lib/classlink_client/request_builder.rb
+- lib/classlink_client/request_signing.rb
+- lib/classlink_client/response.rb
+- lib/classlink_client/version.rb
+homepage: https://github.com/cpoms/classlink_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cpoms/classlink_client
+  source_code_uri: https://github.com/cpoms/classlink_client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.10
+signing_key:
+specification_version: 4
+summary: Client library for ClassLink's OneRoster API
+test_files: []