clever_sdk 0.9.0.pre.pre

data/lib/clever_sdk/client/terms.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/terms"
+
+module CleverSDK
+  class Client
+    module Terms
+      # count - acceptable values are nil, :true, :false, :undefined
+      def terms(limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        response = api.terms(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
+        CleverSDK::Data::Terms.new(response)
+      end
+
+      def term(id)
+        response = api.term(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Term.new(data, response)
+      end
+
+      def term_district(id)
+        response = api.term_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::District.new(data, response)
+      end
+
+      def term_schools(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.term_schools(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Schools.new(response)
+      end
+
+      def term_sections(id)
+        response = api.term_sections(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Sections.new(response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client/users.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/users"
+
+module CleverSDK
+  class Client
+    module Users
+      # role - acceptable values are nil, :contact, :district_admin, :staff, :student, :teacher
+      # count - acceptable values are nil, :true, :false, :undefined
+      def users(role: nil, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        response = api.users(access_token: access_token, role: role,
+          limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
+        CleverSDK::Data::Users.new(response)
+      end
+
+      def user(id)
+        response = api.user(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::User.new(data, response)
+      end
+
+      def user_district(id)
+        response = api.user_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::District.new(data, response)
+      end
+
+      def user_resources(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_resources(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Resources.new(response)
+      end
+
+      # primary - acceptable values are nil, true
+      def user_schools(id, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_schools(access_token: access_token, id: id, primary: primary,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Schools.new(response)
+      end
+
+      def user_sections(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_sections(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Sections.new(response)
+      end
+
+      def user_mycontacts(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_mycontacts(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+
+      def user_mystudents(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_mystudents(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+
+      def user_myteachers(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.user_myteachers(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "clever_sdk/api"
+require "clever_sdk/client/courses"
+require "clever_sdk/client/districts"
+require "clever_sdk/client/resources"
+require "clever_sdk/client/schools"
+require "clever_sdk/client/sections"
+require "clever_sdk/client/terms"
+require "clever_sdk/client/users"
+require "clever_sdk/client/events"
+
+module CleverSDK
+  class Client
+    include CleverSDK::Client::Courses
+    include CleverSDK::Client::Districts
+    include CleverSDK::Client::Resources
+    include CleverSDK::Client::Schools
+    include CleverSDK::Client::Sections
+    include CleverSDK::Client::Terms
+    include CleverSDK::Client::Users
+    include CleverSDK::Client::Events
+
+    attr_accessor :access_token, :configuration
+
+    def initialize(access_token, configuration = CleverSDK.configuration)
+      @access_token = access_token
+      @configuration = configuration
+    end
+
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} #{access_token}>"
+    end
+
+    private
+
+    def api
+      @api ||= CleverSDK::Api.new
+    end
+  end
+end

data/lib/clever_sdk/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Configuration
+    attr_accessor :client_id, :client_secret, :redirect_uri
+
+    def initialize(options = {})
+      @client_id = options.dig(:client_id) || ENV["CLEVER_ID"]
+      @client_secret = options.dig(:client_secret) || ENV["CLEVER_SECRET"]
+      @redirect_uri = options.dig(:redirect_uri) || ENV["CLEVER_REDIRECT_URI"]
+    end
+  end
+end

data/lib/clever_sdk/data/course/refs.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Course
+      class Refs
+        # private
+        def initialize(course)
+          @course = course
+        end
+
+        def district
+          client.course_district(@course.id)
+        end
+
+        def resources(limit: nil, starting_after: nil, ending_before: nil)
+          client.course_resources(@course.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def schools(limit: nil, starting_after: nil, ending_before: nil)
+          client.course_schools(@course.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def sections(limit: nil, starting_after: nil, ending_before: nil)
+          client.course_sections(@course.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@course.response.access_token)
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/course.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/course/refs"
+
+module CleverSDK
+  module Data
+    class Course
+      # 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 number
+        data.dig("number")
+      end
+
+      def refs
+        @refs ||= CleverSDK::Data::Course::Refs.new(self)
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{first_name} #{last_name}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/courses.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/course"
+
+module CleverSDK
+  module Data
+    class Courses
+      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::Course.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")} courses:#{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/district.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class District
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def name
+        data.dig("name")
+      end
+
+      def mdr_number
+        data.dig("mdr_number")
+      end
+
+      def nces_id
+        data.dig("nces_id")
+      end
+
+      def sis_type
+        data.dig("sis_type")
+      end
+
+      def state
+        data.dig("state")
+      end
+
+      def last_sync
+        DateTime.parse(data.dig("last_sync"))
+      rescue
+        nil
+      end
+
+      def portal_url
+        data.dig("portal_url")
+      end
+
+      def login_methods
+        Array(data.dig("login_methods"))
+      end
+
+      def launch_date
+        Date.parse(data.dig("launch_date"))
+      rescue
+        nil
+      end
+
+      def pause_start
+        Date.parse(data.dig("pause_start"))
+      rescue
+        nil
+      end
+
+      def pause_end
+        Date.parse(data.dig("pause_end"))
+      rescue
+        nil
+      end
+
+      def district_contact
+        Contact.new(data.dig("district_contact"))
+      end
+
+      def error
+        data.dig("error")
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{name}>"
+      end
+
+      alias_method :to_h, :data
+
+      class Contact
+        attr_reader :data
+
+        # private
+        def initialize(data)
+          @data = data
+        end
+
+        def id
+          data.dig("id")
+        end
+
+        def district_id
+          data.dig("district_id")
+        end
+
+        def first_name
+          data.dig("name", "first")
+        end
+
+        def middle_name
+          data.dig("name", "middle")
+        end
+
+        def last_name
+          data.dig("name", "last")
+        end
+
+        def email
+          data.dig("email")
+        end
+
+        def title
+          data.dig("title")
+        end
+
+        def inspect
+          "#<#{self.class.name}(#{id}) #{first_name} #{last_name}>"
+        end
+
+        alias_method :to_h, :data
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/districts.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/district"
+
+module CleverSDK
+  module Data
+    class Districts
+      include Enumerable
+
+      # private
+      attr_reader :response
+
+      # private
+      def initialize(response)
+        @response = response
+      end
+
+      def data
+        @data ||= Array(response.body.dig("data"))
+      end
+
+      def each &block
+        return enum_for :each unless block
+
+        data
+          .lazy
+          .map { |datum| CleverSDK::Data::District.new(datum.dig("data"), response) }
+          .each(&block)
+      end
+      alias_method :all, :each
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} districts:#{data.count}>"
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/event.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/courses"
+require "clever_sdk/data/districts"
+require "clever_sdk/data/schools"
+require "clever_sdk/data/sections"
+require "clever_sdk/data/terms"
+require "clever_sdk/data/users"
+
+module CleverSDK
+  module Data
+    class Event
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def type
+        data.dig("type")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def object
+        return object_class.new(object_data, response) if object_class
+
+        object_data
+      end
+
+      def previous_attributes
+        data.dig("data", "previous_attributes")
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{type}>"
+      end
+
+      alias_method :to_h, :data
+
+      private
+
+      def object_type
+        # courses
+        # districts
+        # schools
+        # sections
+        # terms
+        # users
+        type.split(".").first
+      end
+
+      def object_data
+        data.dig("data", "object")
+      end
+
+      def object_class
+        case object_type
+        when "courses"
+          CleverSDK::Data::Course
+        when "districts"
+          CleverSDK::Data::District
+        when "schools"
+          CleverSDK::Data::School
+        when "sections"
+          CleverSDK::Data::Section
+        when "terms"
+          CleverSDK::Data::Term
+        when "users"
+          CleverSDK::Data::User
+        end
+      end
+
+      def object_action
+        # created
+        # deleted
+        # updated
+        type.split(".").last
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/events.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/event"
+
+module CleverSDK
+  module Data
+    class Events
+      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::Event.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")} events:#{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/me.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Me
+      # 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 type
+        data.dig("type")
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}:#{type})>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end