bright 0.1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 381169bba4d0de609bb9650455e7d8e4568d9de4
-  data.tar.gz: 53b5f910b2a5655a194b6a913f75c5a67b1753c5
+SHA256:
+  metadata.gz: dd99510122d136894a8e1ba1fdfb6bea0c424f355624ca2c68178143fcd7965d
+  data.tar.gz: 16b8599ad55c91cf1f925a76da5d49690c49e2315ca63b925b71d31e421de45c
 SHA512:
-  metadata.gz: 1d8fe64474322364c96ebb6f51d30a944b7cb0ba1e3f207f5dba7cb99cb415cbb01a197155c5af9d4f8444354277debc97713c5ea2011a10eba671ce8068ec45
-  data.tar.gz: 8f0a9ea2b0f0299deb7bb3be69713d42b3d315f120af8a045882befa92f992436eae8b5b7690a93db8258de13bfb073ca0b2c3369cc0b3cfaea121ea0c15cfe4
+  metadata.gz: e4499da391786116fef2ef77fbf283fd67f4c4f26f84277f2bf75825d9b2444712f7df8b7bb99ba3279f4c10612addbaaa47dda84ffda2f8e9b4240539d80939
+  data.tar.gz: b544283e756c7114aac543d7b7a3c4d6acf87de7b5c58593a96bcafa619628444a7eaa91b0256dada1e28519914d381fc022563dce10814b5e8d0dbccca74736

data/LICENSE.txt

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

data/bright.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "bright"
   spec.version       = Bright::VERSION
   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 FeePay. 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.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.license       = "MIT"
 
@@ -20,7 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "httpi", "~> 2.1"
   spec.add_runtime_dependency "json", ">= 0"
+  spec.add_runtime_dependency "oauth", ">= 0.5.4"
+  spec.add_runtime_dependency "parallel", "~> 1.2"
 
-  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

@@ -1,6 +1,7 @@
 require 'uri'
 require 'httpi'
 require 'benchmark'
+require 'securerandom'
 
 module Bright
   class Connection
@@ -30,72 +31,79 @@ 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
-    
+
     def configure_timeouts(http)
       http.open_timeout = open_timeout
       http.read_timeout = read_timeout
     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
 
@@ -116,4 +124,4 @@ module Bright
       logger.send(level, message) if logger
     end
   end
-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/email_address.rb

@@ -0,0 +1,7 @@
+module Bright
+  class EmailAddress < Model
+    @attribute_names = [:email_address]
+    attr_accessor *@attribute_names
+    
+  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/blank_helper.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+class Object
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  def blank?
+    false
+  end
+end
+
+class Array
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  def blank?
+    BLANK_RE === self
+  end
+end
+
+class Numeric
+  def blank?
+    false
+  end
+end

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

@@ -0,0 +1,20 @@
+module Bright
+  class PhoneNumber < Model
+    @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,15 @@
+require 'parallel'
+
 class ResponseCollection
   include Enumerable
-  
+
   attr_accessor :paged_objects
   attr_accessor :total
   attr_accessor :per_page
   attr_accessor :load_more_call
-  
+
+  DEFAULT_NO_THREADS = 4
+
   # seed_page, total, per_page, load_more_call
   def initialize(options = {})
     @paged_objects = {0 => options[:seed_page]}
@@ -13,27 +17,24 @@ class ResponseCollection
     @per_page = options[:per_page].to_i
     @pages = @per_page > 0 ? (@total.to_f / @per_page.to_f).ceil : 0
     @load_more_call = options[:load_more_call]
+    @no_threads = options[:no_threads] || DEFAULT_NO_THREADS
   end
-  
+
   def each
-    current_page = -1
-    while (current_page += 1) < @pages do
-      objects = [@paged_objects[current_page]].flatten.compact
-      next_page_no = current_page + 1
-      if load_more_call and @paged_objects[next_page_no].nil? and next_page_no < @pages
-        next_page_thread = Thread.new do
-          load_more_call.call(next_page_no)
-        end
-      else
-        next_page_thread = nil
-      end
+    Parallel.each(0..@pages, in_threads: @no_threads) do |current_page|
+      objects = if @paged_objects[current_page].present?
+                  @paged_objects[current_page]
+                else
+                  load_more_call.call(current_page)
+                end
+      objects = [objects].flatten.compact
+      @paged_objects[current_page] = objects if objects.present?
       objects.each do |obj|
         yield obj
       end
-      @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 +42,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/school.rb

@@ -1,9 +1,9 @@
 module Bright
   class School < Model
-    @attribute_names = [:api_id, :name, :number]
+    @attribute_names = [:api_id, :name, :number, :state_id, :low_grade, :high_grade, :last_modified]
     attr_accessor *@attribute_names
-    attr_accessor :address
-    
+    attr_accessor :address, :phone_number
+
     def address=(address)
       if address.is_a?(Address)
         @address = address
@@ -12,6 +12,15 @@ module Bright
       end
       @address
     end
-    
+
+    def phone_number=(phone_number)
+      if phone_number.is_a?(PhoneNumber)
+        @phone_number = phone_number
+      elsif phone_number.is_a?(Hash)
+        @phone_number = PhoneNumber.new(phone_number)
+      end
+      @phone_number
+    end
+
   end
 end