plurall 0.1.0

data/lib/plurall.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+require_relative "plurall/configuration"
+require_relative "plurall/errors"
+require_relative "plurall/api"
+require_relative "plurall/schools"
+require_relative "plurall/teachers"
+require_relative "plurall/students"
+require_relative "plurall/student_classes"
+require_relative "plurall/classes"
+require_relative "plurall/administrators"
+require_relative "plurall/attendants"
+require_relative "plurall/coordinators"
+require_relative "plurall/directors"
+require_relative "plurall/managers"
+require_relative "plurall/version"
+
+##
+# A full implementation the Plurall API in Ruby.
+#
+# Examples
+#
+#   Plurall.schools.each do |school|
+#     puts school.legal_name
+#   end
+#
+module Plurall
+  ##
+  # Public: Retrieve a list of schools.
+  #
+  # first - The number of schools to retrieve as an Integer.
+  # after - The next cursor to retrieve schools for as a String.
+  # before - The end cursor to retrieve schools for as a String.
+  # page - The numbered page to retrieve schools for as an Integer.
+  # search - The search value to retrieve schools for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.schools.each do |school|
+  #     puts school.legal_name
+  #   end
+  #
+  # Returns Plurall::Schools.
+  #
+  def self.schools first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Schools.new Plurall::Api.schools first: first, after: after, before: before, page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of teachers for a school.
+  #
+  # school_id - The school ID to retrieve teachers for as a String or Integer.
+  # first - The number of teachers to retrieve as an Integer.
+  # after - The next cursor to retrieve teachers for as a String.
+  # before - The end cursor to retrieve teachers for as a String.
+  # page - The numbered page to retrieve teachers for as an Integer.
+  # search - The search value to retrieve teachers for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.teachers(school_id: 123456).each do |teacher|
+  #     puts teacher.name
+  #   end
+  #
+  # Returns Plurall::Teachers.
+  #
+  def self.teachers school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Teachers.new Plurall::Api.teachers school_id: school_id, first: first, after: after, before: before,
+      page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of students for a school.
+  #
+  # school_id - The school ID to retrieve students for as a String or Integer.
+  # first - The number of students to retrieve as an Integer.
+  # after - The next cursor to retrieve students for as a String.
+  # before - The end cursor to retrieve students for as a String.
+  # page - The numbered page to retrieve students for as an Integer.
+  # search - The search value to retrieve students for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.students(school_id: 123456).each do |student|
+  #     puts student.name
+  #   end
+  #
+  # Returns Plurall::Students.
+  #
+  def self.students school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Students.new Plurall::Api.students school_id: school_id, first: first, after: after, before: before,
+      page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of classes for a student.
+  #
+  # school_id - The school ID to retrieve classes for as a String or Integer.
+  # uuid - The student UUID to retrieve classes for as a String.
+  # first - The number of classes to retrieve as an Integer.
+  # after - The next cursor to retrieve classes for as a String.
+  # before - The end cursor to retrieve classes for as a String.
+  # page - The numbered page to retrieve classes for as an Integer.
+  # search - The search value to retrieve classes for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.student_classes(school_id: 123456, uuid: "00000000-0000-0000-0000-000000000000").each do |school_class|
+  #     puts school_class.name
+  #   end
+  #
+  # Returns Plurall::StudentClasses.
+  #
+  def self.student_classes school_id:, uuid:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::StudentClasses.new Plurall::Api.student_classes school_id: school_id, uuid: uuid, first: first,
+      after: after, before: before, page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of classes for a school.
+  #
+  # school_id - The school ID to retrieve classes for as a String or Integer.
+  # first - The number of classes to retrieve as an Integer.
+  # after - The next cursor to retrieve classes for as a String.
+  # before - The end cursor to retrieve classes for as a String.
+  # page - The numbered page to retrieve classes for as an Integer.
+  # search - The search value to retrieve classes for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.classes(school_id: 123456).each do |student_class|
+  #     puts student_class.name
+  #   end
+  #
+  # Returns Plurall::Classes.
+  #
+  def self.classes school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Classes.new Plurall::Api.classes school_id: school_id, first: first, after: after, before: before,
+      page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of administrators for a school.
+  #
+  # school_id - The school ID to retrieve administrators for as a String or Integer.
+  # first - The number of administrators to retrieve as an Integer.
+  # after - The next cursor to retrieve administrators for as a String.
+  # before - The end cursor to retrieve administrators for as a String.
+  # page - The numbered page to retrieve administrators for as an Integer.
+  # search - The search value to retrieve administrators for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.administrators(school_id: 123456).each do |administrator|
+  #     puts administrator.name
+  #   end
+  #
+  # Returns Plurall::Administrators.
+  #
+  def self.administrators school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Administrators.new Plurall::Api.administrators school_id: school_id, first: first, after: after,
+      before: before, page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of attendants for a school.
+  #
+  # school_id - The school ID to retrieve attendants for as a String or Integer.
+  # first - The number of attendants to retrieve as an Integer.
+  # after - The next cursor to retrieve attendants for as a String.
+  # before - The end cursor to retrieve attendants for as a String.
+  # page - The numbered page to retrieve attendants for as an Integer.
+  # search - The search value to retrieve attendants for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.attendants(school_id: 123456).each do |attendant|
+  #     puts attendant.name
+  #   end
+  #
+  # Returns Plurall::Attendants.
+  #
+  def self.attendants school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Attendants.new Plurall::Api.attendants school_id: school_id, first: first, after: after, before: before,
+      page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of coordinators for a school.
+  #
+  # school_id - The school ID to retrieve coordinators for as a String or Integer.
+  # first - The number of coordinators to retrieve as an Integer.
+  # after - The next cursor to retrieve coordinators for as a String.
+  # before - The end cursor to retrieve coordinators for as a String.
+  # page - The numbered page to retrieve coordinators for as an Integer.
+  # search - The search value to retrieve coordinators for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.coordinators(school_id: 123456).each do |coordinator|
+  #     puts coordinator.name
+  #   end
+  #
+  # Returns Plurall::Coordinators.
+  #
+  def self.coordinators school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Coordinators.new Plurall::Api.coordinators school_id: school_id, first: first, after: after,
+      before: before, page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of directors for a school.
+  #
+  # school_id - The school ID to retrieve directors for as a String or Integer.
+  # first - The number of directors to retrieve as an Integer.
+  # after - The next cursor to retrieve directors for as a String.
+  # before - The end cursor to retrieve directors for as a String.
+  # page - The numbered page to retrieve directors for as an Integer.
+  # search - The search value to retrieve directors for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.directors(school_id: 123456).each do |director|
+  #     puts director.name
+  #   end
+  #
+  # Returns Plurall::Directors.
+  #
+  def self.directors school_id:, first: 30, after: "", before: "", page: 0, search: ""
+    Plurall::Directors.new Plurall::Api.directors school_id: school_id, first: first, after: after, before: before,
+      page: page, search: search
+  end
+
+  ##
+  # Public: Retrieve a list of managers for a school.
+  #
+  # school_id - The school ID to retrieve managers for as a String or Integer.
+  # first - The number of managers to retrieve as an Integer.
+  # after - The next cursor to retrieve managers for as a String.
+  # before - The end cursor to retrieve managers for as a String.
+  # page - The numbered page to retrieve managers for as an Integer.
+  # search - The search value to retrieve managers for as a String.
+  #
+  # Examples
+  #
+  #   Plurall.managers(school_id: 123456).each do |manager|
+  #     puts manager.name
+  #   end
+  #
+  # Returns Plurall::Managers.
+  #
+  def self.managers school_id:, first: 30, after: "", before: "", page: 0
+    Plurall::Managers.new Plurall::Api.managers school_id: school_id, first: first, after: after, before: before,
+      page: page
+  end
+
+  ##
+  # Public: Retrieve a person record.
+  #
+  # uuid - The person UUID to retrieve as a String.
+  #
+  # Examples
+  #
+  #   person = Plurall.person uuid: "00000000-0000-0000-0000-000000000000"
+  #   puts person.name
+  #
+  # Returns a GraphQL data object.
+  #
+  def self.person uuid:
+    response = Plurall::Api.person uuid: uuid
+    response.data.person
+  end
+end

data/plurall.gemspec

@@ -0,0 +1,45 @@
+require_relative "lib/plurall/version.rb"
+
+Gem::Specification.new do |spec|
+  spec.name = "plurall"
+  spec.version = Plurall::VERSION
+  spec.authors = ["Ben Eggett"]
+  spec.email = ["beneggett@gmail.com"]
+
+  spec.summary = "Plurall API ruby wrapper"
+  spec.description = "Provides an SDK for interacting wth the Plurall API in Ruby"
+  spec.homepage = "https://example.com/plurall"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to? :metadata
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir File.expand_path("..", __FILE__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "graphql", "~> 2.0.0" # pin to fix github/graphql-client#310
+  spec.add_dependency "graphql-client", "~> 0.18.0"
+  spec.add_dependency "faraday", "~> 1.8"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end