bright 1.3 → 2.0

data/lib/bright/sis_apis/tsis.rb

@@ -1,10 +1,10 @@
-require 'base64'
-require 'json'
+require "base64"
+require "json"
 
 module Bright
   module SisApi
     class TSIS < Base
-      DATE_FORMAT = '%m/%d/%Y'
+      DATE_FORMAT = "%m/%d/%Y"
 
       @@description = "Connects to the TIES API for accessing TIES TSIS student information"
       @@doc_url = "#unkown"
@@ -22,54 +22,54 @@ module Bright
       end
 
       def get_student_by_api_id(api_id, params = {})
-        self.get_student(params.merge({:sis_student_id => api_id}))
+        get_student(params.merge({sis_student_id: api_id}))
       end
 
       def get_student(params = {}, options = {})
-        params = self.apply_options(params, options.merge({:per_page => 1}))
+        params = apply_options(params, options.merge({per_page: 1}))
 
         # Students only gets you students that are enrolled in a school for a given school year.
-        students_response_hash = self.request(:get, 'Students/', self.map_search_params(params))
+        students_response_hash = request(:get, "Students/", map_search_params(params))
         found_student = nil
         if students_response_hash["Return"] and students_response_hash["Return"].first
-          found_student =  Student.new(convert_to_student_data(students_response_hash["Return"].first))
+          found_student = Student.new(convert_to_student_data(students_response_hash["Return"].first))
         end
         if found_student.nil?
           # Students/Family can get you students that are not enrolled in a school for a given school year.
-          family_response_hash = self.request(:get, 'Students/Family/', self.map_search_params(params))
+          family_response_hash = request(:get, "Students/Family/", map_search_params(params))
           if family_response_hash["Return"] and family_response_hash["Return"].first
-            found_student =  Student.new(convert_to_student_data(family_response_hash["Return"].first))
+            found_student = Student.new(convert_to_student_data(family_response_hash["Return"].first))
           end
         end
         found_student
       end
 
       def get_students(params = {}, options = {})
-        params = self.apply_options(params, options)
+        params = apply_options(params, options)
 
-        if params[:schoolyear]
+        response_hash = if params[:schoolyear]
           # Students only gets you students that are enrolled in a school for a given school year.
-          response_hash = self.request(:get, self.apply_page_to_url('Students/', options[:page]), self.map_search_params(params))
+          request(:get, apply_page_to_url("Students/", options[:page]), map_search_params(params))
         else
           # Students/Family can get you students that are not enrolled in a school for a given school year.
-          response_hash = self.request(:get, self.apply_page_to_url('Students/Family/', options[:page]), self.map_search_params(params))
+          request(:get, apply_page_to_url("Students/Family/", options[:page]), map_search_params(params))
         end
 
-        students = response_hash["Return"].collect{|hsh| Student.new(convert_to_student_data(hsh))}
+        students = response_hash["Return"].collect { |hsh| Student.new(convert_to_student_data(hsh)) }
         total_results = response_hash["TotalCount"].to_i
 
         if options[:wrap_in_collection] != false
           api = self
           load_more_call = proc { |page|
             # pages start at one, so add a page here
-            api.get_students(params, {:wrap_in_collection => false, :page => (page + 1)})
+            api.get_students(params, {wrap_in_collection: false, page: (page + 1)})
           }
 
           ResponseCollection.new({
-            :seed_page => students,
-            :total => total_results,
-            :per_page => options[:per_page],
-            :load_more_call => load_more_call
+            seed_page: students,
+            total: total_results,
+            per_page: options[:per_page],
+            load_more_call: load_more_call
           })
         else
           students
@@ -85,26 +85,26 @@ module Bright
       end
 
       def get_schools(params = {}, options = {})
-        params = self.apply_options(params, options)
+        params = apply_options(params, options)
 
         # schools api end point takes page # in the url itself for some reason
-        schools_response_hash = self.request(:get, self.apply_page_to_url('Schools/', options[:page]), params)
+        schools_response_hash = request(:get, apply_page_to_url("Schools/", options[:page]), params)
 
-        schools = schools_response_hash["Return"].collect{|hsh| School.new(convert_to_school_data(hsh))}
+        schools = schools_response_hash["Return"].collect { |hsh| School.new(convert_to_school_data(hsh)) }
         total_results = schools_response_hash["TotalCount"].to_i
 
         if options[:wrap_in_collection] != false
           api = self
           load_more_call = proc { |page|
             # pages start at one, so add a page here
-            api.get_schools(params, {:wrap_in_collection => false, :page => (page + 1)})
+            api.get_schools(params, {wrap_in_collection: false, page: (page + 1)})
           }
 
           ResponseCollection.new({
-            :seed_page => schools,
-            :total => total_results,
-            :per_page => options[:per_page],
-            :load_more_call => load_more_call
+            seed_page: schools,
+            total: total_results,
+            per_page: options[:per_page],
+            load_more_call: load_more_call
           })
         else
           schools
@@ -112,9 +112,9 @@ module Bright
       end
 
       def request(method, path, params = {})
-        uri  = "#{self.connection_options[:uri]}/#{path}"
+        uri = "#{connection_options[:uri]}/#{path}"
         body = nil
-        query = URI.encode(params.map{|k,v| "#{k}=#{v}"}.join("&"))
+        query = URI.encode(params.map { |k, v| "#{k}=#{v}" }.join("&"))
         if method == :get
           uri += "?#{query}"
         else
@@ -123,7 +123,7 @@ module Bright
 
         response = connection_retry_wrapper {
           connection = Bright::Connection.new(uri)
-          headers = self.headers_for_auth
+          headers = headers_for_auth
           connection.request(method, body, headers)
         }
 
@@ -142,15 +142,15 @@ module Bright
         params["studentname"] ||= "#{params.delete(:last_name)}, #{params.delete(:first_name)} #{params.delete(:middle_name)}".strip
         params["studentids"] = params.delete(:sis_student_id)
 
-        params = Hash[params.collect do |k,v|
+        params = params.collect do |k, v|
           if v.is_a?(Array)
             v = v.join(",")
           end
           k = k.to_s.gsub(/[^A-Za-z]/, "").downcase
-          [k,v]
-        end]
+          [k, v]
+        end.to_h
 
-        params.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        params.reject { |k, v| v.respond_to?(:empty?) ? v.empty? : v.nil? }
       end
 
       def convert_to_student_data(attrs)
@@ -160,23 +160,23 @@ module Bright
           if split_name[1]
             split_first_name = split_name[1].to_s.strip.split(" ")
             if split_first_name.size > 1
-              catt[:first_name]       = split_first_name[0...-1].join(" ").strip
-              catt[:middle_name]      = split_first_name[-1].strip
+              catt[:first_name] = split_first_name[0...-1].join(" ").strip
+              catt[:middle_name] = split_first_name[-1].strip
             else
               catt[:first_name] = split_first_name.first.strip
             end
           end
-          catt[:last_name]        = split_name[0].to_s.strip
+          catt[:last_name] = split_name[0].to_s.strip
         else
-          catt[:first_name]       = attrs["FirstName"].strip
-          catt[:middle_name]      = attrs["MiddleName"].strip
-          catt[:last_name]        = (attrs["LastName"] || attrs["SurName"]).strip
+          catt[:first_name] = attrs["FirstName"].strip
+          catt[:middle_name] = attrs["MiddleName"].strip
+          catt[:last_name] = (attrs["LastName"] || attrs["SurName"]).strip
         end
 
         catt[:state_student_id] = (attrs["StateId"] || attrs["StudentStateId"]).to_s
-        catt[:sis_student_id]   = attrs["StudentId"].to_s
-        catt[:api_id]           = attrs["StudentId"].to_s
-        catt[:homeless_code]    = attrs["HomelessCode"]
+        catt[:sis_student_id] = attrs["StudentId"].to_s
+        catt[:api_id] = attrs["StudentId"].to_s
+        catt[:homeless_code] = attrs["HomelessCode"]
 
         # "Economic\":{\"Description\":\"\",\"EconomicIndicatorId\":\"0\"}
 
@@ -189,9 +189,9 @@ module Bright
           end
         end
 
-        catt[:addresses] = [self.convert_to_address_data(attrs["Address"])] if attrs["Address"]
+        catt[:addresses] = [convert_to_address_data(attrs["Address"])] if attrs["Address"]
 
-        catt.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        catt.reject { |k, v| v.respond_to?(:empty?) ? v.empty? : v.nil? }
       end
 
       def convert_to_address_data(attrs)
@@ -207,7 +207,7 @@ module Bright
         cattrs[:postal_code] = attrs["Zip"]
         cattrs[:type] = attrs["Type"].to_s.downcase
 
-        cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        cattrs.reject { |k, v| v.respond_to?(:empty?) ? v.empty? : v.nil? }
       end
 
       def convert_to_school_data(attrs)
@@ -217,7 +217,7 @@ module Bright
         cattrs[:api_id] = cattrs[:number] = attrs["SchoolId"]
         cattrs[:address] = convert_to_address_data(attrs)
 
-        cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        cattrs.reject { |k, v| v.respond_to?(:empty?) ? v.empty? : v.nil? }
       end
 
       def apply_options(params, options)
@@ -228,21 +228,21 @@ module Bright
       end
 
       def apply_page_to_url(url, page)
-        "#{url}#{url[-1] == "/" ? "" : "/"}#{page}"
+        "#{url}#{(url[-1] == "/") ? "" : "/"}#{page}"
       end
 
       def headers_for_auth(uri)
         t = Time.now.utc.httpdate
         string_to_sign = "GET\n#{t}\n#{uri}"
 
-        signature = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), self.connection_options[:secret], string_to_sign)).strip
-        authorization = "TIES" + " " + self.connection_options[:key] + ":" + signature
+        signature = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new("sha1"), connection_options[:secret], string_to_sign)).strip
+        authorization = "TIES" + " " + connection_options[:key] + ":" + signature
 
         {
-            'Authorization' => authorization,
-            'DistrictNumber' => self.connection_options[:district_id],
-            'ties-date' => t,
-            'Content-Type' => "application/json"
+          "Authorization" => authorization,
+          "DistrictNumber" => connection_options[:district_id],
+          "ties-date" => t,
+          "Content-Type" => "application/json"
         }
       end
     end

data/lib/bright/student.rb

@@ -1,13 +1,13 @@
-require 'securerandom'
+require "securerandom"
 
 module Bright
   class Student < Model
     @attribute_names = [:client_id, :api_id, :first_name, :middle_name, :last_name, :nick_name,
-                        :birth_date, :grade, :grade_school_year, :projected_graduation_year, :sex,
-                        :hispanic_ethnicity, :race, :image, :primary_language, :secondary_language,
-                        :homeless_code, :frl_status, :sis_student_id,
-                        :state_student_id, :last_modified]
-    attr_accessor *@attribute_names
+      :birth_date, :grade, :grade_school_year, :projected_graduation_year, :sex,
+      :hispanic_ethnicity, :race, :image, :primary_language, :secondary_language,
+      :homeless_code, :frl_status, :sis_student_id,
+      :state_student_id, :last_modified]
+    attr_accessor(*@attribute_names)
 
     def self.attribute_names
       @attribute_names
@@ -19,27 +19,26 @@ module Bright
     def initialize(*args)
       super
       self.client_id ||= SecureRandom.uuid
-      self
     end
 
     def name
-      "#{self.first_name} #{self.middle_name} #{self.last_name}".gsub(/\s+/, " ").strip
+      "#{first_name} #{middle_name} #{last_name}".gsub(/\s+/, " ").strip
     end
 
     def <=>(other)
-      (self.sis_student_id and self.sis_student_id == other.sis_student_id) or
-      (self.state_student_id and self.state_student_id == other.state_student_id) or
-      (self.first_name == other.first_name and self.middle_name == other.middle_name and self.last_name == other.last_name and self.birth_date == other.birth_date)
+      (sis_student_id && sis_student_id == other.sis_student_id) ||
+        (state_student_id && state_student_id == other.state_student_id) ||
+        (first_name == other.first_name && middle_name == other.middle_name && last_name == other.last_name && birth_date == other.birth_date)
     end
 
-    alias id client_id
+    alias_method :id, :client_id
 
     def addresses=(array)
       if array.size <= 0 or array.first.is_a?(Address)
         @addresses = array
-        @addresses.each{|a| a.student = self}
+        @addresses.each { |a| a.student = self }
       elsif array.first.is_a?(Hash)
-        @addresses = array.collect{|a| Address.new(a)}
+        @addresses = array.collect { |a| Address.new(a) }
       end
       @addresses ||= []
     end
@@ -52,7 +51,7 @@ module Bright
       if array.size <= 0 or array.first.is_a?(PhoneNumber)
         @phone_numbers = array
       elsif array.first.is_a?(Hash)
-        @phone_numbers = array.collect{|a| PhoneNumber.new(a)}
+        @phone_numbers = array.collect { |a| PhoneNumber.new(a) }
       end
       @phone_numbers ||= []
     end
@@ -67,7 +66,6 @@ module Bright
       elsif email.is_a?(Hash)
         @email_address = EmailAddress.new(email)
       end
-      @email_address
     end
 
     def school=(school_val)
@@ -76,14 +74,13 @@ module Bright
       elsif school_val.is_a?(Hash)
         @school = School.new(school_val)
       end
-      @school
     end
 
     def contacts=(array)
       if array.size <= 0 or array.first.is_a?(Contact)
         @contacts = array
       elsif array.first.is_a?(Hash)
-        @contacts = array.collect{|a| Contact.new(a)}
+        @contacts = array.collect { |a| Contact.new(a) }
       end
       @contacts ||= []
     end
@@ -91,6 +88,5 @@ module Bright
     def contacts
       @contacts ||= []
     end
-
   end
 end

data/lib/bright/version.rb

@@ -1,3 +1,3 @@
 module Bright
-  VERSION = "1.3"
+  VERSION = "2.0"
 end

data/lib/bright.rb

@@ -1,8 +1,8 @@
 require_relative "bright/version"
 require_relative "bright/errors"
 
-require_relative "bright/helpers/blank_helper.rb"
-require_relative "bright/helpers/boolean_parser_helper.rb"
+require_relative "bright/helpers/blank_helper"
+require_relative "bright/helpers/boolean_parser_helper"
 
 require_relative "bright/model"
 require_relative "bright/student"
@@ -13,20 +13,22 @@ require_relative "bright/enrollment"
 require_relative "bright/school"
 require_relative "bright/contact"
 
-
 require_relative "bright/connection"
 require_relative "bright/response_collection"
 require_relative "bright/cursor_response_collection"
 
-require_relative "bright/sis_apis/base.rb"
-require_relative "bright/sis_apis/tsis.rb"
-require_relative "bright/sis_apis/power_school.rb"
-require_relative "bright/sis_apis/aeries.rb"
-require_relative "bright/sis_apis/infinite_campus.rb"
-require_relative "bright/sis_apis/skyward.rb"
-require_relative "bright/sis_apis/bright_sis.rb"
-require_relative "bright/sis_apis/synergy.rb"
-require_relative "bright/sis_apis/focus.rb"
+require_relative "bright/sis_apis/base"
+require_relative "bright/sis_apis/tsis"
+require_relative "bright/sis_apis/power_school"
+require_relative "bright/sis_apis/aeries"
+
+require_relative "bright/sis_apis/bright_sis"
+require_relative "bright/sis_apis/synergy"
+require_relative "bright/sis_apis/focus"
+
+require_relative "bright/sis_apis/one_roster"
+require_relative "bright/sis_apis/one_roster/infinite_campus"
+require_relative "bright/sis_apis/one_roster/skyward"
 
 module Bright
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '2.0'
 platform: ruby
 authors:
 - Arux Software
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -129,9 +129,10 @@ files:
 - lib/bright/sis_apis/base.rb
 - lib/bright/sis_apis/bright_sis.rb
 - lib/bright/sis_apis/focus.rb
-- lib/bright/sis_apis/infinite_campus.rb
+- lib/bright/sis_apis/one_roster.rb
+- lib/bright/sis_apis/one_roster/infinite_campus.rb
+- lib/bright/sis_apis/one_roster/skyward.rb
 - lib/bright/sis_apis/power_school.rb
-- lib/bright/sis_apis/skyward.rb
 - lib/bright/sis_apis/synergy.rb
 - lib/bright/sis_apis/tsis.rb
 - lib/bright/student.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Framework and tools for dealing with Student Information Systems