bright 0.2.0 → 1.0

data/lib/bright/sis_apis/tsis.rb

@@ -5,12 +5,12 @@ module Bright
   module SisApi
     class TSIS < Base
       DATE_FORMAT = '%m/%d/%Y'
-      
+
       @@description = "Connects to the TIES API for accessing TIES TSIS student information"
       @@doc_url = "#unkown"
-      
+
       attr_accessor :connection_options
-      
+
       def initialize(options = {})
         self.connection_options = options[:connection] || {}
         # {
@@ -20,17 +20,17 @@ module Bright
         #   :uri => ""
         # }
       end
-      
+
       def get_student_by_api_id(api_id, params = {})
         self.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}))
 
         # 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))
-        found_student = nil 
+        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))
         end
@@ -43,10 +43,10 @@ module Bright
         end
         found_student
       end
-      
+
       def get_students(params = {}, options = {})
         params = self.apply_options(params, options)
-        
+
         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))
@@ -54,10 +54,10 @@ module Bright
           # 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))
         end
-        
+
         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|
@@ -66,24 +66,24 @@ module Bright
           }
 
           ResponseCollection.new({
-            :seed_page => students, 
+            :seed_page => students,
             :total => total_results,
-            :per_page => options[:per_page], 
+            :per_page => options[:per_page],
             :load_more_call => load_more_call
           })
         else
           students
         end
       end
-      
+
       def create_student(student)
         raise NotImplementedError, "TSIS does not support creating students"
       end
-      
+
       def update_student(student)
         raise NotImplementedError, "TSIS does not support updating students"
       end
-      
+
       def get_schools(params = {}, options = {})
         params = self.apply_options(params, options)
 
@@ -110,7 +110,7 @@ module Bright
           schools
         end
       end
-            
+
       def request(method, path, params = {})
         uri  = "#{self.connection_options[:uri]}/#{path}"
         body = nil
@@ -120,22 +120,24 @@ module Bright
         else
           body = query
         end
-        
-        headers = self.headers_for_auth(uri)
 
-        connection = Bright::Connection.new(uri)
-        response = connection.request(method, body, headers)
+        response = connection_retry_wrapper {
+          connection = Bright::Connection.new(uri)
+          headers = self.headers_for_auth
+          connection.request(method, body, headers)
+        }
+
         if !response.error?
           response_hash = JSON.parse(response.body)
         end
         response_hash
       end
-      
+
       protected
-      
+
       def map_search_params(params)
         params = params.dup
-        
+
         params["studentname"] = params.delete(:name)
         params["studentname"] ||= "#{params.delete(:last_name)}, #{params.delete(:first_name)} #{params.delete(:middle_name)}".strip
         params["studentids"] = params.delete(:sis_student_id)
@@ -147,10 +149,10 @@ module Bright
           k = k.to_s.gsub(/[^A-Za-z]/, "").downcase
           [k,v]
         end]
-        
+
         params.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
       end
-      
+
       def convert_to_student_data(attrs)
         catt = {}
         if attrs["StudentName"]
@@ -170,7 +172,7 @@ module Bright
           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
@@ -180,18 +182,18 @@ module Bright
 
         bd = attrs["BirthDate"] || attrs["StudentBirthDate"]
         if !(bd.nil? or bd.empty?)
-          begin 
+          begin
             catt[:birth_date] = Date.strptime(bd, DATE_FORMAT)
           rescue => e
             puts "#{e.inspect} #{bd}"
           end
         end
-        
+
         catt[:addresses] = [self.convert_to_address_data(attrs["Address"])] if attrs["Address"]
-        
+
         catt.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
       end
-      
+
       def convert_to_address_data(attrs)
         cattrs = {}
 
@@ -204,38 +206,38 @@ module Bright
         cattrs[:state] = attrs["State"]
         cattrs[:postal_code] = attrs["Zip"]
         cattrs[:type] = attrs["Type"].to_s.downcase
-        
+
         cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
       end
-      
+
       def convert_to_school_data(attrs)
         cattrs = {}
-        
+
         cattrs[:name] = attrs["Name"]
         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?}
       end
-      
+
       def apply_options(params, options)
         options[:per_page] = params[:rpp] ||= params.delete(:per_page) || options[:per_page] || 100
         options[:page] = params.delete(:page) || options[:page]
         params[:schoolyear] ||= params.delete(:school_year) || options[:school_year]
         params
       end
-      
+
       def apply_page_to_url(url, 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
-    
+
         {
             'Authorization' => authorization,
             'DistrictNumber' => self.connection_options[:district_id],
@@ -245,4 +247,4 @@ module Bright
       end
     end
   end
-end
+end

data/lib/bright/student.rb

@@ -14,7 +14,7 @@ module Bright
     end
 
     # TODO:: map contact info (addresses, email, phone, etc)
-    attr_accessor :enrollment, :addresses, :email_address, :school
+    attr_accessor :enrollment, :addresses, :email_address, :phone_numbers, :school, :contacts
 
     def initialize(*args)
       super
@@ -48,6 +48,19 @@ module Bright
       @addresses ||= []
     end
 
+    def phone_numbers=(array)
+      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)}
+      end
+      @phone_numbers ||= []
+    end
+
+    def phone_numbers
+      @phone_numbers ||= []
+    end
+
     def email_address=(email)
       if email.is_a?(EmailAddress)
         @email_address = email
@@ -66,5 +79,18 @@ module Bright
       @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)}
+      end
+      @contacts ||= []
+    end
+
+    def contacts
+      @contacts ||= []
+    end
+
   end
 end

data/lib/bright/version.rb

@@ -1,3 +1,3 @@
 module Bright
-  VERSION = "0.2.0"
+  VERSION = "1.0"
 end

data/lib/bright.rb

@@ -2,6 +2,7 @@ require "bright/version"
 require "bright/errors"
 
 require "bright/helpers/blank_helper.rb"
+require "bright/helpers/boolean_parser_helper.rb"
 
 require "bright/model"
 require "bright/student"
@@ -10,17 +11,23 @@ require "bright/phone_number"
 require "bright/email_address"
 require "bright/enrollment"
 require "bright/school"
+require "bright/contact"
+
 
 require "bright/connection"
 require "bright/response_collection"
+require "bright/cursor_response_collection"
 
 require "bright/sis_apis/base.rb"
 require "bright/sis_apis/tsis.rb"
 require "bright/sis_apis/power_school.rb"
 require "bright/sis_apis/aeries.rb"
 require "bright/sis_apis/infinite_campus.rb"
+require "bright/sis_apis/skyward.rb"
 require "bright/sis_apis/bright_sis.rb"
 
 module Bright
-
+  class << self
+    attr_accessor :devmode
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '1.0'
 platform: ruby
 authors:
 - Arux Software
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -56,32 +56,32 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 description: Bright is a simple Student Information System API abstraction library
-  used in and sponsored by Eleyo. It is written by Stephen Heuer, Steven Novotny,
+  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.
@@ -100,10 +100,13 @@ files:
 - lib/bright.rb
 - lib/bright/address.rb
 - lib/bright/connection.rb
+- lib/bright/contact.rb
+- lib/bright/cursor_response_collection.rb
 - lib/bright/email_address.rb
 - lib/bright/enrollment.rb
 - lib/bright/errors.rb
 - lib/bright/helpers/blank_helper.rb
+- lib/bright/helpers/boolean_parser_helper.rb
 - lib/bright/model.rb
 - lib/bright/phone_number.rb
 - lib/bright/response_collection.rb
@@ -113,6 +116,7 @@ files:
 - lib/bright/sis_apis/bright_sis.rb
 - lib/bright/sis_apis/infinite_campus.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
@@ -121,7 +125,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Framework and tools for dealing with Student Information Systems
 test_files: []