plurall 0.1.0

data/lib/plurall/student_classes.rb

@@ -0,0 +1,197 @@
+module Plurall
+  ##
+  # Public: A list of school classes that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.classes(school_id: 123456).each do |school_class|
+  #     puts school_class.name
+  #   end
+  #
+  class StudentClasses
+    include Enumerable
+
+    # Internal: Returns the GraphQL API response as a GraphQL::Client::Response.
+    attr_reader :response
+
+    ##
+    # Internal: Create a new object from a GraphQL API response.
+    #
+    # response - The GraphQL API response as a GraphQL::Client::Response.
+    #
+    def initialize response
+      @response = response
+    end
+
+    ##
+    # Public: Returns the number of classes as an Integer.
+    def total_count
+      student_node.classes.total_count
+    end
+
+    ##
+    # Public: Returns the list of classes as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Returns the school id for list of classes as a String.
+    def school_id
+      school_node.id
+    end
+
+    ##
+    # Public: Returns the student uuid for list of classes as a String.
+    def student_uuid
+      student_node.uuid
+    end
+
+    ##
+    # Public: Returns the student id for list of classes as a String.
+    def student_id
+      student_node.id
+    end
+
+    ##
+    # Public: Iterates the list of student classes.
+    #
+    # Examples
+    #
+    #   Plurall.classes(school_id: 123456).each do |school_class|
+    #     puts school_class.name
+    #   end
+    #
+    # Yields a school class object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    def each &block
+      return enum_for :each unless block
+
+      student_node.classes.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all student classes.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.classes(school_id: 123456).all do |school_class|
+    #     puts school_class.name
+    #   end
+    #
+    # Yields a school class object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    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
+
+    ##
+    # Public: Whether there are more classes available.
+    #
+    # Examples
+    #
+    #   classes = Plurall.classes school_id: 123456
+    #   classes.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      student_node.classes.page_info.has_next_page
+    end
+
+    ##
+    # Internal: The next cursor used for pagination.
+    #
+    # Returns the next cursor as a String, or nil.
+    #
+    def next_cursor
+      return nil unless next?
+
+      student_node.classes.page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of classes.
+    #
+    # Returns the next page as Plurall::Classes, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.classes school_id: school_id, after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous classes available.
+    #
+    # Examples
+    #
+    #   classes = Plurall.classes school_id: 123456
+    #   classes.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      student_node.classes.page_info.has_previous_page
+    end
+
+    ##
+    # Internal: The previous cursor used for pagination.
+    #
+    # Returns the previous cursor as a String, or nil.
+    #
+    def prev_cursor
+      return nil unless prev?
+
+      student_node.classes.page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of classes.
+    #
+    # Examples
+    #
+    #   classes = Plurall.classes school_id: 123456
+    #   prev_classes = classes.prev
+    #
+    # Returns the previous page as Plurall::Classes, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.classes school_id: school_id, before: prev_cursor
+      self.class.new prev_response
+    end
+
+    ##
+    # Internal: Returns a string representation of the list.
+    #
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} classes:#{total_count}>"
+    end
+
+    private
+
+    def school_node
+      response.data.schools.first.edges.first.node
+    end
+
+    def student_node
+      school_node.students.edges.first.node
+    end
+  end
+end

data/lib/plurall/students.rb

@@ -0,0 +1,185 @@
+module Plurall
+  ##
+  # Public: A list of school students that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.students(school_id: 123456).each do |student|
+  #     puts student.name
+  #   end
+  #
+  class Students
+    include Enumerable
+
+    # Internal: Returns the GraphQL API response as a GraphQL::Client::Response.
+    attr_reader :response
+
+    ##
+    # Internal: Create a new object from a GraphQL API response.
+    #
+    # response - The GraphQL API response as a GraphQL::Client::Response.
+    #
+    def initialize response
+      @response = response
+    end
+
+    ##
+    # Public: Returns the number of students as an Integer.
+    def total_count
+      school_node.students.total_count
+    end
+
+    ##
+    # Public: Returns the list of students as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Returns the school id for list of students as a String.
+    def school_id
+      school_node.id
+    end
+
+    ##
+    # Public: Iterates the list of students.
+    #
+    # Examples
+    #
+    #   Plurall.students(school_id: 123456).each do |student|
+    #     puts student.name
+    #   end
+    #
+    # Yields a student object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    def each &block
+      return enum_for :each unless block
+
+      school_node.students.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all students.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.students(school_id: 123456).all do |student|
+    #     puts student.name
+    #   end
+    #
+    # Yields a student object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    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
+
+    ##
+    # Public: Whether there are more students available.
+    #
+    # Examples
+    #
+    #   students = Plurall.students school_id: 123456
+    #   students.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      students_page_info.has_next_page
+    end
+
+    ##
+    # Internal: The next cursor used for pagination.
+    #
+    # Returns the next cursor as a String, or nil.
+    #
+    def next_cursor
+      return nil unless next?
+
+      students_page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of students.
+    #
+    # Returns the next page as Plurall::Students, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.students school_id: school_id, after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous students available.
+    #
+    # Examples
+    #
+    #   students = Plurall.students school_id: 123456
+    #   students.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      students_page_info.has_previous_page
+    end
+
+    ##
+    # Internal: The previous cursor used for pagination.
+    #
+    # Returns the previous cursor as a String, or nil.
+    #
+    def prev_cursor
+      return nil unless prev?
+
+      students_page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of students.
+    #
+    # Examples
+    #
+    #   students = Plurall.students school_id: 123456
+    #   prev_students = students.prev
+    #
+    # Returns the previous page as Plurall::Students, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.students school_id: school_id, before: prev_cursor
+      self.class.new prev_response
+    end
+
+    ##
+    # Internal: Returns a string representation of the list.
+    #
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} students:#{total_count}>"
+    end
+
+    private
+
+    def school_node
+      response.data.schools.first.edges.first.node
+    end
+
+    def students_page_info
+      school_node.students.page_info
+    end
+  end
+end

data/lib/plurall/teachers.rb

@@ -0,0 +1,185 @@
+module Plurall
+  ##
+  # Public: A list of school teachers that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.teachers(school_id: 123456).each do |teacher|
+  #     puts teacher.name
+  #   end
+  #
+  class Teachers
+    include Enumerable
+
+    # Internal: Returns the GraphQL API response as a GraphQL::Client::Response.
+    attr_reader :response
+
+    ##
+    # Internal: Create a new object from a GraphQL API response.
+    #
+    # response - The GraphQL API response as a GraphQL::Client::Response.
+    #
+    def initialize response
+      @response = response
+    end
+
+    ##
+    # Public: Returns the number of teachers as an Integer.
+    def total_count
+      school_node.teachers.total_count
+    end
+
+    ##
+    # Public: Returns the list of teachers as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Returns the school id for list of teachers as a String.
+    def school_id
+      school_node.id
+    end
+
+    ##
+    # Public: Iterates the list of teachers.
+    #
+    # Examples
+    #
+    #   Plurall.teachers(school_id: 123456).each do |teacher|
+    #     puts teacher.name
+    #   end
+    #
+    # Yields a teacher object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    def each &block
+      return enum_for :each unless block
+
+      school_node.teachers.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all teachers.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.teachers(school_id: 123456).all do |teacher|
+    #     puts teacher.name
+    #   end
+    #
+    # Yields a teacher object to the block.
+    #
+    # Returns an Enumerator when no block argument is given, or nothing when when a block argument is given.
+    #
+    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
+
+    ##
+    # Public: Whether there are more teachers available.
+    #
+    # Examples
+    #
+    #   teachers = Plurall.teachers school_id: 123456
+    #   teachers.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      teachers_page_info.has_next_page
+    end
+
+    ##
+    # Internal: The next cursor used for pagination.
+    #
+    # Returns the next cursor as a String, or nil.
+    #
+    def next_cursor
+      return nil unless next?
+
+      teachers_page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of teachers.
+    #
+    # Returns the next page as Plurall::Teachers, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.teachers school_id: school_id, after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous teachers available.
+    #
+    # Examples
+    #
+    #   teachers = Plurall.teachers school_id: 123456
+    #   teachers.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      teachers_page_info.has_previous_page
+    end
+
+    ##
+    # Internal: The previous cursor used for pagination.
+    #
+    # Returns the previous cursor as a String, or nil.
+    #
+    def prev_cursor
+      return nil unless prev?
+
+      teachers_page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of teachers.
+    #
+    # Examples
+    #
+    #   teachers = Plurall.teachers school_id: 123456
+    #   prev_teachers = teachers.prev
+    #
+    # Returns the previous page as Plurall::Teachers, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.teachers school_id: school_id, before: prev_cursor
+      self.class.new prev_response
+    end
+
+    ##
+    # Internal: Returns a string representation of the list.
+    #
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id * 2).to_s(16).rjust(16, "0")} teachers:#{total_count}>"
+    end
+
+    private
+
+    def school_node
+      response.data.schools.first.edges.first.node
+    end
+
+    def teachers_page_info
+      school_node.teachers.page_info
+    end
+  end
+end

data/lib/plurall/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Plurall
+  # Public: The version number as a String.
+  VERSION = "0.1.0"
+end