plurall 0.1.0

data/lib/plurall/attendants.rb

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

data/lib/plurall/classes.rb

@@ -0,0 +1,185 @@
+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 Classes
+    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
+      school_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: Iterates the list of school 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
+
+      school_node.classes.edges.lazy.map(&:node).each(&block)
+    end
+
+    ##
+    # Public: Iterates all school 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?
+      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?
+
+      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?
+      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?
+
+      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 classes_page_info
+      school_node.classes.page_info
+    end
+  end
+end

data/lib/plurall/configuration.rb

@@ -0,0 +1,41 @@
+module Plurall
+  ##
+  # Public: The configuration instance used to configure the library.
+  #
+  # Examples
+  #
+  #   Plurall.configure do |config|
+  #     config.client_id      = "YOUR_PLURALL_CLIENT_ID"
+  #     config.client_secret  = "YOUR_PLURALL_CLIENT_SECRET"
+  #     config.id_application = "YOUR_PLURALL_APPLICATION_ID"
+  #   end
+  #
+  class Configuration
+    attr_accessor :client_id, :client_secret
+    attr_accessor :oauth_authorize_url, :oauth_token_url, :me_url
+    attr_accessor :id_application, :id_auth_url, :id_graphql_url
+
+    def initialize(options = {})
+      @client_id = options.dig :client_id
+      @client_secret = options.dig :client_secret
+      @oauth_authorize_url = options.dig(:oauth_authorize_url) || "https://ms-api.plurall.net/oauth/authorize"
+      @oauth_token_url = options.dig(:oauth_token_url) || "https://ms-api.plurall.net/oauth/token"
+      @me_url = options.dig(:me_url) || "https://ms-api.plurall.net/me"
+      @id_application = options.dig :id_application
+      @id_auth_url = options.dig(:id_auth_url) || "https://ms-api.plurall.net/identity/data-exchange/auth"
+      @id_graphql_url = options.dig(:id_graphql_url) || "https://ms-api.plurall.net/identity/data-exchange/v2/graphql"
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Plurall::Configuration.new
+  end
+end

data/lib/plurall/coordinators.rb

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