clever_sdk 0.9.0.pre.pre

data/lib/clever_sdk/api/schools.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Schools
+      # count - acceptable values are nil, :true, :false, :undefined
+      def schools(access_token:, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        get(
+          "https://api.clever.com/v3.0/schools",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before, count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def school(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def school_courses(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}/courses",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def school_district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}/district",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def school_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def school_terms(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}/terms",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      # role - acceptable values are nil, :staff, :student, :teacher
+      # primary - acceptable values are nil, true
+      def school_users(access_token:, id:, role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/schools/#{id}/users",
+          params: params(role: role, primary: primary,
+            limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+      # def school_staff(access_token:, id:, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+      # def school_students(access_token:, id:, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+      # def school_teachers(access_token:, id:, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+    end
+  end
+end

data/lib/clever_sdk/api/sections.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Sections
+      # count - acceptable values are nil, :true, :false, :undefined
+      def sections(access_token:, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        get(
+          "https://api.clever.com/v3.0/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before, count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section_course(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/course",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section_district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/district",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section_resources(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/resources",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section_school(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/school",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def section_term(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/term",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      # role - acceptable values are nil, :student, :teacher
+      def section_users(access_token:, id:, role: nil, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/sections/#{id}/users",
+          params: params(role: role, limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+      # def section_students(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+      # def section_teachers(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+    end
+  end
+end

data/lib/clever_sdk/api/terms.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Terms
+      # count - acceptable values are nil, :true, :false, :undefined
+      def terms(access_token:, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        get(
+          "https://api.clever.com/v3.0/terms",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before, count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def term(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/terms/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def term_district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/terms/#{id}/district",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def term_schools(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/terms/#{id}/schools",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def term_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/terms/#{id}/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api/users.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module CleverSDK
+  class Api
+    module Users
+      # role - acceptable values are nil, :contact, :district_admin, :staff, :student, :teacher
+      # count - acceptable values are nil, :true, :false, :undefined
+      def users(access_token:, role: nil, limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        get(
+          "https://api.clever.com/v3.0/users",
+          params: params(role: role, limit: limit, starting_after: starting_after, ending_before: ending_before,
+            count: count),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_district(access_token:, id:)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/district",
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_resources(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/resources",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      # primary - acceptable values are nil, true
+      def user_schools(access_token:, id:, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/schools",
+          params: params(primary: primary, limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_sections(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/sections",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_mycontacts(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/mycontacts",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_mystudents(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/mystudents",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+
+      def user_myteachers(access_token:, id:, limit: nil, starting_after: nil, ending_before: nil)
+        get(
+          "https://api.clever.com/v3.0/users/#{id}/myteachers",
+          params: params(limit: limit, starting_after: starting_after, ending_before: ending_before),
+          headers: bearer_headers(access_token)
+        )
+      end
+    end
+  end
+end

data/lib/clever_sdk/api.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require "clever_sdk/error"
+require "clever_sdk/api/response"
+require "clever_sdk/api/authentication"
+require "clever_sdk/api/courses"
+require "clever_sdk/api/districts"
+require "clever_sdk/api/resources"
+require "clever_sdk/api/schools"
+require "clever_sdk/api/sections"
+require "clever_sdk/api/terms"
+require "clever_sdk/api/users"
+require "clever_sdk/api/events"
+
+module CleverSDK
+  ##
+  # private
+  # CleverSDK::Api is only responsible for making requests to Clever API.
+  # CleverSDK::Api is not responsible for managing authentication state.
+  # CleverSDK::Api is not responsible for specifying/using configured values.
+  # CleverSDK::Api is not responsible for iterating across multiple Clever API requests.
+  class Api
+    include CleverSDK::Api::Authentication
+    include CleverSDK::Api::Courses
+    include CleverSDK::Api::Districts
+    include CleverSDK::Api::Resources
+    include CleverSDK::Api::Schools
+    include CleverSDK::Api::Sections
+    include CleverSDK::Api::Terms
+    include CleverSDK::Api::Users
+    include CleverSDK::Api::Events
+
+    # internal
+    def page(access_token:, path:)
+      get(
+        "https://api.clever.com#{path}",
+        headers: bearer_headers(access_token)
+      )
+    end
+
+    private
+
+    def get url, **kwargs
+      run(url, method: :get, **kwargs)
+    end
+
+    def post url, **kwargs
+      run(url, method: :post, **kwargs)
+    end
+
+    def run url, **kwargs
+      CleverSDK::Api::Response.handle(
+        Typhoeus::Request.new(url, **kwargs).run
+      )
+    end
+
+    def params **kwargs
+      kwargs.delete_if { |_k, v| v.nil? }
+    end
+
+    def basic_auth_token(client_id, client_secret)
+      Base64.strict_encode64([client_id, client_secret].join(":"))
+    end
+
+    def basic_auth_headers(client_id, client_secret)
+      {
+        "Accept" => "application/json",
+        "Authorization" => "Basic #{basic_auth_token(client_id, client_secret)}"
+      }
+    end
+
+    def bearer_headers(access_token)
+      {
+        "Accept" => "application/json",
+        "Authorization" => "Bearer #{access_token}"
+      }
+    end
+  end
+end

data/lib/clever_sdk/authentication.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "clever_sdk/api"
+require "clever_sdk/data/tokens"
+require "clever_sdk/data/tokeninfo"
+require "clever_sdk/data/me"
+require "clever_sdk/data/sso"
+
+module CleverSDK
+  class Authentication
+    attr_accessor :configuration
+
+    def initialize(configuration = CleverSDK.configuration)
+      yield configuration if block_given?
+
+      @configuration = configuration
+    end
+
+    def tokens
+      response = Api.new.tokens(
+        client_id: configuration.client_id,
+        client_secret: configuration.client_secret
+      )
+      CleverSDK::Data::Tokens.new(response)
+    end
+
+    def token(district_id)
+      response = Api.new.tokens(
+        client_id: configuration.client_id,
+        client_secret: configuration.client_secret,
+        district: district_id
+      )
+      data = Array(response.body.dig("data")).first
+      CleverSDK::Data::Token.new(data, response)
+    end
+
+    def tokeninfo(access_token)
+      response = Api.new.tokeninfo(access_token: access_token)
+      CleverSDK::Data::Tokeninfo.new(response.body, response)
+    end
+
+    def me(access_token)
+      response = Api.new.me(access_token: access_token)
+      data = response.body.dig("data")
+      CleverSDK::Data::Me.new(data, response)
+    end
+
+    def sso(code)
+      response = Api.new.tokens!(
+        code: code,
+        grant_type: "authorization_code",
+        client_id: configuration.client_id,
+        client_secret: configuration.client_secret,
+        redirect_uri: configuration.redirect_uri
+      )
+      CleverSDK::Data::SSO.new(code, response)
+    end
+
+    def sso_redirect_uri
+      "https://clever.com/oauth/authorize?response_type=code&redirect_uri=#{configuration.redirect_uri}&client_id=#{configuration.client_id}"
+    end
+
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")}>"
+    end
+  end
+end

data/lib/clever_sdk/client/courses.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/courses"
+
+module CleverSDK
+  class Client
+    module Courses
+      # count - acceptable values are nil, :true, :false, :undefined
+      def courses(limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        response = api.courses(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
+        CleverSDK::Data::Courses.new(response)
+      end
+
+      def course(id)
+        response = api.course(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Course.new(data, response)
+      end
+
+      def course_district(id)
+        response = api.course_district(access_token: access_token, id: id)
+        CleverSDK::Data::District.new(response.body.dig("data"), response)
+      end
+
+      def course_resources(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.course_resources(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Resources.new(response)
+      end
+
+      def course_schools(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.course_schools(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Schools.new(response)
+      end
+
+      def course_sections(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.course_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/districts.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/districts"
+
+module CleverSDK
+  class Client
+    module Districts
+      # count - acceptable values are nil, :true, :false, :undefined
+      def districts(count: nil)
+        response = api.districts(access_token: access_token, count: count)
+        CleverSDK::Data::Districts.new(response)
+      end
+
+      def district(id)
+        response = api.district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::District.new(data, response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client/events.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/events"
+
+module CleverSDK
+  class Client
+    module Events
+      def events(limit: nil, starting_after: nil, ending_before: nil, school: nil, record_type: nil)
+        response = api.events(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before,
+          school: school, record_type: record_type)
+        CleverSDK::Data::Events.new(response)
+      end
+
+      def event(id)
+        response = api.event(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Event.new(data, response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client/resources.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/resources"
+
+module CleverSDK
+  class Client
+    module Resources
+      def resources(limit: nil, starting_after: nil, ending_before: nil)
+        response = api.resources(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Resources.new(response)
+      end
+
+      def resource(id)
+        response = api.resource(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Resources.new(data, response)
+      end
+
+      def resource_courses(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.resource_courses(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Courses.new(response)
+      end
+
+      def resource_sections(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.resource_sections(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Sections.new(response)
+      end
+
+      # role - acceptable values are nil, :student, :teacher
+      def resource_users(id, role: nil, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.resource_users(access_token: access_token, id: id, role: role,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client/schools.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/schools"
+
+module CleverSDK
+  class Client
+    module Schools
+      # count - acceptable values are nil, :true, :false, :undefined
+      def schools(limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        response = api.schools(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
+        CleverSDK::Data::Schools.new(response)
+      end
+
+      def school(id)
+        response = api.school(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::School.new(data, response)
+      end
+
+      def school_courses(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.school_courses(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Courses.new(response)
+      end
+
+      def school_district(id)
+        response = api.school_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::District.new(data, response)
+      end
+
+      def school_sections(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.school_sections(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Sections.new(response)
+      end
+
+      def school_terms(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.school_terms(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Terms.new(response)
+      end
+
+      # role - acceptable values are nil, :staff, :student, :teacher
+      # primary - acceptable values are nil, true
+      def school_users(id, role: nil, primary: nil, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.school_users(access_token: access_token, id: id, role: role, primary: primary,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+    end
+  end
+end

data/lib/clever_sdk/client/sections.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "clever_sdk/data/sections"
+
+module CleverSDK
+  class Client
+    module Sections
+      # count - acceptable values are nil, :true, :false, :undefined
+      def sections(limit: nil, starting_after: nil, ending_before: nil, count: nil)
+        response = api.sections(access_token: access_token,
+          limit: limit, starting_after: starting_after, ending_before: ending_before, count: count)
+        CleverSDK::Data::Sections.new(response)
+      end
+
+      def section(id)
+        response = api.section(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Section.new(data, response)
+      end
+
+      def section_course(id)
+        response = api.section_course(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Course.new(data, response)
+      end
+
+      def section_district(id)
+        response = api.section_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::District.new(data, response)
+      end
+
+      def section_resources(id, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.section_resources(access_token: access_token, id: id,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Resources.new(response)
+      end
+
+      def section_school(id)
+        response = api.section_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::School.new(data, response)
+      end
+
+      def section_term(id)
+        response = api.section_district(access_token: access_token, id: id)
+        data = response.body.dig("data")
+        CleverSDK::Data::Term.new(data, response)
+      end
+
+      # role - acceptable values are nil, :student, :teacher
+      def section_users(id, role: nil, limit: nil, starting_after: nil, ending_before: nil)
+        response = api.section_users(access_token: access_token, id: id, role: role,
+          limit: limit, starting_after: starting_after, ending_before: ending_before)
+        CleverSDK::Data::Users.new(response)
+      end
+    end
+  end
+end