clever 1.2.5

data/lib/clever/paginator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Clever
+  PAGE_LIMIT  = 10_000
+  EVENT_TYPES = %w(students teachers sections).freeze
+
+  class Paginator
+    def initialize(connection, path, method, type, client: nil)
+      @connection = connection
+      @path       = path
+      @method     = method
+      @type       = type
+      @client     = client
+      @next_path  = nil
+    end
+
+    def fetch
+      Enumerator.new do |yielder|
+        loop do
+          response = request(@next_path || @path)
+          body = response.body
+
+          fail "Failed to fetch #{@path}" unless response.success?
+
+          body.each { |item| add_record(yielder, item) } if body.any?
+
+          @next_path = response.next_uri
+
+          fail StopIteration unless @next_path
+        end
+      end.lazy
+    end
+
+    def self.fetch(*params)
+      new(*params).fetch
+    end
+
+    private
+
+    def add_record(yielder, item)
+      return unless should_add_record?(item)
+
+      yielder << @type.new(item['data'], client: @client)
+    end
+
+    def should_add_record?(item)
+      return true unless @type == Clever::Types::Event
+
+      item['data']['type'].start_with?(*EVENT_TYPES)
+    end
+
+    def request(path = @path)
+      @connection.execute(path, @method, limit: PAGE_LIMIT)
+    end
+  end
+end

data/lib/clever/response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Clever
+  class Response
+    attr_reader :status, :raw_body, :links, :self_uri, :next_uri
+
+    attr_accessor :body
+
+    def initialize(faraday_response)
+      @status   = faraday_response.status
+      @raw_body = faraday_response.body
+
+      return unless faraday_response.body
+
+      @body     = faraday_response.body['data']
+      @links    = faraday_response.body['links']
+
+      uri(:self)
+      uri(:next)
+    end
+
+    def success?
+      @status == 200
+    end
+
+    private
+
+    def uri(kind)
+      return unless @links
+
+      object = @links.find { |link| link['rel'] == kind.to_s }
+
+      return unless object
+
+      instance_variable_set("@#{kind}_uri", object['uri'])
+    end
+  end
+end

data/lib/clever/types/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Clever
+  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/clever/types/classroom.rb

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

data/lib/clever/types/course.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Course < Base
+      attr_reader :uid,
+                  :district,
+                  :name,
+                  :number,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid      = attributes['id']
+        @district = attributes['district']
+        @name     = attributes['name']
+        @number   = attributes['number']
+        @provider = 'clever'
+      end
+    end
+  end
+end

data/lib/clever/types/enrollment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Enrollment < Base
+      attr_reader :classroom_uid,
+                  :user_uid,
+                  :provider
+
+      def initialize(attributes = {})
+        @classroom_uid = attributes['classroom_uid']
+        @user_uid      = attributes['user_uid']
+        @provider      = 'clever'
+      end
+    end
+  end
+end

data/lib/clever/types/event.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'clever/types/section'
+require 'clever/types/teacher'
+require 'clever/types/student'
+
+module Clever
+  module Types
+    class Event < Base
+      attr_reader :uid,
+                  :type,
+                  :action,
+                  :object,
+                  :provider
+
+      TYPE_MAP = {
+        'sections' => ::Clever::Types::Section,
+        'teachers' => ::Clever::Types::Teacher,
+        'students' => ::Clever::Types::Student
+      }.freeze
+
+      def initialize(attributes = {}, *)
+        @uid           = attributes['id']
+        @type, @action = attributes['type'].split('.')
+        @object        = TYPE_MAP[@type]&.new(attributes['data']['object'])
+        @provider      = 'clever'
+      end
+    end
+  end
+end

data/lib/clever/types/section.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Section < Base
+      attr_reader :uid,
+                  :name,
+                  :period,
+                  :course,
+                  :grades,
+                  :students,
+                  :teachers,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid      = attributes['id']
+        @name     = attributes['name']
+        @period   = attributes['period']
+        @course   = attributes['course']
+        @grades   = attributes['grade']
+        @students = attributes['students']
+        @teachers = attributes['teachers']
+        @provider = 'clever'
+      end
+    end
+  end
+end

data/lib/clever/types/student.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Student < Base
+      attr_reader :uid,
+                  :first_name,
+                  :last_name,
+                  :provider
+
+      def initialize(attributes = {}, client: nil)
+        @uid               = attributes['id']
+        @first_name        = attributes['name']['first']
+        @last_name         = attributes['name']['last']
+        @district_username = attributes.dig('credentials', 'district_username')
+        @sis_id            = attributes['sis_id']
+        @email             = attributes['email']
+        @username          = username(client)
+        @provider          = 'clever'
+      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 if blank?(username_source)
+
+        presence(instance_variable_get("@#{username_source}"))
+      end
+
+      def default_username
+        presence(@district_username) || presence(@email) || @sis_id
+      end
+    end
+  end
+end

data/lib/clever/types/teacher.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Teacher < Base
+      attr_reader :uid,
+                  :email,
+                  :first_name,
+                  :last_name,
+                  :provider
+
+      def initialize(attributes = {}, *)
+        @uid        = attributes['id']
+        @email      = attributes['email']
+        @first_name = attributes['name']['first']
+        @last_name  = attributes['name']['last']
+        @provider   = 'clever'
+      end
+    end
+  end
+end

data/lib/clever/types/token.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Token < Base
+      attr_reader :uid,
+                  :created,
+                  :owner,
+                  :access_token,
+                  :scopes
+
+      def initialize(attributes = {}, *)
+        @uid          = attributes['id']
+        @created      = attributes['created']
+        @owner        = attributes['owner']
+        @access_token = attributes['access_token']
+        @scopes       = attributes['scopes']
+      end
+    end
+  end
+end

data/lib/clever/version.rb

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

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: clever
+version: !ruby/object:Gem::Version
+  version: 1.2.5
+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: 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 Clever 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"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- clever.gemspec
+- lib/clever.rb
+- lib/clever/client.rb
+- lib/clever/connection.rb
+- lib/clever/paginator.rb
+- lib/clever/response.rb
+- lib/clever/types/base.rb
+- lib/clever/types/classroom.rb
+- lib/clever/types/course.rb
+- lib/clever/types/enrollment.rb
+- lib/clever/types/event.rb
+- lib/clever/types/section.rb
+- lib/clever/types/student.rb
+- lib/clever/types/teacher.rb
+- lib/clever/types/token.rb
+- lib/clever/version.rb
+homepage: https://github.com/tci/clever
+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 Clever API.
+test_files: []