bright 1.3 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a3d3db120102506bfe30f6e5e301eb8baa8fd9365ba042698423ab3ccc536ae
-  data.tar.gz: cba89c2569e6a8b657009032026607efe0c4d634f20ec2835a13dada74898097
+  metadata.gz: d2478a62cb11741cb1406e3f38bd2e387beb5f042c2c8e170d455e7d531d779b
+  data.tar.gz: 507582c1502e2894e470236fedeba7efcd906d9a29d15a5c4d6218b1468666ca
 SHA512:
-  metadata.gz: 1ee050314bef57a8a4d42a33096155cd3e3a6d0fd8acc080e7857f89b1c6f25ab5c3dad8ee297e08712a34a46d5056bb5ad8d6491a2d4d07befd8ba91cc669f2
-  data.tar.gz: 30125dbe150d94a911692d542881e6bb7be366260e2596b9ff602f55ce6541bf5a8d5a2df63d4c38fc96374dad0e4ad1a91b41458a656db7c8c84d64c2bcf3f6
+  metadata.gz: 1b07d3fee51e60da6f25f84cb2ba4a275d7597da0fc481866e5c838a7bbdeb63b4c80c22de44f145f91becc22e53ea5ee50d888aa931517c142fb199f277d32c
+  data.tar.gz: 934e5d22043fc74251b2321532897cbff7d06e63b722321e99fb00ca2711d23abfc853234642bb6c72db2dddcafad58d324a5e0251c9f36a42e2755df18eb765

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in bright.gemspec
 gemspec

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-

data/bright.gemspec

@@ -1,21 +1,19 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bright/version'
+require "bright/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "bright"
-  spec.version       = Bright::VERSION
-  spec.authors       = ["Arux Software"]
-  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      = "https://github.com/Arux-Software/Bright"
-  spec.license       = "MIT"
+  spec.name = "bright"
+  spec.version = Bright::VERSION
+  spec.authors = ["Arux Software"]
+  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 = "https://github.com/Arux-Software/Bright"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "httpi", "~> 2.1"

data/lib/bright/address.rb

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

data/lib/bright/connection.rb

@@ -1,7 +1,7 @@
-require 'uri'
-require 'httpi'
-require 'benchmark'
-require 'securerandom'
+require "uri"
+require "httpi"
+require "benchmark"
+require "securerandom"
 
 module Bright
   class Connection
@@ -23,10 +23,10 @@ module Bright
     attr_accessor :proxy_port
 
     def initialize(endpoint)
-      @endpoint     = endpoint.is_a?(URI) ? endpoint : URI.parse(endpoint)
+      @endpoint = endpoint.is_a?(URI) ? endpoint : URI.parse(endpoint)
       @open_timeout = OPEN_TIMEOUT
       @read_timeout = READ_TIMEOUT
-      @verify_peer  = VERIFY_PEER
+      @verify_peer = VERIFY_PEER
       @ignore_http_status = false
       @ssl_version = nil
       @proxy_address = nil
@@ -36,7 +36,6 @@ module Bright
         @logger = Logger.new(STDOUT)
         @logger.level = Logger::INFO
       end
-
     end
 
     def request(method, body, headers = {})
@@ -83,7 +82,6 @@ module Bright
       end
 
       handle_response(result)
-
     ensure
       info "connection_request_total_time=%.4fs" % [Time.now.to_f - request_start], tag
     end
@@ -101,7 +99,7 @@ module Bright
 
     def handle_response(response)
       if @ignore_http_status or !response.error?
-        return response
+        response
       else
         raise ResponseError.new(response, endpoint.to_s)
       end

data/lib/bright/contact.rb

@@ -1,12 +1,12 @@
-require 'securerandom'
+require "securerandom"
 
 module Bright
   class Contact < Model
     @attribute_names = [:client_id, :api_id, :first_name, :middle_name, :last_name, :nick_name,
-                        :birth_date, :sex, :relationship_type,
-                        :hispanic_ethnicity, :race, :image,
-                        :sis_student_id, :state_student_id, :last_modified]
-    attr_accessor *@attribute_names
+      :birth_date, :sex, :relationship_type,
+      :hispanic_ethnicity, :race, :image,
+      :sis_student_id, :state_student_id, :last_modified]
+    attr_accessor(*@attribute_names)
 
     def self.attribute_names
       @attribute_names
@@ -18,7 +18,7 @@ module Bright
       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)}
+        @phone_numbers = array.collect { |a| PhoneNumber.new(a) }
       end
       @phone_numbers ||= []
     end
@@ -31,7 +31,7 @@ module Bright
       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)}
+        @addresses = array.collect { |a| Address.new(a) }
       end
       @addresses ||= []
     end
@@ -46,8 +46,6 @@ module Bright
       elsif email.is_a?(Hash)
         @email_address = EmailAddress.new(email)
       end
-      @email_address
     end
-
   end
 end

data/lib/bright/cursor_response_collection.rb

@@ -1,5 +1,4 @@
 class CursorResponseCollection < ResponseCollection
-
   attr_accessor :collected_objects
 
   def initialize(options = {})
@@ -10,7 +9,7 @@ class CursorResponseCollection < ResponseCollection
   end
 
   def each
-    while (!@next_cursor.blank?) do
+    until @next_cursor.blank?
       objects_hsh = load_more_call.call(@next_cursor)
       objects = objects_hsh[:objects]
       @next_cursor = objects_hsh[:next_cursor]
@@ -22,8 +21,8 @@ class CursorResponseCollection < ResponseCollection
   end
 
   def last
-    self.to_a
-    return @collected_objects.last
+    to_a
+    @collected_objects.last
   end
 
   def loaded_results
@@ -31,15 +30,14 @@ class CursorResponseCollection < ResponseCollection
   end
 
   def total
-    self.to_a
-    self.loaded_results.size
+    to_a
+    loaded_results.size
   end
 
-  alias size total
-  alias length total
+  alias_method :size, :total
+  alias_method :length, :total
 
   def empty?
-    self.to_a.empty?
+    to_a.empty?
   end
-
 end

data/lib/bright/email_address.rb

@@ -1,7 +1,6 @@
 module Bright
   class EmailAddress < Model
     @attribute_names = [:email_address]
-    attr_accessor *@attribute_names
-    
+    attr_accessor(*@attribute_names)
   end
 end

data/lib/bright/enrollment.rb

@@ -1,7 +1,7 @@
 module Bright
   class Enrollment < Model
     @attribute_names = [:entry_date, :entry_comment, :exit_date, :exit_comment, :grade]
-    attr_accessor *@attribute_names
+    attr_accessor(*@attribute_names)
     attr_accessor :student, :school
   end
-end
+end

data/lib/bright/errors.rb

@@ -19,7 +19,6 @@ module Bright
     def server_error?
       (500..599).include?(response&.code.to_i)
     end
-
   end
 
   class UnknownAttributeError < NoMethodError

data/lib/bright/helpers/blank_helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Object
   def blank?
     respond_to?(:empty?) ? !!empty? : !self

data/lib/bright/model.rb

@@ -1,33 +1,33 @@
 module Bright
   class Model
     @attribute_names = []
-    
-    def initialize(attributes={})
+
+    def initialize(attributes = {})
       assign_attributes(attributes) if attributes
 
       super()
     end
-    
+
     def assign_attributes(new_attributes)
       if !new_attributes.is_a?(Hash)
         raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
       end
       return if new_attributes.empty?
 
-      attributes = Hash[new_attributes.collect{|k,v| [k.to_sym, v]}]
+      attributes = new_attributes.collect { |k, v| [k.to_sym, v] }.to_h
       _assign_attributes(attributes)
     end
-    
+
     def self.attribute_names
       @attribute_names
     end
-    
+
     def to_json
-      Hash[self.class.attribute_names.collect do |n|
-        [n, self.send(n)]
-      end].to_json
+      self.class.attribute_names.collect do |n|
+        [n, send(n)]
+      end.to_h.to_json
     end
-    
+
     private
 
     def _assign_attributes(attributes)
@@ -37,11 +37,11 @@ module Bright
     end
 
     def _assign_attribute(k, v)
-      if respond_to?("#{k}=")
-        public_send("#{k}=", v)
+      if respond_to?(:"#{k}=")
+        public_send(:"#{k}=", v)
       else
         raise UnknownAttributeError.new(self, k)
       end
     end
   end
-end
+end

data/lib/bright/phone_number.rb

@@ -1,7 +1,7 @@
 module Bright
   class PhoneNumber < Model
     @attribute_names = [:phone_number, :extension, :type]
-    attr_accessor *@attribute_names
+    attr_accessor(*@attribute_names)
     TYPES = ["Cell", "Home", "Work", "Other"]
 
     def phone_number=(number)
@@ -15,6 +15,5 @@ module Bright
     def extension=(number)
       @extension = number.gsub(/[^0-9]/, "").strip
     end
-
   end
 end

data/lib/bright/response_collection.rb

@@ -1,4 +1,4 @@
-require 'parallel'
+require "parallel"
 
 class ResponseCollection
   include Enumerable
@@ -15,7 +15,7 @@ class ResponseCollection
     @paged_objects = {0 => options[:seed_page]}
     @total = options[:total].to_i
     @per_page = options[:per_page].to_i
-    @pages = @per_page > 0 ? (@total.to_f / @per_page.to_f).ceil : 0
+    @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
@@ -23,10 +23,10 @@ class ResponseCollection
   def each
     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
+        @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|
@@ -47,8 +47,8 @@ class ResponseCollection
     @paged_objects.values.flatten
   end
 
-  alias size total
-  alias length total
+  alias_method :size, :total
+  alias_method :length, :total
 
   def empty?
     total <= 0

data/lib/bright/school.rb

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

data/lib/bright/sis_apis/aeries.rb

@@ -1,7 +1,7 @@
 module Bright
   module SisApi
     class Aeries < Base
-      DATE_FORMAT = '%Y-%m-%dT%H:%M:%S'
+      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"
@@ -18,11 +18,11 @@ module Bright
       end
 
       def get_student_by_api_id(api_id)
-        get_students({:api_id => api_id, :limit => 1}).first
+        get_students({api_id: api_id, limit: 1}).first
       end
 
       def get_student(params)
-        get_students(params.merge(:limit => 1)).first
+        get_students(params.merge(limit: 1)).first
       end
 
       def get_students(params)
@@ -43,15 +43,15 @@ module Bright
 
       def get_students_by_school(school, params = {})
         school_api_id = school.is_a?(School) ? school.api_id : school
-        if params.has_key?(:api_id)
-          path = "api/schools/#{school_api_id}/students/#{params[:api_id]}"
+        path = if params.has_key?(:api_id)
+          "api/schools/#{school_api_id}/students/#{params[:api_id]}"
         elsif params.has_key?(:sis_student_id)
-          path = "api/schools/#{school_api_id}/students/sn/#{params[:sis_student_id]}"
+          "api/schools/#{school_api_id}/students/sn/#{params[:sis_student_id]}"
         else
-          path = "api/schools/#{school_api_id}/students"
+          "api/schools/#{school_api_id}/students"
         end
-        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))}
+        students_response_hash = request(:get, path, map_student_search_params(params))
+        students_response_hash.collect { |shsh| Student.new(convert_to_student_data(shsh)) }
       end
 
       def create_student(student)
@@ -63,13 +63,13 @@ module Bright
       end
 
       def get_schools(params = {})
-        schools_response_hash = self.request(:get, 'api/v2/schools', params)
+        schools_response_hash = request(:get, "api/v2/schools", params)
 
-        schools_response_hash.collect{|h| School.new(convert_to_school_data(h))}
+        schools_response_hash.collect { |h| School.new(convert_to_school_data(h)) }
       end
 
       def request(method, path, params = {})
-        uri  = "#{self.connection_options[:uri]}/#{path}"
+        uri = "#{connection_options[:uri]}/#{path}"
         body = nil
         if method == :get
           query = URI.encode_www_form(params)
@@ -80,7 +80,7 @@ module Bright
 
         response = connection_retry_wrapper {
           connection = Bright::Connection.new(uri)
-          headers = self.headers_for_auth
+          headers = headers_for_auth
           connection.request(method, body, headers)
         }
 
@@ -119,9 +119,9 @@ module Bright
           end
         end
 
-        #SchoolCode
+        # SchoolCode
 
-        cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        cattrs.reject { |k, v| v.respond_to?(:empty?) ? v.empty? : v.nil? }
       end
 
       def convert_to_school_data(attrs)
@@ -131,16 +131,15 @@ module Bright
         cattrs[:name] = attrs["Name"]
         cattrs[:number] = attrs["SchoolCode"]
 
-        cattrs.reject{|k,v| v.respond_to?(:empty?) ? v.empty? : v.nil?}
+        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"
+          "AERIES-CERT" => connection_options[:certificate],
+          "Content-Type" => "application/json"
         }
       end
-
     end
   end
 end

data/lib/bright/sis_apis/base.rb

@@ -1,7 +1,6 @@
 module Bright
   module SisApi
     class Base
-
       def filter_students_by_params(students, params)
         total = params[:limit]
         count = 0
@@ -12,7 +11,7 @@ module Bright
         students.each do |student|
           break if total and count >= total
 
-          should = (keys).all? do |m|
+          should = keys.all? do |m|
             student.send(m) =~ Regexp.new(Regexp.escape(params[m]), Regexp::IGNORECASE)
           end
           count += 1 if total and should
@@ -29,7 +28,7 @@ module Bright
         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}"
+            puts "retrying #{retries}: #{e.class} - #{e}"
             sleep(retries * 3)
             retry
           else
@@ -38,7 +37,7 @@ module Bright
         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}"
+            puts "retrying #{retries}: #{e.class} - #{e}"
             sleep(retries * 3)
             retry
           else
@@ -46,7 +45,6 @@ module Bright
           end
         end
       end
-
     end
   end
 end