bright 0.2.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f5aa090aca3509db5190f180780fab41aaca20cad1b2c8ad87d840ebc069e4
-  data.tar.gz: 2371c2a573db38ff164e6f89e9721793d4c3e73be4bf76f090990f68964590d1
+  metadata.gz: 21ec0c637efbc8a7cf6f4089fc7e5357dc9e0a40616164058ca09b75183b420f
+  data.tar.gz: f20c064ba1a5a3aa292874b2ae2ce82274e5b426cdd3f71c8d705e93c4c73b65
 SHA512:
-  metadata.gz: c1e87336d8567425a1a18f002ac4b3e25fc07ebac5e4b4248b6b280ddcce7d5aa7c578fb8927e5b8abbf8603f78f88f4dccfece3ced374903328769c17604559
-  data.tar.gz: 9c1a8f380871e59f68d2d3733ac59f4796ae46031f9f5726a4c8707ff7585c7e4d860ff8643b8bb0550792e97751b868295dc12d967702241feb0168e9d9a595
+  metadata.gz: 57e8c1aa2f91505b5d51c2c6b5d0b19502517a9990095904f96f8c4e9b6870b7ae701f8c6d6a9bb750d829dce4341facfcf80be19018dae1633b4296fd5c1376
+  data.tar.gz: 2260684a855a642a93688037db1ceaa521f6e7f33615c77b95d8e440cd68aad25e5f78073ed170275f22dac779846488e7ba3a51948fa348d8954754608c2884

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Stephen Heuer and Steven Novotny
+Copyright (c) 2022 Arux Software, Inc.
 
 MIT License
 

data/bright.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Arux Software"]
   spec.email         = ["sheuer@aruxsoftware.com"]
   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 Eleyo. 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.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.license       = "MIT"
 
@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "json", ">= 0"
   spec.add_runtime_dependency 'oauth', ">= 0.5.4"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake", "~> 12.3.3"
 end

data/lib/bright/address.rb

@@ -1,17 +1,15 @@
 module Bright
   class Address < Model
-    @attribute_names = [:street, :apt, :city, :state, :postal_code, :lattitude, :longitude, :type]
+    @attribute_names = [:street, :apt, :city, :state, :postal_code, :latitude, :longitude, :type]
     attr_accessor *@attribute_names
-    
-    alias lat lattitude
+
+    alias lat latitude
     alias lng longitude
-    
+
     def geographical_coordinates
-      if self.lattitude and self.longitude
-        "#{self.lattitude},#{self.longitude}"
+      if self.latitude and self.longitude
+        "#{self.latitude},#{self.longitude}"
       end
     end
   end
 end
-
-

data/lib/bright/connection.rb

@@ -31,53 +31,65 @@ module Bright
       @ssl_version = nil
       @proxy_address = nil
       @proxy_port = nil
+
+      if Bright.devmode && !@logger
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+
     end
 
     def request(method, body, headers = {})
       request_start = Time.now.to_f
+      info "connection_http_method=#{method.to_s.upcase} connection_uri=#{endpoint} headers=#{headers.inspect}", tag
+
+      result = nil
 
-      begin
-        info "connection_http_method=#{method.to_s.upcase} connection_uri=#{endpoint}", tag
-
-        result = nil
-
-        realtime = Benchmark.realtime do
-          request = HTTPI::Request.new(endpoint.to_s)
-          request.headers = headers
-          request.body = body if body
-          request.auth.ssl.verify_mode = :none if !@verify_peer
-          configure_proxy(request)
-          configure_timeouts(request)
-
-          result = case method
-          when :get
-            raise ArgumentError, "GET requests do not support a request body" if body
-            HTTPI.get(request)
-          when :post
-            debug body
-            HTTPI.post(request)
-          when :put
-            debug body
-            HTTPI.put(request)
-          when :patch
-            debug body
-            HTTPI.patch(request)
-          when :delete
-            HTTPI.delete(request)
-          else
-            raise ArgumentError, "Unsupported request method #{method.to_s.upcase}"
-          end
+      if !Bright.devmode
+        HTTPI.log = false
+      end
+
+      realtime = Benchmark.realtime do
+        request = HTTPI::Request.new(endpoint.to_s)
+        request.headers = headers
+        request.body = body if body
+        request.auth.ssl.verify_mode = :none if !@verify_peer
+        configure_proxy(request)
+        configure_timeouts(request)
+
+        result = case method
+        when :get
+          raise ArgumentError, "GET requests do not support a request body" if body
+          HTTPI.get(request)
+        when :post
+          debug(body) if Bright.devmode
+          HTTPI.post(request)
+        when :put
+          debug(body) if Bright.devmode
+          HTTPI.put(request)
+        when :patch
+          debug(body) if Bright.devmode
+          HTTPI.patch(request)
+        when :delete
+          HTTPI.delete(request)
+        else
+          raise ArgumentError, "Unsupported request method #{method.to_s.upcase}"
         end
+      end
 
-        info "--> %d (%d %.4fs)" % [result.code, result.body ? result.body.length : 0, realtime], tag
-        debug result.body
-        result
+      if Bright.devmode
+        info("--> %d (%d %.4fs)" % [result.code, result.body ? result.body.length : 0, realtime], tag)
+        debug(result.body)
       end
+
+      handle_response(result)
+
     ensure
       info "connection_request_total_time=%.4fs" % [Time.now.to_f - request_start], tag
     end
 
     private
+
     def configure_proxy(http)
       http.proxy = "#{proxy_address}:#{proxy_port}" if proxy_address
     end
@@ -88,15 +100,10 @@ module Bright
     end
 
     def handle_response(response)
-      if @ignore_http_status then
-        return response.body
+      if @ignore_http_status or !response.error?
+        return response
       else
-        case response.code.to_i
-        when 200...300
-          response.body
-        else
-          raise ResponseError.new(response)
-        end
+        raise ResponseError.new(response, endpoint.to_s)
       end
     end
 

data/lib/bright/contact.rb

@@ -0,0 +1,53 @@
+require 'securerandom'
+
+module Bright
+  class Contact < Model
+    @attribute_names = [:client_id, :api_id, :first_name, :middle_name, :last_name, :nick_name,
+                        :birth_date, :gender, :relationship_type,
+                        :hispanic_ethnicity, :race, :image,
+                        :sis_student_id, :state_student_id, :last_modified]
+    attr_accessor *@attribute_names
+
+    def self.attribute_names
+      @attribute_names
+    end
+
+    attr_accessor :phone_numbers, :addresses, :email_address
+
+    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 addresses=(array)
+      if array.size <= 0 or array.first.is_a?(Address)
+        @addresses = array
+      elsif array.first.is_a?(Hash)
+        @addresses = array.collect{|a| Address.new(a)}
+      end
+      @addresses ||= []
+    end
+
+    def addresses
+      @addresses ||= []
+    end
+
+    def email_address=(email)
+      if email.is_a?(EmailAddress)
+        @email_address = email
+      elsif email.is_a?(Hash)
+        @email_address = EmailAddress.new(email)
+      end
+      @email_address
+    end
+
+  end
+end

data/lib/bright/cursor_response_collection.rb

@@ -0,0 +1,45 @@
+class CursorResponseCollection < ResponseCollection
+
+  attr_accessor :collected_objects
+
+  def initialize(options = {})
+    @collected_objects = [options[:seed_page]].flatten
+    @per_page = options[:per_page].to_i
+    @load_more_call = options[:load_more_call]
+    @next_cursor = options[:next_cursor]
+  end
+
+  def each
+    while (!@next_cursor.blank?) do
+      objects_hsh = load_more_call.call(@next_cursor)
+      objects = objects_hsh[:objects]
+      @next_cursor = objects_hsh[:next_cursor]
+      objects.each do |obj|
+        yield obj
+      end
+      @collected_objects += objects
+    end
+  end
+
+  def last
+    self.to_a
+    return @collected_objects.last
+  end
+
+  def loaded_results
+    @collected_objects.flatten
+  end
+
+  def total
+    self.to_a
+    self.loaded_results.size
+  end
+
+  alias size total
+  alias length total
+
+  def empty?
+    self.to_a.empty?
+  end
+
+end

data/lib/bright/errors.rb

@@ -1,15 +1,25 @@
 module Bright
   class ResponseError < StandardError
     attr_reader :response
+    attr_reader :uri
 
-    def initialize(response, message = nil)
+    def initialize(response, uri = nil)
       @response = response
-      @message  = message
+      @uri = uri
     end
 
     def to_s
-      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
+      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}".strip
     end
+
+    def body
+      response.body
+    end
+
+    def server_error?
+      (500..599).include?(response&.code.to_i)
+    end
+
   end
 
   class UnknownAttributeError < NoMethodError

data/lib/bright/helpers/boolean_parser_helper.rb

@@ -0,0 +1,13 @@
+module Kernel
+  def Boolean(string)
+    return true if string == true || string =~ /^true$/i || string == "1" || string == 1 || string.to_s.downcase == "yes"
+    return false if string == false || string.nil? || string =~ /^false$/i || string == "0" || string == 0 || string.to_s.downcase == "no" || string.blank?
+    raise ArgumentError.new("invalid value for Boolean: \"#{string}\"")
+  end
+end
+
+class Object
+  def to_bool
+    Boolean(self)
+  end
+end

data/lib/bright/phone_number.rb

@@ -1,8 +1,20 @@
 module Bright
   class PhoneNumber < Model
-    @attribute_names = [:phone_number, :type]
+    @attribute_names = [:phone_number, :extension, :type]
     attr_accessor *@attribute_names
     TYPES = ["Cell", "Home", "Work", "Other"]
-    
+
+    def phone_number=(number)
+      number_a = number.to_s.split(/x|X/)
+      if number_a.size == 2
+        @extension = number_a.last.gsub(/[^0-9]/, "").strip
+      end
+      @phone_number = number_a.first.gsub(/[^0-9]/, "").strip
+    end
+
+    def extension=(number)
+      @extension = number.gsub(/[^0-9]/, "").strip
+    end
+
   end
 end

data/lib/bright/response_collection.rb

@@ -1,11 +1,11 @@
 class ResponseCollection
   include Enumerable
-  
+
   attr_accessor :paged_objects
   attr_accessor :total
   attr_accessor :per_page
   attr_accessor :load_more_call
-  
+
   # seed_page, total, per_page, load_more_call
   def initialize(options = {})
     @paged_objects = {0 => options[:seed_page]}
@@ -14,7 +14,7 @@ class ResponseCollection
     @pages = @per_page > 0 ? (@total.to_f / @per_page.to_f).ceil : 0
     @load_more_call = options[:load_more_call]
   end
-  
+
   def each
     current_page = -1
     while (current_page += 1) < @pages do
@@ -33,7 +33,7 @@ class ResponseCollection
       @paged_objects[next_page_no] = next_page_thread.value if next_page_thread
     end
   end
-  
+
   def last
     last_page_no = @pages - 1
     if load_more_call and (last_page = @paged_objects[last_page_no]).nil?
@@ -41,15 +41,15 @@ class ResponseCollection
     end
     last_page.last
   end
-  
+
   def loaded_results
     @paged_objects.values.flatten
   end
-  
+
   alias size total
   alias length total
 
   def empty?
     total <= 0
   end
-end
+end

data/lib/bright/sis_apis/aeries.rb

@@ -2,29 +2,29 @@ module Bright
   module SisApi
     class Aeries < Base
       DATE_FORMAT = '%Y-%m-%dT%H:%M:%S'
-      
+
       @@description = "Connects to the Aeries API for accessing student information"
       @@doc_url = "http://www.aeries.com/downloads/docs.1234/TechnicalSpecs/Aeries_API_Documentation.pdf"
       @@api_version = ""
-      
+
       attr_accessor :connection_options
-      
+
       def initialize(options = {})
         self.connection_options = options[:connection] || {}
         # {
-        #   :certficate => "", 
+        #   :certficate => "",
         #   :uri => ""
         # }
       end
-      
+
       def get_student_by_api_id(api_id)
         get_students({:api_id => api_id, :limit => 1}).first
       end
-      
+
       def get_student(params)
         get_students(params.merge(:limit => 1)).first
       end
-      
+
       def get_students(params)
         if params.has_key?(:school) or params.has_key?(:school_api_id)
           school_api_id = params.delete(:school) || params.delete(:school_api_id)
@@ -32,7 +32,7 @@ module Bright
         else
           threads = []
           get_schools.each do |school|
-            threads << Thread.new do 
+            threads << Thread.new do
               get_students_by_school(school, params)
             end
           end
@@ -40,7 +40,7 @@ module Bright
         end
         filter_students_by_params(students, params)
       end
-      
+
       def get_students_by_school(school, params = {})
         school_api_id = school.is_a?(School) ? school.api_id : school
         if params.has_key?(:api_id)
@@ -53,21 +53,21 @@ module Bright
         students_response_hash = self.request(:get, path, self.map_student_search_params(params))
         students_response_hash.collect{|shsh| Student.new(convert_to_student_data(shsh))}
       end
-      
+
       def create_student(student)
         raise NotImplementedError
       end
-      
+
       def update_student(student)
         raise NotImplementedError
       end
-      
+
       def get_schools(params = {})
         schools_response_hash = self.request(:get, 'api/v2/schools', params)
-        
+
         schools_response_hash.collect{|h| School.new(convert_to_school_data(h))}
       end
-      
+
       def request(method, path, params = {})
         uri  = "#{self.connection_options[:uri]}/#{path}"
         body = nil
@@ -78,11 +78,12 @@ module Bright
           body = JSON.dump(params)
         end
         
-        headers = self.headers_for_auth
+        response = connection_retry_wrapper {
+          connection = Bright::Connection.new(uri)
+          headers = self.headers_for_auth
+          connection.request(method, body, headers)
+        }
 
-        connection = Bright::Connection.new(uri)
-        response = connection.request(method, body, headers)
-        
         if !response.error?
           response_hash = JSON.parse(response.body)
         else
@@ -91,55 +92,55 @@ module Bright
         end
         response_hash
       end
-      
+
       protected
-      
+
       def map_student_search_params(attrs)
         attrs
       end
-      
+
       def convert_to_student_data(attrs)
         cattrs = {}
-        
+
         cattrs[:first_name]        = attrs["FirstName"]
         cattrs[:middle_name]       = attrs["MiddleName"]
         cattrs[:last_name]         = attrs["LastName"]
-        
+
         cattrs[:api_id]           = attrs["PermanentID"]
         cattrs[:sis_student_id]   = attrs["StudentNumber"]
         cattrs[:state_student_id] = attrs["StateStudentID"]
-        
+
         cattrs[:gender]           = attrs["Sex"]
         if attrs["Birthdate"]
-          begin 
+          begin
             cattrs[:birth_date] = Date.strptime(attrs["Birthdate"], DATE_FORMAT)
           rescue => e
             puts "#{e.inspect} #{bd}"
           end
         end
-        
+
         #SchoolCode
-        
+
         cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
       end
-      
+
       def convert_to_school_data(attrs)
         cattrs = {}
-        
+
         cattrs[:api_id] = attrs["SchoolCode"]
         cattrs[:name] = attrs["Name"]
         cattrs[:number] = attrs["SchoolCode"]
-        
+
         cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
       end
-      
+
       def headers_for_auth
         {
             'AERIES-CERT' => self.connection_options[:certificate],
             'Content-Type' => "application/json"
         }
       end
-            
+
     end
   end
-end
+end

data/lib/bright/sis_apis/base.rb

@@ -1,17 +1,17 @@
 module Bright
   module SisApi
     class Base
-      
+
       def filter_students_by_params(students, params)
         total = params[:limit]
         count = 0
         found = []
-  
+
         keys = (Student.attribute_names & params.keys.collect(&:to_sym))
         puts "filtering on #{keys.join(",")}"
         students.each do |student|
           break if total and count >= total
-    
+
           should = (keys).all? do |m|
             student.send(m) =~ Regexp.new(Regexp.escape(params[m]), Regexp::IGNORECASE)
           end
@@ -20,7 +20,33 @@ module Bright
         end
         found
       end
-  
+
+      def connection_retry_wrapper(&block)
+        retry_attempts = connection_options[:retry_attempts] || 2
+        retries = 0
+        begin
+          yield
+        rescue Bright::ResponseError => e
+          retries += 1
+          if e.server_error? && retries <= retry_attempts.to_i
+            puts "retrying #{retries}: #{e.class.to_s} - #{e.to_s}"
+            sleep(retries * 3)
+            retry
+          else
+            raise
+          end
+        rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Net::ReadTimeout, Net::OpenTimeout, EOFError => e
+          retries += 1
+          if retries <= retry_attempts.to_i
+            puts "retrying #{retries}: #{e.class.to_s} - #{e.to_s}"
+            sleep(retries * 3)
+            retry
+          else
+            raise
+          end
+        end
+      end
+
     end
   end
-end
+end