bright 0.1.0 → 1.1

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, additional_params = {})
+
+      def create_student(student)
         raise NotImplementedError
       end
-      
-      def update_student(student, additional_params = {})
+
+      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

data/lib/bright/sis_apis/bright_sis.rb

@@ -0,0 +1,305 @@
+module Bright
+  module SisApi
+    class BrightSis < Base
+
+      @@description = "Connects to the Bright SIS Data Store"
+      @@doc_url = ""
+      @@api_version = "v1"
+
+      attr_accessor :connection_options
+
+      DEMOGRAPHICS_CONVERSION = {
+        "I"=>"American Indian Or Alaska Native",
+        "A"=>"Asian",
+        "B"=>"Black Or African American",
+        "P"=>"Native Hawaiian Or Other Pacific Islander",
+        "W"=>"White",
+        "M"=>"Other"
+      }
+
+      def initialize(options = {})
+        self.connection_options = options[:connection] || {}
+        # {
+        #   :access_token => ""
+        #   :uri => ""
+        # }
+      end
+
+      def get_student_by_api_id(api_id, options = {})
+        self.get_students({"uuid" => api_id}, options.merge(:limit => 1, :wrap_in_collection => false)).first
+      end
+
+      def get_student(params = {}, options = {})
+        self.get_students(params, options.merge(:limit => 1, :wrap_in_collection => false)).first
+      end
+
+      def get_students(params = {}, options = {})
+        params[:limit] = params[:limit] || options[:limit] || 100
+        students_response_hash = self.request(:get, 'students', self.map_student_search_params(params))
+        total_results = students_response_hash[:response_headers]["total"].to_i
+        if students_response_hash and students_response_hash["students"]
+          students_hash = [students_response_hash["students"]].flatten
+
+          students = students_hash.compact.collect {|st_hsh|
+            Student.new(convert_to_student_data(st_hsh))
+          }
+        end
+        if options[:wrap_in_collection] != false
+          api = self
+          load_more_call = proc { |page|
+            # pages start at one, so add a page here
+            params[:offset] = (params[:limit].to_i * page)
+            api.get_students(params, {:wrap_in_collection => false})
+          }
+          ResponseCollection.new({
+            :seed_page => students,
+            :total => total_results,
+            :per_page => params[:limit],
+            :load_more_call => load_more_call,
+            :no_threads => options[:no_threads]
+          })
+        else
+          students
+        end
+      end
+
+      def create_student(student)
+        raise NotImplementedError
+      end
+
+      def update_student(student)
+        raise NotImplementedError
+      end
+
+      def get_schools(params = {}, options = {})
+        params[:limit] = params[:limit] || options[:limit] || 100
+        schools_response_hash = self.request(:get, 'schools', self.map_school_search_params(params))
+        total_results = schools_response_hash[:response_headers]["total"].to_i
+        if schools_response_hash and schools_response_hash["schools"]
+          schools_hash = [schools_response_hash["schools"]].flatten
+
+          schools = schools_hash.compact.collect {|st_hsh|
+            School.new(convert_to_school_data(st_hsh))
+          }
+        end
+        if options[:wrap_in_collection] != false
+          api = self
+          load_more_call = proc { |page|
+            # pages start at one, so add a page here
+            params[:offset] = (params[:limit].to_i * page)
+            api.get_schools(params, {:wrap_in_collection => false})
+          }
+          ResponseCollection.new({
+            :seed_page => schools,
+            :total => total_results,
+            :per_page => params[:limit],
+            :load_more_call => load_more_call,
+            :no_threads => options[:no_threads]
+          })
+        else
+          schools
+        end
+      end
+
+      def request(method, path, params = {})
+        uri  = "#{self.connection_options[:uri]}/#{path}"
+        body = nil
+        if method == :get
+          query = URI.encode_www_form(params)
+          uri += "?#{query}" unless query.strip == ""
+        else
+          body = JSON.dump(params)
+        end
+
+        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)
+          response_hash[:response_headers] = response.headers
+        else
+          puts "#{response.inspect}"
+          puts "#{response.body}"
+        end
+        response_hash
+      end
+
+      protected
+
+      def headers_for_auth(uri)
+        {"Authorization" => "Token token=#{self.connection_options[:access_token]}"}
+      end
+
+      def map_student_search_params(attrs)
+        filter_params = {}
+        attrs.each do |k,v|
+          case k.to_s
+          when "api_id"
+            filter_params["uuid"] = v
+          when "sis_student_id"
+            filter_params["student_number"] = v
+          when "state_student_id"
+            filter_params["state_id"] = v
+          else
+            filter_params[k] = v
+          end
+        end
+        return filter_params
+      end
+
+      def convert_to_student_data(student_params)
+        return {} if student_params.nil?
+        student_data_hsh = {
+          :api_id => student_params["uuid"],
+          :first_name => student_params["first_name"],
+          :middle_name => student_params["middle_name"],
+          :last_name => student_params["last_name"],
+          :sis_student_id => student_params["student_number"],
+          :state_student_id => student_params["state_id"],
+          :grade => student_params["grade"],
+          :grade_school_year => student_params["grade_school_year"],
+          :projected_graduation_year => student_params["graduation_year"],
+          :gender => student_params["gender"],
+          :frl_status => student_params["frl_status"],
+          :image => student_params["picture"],
+          :hispanic_ethnicity => student_params["hispanic_latino"],
+          :last_modified => student_params["updated_at"]
+        }.reject{|k,v| v.blank?}
+        unless student_params["birthdate"].blank?
+          student_data_hsh[:birth_date] = Date.parse(student_params["birthdate"]).to_s
+        end
+
+        DEMOGRAPHICS_CONVERSION.each do |demographics_key, demographics_value|
+          if student_params["race"].to_s.upcase.include?(demographics_key)
+            student_data_hsh[:race] ||= []
+            student_data_hsh[:race] << demographics_value
+          end
+        end
+
+        unless student_params["addresses"].blank?
+          student_data_hsh[:addresses] = student_params["addresses"].collect do |address_params|
+            convert_to_address_data(address_params)
+          end
+        end
+
+        unless student_params["phone_numbers"].blank?
+          student_data_hsh[:phone_numbers] = student_params["phone_numbers"].collect do |phone_params|
+            convert_to_phone_number_data(phone_params)
+          end
+        end
+
+        unless student_params["email_addresses"].blank?
+          student_data_hsh[:email_address] = {
+            :email_address => student_params["email_addresses"].first["email_address"]
+          }
+        end
+
+        unless student_params["school"].blank?
+          student_data_hsh[:school] = convert_to_school_data(student_params["school"])
+        end
+
+        unless student_params["contacts"].blank?
+          student_data_hsh[:contacts] = student_params["contacts"].collect do |contact_params|
+            contact_data_hsh = {
+              :api_id => contact_params["uuid"],
+              :first_name => contact_params["first_name"],
+              :middle_name => contact_params["middle_name"],
+              :last_name => contact_params["last_name"],
+              :relationship_type => contact_params["relationship"],
+              :sis_student_id => contact_params["sis_id"],
+              :last_modified => contact_params["updated_at"]
+            }
+            unless contact_params["addresses"].blank?
+              contact_data_hsh[:addresses] = contact_params["addresses"].collect do |address_params|
+                convert_to_address_data(address_params)
+              end
+            end
+            unless contact_params["phone_numbers"].blank?
+              contact_data_hsh[:phone_numbers] = contact_params["phone_numbers"].collect do |phone_params|
+                convert_to_phone_number_data(phone_params)
+              end
+            end
+            unless contact_params["email_addresses"].blank?
+              contact_data_hsh[:email_address] = {
+                :email_address => contact_params["email_addresses"].first["email_address"]
+              }
+            end
+            contact_data_hsh.reject{|k,v| v.blank?}
+          end
+        end
+
+        return student_data_hsh
+      end
+
+      def map_school_search_params(attrs)
+        filter_params = {}
+        attrs.each do |k,v|
+          case k.to_s
+          when "api_id"
+            filter_params["id"] = v
+          else
+            filter_params[k] = v
+          end
+        end
+        return filter_params
+      end
+
+      def convert_to_phone_number_data(phone_number_params)
+        return {} if phone_number_params.nil?
+        {
+          :phone_number => phone_number_params["phone_number"],
+          :type => phone_number_params["phone_type"]
+        }.reject{|k,v| v.blank?}
+      end
+
+      def convert_to_address_data(address_params)
+        return {} if address_params.nil?
+        {
+          :street => address_params["street"],
+          :apt => address_params["street_line_2"],
+          :city => address_params["city"],
+          :state => address_params["state"],
+          :postal_code => address_params["zip"],
+          :lattitude => address_params["latitude"],
+          :longitude => address_params["longitude"],
+          :type => address_params["address_type"]
+        }.reject{|k,v| v.blank?}
+      end
+
+      def convert_to_school_data(school_params)
+        return {} if school_params.nil?
+
+        school_data_hsh = {
+          :api_id => school_params["id"],
+          :name => school_params["name"],
+          :number => school_params["number"],
+          :state_id => school_params["state_id"],
+          :low_grade => school_params["low_grade"],
+          :high_grade => school_params["high_grade"],
+          :last_modified => school_params["updated_at"]
+        }
+
+        unless school_params["school_address"].blank?
+          school_data_hsh[:address] = {
+            :street => school_params["school_address"],
+            :city => school_params["school_city"],
+            :state => school_params["school_state"],
+            :postal_code => school_params["school_zip"]
+          }
+        end
+
+        unless school_params["school_phone"].blank?
+          school_data_hsh[:phone_number] = {
+            :phone_number => school_params["school_phone"]
+          }
+        end
+
+        return school_data_hsh
+      end
+
+    end
+  end
+end