oneroster 1.3.6

data/lib/one_roster/paginator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OneRoster
+  PAGE_LIMIT = 5_000
+
+  class Paginator
+    def initialize(connection, path, method, type, offset = 0, limit = PAGE_LIMIT, client: nil)
+      @connection = connection
+      @path       = path
+      @method     = method
+      @type       = type
+      @offset     = offset
+      @limit      = limit
+      @client     = client
+    end
+
+    def fetch
+      Enumerator.new do |yielder|
+        loop do
+          response = request(@path, @offset)
+          body = response.body
+
+          fail "Failed to fetch #{@path}" unless response.success?
+          fail StopIteration if body.empty?
+
+          if body.any?
+            body.each do |item|
+              yielder << @type.new(item, client: @client) unless item['status'] == 'tobedeleted'
+            end
+          end
+
+          @offset = next_offset
+        end
+      end.lazy
+    end
+
+    def self.fetch(*params)
+      new(*params).fetch
+    end
+
+    private
+
+    def next_offset
+      @offset + @limit
+    end
+
+    def request(path, offset)
+      @connection.execute(path, @method, limit: @limit, offset: offset)
+    end
+  end
+end
+

data/lib/one_roster/response.rb

@@ -0,0 +1,31 @@
+module OneRoster
+  class Response
+    attr_reader :status, :raw_body, :headers
+
+    attr_accessor :body
+
+    def initialize(faraday_response)
+      @status = faraday_response.status
+      @raw_body = faraday_response.body
+      @type = resource_type(faraday_response)
+
+      return unless faraday_response.body
+
+      @body = faraday_response.body[@type]
+
+      return unless faraday_response.headers
+
+      @headers = faraday_response.headers
+    end
+
+    def success?
+      @status == 200
+    end
+
+    private
+
+    def resource_type(faraday_response)
+      RESPONSE_TYPE_MAP[faraday_response.env.url.path.split('/').last]
+    end
+  end
+end

data/lib/one_roster/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OneRoster
+  VERSION = '1.3.6'
+end

data/lib/types/application.rb

@@ -0,0 +1,19 @@
+module OneRoster
+  module Types
+    class Application < Base
+      attr_reader :uid,
+                  :bearer,
+                  :name,
+                  :tenant_name,
+                  :app_id
+
+      def initialize(attributes = {}, *)
+        @uid         = attributes['id']
+        @bearer      = attributes['bearer']
+        @name        = attributes['name']
+        @tenant_name = attributes['tenant_name']
+        @app_id      = attributes['oneroster_application_id']
+      end
+    end
+  end
+end

data/lib/types/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Base
+      def to_h
+        instance_variables.each_with_object({}) do |instance_var, variables|
+          key = instance_var.to_s.tr('@', '').to_sym
+          value = instance_variable_get(instance_var)
+          variables[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/types/class.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Class < Base
+      attr_reader :uid,
+                  :title,
+                  :course_uid,
+                  :provider,
+                  :period,
+                  :grades
+
+      def initialize(attributes = {}, *)
+        @uid        = attributes['sourcedId']
+        @title      = capitalize(attributes['title'])
+        @course_uid = attributes['course']['sourcedId']
+        @status     = attributes['status']
+        @period     = first_period(attributes) || period_from_code(attributes)
+        @grades     = attributes['grades']
+        @provider   = 'oneroster'
+      end
+
+      private
+
+      def capitalize(string)
+        string.split(' ').map(&:capitalize).join(' ')
+      end
+
+      def first_period(attributes)
+        attributes['periods']&.first
+      end
+
+      def period_from_code(attributes)
+        attributes['classCode']&.match(/- Period (\d+) -/) { |m| m[1] }
+      end
+    end
+  end
+end

data/lib/types/classroom.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Classroom < Base
+      attr_reader :uid,
+                  :name,
+                  :course_number,
+                  :period,
+                  :grades,
+                  :provider
+
+      def initialize(attributes = {})
+        @uid           = attributes['id']
+        @name          = attributes['name']
+        @course_number = attributes['course_number']
+        @period        = attributes['period']
+        @grades        = attributes['grades']
+        @provider      = 'oneroster'
+      end
+    end
+  end
+end

data/lib/types/course.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Course < Base
+      attr_reader :uid,
+                  :course_code,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid          = attributes['sourcedId']
+        @course_code  = attributes['courseCode']
+        @provider     = 'oneroster'
+      end
+    end
+  end
+end

data/lib/types/enrollment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Enrollment < Base
+      attr_reader :uid,
+                  :classroom_uid,
+                  :user_uid,
+                  :role,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid           = attributes['sourcedId']
+        # allow instantiation with classroom_uid and user_uid attrs for consistency with clever
+        @classroom_uid = attributes['classroom_uid'] || attributes.dig('class', 'sourcedId')
+        @user_uid      = attributes['user_uid'] || attributes.dig('user', 'sourcedId')
+        @role          = attributes['role']
+        @primary       = attributes['primary']
+        @provider      = 'oneroster'
+      end
+
+      def valid?
+        return true if student?
+
+        teacher?
+      end
+
+      def primary_teacher?
+        teacher? && @primary.to_s == 'true'
+      end
+
+      def teacher?
+        @role == 'teacher'
+      end
+
+      def student?
+        @role == 'student'
+      end
+
+      def to_h
+        {
+          classroom_uid: @classroom_uid,
+          user_uid: @user_uid,
+          provider: @provider
+        }
+      end
+    end
+  end
+end

data/lib/types/student.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Student < Base
+      attr_reader :uid,
+                  :first_name,
+                  :last_name,
+                  :provider
+
+      def initialize(attributes = {}, client: nil)
+        @uid          = attributes['sourcedId']
+        @first_name   = attributes['givenName']
+        @last_name    = attributes['familyName']
+        @api_username = attributes['username']
+        @status       = attributes['status']
+        @email        = attributes['email']
+        @username     = username(client)
+        @provider     = 'oneroster'
+      end
+
+      def username(client = nil)
+        username_source = client&.username_source
+
+        @username ||= presence(username_from(username_source)) || default_username
+      end
+
+      def to_h
+        {
+          uid: @uid,
+          first_name: @first_name,
+          last_name: @last_name,
+          username: @username,
+          provider: @provider
+        }
+      end
+
+      private
+
+      def presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
+      end
+
+      def username_from(username_source)
+        return unless presence(username_source)
+
+        source = username_source(username_source)
+
+        presence(instance_variable_get("@#{source}"))
+      end
+
+      # if the username_source is `sourcedId`, we want to return `uid`
+      # so we can grab the right instance variable
+      def username_source(source)
+        case source
+        when 'sourcedId' then 'uid'
+        when 'username' then 'api_username'
+        else
+          source
+        end
+      end
+
+      def default_username
+        presence(@api_username) || presence(@email) || @uid
+      end
+    end
+  end
+end

data/lib/types/teacher.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Teacher < Base
+      attr_reader :uid,
+                  :email,
+                  :first_name,
+                  :last_name,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid        = attributes['sourcedId']
+        @email      = attributes['email']
+        @first_name = attributes['givenName']
+        @last_name  = attributes['familyName']
+        @provider   = 'oneroster'
+      end
+    end
+  end
+end

data/one_roster.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'one_roster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oneroster'
+  spec.version       = OneRoster::VERSION
+  spec.authors       = ['Robert Julius']
+  spec.email         = ['robertmjulius@gmail.com']
+
+  spec.summary       = 'Wrapper for the OneRoster API.'
+  spec.description   = 'Wrapper for the OneRoster API.'
+  spec.homepage      = "https://github.com/TCI/oneroster"
+  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_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'dry-inflector'
+  spec.add_runtime_dependency 'simple_oauth'
+  spec.add_runtime_dependency 'oauth'
+
+  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

metadata

@@ -0,0 +1,272 @@
+--- !ruby/object:Gem::Specification
+name: oneroster
+version: !ruby/object:Gem::Version
+  version: 1.3.6
+platform: ruby
+authors:
+- Robert Julius
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: dry-inflector
+  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: simple_oauth
+  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: oauth
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for the OneRoster API.
+email:
+- robertmjulius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-style.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/one_roster.rb
+- lib/one_roster/client.rb
+- lib/one_roster/connection.rb
+- lib/one_roster/paginator.rb
+- lib/one_roster/response.rb
+- lib/one_roster/version.rb
+- lib/types/application.rb
+- lib/types/base.rb
+- lib/types/class.rb
+- lib/types/classroom.rb
+- lib/types/course.rb
+- lib/types/enrollment.rb
+- lib/types/student.rb
+- lib/types/teacher.rb
+- one_roster.gemspec
+homepage: https://github.com/TCI/oneroster
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Wrapper for the OneRoster API.
+test_files: []