clever_sdk 0.9.0.pre.pre

data/lib/clever_sdk/data/term.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Term
+      # 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 start_date
+        Date.parse(data.dig("start_date"))
+      rescue
+        nil
+      end
+
+      def end_date
+        Date.parse(data.dig("end_date"))
+      rescue
+        nil
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{name}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/terms.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/term"
+
+module CleverSDK
+  module Data
+    class Terms
+      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::Term.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")} terms:#{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/token.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Token
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def id
+        data.dig("id")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def owner_id
+        data.dig("owner", "id")
+      end
+
+      def owner_type
+        data.dig("owner", "type")
+      end
+
+      def access_token
+        data.dig("access_token")
+      end
+
+      def scopes
+        data.dig("scopes")
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{id}) #{access_token}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end
+
+# example response
+# {
+#   "id"=>"63e673d9d016950008e5b5b2",
+#   "created"=>"2023-02-10T16:42:01.701Z",
+#   "owner"=>{"type"=>"district", "id"=>"63e673d91c05c2527736ba41"},
+#   "access_token"=>"TEST_TOKEN",
+#   "scopes"=>
+#    ["read:district_admins",
+#     "read:districts",
+#     "read:resources",
+#     "read:school_admins",
+#     "read:schools",
+#     "read:sections",
+#     "read:student_contacts",
+#     "read:students",
+#     "read:teachers",
+#     "read:user_id"]
+# }

data/lib/clever_sdk/data/tokeninfo.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class Tokeninfo
+      # private
+      attr_reader :data, :response
+
+      # private
+      def initialize(data, response)
+        @data = data
+        @response = response
+      end
+
+      def client_id
+        data.dig("client_id")
+      end
+
+      def scopes
+        data.dig("scopes")
+      end
+
+      def inspect
+        "#<#{self.class.name}(#{client_id}) #{access_token}>"
+      end
+
+      alias_method :to_h, :data
+    end
+  end
+end

data/lib/clever_sdk/data/tokens.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/token"
+
+module CleverSDK
+  module Data
+    class Tokens
+      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
+
+        tokens = Array(data).lazy.map { |datum| CleverSDK::Data::Token.new(datum, response) }
+        tokens.each(&block)
+      end
+      alias_method :all, :each
+
+      def inspect
+        "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} tokens:#{data.count}>"
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/contact_role.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class ContactRole
+        # private
+        def initialize(user)
+          @user = user
+          @role = @user.roles.dig("contact")
+        end
+
+        def legacy_id
+          @role.dig("legacy_id")
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/district_admin_role.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class DistrictAdminRole
+        # private
+        def initialize(user)
+          @user = user
+          @role = @user.roles.dig("district_admin")
+        end
+
+        def legacy_id
+          @role.dig("legacy_id")
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/refs.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class Refs
+        # private
+        def initialize(user)
+          @user = user
+        end
+
+        def district
+          client.user_district(@user.id)
+        end
+
+        def resources(limit: nil, starting_after: nil, ending_before: nil)
+          client.user_resources(@user.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        # primary - acceptable values are nil, true
+        def schools(primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+          client.user_schools(@user.id, primary: primary,
+            limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def sections(limit: nil, starting_after: nil, ending_before: nil)
+          client.user_sections(@user.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def mycontacts(limit: nil, starting_after: nil, ending_before: nil)
+          return unless @user.student?
+
+          client.user_mycontacts(@user.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def mystudents(limit: nil, starting_after: nil, ending_before: nil)
+          return unless @user.teacher?
+
+          client.user_mystudents(@user.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        def myteachers(limit: nil, starting_after: nil, ending_before: nil)
+          return unless @user.student?
+
+          client.user_myteachers(@user.id, limit: limit, starting_after: starting_after, ending_before: ending_before)
+        end
+
+        private
+
+        def client
+          @client ||= CleverSDK::Client.new(@user.response.access_token)
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/staff_role.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class StaffRole
+        # private
+        def initialize(user)
+          @user = user
+          @role = @user.roles.dig("staff")
+        end
+
+        def legacy_id
+          @role.dig("legacy_id")
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/student_role.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class StudentRole
+        # private
+        def initialize(user)
+          @user = user
+          @role = @user.roles.dig("student")
+        end
+
+        def sis_id
+          @role.dig("sis_id")
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user/teacher_role.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  module Data
+    class User
+      class TeacherRole
+        # private
+        def initialize(user)
+          @user = user
+          @role = @user.roles.dig("teacher")
+        end
+
+        def legacy_id
+          @role.dig("legacy_id")
+        end
+      end
+    end
+  end
+end

data/lib/clever_sdk/data/user.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/user/contact_role"
+require "clever_sdk/data/user/district_admin_role"
+require "clever_sdk/data/user/staff_role"
+require "clever_sdk/data/user/student_role"
+require "clever_sdk/data/user/teacher_role"
+require "clever_sdk/data/user/refs"
+
+module CleverSDK
+  module Data
+    class User
+      # 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 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 roles
+        data.dig("roles")
+      end
+
+      def created
+        DateTime.parse(data.dig("created"))
+      rescue
+        nil
+      end
+
+      def last_modified
+        DateTime.parse(data.dig("last_modified"))
+      rescue
+        nil
+      end
+
+      def contact?
+        !roles.dig("contact").nil?
+      end
+
+      def contact
+        return unless contact?
+
+        @contact ||= CleverSDK::Data::User::ContactRole.new(self)
+      end
+
+      def district_admin?
+        !roles.dig("district_admin").nil?
+      end
+
+      def district_admin
+        return unless district_admin?
+
+        @district_admin ||= CleverSDK::Data::User::DistrictAdminRole.new(self)
+      end
+
+      def staff?
+        !roles.dig("staff").nil?
+      end
+
+      def staff
+        return unless staff?
+
+        @staff ||= CleverSDK::Data::User::StaffRole.new(self)
+      end
+
+      def teacher?
+        !roles.dig("teacher").nil?
+      end
+
+      def teacher
+        return unless teacher?
+
+        @teacher ||= CleverSDK::Data::User::TeacherRole.new(self)
+      end
+
+      def student?
+        !roles.dig("student").nil?
+      end
+
+      def student
+        return unless student?
+
+        @student ||= CleverSDK::Data::User::StudentRole.new(self)
+      end
+
+      def refs
+        @refs ||= CleverSDK::Data::User::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/users.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/user"
+
+module CleverSDK
+  module Data
+    class Users
+      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::User.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")} users:#{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/error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Error < StandardError
+    def self.handle(typhoeus_response)
+      explanation = CleverSDK::Api::Response.status_code_explanations[typhoeus_response.code]
+
+      error_obj = if explanation.nil?
+        new
+      else
+        new([explanation[:meaning], explanation[:action_to_take]].join(": "))
+      end
+
+      error_obj.response = typhoeus_response
+      error_obj.code = typhoeus_response.code
+      error_obj.meaning = explanation[:meaning] if explanation
+      error_obj.action_to_take = explanation[:action_to_take] if explanation
+      error_obj
+    end
+
+    attr_accessor :response, :code, :meaning, :action_to_take
+
+    def intitialize(message = "Unknown API error")
+      super(message)
+    end
+  end
+end

data/lib/clever_sdk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  VERSION = "0.9.0-pre"
+end

data/lib/clever_sdk.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "typhoeus"
+require "json"
+
+require "clever_sdk/configuration"
+require "clever_sdk/error"
+require "clever_sdk/authentication"
+require "clever_sdk/client"
+require "clever_sdk/version"
+
+module CleverSDK
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= CleverSDK::Configuration.new
+  end
+
+  def self.authentication(configuration = CleverSDK.configuration)
+    yield configuration if block_given?
+
+    CleverSDK::Authentication.new(configuration)
+  end
+
+  def self.client(access_token, configuration = CleverSDK.configuration)
+    yield configuration if block_given?
+
+    CleverSDK::Client.new(access_token, configuration)
+  end
+end