plurall 0.1.0

data/lib/plurall/directors.rb

@@ -0,0 +1,185 @@
+module Plurall
+  ##
+  # Public: A list of school directors that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.directors(school_id: 123456).each do |director|
+  #     puts director.name
+  #   end
+  #
+  class Directors
+    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 directors as an Integer.
+    def total_count
+      school_node.directors.total_count
+    end
+
+    ##
+    # Public: Returns the list of directors as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Returns the school id for list of directors as a String.
+    def school_id
+      school_node.id
+    end
+
+    ##
+    # Public: Iterates the list of directors.
+    #
+    # Examples
+    #
+    #   Plurall.directors(school_id: 123456).each do |director|
+    #     puts director.name
+    #   end
+    #
+    # Yields a director 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.directors.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all directors.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.directors(school_id: 123456).all do |director|
+    #     puts director.name
+    #   end
+    #
+    # Yields a director 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 directors available.
+    #
+    # Examples
+    #
+    #   directors = Plurall.directors school_id: 123456
+    #   directors.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      directors_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?
+
+      directors_page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of directors.
+    #
+    # Returns the next page as Plurall::Directors, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.directors school_id: school_id, after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous directors available.
+    #
+    # Examples
+    #
+    #   directors = Plurall.directors school_id: 123456
+    #   directors.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      directors_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?
+
+      directors_page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of directors.
+    #
+    # Examples
+    #
+    #   directors = Plurall.directors school_id: 123456
+    #   prev_directors = directors.prev
+    #
+    # Returns the previous page as Plurall::Directors, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.directors 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")} directors:#{total_count}>"
+    end
+
+    private
+
+    def school_node
+      response.data.schools.first.edges.first.node
+    end
+
+    def directors_page_info
+      school_node.directors.page_info
+    end
+  end
+end

data/lib/plurall/errors.rb

@@ -0,0 +1,11 @@
+module Plurall
+  ##
+  # Public: The main error for the library.
+  #
+  class Error < StandardError; end
+
+  ##
+  # Public: Raised when the authorization token has expired.
+  #
+  class TokenExpiredError < Error; end
+end

data/lib/plurall/managers.rb

@@ -0,0 +1,185 @@
+module Plurall
+  ##
+  # Public: A list of school managers that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.managers(school_id: 123456).each do |manager|
+  #     puts manager.name
+  #   end
+  #
+  class Managers
+    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 managers as an Integer.
+    def total_count
+      school_node.managers.total_count
+    end
+
+    ##
+    # Public: Returns the list of managers as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Returns the school id for list of managers as a String.
+    def school_id
+      school_node.id
+    end
+
+    ##
+    # Public: Iterates the list of managers.
+    #
+    # Examples
+    #
+    #   Plurall.managers(school_id: 123456).each do |manager|
+    #     puts manager.name
+    #   end
+    #
+    # Yields a manager 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.managers.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all managers.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.managers(school_id: 123456).all do |manager|
+    #     puts manager.name
+    #   end
+    #
+    # Yields a manager 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 managers available.
+    #
+    # Examples
+    #
+    #   managers = Plurall.managers school_id: 123456
+    #   managers.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      managers_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?
+
+      managers_page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of managers.
+    #
+    # Returns the next page as Plurall::Managers, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.managers school_id: school_id, after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous managers available.
+    #
+    # Examples
+    #
+    #   managers = Plurall.managers school_id: 123456
+    #   managers.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      managers_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?
+
+      managers_page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of managers.
+    #
+    # Examples
+    #
+    #   managers = Plurall.managers school_id: 123456
+    #   prev_managers = managers.prev
+    #
+    # Returns the previous page as Plurall::Managers, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.managers 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")} managers:#{total_count}>"
+    end
+
+    private
+
+    def school_node
+      response.data.schools.first.edges.first.node
+    end
+
+    def managers_page_info
+      school_node.managers.page_info
+    end
+  end
+end

data/lib/plurall/schools.rb

@@ -0,0 +1,169 @@
+module Plurall
+  ##
+  # Public: A list of schools that supports pagination.
+  #
+  # Examples
+  #
+  #   Plurall.schools.each do |school|
+  #     puts school.legal_name
+  #   end
+  #
+  class Schools
+    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 schools as an Integer.
+    def total_count
+      response.data.schools.first.total_count
+    end
+
+    ##
+    # Public: Returns the list of schools as a Hash.
+    def data
+      response.data.to_h
+    end
+
+    ##
+    # Public: Iterates the list of schools.
+    #
+    # Examples
+    #
+    #   Plurall.schools.each do |school|
+    #     puts school.legal_name
+    #   end
+    #
+    # Yields a school 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
+
+      response.data.schools.first.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all schools.
+    #
+    # Several API calls may be made to retrieve all by repeatedly calling #next until #next? returns `false`.
+    #
+    # Examples
+    #
+    #   Plurall.schools.all do |school|
+    #     puts school.legal_name
+    #   end
+    #
+    # Yields a school 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 schools available.
+    #
+    # Examples
+    #
+    #   schools = Plurall.schools school_id: 123456
+    #   schools.next?
+    #
+    # Returns true or false.
+    #
+    def next?
+      response.data.schools.first.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?
+
+      response.data.schools.first.page_info.end_cursor
+    end
+
+    ##
+    # Public: Retrieve the next page of schools.
+    #
+    # Returns the next page as Plurall::Schools, or nil.
+    #
+    def next
+      return nil unless next?
+
+      next_response = Plurall::Api.schools after: next_cursor
+      self.class.new next_response
+    end
+
+    ##
+    # Public: Whether there are previous schools available.
+    #
+    # Examples
+    #
+    #   schools = Plurall.schools school_id: 123456
+    #   schools.prev?
+    #
+    # Returns true or false.
+    #
+    def prev?
+      response.data.schools.first.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?
+
+      response.data.schools.first.page_info.start_cursor
+    end
+
+    ##
+    # Public: Retrieve the previous page of schools.
+    #
+    # Examples
+    #
+    #   schools = Plurall.schools school_id: 123456
+    #   prev_schools = schools.prev
+    #
+    # Returns the previous page as Plurall::Schools, or nil.
+    #
+    def prev
+      return nil unless prev?
+
+      prev_response = Plurall::Api.schools 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")} schools:#{total_count}>"
+    end
+  end
+end