bright 1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd99510122d136894a8e1ba1fdfb6bea0c424f355624ca2c68178143fcd7965d
-  data.tar.gz: 16b8599ad55c91cf1f925a76da5d49690c49e2315ca63b925b71d31e421de45c
+  metadata.gz: ed9189d57c0583da9fe8c388390b5fdfe7d1219ec1aa7f705c8d5bdcb86a380d
+  data.tar.gz: 114e30a3f065134cd467aeb5186662cc0b296dff3b35ea276d790661bfc3ed58
 SHA512:
-  metadata.gz: e4499da391786116fef2ef77fbf283fd67f4c4f26f84277f2bf75825d9b2444712f7df8b7bb99ba3279f4c10612addbaaa47dda84ffda2f8e9b4240539d80939
-  data.tar.gz: b544283e756c7114aac543d7b7a3c4d6acf87de7b5c58593a96bcafa619628444a7eaa91b0256dada1e28519914d381fc022563dce10814b5e8d0dbccca74736
+  metadata.gz: bcf315c80eb63fa3c4b27e92255721f92d79ed1bc1593cddb75c635e59b8d77d01ddf4e95a6dd4184524e174c2a5f9e2ad310f66c3228fad779bd8c94d8de73b
+  data.tar.gz: 764e099470d73800e6ee90fdbc8cd38e20aac97e65226a8caee377d306f959870637e7e7526bbc54bcd7ff644d3e343a580c805ef299a3cfbcf88d968c696b4d

data/bright.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["hello@arux.software"]
   spec.summary       = "Framework and tools for dealing with Student Information Systems"
   spec.description   = "Bright is a simple Student Information System API abstraction library used in and sponsored by Arux Software. It is written by Stephen Heuer, Steven Novotny, and contributors. The aim of the project is to abstract as many parts as possible away from the user to offer a consistent interface across all supported Student Information System APIs."
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/Arux-Software/Bright"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/bright/sis_apis/base.rb

@@ -35,7 +35,7 @@ module Bright
           else
             raise
           end
-        rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Net::ReadTimeout, Net::OpenTimeout, EOFError => e
+        rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Net::ReadTimeout, Net::OpenTimeout, SocketError, EOFError => e
           retries += 1
           if retries <= retry_attempts.to_i
             puts "retrying #{retries}: #{e.class.to_s} - #{e.to_s}"

data/lib/bright/sis_apis/focus.rb

@@ -0,0 +1,377 @@
+require 'oauth'
+
+module Bright
+  module SisApi
+    class Focus < Base
+
+      @@description = "Connects to the Focus OneRoster API for accessing student information"
+      @@doc_url = ""
+      @@api_version = "1.1"
+
+      attr_accessor :connection_options, :schools_cache, :school_years_cache
+
+      DEMOGRAPHICS_CONVERSION = {
+        "americanIndianOrAlaskaNative"=>"American Indian Or Alaska Native",
+        "asian"=>"Asian",
+        "blackOrAfricanAmerican"=>"Black Or African American",
+        "nativeHawaiianOrOtherPacificIslander"=>"Native Hawaiian Or Other Pacific Islander",
+        "white"=>"White",
+        "hispanicOrLatinoEthnicity"=>"Hispanic Or Latino"
+      }
+
+      def initialize(options = {})
+        self.connection_options = options[:connection] || {}
+        # {
+        #   :client_id => "",
+        #   :client_secret => "",
+        #   :api_version => "", (defaults to @@api_version)
+        #   :uri => "",
+        #   :token_uri => ""  (api_version 1.2 required)
+        # }
+      end
+
+      def api_version
+        Gem::Version.new(self.connection_options.dig(:api_version) || @@api_version)
+      end
+
+      def get_student_by_api_id(api_id, params = {})
+        st_hsh = self.request(:get, "students/#{api_id}", params)
+        Student.new(convert_to_user_data(st_hsh["user"])) if st_hsh and st_hsh["user"]
+      end
+
+      def get_student(params = {}, options = {})
+        self.get_students(params, options.merge(:limit => 1, :wrap_in_collection => false)).first
+      end
+
+      def get_students(params = {}, options = {})
+        params[:limit] = params[:limit] || options[:limit] || 100
+        students_response_hash = self.request(:get, 'students', self.map_search_params(params))
+        total_results = students_response_hash[:response_headers]["x-total-count"].to_i
+        if students_response_hash and students_response_hash["users"]
+          students_hash = [students_response_hash["users"]].flatten
+
+          students = students_hash.compact.collect {|st_hsh|
+            Student.new(convert_to_user_data(st_hsh))
+          }
+        end
+        if options[:wrap_in_collection] != false
+          api = self
+          load_more_call = proc { |page|
+            # pages start at one, so add a page here
+            params[:offset] = (params[:limit].to_i * page)
+            api.get_students(params, {:wrap_in_collection => false})
+          }
+          ResponseCollection.new({
+            :seed_page => students,
+            :total => total_results,
+            :per_page => params[:limit],
+            :load_more_call => load_more_call,
+            :no_threads => options[:no_threads]
+          })
+        else
+          students
+        end
+      end
+
+      def create_student(student)
+        raise NotImplementedError
+      end
+
+      def update_student(student)
+        raise NotImplementedError
+      end
+
+      def get_school_by_api_id(api_id, params = {})
+        sc_hsh = self.request(:get, "schools/#{api_id}", params)
+        School.new(convert_to_school_data(sc_hsh["org"])) if sc_hsh and sc_hsh["org"]
+      end
+
+      def get_school(params = {}, options = {})
+        self.get_schools(params, options.merge(:limit => 1, :wrap_in_collection => false)).first
+      end
+
+      def get_schools(params = {}, options = {})
+        params[:limit] = params[:limit] || options[:limit] || 100
+        schools_response_hash = self.request(:get, 'schools', self.map_school_search_params(params))
+        total_results = schools_response_hash[:response_headers]["x-total-count"].to_i
+        if schools_response_hash and schools_response_hash["orgs"]
+          schools_hash = [schools_response_hash["orgs"]].flatten
+
+          schools = schools_hash.compact.collect {|sc_hsh|
+            School.new(convert_to_school_data(sc_hsh))
+          }
+        end
+        if options[:wrap_in_collection] != false
+          api = self
+          load_more_call = proc { |page|
+            # pages start at one, so add a page here
+            params[:offset] = (params[:limit].to_i * page)
+            api.get_schools(params, {:wrap_in_collection => false})
+          }
+          ResponseCollection.new({
+            :seed_page => schools,
+            :total => total_results,
+            :per_page => params[:limit],
+            :load_more_call => load_more_call,
+            :no_threads => options[:no_threads]
+          })
+        else
+          schools
+        end
+      end
+
+      def get_contact_by_api_id(api_id, params ={})
+        contact_hsh = self.request(:get, "users/#{api_id}", params)
+        Contact.new(convert_to_user_data(contact_hsh["user"], bright_type: "Contact")) if contact_hsh and contact_hsh["user"]
+      end
+
+      def request(method, path, params = {})
+        uri  = "#{self.connection_options[:uri]}/#{path}"
+        body = nil
+        if method == :get
+          query = URI.encode_www_form(params)
+          uri += "?#{query}" unless query.strip == ""
+        else
+          body = JSON.dump(params)
+        end
+
+        response = connection_retry_wrapper {
+          connection = Bright::Connection.new(uri)
+          headers = self.headers_for_auth(uri)
+          connection.request(method, body, headers)
+        }
+
+        if !response.error?
+          response_hash = JSON.parse(response.body)
+          response_hash[:response_headers] = response.headers
+        else
+          puts "#{response.inspect}"
+          puts "#{response.body}"
+        end
+        response_hash
+      end
+
+      protected
+
+      def headers_for_auth(uri)
+        case api_version
+        when Gem::Version.new("1.1")
+          site = URI.parse(self.connection_options[:uri])
+          site = "#{site.scheme}://#{site.host}"
+          consumer = OAuth::Consumer.new(self.connection_options[:client_id], self.connection_options[:client_secret], { :site => site, :scheme => :header })
+          options = {:timestamp => Time.now.to_i, :nonce => SecureRandom.uuid}
+          {"Authorization" => consumer.create_signed_request(:get, uri, nil, options)["Authorization"]}
+        when Gem::Version.new("1.2")
+          if self.connection_options[:access_token].nil? or self.connection_options[:access_token_expires] < Time.now
+            self.retrieve_access_token
+          end
+          {
+            "Authorization" => "Bearer #{self.connection_options[:access_token]}",
+            "Accept" => "application/json;charset=UTF-8",
+            "Content-Type" =>"application/json;charset=UTF-8"
+          }
+        end
+      end
+
+      def retrieve_access_token
+        connection = Bright::Connection.new(self.connection_options[:token_uri])
+        response = connection.request(:post,
+          {
+            "grant_type" => "client_credentials",
+            "username" => self.connection_options[:client_id],
+            "password" => self.connection_options[:client_secret]
+          },
+          self.headers_for_access_token
+        )
+        if !response.error?
+          response_hash = JSON.parse(response.body)
+        end
+        if response_hash["access_token"]
+          self.connection_options[:access_token] = response_hash["access_token"]
+          self.connection_options[:access_token_expires] = (Time.now - 10) + response_hash["expires_in"]
+        end
+        response_hash
+      end
+
+      def headers_for_access_token
+        {
+          "Authorization" => "Basic #{Base64.strict_encode64("#{self.connection_options[:client_id]}:#{self.connection_options[:client_secret]}")}",
+          "Content-Type" => "application/x-www-form-urlencoded;charset=UTF-8"
+        }
+      end
+
+      def map_search_params(params)
+        params = params.dup
+        default_params = {}
+
+        filter = []
+        params.each do |k,v|
+          case k.to_s
+          when "first_name"
+            filter << "givenName='#{v}'"
+          when "last_name"
+            filter << "familyName='#{v}'"
+          when "email"
+            filter << "email='#{v}'"
+          when "student_id"
+            filter << "identifier='#{v}'"
+          when "last_modified"
+            filter << "dateLastModified>='#{v.to_time.utc.xmlschema}'"
+          when "role"
+            filter << "role='#{v}'"
+          else
+            default_params[k] = v
+          end
+        end
+        unless filter.empty?
+          params = {"filter" => filter.join(" AND ")}
+        end
+        default_params.merge(params).reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+      end
+
+      def map_school_search_params(params)
+        params = params.dup
+        default_params = {}
+        filter = []
+        params.each do |k,v|
+          case k.to_s
+          when "number"
+            filter << "identifier='#{v}'"
+          when "last_modified"
+            filter << "dateLastModified>='#{v.to_time.utc.xmlschema}'"
+          else
+            default_params[k] = v
+          end
+        end
+        unless filter.empty?
+          params = {"filter" => filter.join(" AND ")}
+        end
+        default_params.merge(params).reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+      end
+
+      def convert_to_school_data(school_params)
+        return {} if school_params.blank?
+        school_data_hsh = {
+          :api_id => school_params["sourcedId"],
+          :name => school_params["name"],
+          :number => school_params["identifier"],
+          :last_modified => school_params["dateLastModified"]
+        }
+        return school_data_hsh
+      end
+
+      def convert_to_user_data(user_params, bright_type: "Student")
+        return {} if user_params.blank?
+        user_data_hsh = {
+          :api_id => user_params["sourcedId"],
+          :first_name => user_params["givenName"],
+          :middle_name => user_params["middleName"],
+          :last_name => user_params["familyName"],
+          :last_modified => user_params["dateLastModified"]
+        }.reject{|k,v| v.blank?}
+        unless user_params["identifier"].blank?
+          user_data_hsh[:sis_student_id] = user_params["identifier"]
+        end
+        unless user_params["userMasterIdentifier"].blank?
+          user_data_hsh[:state_student_id] = user_params["userMasterIdentifier"]
+        end
+        unless user_params.dig("metadata", "stateId").blank?
+          user_data_hsh[:state_student_id] = user_params.dig("metadata", "stateId")
+        end
+        unless user_params["email"].blank?
+          user_data_hsh[:email_address] = {
+            :email_address => user_params["email"]
+          }
+        end
+        unless user_params["orgs"].blank?
+          if (s = user_params["orgs"].detect{|org| org["href"] =~ /\/schools\//})
+            self.schools_cache ||= {}
+            if (attending_school = self.schools_cache[s["sourcedId"]]).nil?
+              attending_school = self.get_school_by_api_id(s["sourcedId"])
+              self.schools_cache[attending_school.api_id] = attending_school
+            end
+          end
+          if attending_school
+            user_data_hsh[:school] = attending_school
+          end
+        end
+        unless user_params["phone"].blank?
+          user_data_hsh[:phone_numbers] = [{:phone_number => user_params["phone"]}]
+        end
+        unless user_params["sms"].blank?
+          user_data_hsh[:phone_numbers] ||= []
+          user_data_hsh[:phone_numbers] << {:phone_number => user_params["sms"]}
+        end
+
+        #add the demographic information
+        demographics_hash = get_demographic_information(user_data_hsh[:api_id])
+        user_data_hsh.merge!(demographics_hash) unless demographics_hash.blank?
+
+        #if you're a student, build the contacts too
+        if bright_type == "Student" and !user_params["agents"].blank?
+          user_data_hsh[:contacts] = user_params["agents"].collect do |agent_hsh|
+            begin
+              self.get_contact_by_api_id(agent_hsh["sourcedId"])
+            rescue Bright::ResponseError => e
+              if !e.message.to_s.include?("404")
+                raise e
+              end
+            end
+          end.compact
+          user_data_hsh[:grade] = (user_params["grades"] || []).first
+          if !user_data_hsh[:grade].blank?
+            user_data_hsh[:grade_school_year] = get_grade_school_year
+          end
+        end
+
+        return user_data_hsh
+      end
+
+      def get_demographic_information(api_id)
+        demographic_hsh = {}
+
+        begin
+          demographics_params = request(:get, "demographics/#{api_id}")["demographics"]
+        rescue Bright::ResponseError => e
+          if e.message.to_s.include?('404')
+            return demographic_hsh
+          else
+            raise e
+          end
+        end
+
+        unless (bday = demographics_params["birthdate"] || demographics_params["birthDate"]).blank?
+          demographic_hsh[:birth_date] = Date.parse(bday).to_s
+        end
+        unless demographics_params["sex"].to_s[0].blank?
+          demographic_hsh[:gender] = demographics_params["sex"].to_s[0].upcase
+        end
+        DEMOGRAPHICS_CONVERSION.each do |demographics_key, demographics_value|
+          if demographics_params[demographics_key].to_bool
+            if demographics_value == "Hispanic Or Latino"
+              demographic_hsh[:hispanic_ethnicity] = true
+            else
+              demographic_hsh[:race] ||= []
+              demographic_hsh[:race] << demographics_value
+            end
+          end
+        end
+        return demographic_hsh
+      end
+
+      def get_grade_school_year(date = Date.today)
+        # return the school year of a specific date
+        self.school_years_cache ||= {}
+        if self.school_years_cache[date].nil?
+          academic_periods_params = self.request(:get, "academicSessions", {"filter" => "startDate<='#{date.to_s}' AND endDate>='#{date.to_s}' AND status='active'"})["academicSessions"]
+          school_years = academic_periods_params.map{|ap| ap["schoolYear"]}.uniq
+          if school_years.size == 1
+            self.school_years_cache[date] = school_years.first
+          end
+        end
+        return self.school_years_cache[date]
+      end
+
+    end
+  end
+end

data/lib/bright/sis_apis/skyward.rb

@@ -214,7 +214,7 @@ module Bright
         end
 
         ["PhoneNumber", "PhoneNumber2", "PhoneNumber3"].each do |phone_param|
-          if !user_params[phone_param].blank?
+          if user_params[phone_param].present? && user_params["#{phone_param}Type"].present?
             user_data_hsh[:phone_numbers] ||= []
             user_data_hsh[:phone_numbers] << {
               :phone_number => user_params[phone_param],

data/lib/bright/version.rb

@@ -1,3 +1,3 @@
 module Bright
-  VERSION = "1.1"
+  VERSION = "1.2.1"
 end

data/lib/bright.rb

@@ -26,6 +26,7 @@ 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"
 
 module Bright
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.2.1
 platform: ruby
 authors:
 - Arux Software
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -128,6 +128,7 @@ files:
 - lib/bright/sis_apis/aeries.rb
 - 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/power_school.rb
 - lib/bright/sis_apis/skyward.rb
@@ -135,7 +136,7 @@ files:
 - lib/bright/sis_apis/tsis.rb
 - lib/bright/student.rb
 - lib/bright/version.rb
-homepage: ''
+homepage: https://github.com/Arux-Software/Bright
 licenses:
 - MIT
 metadata: {}