bright 0.1.0

data/lib/bright/sis_apis/tsis.rb

@@ -0,0 +1,248 @@
+require 'base64'
+require 'json'
+
+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] || {}
+        # {
+        #   :key => "",
+        #   :secret => "",
+        #   :district_id => "",
+        #   :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 
+        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
+        if found_student.nil?
+          # Students/Family can get you students that are not enrolled in a school for a given school year.
+          family_response_hash = self.request(:get, 'Students/Family/', self.map_search_params(params))
+          if family_response_hash["Return"] and family_response_hash["Return"].first
+            found_student =  Student.new(convert_to_student_data(family_response_hash["Return"].first))
+          end
+        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))
+        else
+          # 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|
+            # pages start at one, so add a page here
+            api.get_students(params, {:wrap_in_collection => false, :page => (page + 1)})
+          }
+
+          ResponseCollection.new({
+            :seed_page => students, 
+            :total => total_results,
+            :per_page => options[:per_page], 
+            :load_more_call => load_more_call
+          })
+        else
+          students
+        end
+      end
+      
+      def create_student(student, additional_params = {})
+        raise NotImplementedError, "TSIS does not support creating students"
+      end
+      
+      def update_student(student, additional_params = {})
+        raise NotImplementedError, "TSIS does not support updating students"
+      end
+      
+      def get_schools(params = {}, options = {})
+        params = self.apply_options(params, options)
+
+        # schools api end point takes page # in the url itself for some reason
+        schools_response_hash = self.request(:get, self.apply_page_to_url('Schools/', options[:page]), params)
+
+        schools = schools_response_hash["Return"].collect{|hsh| School.new(convert_to_school_data(hsh))}
+        total_results = schools_response_hash["TotalCount"].to_i
+
+        if options[:wrap_in_collection] != false
+          api = self
+          load_more_call = proc { |page|
+            # pages start at one, so add a page here
+            api.get_schools(params, {:wrap_in_collection => false, :page => (page + 1)})
+          }
+
+          ResponseCollection.new({
+            :seed_page => schools,
+            :total => total_results,
+            :per_page => options[:per_page],
+            :load_more_call => load_more_call
+          })
+        else
+          schools
+        end
+      end
+            
+      def request(method, path, params = {})
+        uri  = "#{self.connection_options[:uri]}/#{path}"
+        body = nil
+        query = URI.encode(params.map{|k,v| "#{k}=#{v}"}.join("&"))
+        if method == :get
+          uri += "?#{query}"
+        else
+          body = query
+        end
+        
+        headers = self.headers_for_auth(uri)
+
+        connection = Bright::Connection.new(uri)
+        response = 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)
+
+        params = Hash[params.collect do |k,v|
+          if v.is_a?(Array)
+            v = v.join(",")
+          end
+          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"]
+          split_name = attrs["StudentName"].strip.split(",")
+          if split_name[1]
+            split_first_name = split_name[1].to_s.strip.split(" ")
+            if split_first_name.size > 1
+              catt[:first_name]       = split_first_name[0...-1].join(" ").strip
+              catt[:middle_name]      = split_first_name[-1].strip
+            else
+              catt[:first_name] = split_first_name.first.strip
+            end
+          end
+          catt[:last_name]        = split_name[0].to_s.strip
+        else
+          catt[:first_name]       = attrs["FirstName"].strip
+          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
+        catt[:homeless_code]    = attrs["HomelessCode"]
+
+        # "Economic\":{\"Description\":\"\",\"EconomicIndicatorId\":\"0\"}
+
+        bd = attrs["BirthDate"] || attrs["StudentBirthDate"]
+        if !(bd.nil? or bd.empty?)
+          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 = {}
+
+        if attrs["Line1"]
+          cattrs[:street] = "#{attrs["Line1"]}\n#{attrs["Line2"]}\n#{attrs["Line3"]}".strip
+        elsif attrs["Address1"]
+          cattrs[:street] = "#{attrs["Address1"]}\n#{attrs["Address2"]}".strip
+        end
+        cattrs[:city] = attrs["City"]
+        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],
+            'ties-date' => t,
+            'Content-Type' => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/bright/student.rb

@@ -0,0 +1,53 @@
+require 'securerandom'
+
+module Bright
+  class Student < Model
+    @attribute_names = [:client_id, :api_id, :first_name, :middle_name, :last_name, :nick_name, 
+                        :birth_date, :grade, :projected_graduation_year, :gender, 
+                        :hispanic_ethnicity, :race, :image, :primary_language, :secondary_language, 
+                        :homeless_code, :frl_status, :sis_student_id, 
+                        :state_student_id, :last_modified]
+    attr_accessor *@attribute_names
+    
+    def self.attribute_names
+      @attribute_names
+    end
+    
+    # TODO:: map contact info (addresses, email, phone, etc)
+    attr_accessor :enrollment, :addresses
+
+    def initialize(*args)
+      super
+      self.client_id ||= SecureRandom.uuid
+      self
+    end
+    
+    def name
+      "#{self.first_name} #{self.middle_name} #{self.last_name}".gsub(/\s+/, " ").strip
+    end
+    
+    def <=>(other)
+      (self.sis_student_id and self.sis_student_id == other.sis_student_id) or
+      (self.state_student_id and self.state_student_id == other.state_student_id) or
+      (self.first_name == other.first_name and self.middle_name == other.middle_name and self.last_name == other.last_name and self.birth_date == other.birth_date)
+    end
+    
+    alias id client_id
+    
+    def addresses=(array)
+      if array.size <= 0 or array.first.is_a?(Address)
+        @addresses = array
+        @addresses.each{|a| a.student = self}
+      elsif array.first.is_a?(Hash)
+        @addresses = array.collect{|a| Address.new(a)}
+      end
+      @addresses ||= []
+    end
+    
+    def addresses
+      @addresses ||= []
+    end
+  end
+end
+
+

data/lib/bright/version.rb

@@ -0,0 +1,3 @@
+module Bright
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: bright
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arux Software
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+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.
+email:
+- sheuer@aruxsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bright.gemspec
+- lib/bright.rb
+- lib/bright/address.rb
+- lib/bright/connection.rb
+- lib/bright/enrollment.rb
+- lib/bright/errors.rb
+- lib/bright/model.rb
+- lib/bright/response_collection.rb
+- lib/bright/school.rb
+- lib/bright/sis_apis/aeries.rb
+- lib/bright/sis_apis/base.rb
+- lib/bright/sis_apis/infinite_campus.rb
+- lib/bright/sis_apis/power_school.rb
+- lib/bright/sis_apis/synergy.rb
+- lib/bright/sis_apis/tsis.rb
+- lib/bright/student.rb
+- lib/bright/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Framework and tools for dealing with Student Information Systems
+test_files: []