bright 2.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2478a62cb11741cb1406e3f38bd2e387beb5f042c2c8e170d455e7d531d779b
-  data.tar.gz: 507582c1502e2894e470236fedeba7efcd906d9a29d15a5c4d6218b1468666ca
+  metadata.gz: cecf72fc184d3cdf9aabf35502de293d80fd66ebf89d1f7e54a26ed9b8eb3bc3
+  data.tar.gz: 195907040f1522459af343ca88d19bec678678112ac312ad6b40ce0710a1033a
 SHA512:
-  metadata.gz: 1b07d3fee51e60da6f25f84cb2ba4a275d7597da0fc481866e5c838a7bbdeb63b4c80c22de44f145f91becc22e53ea5ee50d888aa931517c142fb199f277d32c
-  data.tar.gz: 934e5d22043fc74251b2321532897cbff7d06e63b722321e99fb00ca2711d23abfc853234642bb6c72db2dddcafad58d324a5e0251c9f36a42e2755df18eb765
+  metadata.gz: cef10a48aaf47c282d87c2b18d23ad39b0747667e21c2841f698a4ef22ba35f7c83dd2b407cc16a27333b0e16923648b8f8ad5d623633898e5fbb40714e441e5
+  data.tar.gz: 99da5c90309415481bf7eabd7b08a12e5836b127aee8e0ed6835956bffa1833ff000bb82b596fa8921c288a1105d2fd56b44fe0e4911d55e6ddabf116b88ad05

data/README.md

@@ -1,6 +1,6 @@
 # Bright
 
-TODO: Write a gem description
+The `bright` gem provides a framework and tools for interacting with various Student Information Systems (SIS). It supports multiple SIS platforms, including Infinite Campus, Skyward, TSIS, Aeries, and PowerSchool, offering functionalities to retrieve and manage student and school data.
 
 ## Installation
 

data/lib/bright/sis_apis/one_roster.rb

@@ -40,7 +40,7 @@ module Bright
           {roles: "student"}.merge(params)
         end
         st_hsh = request(:get, "users/#{api_id}", params)
-        Student.new(convert_to_user_data(st_hsh["user"])) if st_hsh and st_hsh["user"]
+        Student.new(convert_to_user_data(st_hsh["user"])) if st_hsh && st_hsh["user"]
       end
 
       def get_student(params = {}, options = {})
@@ -56,7 +56,7 @@ module Bright
         params[:limit] = params[:limit] || options[:limit] || 100
         students_response_hash = request(:get, "users", 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"]
+        if students_response_hash && students_response_hash["users"]
           students_hash = [students_response_hash["users"]].flatten
 
           students = students_hash.compact.collect { |st_hsh|
@@ -92,7 +92,7 @@ module Bright
 
       def get_school_by_api_id(api_id, params = {})
         sc_hsh = request(:get, "schools/#{api_id}", params)
-        School.new(convert_to_school_data(sc_hsh["org"])) if sc_hsh and sc_hsh["org"]
+        School.new(convert_to_school_data(sc_hsh["org"])) if sc_hsh && sc_hsh["org"]
       end
 
       def get_school(params = {}, options = {})
@@ -103,7 +103,7 @@ module Bright
         params[:limit] = params[:limit] || options[:limit] || 100
         schools_response_hash = request(:get, "schools", 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"]
+        if schools_response_hash && schools_response_hash["orgs"]
           schools_hash = [schools_response_hash["orgs"]].flatten
 
           schools = schools_hash.compact.collect { |sc_hsh|
@@ -131,7 +131,7 @@ module Bright
 
       def get_contact_by_api_id(api_id, params = {})
         contact_hsh = 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"]
+        Contact.new(convert_to_user_data(contact_hsh["user"], bright_type: "Contact")) if contact_hsh && contact_hsh["user"]
       end
 
       def request(method, path, params = {})
@@ -154,8 +154,8 @@ module Bright
           response_hash = JSON.parse(response.body)
           response_hash[:response_headers] = response.headers
         else
-          puts "#{response.inspect}"
-          puts "#{response.body}"
+          puts response.inspect
+          puts response.body
         end
         response_hash
       end
@@ -163,15 +163,8 @@ module Bright
       protected
 
       def headers_for_auth(uri)
-        case api_version
-        when Gem::Version.new("1.1")
-          site = URI.parse(connection_options[:uri])
-          site = "#{site.scheme}://#{site.host}"
-          consumer = OAuth::Consumer.new(connection_options[:client_id], 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 connection_options[:access_token].nil? or connection_options[:access_token_expires] < Time.now
+        if api_version >= Gem::Version.new("1.2") || connection_options[:token_uri].present?
+          if connection_options[:access_token].nil? || (connection_options[:access_token_expires] < Time.now)
             retrieve_access_token
           end
           {
@@ -179,6 +172,12 @@ module Bright
             "Accept" => "application/json",
             "Content-Type" => "application/json"
           }
+        else
+          site = URI.parse(connection_options[:uri])
+          site = "#{site.scheme}://#{site.host}"
+          consumer = OAuth::Consumer.new(connection_options[:client_id], 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"]}
         end
       end
 
@@ -314,7 +313,7 @@ module Bright
         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?
+        if (bright_type == "Student") && !user_params["agents"].blank?
           user_data_hsh[:contacts] = user_params["agents"].collect do |agent_hsh|
             get_contact_by_api_id(agent_hsh["sourcedId"])
           rescue Bright::ResponseError => e

data/lib/bright/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bright
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.1'
 platform: ruby
 authors:
 - Arux Software
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -141,7 +140,6 @@ homepage: https://github.com/Arux-Software/Bright
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Framework and tools for dealing with Student Information Systems
 test_files: []