clever_sdk 0.9.0.pre.pre

data/lib/clever_sdk/data/resource/refs.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Resource
+      class Refs
+        # private
+        def initialize(resource)
+          @resource = resource
+        end
+
+        def district
+          client.course_district(@resource.id)
+        end
+
+        def courses(limit: nil, starting_after: nil, ending_before: nil)
+          client.resource_courses(@resource.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def sections(limit: nil, starting_after: nil, ending_before: nil)
+          client.resource_sections(@resource.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        # role - acceptable values are nil, :student, :teacher
+        def users(role: nil, limit: nil, starting_after: nil, ending_before: nil)
+          client.resource_users(@resource.id, role: role, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        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
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@resource.response.access_token)
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/resource.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/resource/refs"
+
+module CleverSDK
+  module Data
+    class Resource
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def resource_id
+        data.dig("resource_id")
+      end
+
+      def district
+        data.dig("district")
+      end
+
+      def title
+        data.dig("title")
+      end
+
+      def roles
+        data.dig("roles")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def updated
+        DateTime.parse(data.dig("updated"))
+      rescue
+        nil
+      end
+
+      def refs
+        @refs ||= CleverSDK::Data::Resource::Refs.new(self)
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{title}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/resources.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/resource"
+
+module CleverSDK
+  module Data
+    class Resources
+      include Enumerable
+
+      # private
+      attr_reader :response
+
+      # private
+      def initialize(response)
+        @response = response
+      end
+
+      def resources
+        Array(response.body.dig("resources"))
+      end
+
+      def each &block
+        return enum_for :each unless block
+
+        resources
+          .lazy
+          .map { |resource| CleverSDK::Data::Resource.new(resource, response) }
+          .each(&block)
+      end
+
+      def all &block
+        return enum_for :all unless block
+
+        page = self
+        loop do
+          page.each(&block)
+          page = page.next
+          break if page.nil?
+        end
+      end
+
+      def next?
+        link = find_link("next")
+        !link.nil?
+      end
+
+      def next
+        link = find_link("next")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def prev?
+        link = find_link("prev")
+        !link.nil?
+      end
+
+      def prev
+        link = find_link("prev")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} resources:#{resources.count}>"
+      end
+
+      private
+
+      def find_link rel
+        Array(response.body.dig("links")).find { |link| link.dig("rel") == rel }
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/school/refs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class School
+      class Refs
+        # private
+        def initialize(school)
+          @school = school
+        end
+
+        def courses(limit: nil, starting_after: nil, ending_before: nil)
+          client.school_courses(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def district
+          client.school_district(@school.id)
+        end
+
+        def sections(limit: nil, starting_after: nil, ending_before: nil)
+          client.school_sections(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def terms(limit: nil, starting_after: nil, ending_before: nil)
+          client.school_terms(@school.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        # role - acceptable values are nil, :staff, :student, :teacher
+        # primary - acceptable values are nil, true
+        def users(role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+          client.school_users(@school.id, role: role, primary: primary, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@school.response.access_token)
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/school.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/school/refs"
+
+module CleverSDK
+  module Data
+    class School
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def district
+        data.dig("district")
+      end
+
+      def name
+        data.dig("name")
+      end
+
+      def sis_id
+        data.dig("sis_id")
+      end
+
+      def low_grade
+        data.dig("low_grade")
+      end
+
+      def high_grade
+        data.dig("high_grade")
+      end
+
+      def school_number
+        data.dig("school_number")
+      end
+
+      def principal
+        data.dig("principal")
+      end
+
+      def state_id
+        data.dig("state_id")
+      end
+
+      def phone
+        data.dig("phone")
+      end
+
+      def ext
+        data.dig("ext")
+      end
+
+      def location
+        data.dig("location")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def last_modified
+        DateTime.parse(data.dig("last_modified"))
+      rescue
+        nil
+      end
+
+      def refs
+        @refs ||= CleverSDK::Data::School::Refs.new(self)
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{name}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/schools.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/school"
+
+module CleverSDK
+  module Data
+    class Schools
+      include Enumerable
+
+      # private
+      attr_reader :response
+
+      # private
+      def initialize(response)
+        @response = response
+      end
+
+      def data
+        Array(response.body.dig("data"))
+      end
+
+      def each &block
+        return enum_for :each unless block
+
+        data
+          .lazy
+          .map { |datum| CleverSDK::Data::School.new(datum.dig("data"), response) }
+          .each(&block)
+      end
+
+      def all &block
+        return enum_for :all unless block
+
+        page = self
+        loop do
+          page.each(&block)
+          page = page.next
+          break if page.nil?
+        end
+      end
+
+      def next?
+        link = find_link("next")
+        !link.nil?
+      end
+
+      def next
+        link = find_link("next")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def prev?
+        link = find_link("prev")
+        !link.nil?
+      end
+
+      def prev
+        link = find_link("prev")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} schools:#{data.count}>"
+      end
+
+      private
+
+      def find_link rel
+        Array(response.body.dig("links")).find { |link| link.dig("rel") == rel }
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/section/refs.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Section
+      class Refs
+        # private
+        def initialize(section)
+          @section = section
+        end
+
+        def course
+          client.section_course(@section.id)
+        end
+
+        def district
+          client.section_district(@section.id)
+        end
+
+        def resources(limit: nil, starting_after: nil, ending_before: nil)
+          client.section_resources(@section.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def school
+          client.section_school(@section.id)
+        end
+
+        def term
+          client.section_term(@section.id)
+        end
+
+        # role - acceptable values are nil, :staff, :student, :teacher
+        def users(role: nil, limit: nil, starting_after: nil, ending_before: nil)
+          client.section_users(@section.id, role: role, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@section.response.access_token)
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/section.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/section/refs"
+
+module CleverSDK
+  module Data
+    class Section
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def course
+        data.dig("course")
+      end
+
+      def district
+        data.dig("district")
+      end
+
+      def school
+        data.dig("school")
+      end
+
+      def term_id
+        data.dig("term_id")
+      end
+
+      def name
+        data.dig("name")
+      end
+
+      def subject
+        data.dig("subject")
+      end
+
+      def section_number
+        data.dig("section_number")
+      end
+
+      def sis_id
+        data.dig("sis_id")
+      end
+
+      def grade
+        data.dig("grade")
+      end
+
+      def period
+        data.dig("period")
+      end
+
+      def ext
+        data.dig("ext")
+      end
+
+      def students
+        data.dig("students")
+      end
+
+      def teacher
+        data.dig("teacher")
+      end
+
+      def teachers
+        data.dig("teachers")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def last_modified
+        DateTime.parse(data.dig("last_modified"))
+      rescue
+        nil
+      end
+
+      def refs
+        @refs ||= CleverSDK::Data::Section::Refs.new(self)
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{name}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/sections.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/section"
+
+module CleverSDK
+  module Data
+    class Sections
+      include Enumerable
+
+      # private
+      attr_reader :response
+
+      # private
+      def initialize(response)
+        @response = response
+      end
+
+      def data
+        Array(response.body.dig("data"))
+      end
+
+      def each &block
+        return enum_for :each unless block
+
+        data
+          .lazy
+          .map { |datum| CleverSDK::Data::Section.new(datum.dig("data"), response) }
+          .each(&block)
+      end
+
+      def all &block
+        return enum_for :all unless block
+
+        page = self
+        loop do
+          page.each(&block)
+          page = page.next
+          break if page.nil?
+        end
+      end
+
+      def next?
+        link = find_link("next")
+        !link.nil?
+      end
+
+      def next
+        link = find_link("next")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def prev?
+        link = find_link("prev")
+        !link.nil?
+      end
+
+      def prev
+        link = find_link("prev")
+
+        return nil if link.nil?
+
+        self.class.new(CleverSDK::Api.new.page(path: link.dig("uri"), access_token: response.access_token))
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} sections:#{data.count}>"
+      end
+
+      private
+
+      def find_link rel
+        Array(response.body.dig("links")).find { |link| link.dig("rel") == rel }
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/sso.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    ##
+    # Represents the data returned from a successful call to CleverSDK::Authentication#sso.
+    class SSO
+      # public
+      attr_reader :code
+      # private
+      attr_reader :response
+
+      # private
+      def initialize(code, response)
+        @code = code
+        @response = response
+      end
+
+      def access_token
+        response.body.dig("access_token")
+      end
+
+      def token_type
+        response.body.dig("token_type")
+      end
+
+      def me
+        @me ||= CleverSDK.authentication.me(access_token)
+      end
+
+      def user
+        @user ||= CleverSDK.client(access_token).user(me.id)
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{code}) #{access_token}>"
+      end
+
+      def to_h
+        response.body.merge("code" => code, "me" => @me, "user" => @user).delete_if {|_k, v| v.nil?}
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/term/refs.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Term
+      class Refs
+        # private
+        def initialize(term)
+          @term = term
+        end
+
+        def district
+          client.term_district(@term.id)
+        end
+
+        def schools(limit: nil, starting_after: nil, ending_before: nil)
+          client.term_schools(@term.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def sections(limit: nil, starting_after: nil, ending_before: nil)
+          client.term_sections(@term.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@term.response.access_token)
+        end
+      end
+    end
+  end
+end