old_school 0.0.5

data/README.md

@@ -0,0 +1,4 @@
+old_school
+==========
+
+Ruby Gem to interface with a Powerful SIS

data/lib/old_school.rb

@@ -0,0 +1,19 @@
+require 'virtus'
+
+require 'old_school/virtus_ext'
+require 'old_school/core_ext'
+require 'old_school/csv'
+
+require 'old_school/api'
+require 'old_school/models/student'
+require 'old_school/models/name'
+require 'old_school/models/contact_info'
+require 'old_school/models/demographics'
+require 'old_school/models/school'
+require 'old_school/models/section'
+require 'old_school/models/course'
+require 'old_school/models/term'
+require 'old_school/models/assignment'
+require 'old_school/models/assignment_score'
+require 'old_school/models/section_enrollment'
+require 'old_school/models/staff'

data/lib/old_school/api.rb

@@ -0,0 +1,209 @@
+require_relative 'api/utils'
+require_relative 'api/url_factory'
+
+module OldSchool
+  class API
+    include Utils
+
+    def initialize(host, id, secret)
+      @url_factory = URLFactory.new(host)
+      self.id = id
+      self.secret = secret
+      self.token = nil
+    end
+
+    #Assignment Resource
+    def get_assignment(assignment_id)
+      hash_from_response get(@url_factory.assignment_url(assignment_id)), 'assignment'
+    end
+
+    def get_assignments(assignment_ids)
+      get_many assignment_ids, 'assignment', ->(id){ @url_factory.assignment_url(id) }
+    end
+
+    def update_assignment(assignment_id, assignment)
+      put @url_factory.assignment_url(assignment_id), {assignment: assignment}.to_json
+    end
+
+    def delete_assignment(assignment_id)
+      delete @url_factory.assignment_url(assignment_id)
+    end
+
+    def update_student_assignment_score(assignment_id, student_id, assignment_score)
+      put @url_factory.assignment_student_score_url(assignment_id, student_id), {assignment_score: assignment_score}.to_json
+    end
+
+    def get_student_assignment_score(assignment_id, student_id)
+      hash_from_response get(@url_factory.assignment_student_score_url(assignment_id, student_id)), 'assignment_score'
+    end
+
+    def get_student_assignment_scores(assignment_id, student_ids)
+      get_many student_ids, 'assignment_score', ->(id){ @url_factory.assignment_student_score_url(assignment_id, id) }
+    end
+
+    def update_multiple_student_assignment_scores(assignment_id, assignment_scores)
+      put @url_factory.assignment_score_url(assignment_id), {assignment_scores: {assignment_score: assignment_scores}}.to_json
+    end
+
+    def get_multiple_student_assignment_scores(assignment_id)
+      hash_from_response get(@url_factory.assignment_score_url(assignment_id)), %w(assignment_scores assignment_score)
+    end
+
+    def delete_assignment_score(assignment_id, student_id)
+      delete @url_factory.assignment_student_score_url(assignment_id, student_id)
+    end
+
+    #School Resource
+    def get_students_by_school(school_id)
+      num_students = get_students_count_by_school(school_id)
+      results = get_with_pagination_url('student', num_students) {|page|
+        @url_factory.school_students_url(school_id, {
+          page: page,
+          expansions: 'contact_info,demographics'
+        })
+      }
+      results.map { |item| OldSchool::Student.new({school_id: school_id}.merge(item)) }
+    end
+
+    def get_students_count_by_school(school_id)
+      hash_from_response get(@url_factory.school_student_count_url(school_id)), %w(resource count)
+    end
+
+    def get_staff_by_school(school_id)
+      num_staff = get_staff_count_by_school(school_id)
+      results = get_with_pagination_url('staff', num_staff) {|page|
+        @url_factory.school_staff_index_url(school_id, {page: page})
+      }
+      results.map { |item|
+        attributes = {school_id: school_id}.merge(item)
+        OldSchool::Staff.new(attributes)
+      }
+    end
+
+    def get_staff_count_by_school(school_id)
+      hash_from_response get(@url_factory.school_staff_count_url(school_id)), %w(resource count)
+    end
+
+    def get_sections_by_school(school_id, start_year = nil)
+      num_sections = get_section_count_by_school(school_id, start_year)
+      results = get_with_pagination_url('section', num_sections) { |page|
+        query = {page: page}
+        query["q"] = "term.start_year==#{ start_year }" unless start_year.nil?
+        @url_factory.school_sections_url(school_id, query)
+      }
+      results.map { |item| OldSchool::Section.new({school_id: school_id}.merge(item)) }
+    end
+
+    def get_section_count_by_school(school_id, start_year = nil)
+      query = {}
+      query["q"] = "term.start_year==#{ start_year }" unless start_year.nil?
+      url = @url_factory.school_section_count_url(school_id, query)
+      hash_from_response get(url), %w(resource count)
+    end
+
+    def get_terms_by_school(school_id, start_year = nil)
+      num_terms = get_terms_count_by_school(school_id, start_year)
+      results = get_with_pagination_url('term', num_terms) do |page|
+        query = {page: page}
+        query["q"] = "start_year==#{ start_year }" unless start_year.nil?
+        @url_factory.school_terms_url(school_id, query)
+      end
+      results.map { |item| OldSchool::Term.new({school_id: school_id}.merge(item)) }
+    end
+
+    def get_terms_count_by_school(school_id, start_year = nil)
+      query = {}
+      query["q"] = "start_year==#{ start_year }" unless start_year.nil?
+      url = @url_factory.school_term_count_url(school_id, query)
+      hash_from_response get(url), %w(resource count)
+    end
+
+    def get_courses_by_school(school_id)
+      num_courses = get_course_count_by_school(school_id)
+      results = get_with_pagination_url('course', num_courses) {|page|
+        @url_factory.school_courses_url(school_id, {page: page})
+      }
+      results.map { |item| OldSchool::Course.new({school_id: school_id}.merge(item)) }
+    end
+
+    def get_course_count_by_school(school_id)
+      hash_from_response get(@url_factory.school_course_count_url(school_id)), %w(resource count)
+    end
+
+    def get_schools_in_current_district
+      num_schools = get_school_count_in_current_district
+      results = get_with_pagination_url('school', num_schools) {|page|
+        @url_factory.district_schools_url({
+          page: page,
+        })
+      }
+      results.map { |item| OldSchool::School.new(item) }
+    end
+
+    def get_school_count_in_current_district
+      hash_from_response get(@url_factory.district_school_count_url), %w(resource count)
+    end
+
+    def get_school_by_id(school_id)
+      hash_from_response get(@url_factory.school_url(school_id)), 'school'
+    end
+
+    def get_current_district
+      hash_from_response get(@url_factory.district_url), 'district'
+    end
+
+    #staff resources
+    def get_staff_by_id(staff_id)
+      hash_from_response get(@url_factory.staff_url(staff_id)), 'staff'
+    end
+
+    #student resource
+    def get_student_by_id(student_id)
+      hash_from_response get(@url_factory.student_url(student_id)), 'student'
+    end
+
+    #term resource
+    def get_term_by_id(term_id)
+      hash_from_response get(@url_factory.term_url(term_id)), 'term'
+    end
+
+    #Section Enrollment Resource
+    def get_section_enrollment_by_id(section_enrollment_id)
+      hash_from_response get(@url_factory.section_enrollment_url(section_enrollment_id)), 'section_enrollment'
+    end
+
+    def get_section_by_id(section_id)
+      hash_from_response get(@url_factory.section_url(section_id)),'section'
+    end
+
+    def get_section_enrollments_by_section_id(section_id)
+      results = collection_from_response get(@url_factory.section_section_enrollments_url(section_id)), %w(section_enrollments section_enrollment)
+      results.map { |item| OldSchool::SectionEnrollment.new(item) }
+    end
+
+    #Section Resource
+    def add_assignment_to_section(section_id, assignment)
+      url = @url_factory.section_assignments_url(section_id)
+      data = { assignment: hash_without_nil_values(assignment) }.to_json
+      response = post url, data
+      case response.code
+      when 201
+        assignment_id_from_response response
+      else
+        code, msg = parse_error(response)
+        case error["errors"]["code"]
+        when "MISSING_DATE_ASSIGNMENT_DUE"
+          raise MissingRequiredField, msg
+        when "ASSIGNMENT_NAME_OR_ABBREVIATION_IN_USE"
+          raise AlreadyExists, msg
+        else
+          raise ResponseError, msg
+        end
+      end
+    end
+
+    def assignment_id_from_response(response)
+      response.headers["Location"].split(/[\s\/]/).last
+    end
+  end
+end

data/lib/old_school/api/url_factory.rb

@@ -0,0 +1,181 @@
+require 'uri'
+
+module OldSchool
+  class API
+    class URLFactory
+      PTG_V2_NAMESPACE = '/powerschool-ptg-api/v2'
+
+      WS_V1_NAMESPACE = '/ws/v1'
+      WS_V1_RESOURCES = %w{school staff student term section_enrollment section}
+      WS_V1_RESOURCES_NESTED_IN_DISTRICT = %w{school}
+      WS_V1_RESOURCES_NESTED_IN_SCHOOL = %w{student section term course}
+
+      def initialize(host_with_protocol)
+        @base_uri = URI.parse(host_with_protocol)
+        if @base_uri.scheme.nil?
+          @base_uri = URI.parse('https://' + host_with_protocol)
+        end
+      end
+
+      def base_url
+        @base_uri.to_s
+      end
+
+      def access_token_url
+        merge_with_base '/oauth/access_token'
+      end
+
+      def assignment_url(id)
+        merge_with_base ptg_v2_resource_path('assignment', id)
+      end
+
+      def assignment_score_url(id)
+        merge_with_base assignment_score_path(id)
+      end
+
+      def assignment_student_score_url(assignment_id, student_id)
+        merge_with_base assignment_student_score_path(assignment_id, student_id)
+      end
+
+      def district_url
+        merge_with_base ws_v1_resource_path('district')
+      end
+
+      WS_V1_RESOURCES_NESTED_IN_DISTRICT.each do |resource|
+        define_method "district_#{ resource }_count_url" do |query = {}|
+          merge_with_base district_resource_uri(resource, 'count', query)
+        end
+
+        define_method "district_#{ resource }s_url" do |query = {}|
+          merge_with_base district_resource_uri(resource, query)
+        end
+      end
+
+      WS_V1_RESOURCES.each do |resource|
+        define_method "#{ resource }_url" do |id|
+          merge_with_base ws_v1_resource_path(resource, id)
+        end
+      end
+
+      def metadata_url
+        merge_with_base ws_v1_resource_path('metadata')
+      end
+
+      def merge_with_base(path_or_uri)
+        new_uri = @base_uri.dup
+        if String === path_or_uri
+          new_uri.path += path_or_uri
+          new_uri.path.gsub!(/\/\//, '/')
+        else
+          new_uri.path += path_or_uri.path
+          new_uri.query = path_or_uri.query
+        end
+        new_uri.to_s
+      end
+
+      def section_assignments_url(section_id)
+        merge_with_base section_assignments_path(section_id)
+      end
+
+      def section_section_enrollments_url(section_id)
+        merge_with_base section_section_enrollments_path(section_id)
+      end
+
+      def school_url(id)
+        merge_with_base school_resource_uri(id)
+      end
+
+      WS_V1_RESOURCES_NESTED_IN_SCHOOL.each do |resource|
+        define_method "school_#{ resource }_count_url" do |id, query = {}|
+          merge_with_base school_resource_uri(id, resource, 'count', query)
+        end
+
+        define_method "school_#{ resource }s_url" do |id, query = {}|
+          merge_with_base school_resource_uri(id, resource, query)
+        end
+      end
+
+      # because staffs isn't the correct pluralization and we aren't
+      # going to pull in active support for this pair of methods
+      def school_staff_count_url(id, query = {})
+        merge_with_base school_resource_uri(id, 'staff', 'count', query)
+      end
+
+      def school_staff_index_url(id, query = {})
+        merge_with_base school_resource_uri(id, 'staff', query)
+      end
+
+      private
+
+      def assignment_score_path(id)
+        tuple_to_path(ptg_v2_resource_path_tuple('assignment',id) + ['score'])
+      end
+
+      def assignment_student_path_tuple(assignment_id, student_id)
+        ptg_v2_resource_path_tuple('assignment',assignment_id) + resource_path_tuple('student', student_id)
+      end
+
+      def assignment_student_score_path_tuple(assignment_id, student_id)
+        assignment_student_path_tuple(assignment_id, student_id) + ['score']
+      end
+
+      def assignment_student_score_path(assignment_id, student_id)
+        tuple_to_path(assignment_student_score_path_tuple(assignment_id, student_id))
+      end
+
+      def district_resource_uri(*nested_resources_and_query)
+        query = nested_resources_and_query.pop if Hash === nested_resources_and_query.last
+        URI::Generic.build({}).tap {|uri|
+          uri.path = tuple_to_path(ws_v1_resource_path_tuple('district') + nested_resources_and_query)
+          uri.query = encode_query(query) unless query.nil? || query.empty?
+        }
+      end
+
+      def encode_query(enumerable)
+        enumerable.map{|k, v|
+          [k.to_s, v.to_s].join('=')
+        }.join('&')
+      end
+
+      def ptg_v2_resource_path_tuple(resource, id)
+        resource_path_tuple(resource, id).unshift(PTG_V2_NAMESPACE)
+      end
+
+      def ptg_v2_resource_path(resource, id)
+        tuple_to_path ptg_v2_resource_path_tuple(resource, id)
+      end
+
+      def resource_path_tuple(resource, id)
+        [resource, id].compact
+      end
+
+      def section_assignments_path(section_id)
+        tuple_to_path(ptg_v2_resource_path_tuple('section', section_id) + resource_path_tuple('assignment', nil))
+      end
+
+      def section_section_enrollments_path(section_id)
+        tuple_to_path(ws_v1_resource_path_tuple('section', section_id) + resource_path_tuple('section_enrollment', nil))
+      end
+
+      def school_resource_uri(id, *nested_resources_and_query)
+        query = nested_resources_and_query.pop if Hash === nested_resources_and_query.last
+        URI::Generic.build({}).tap {|uri|
+          uri.path = tuple_to_path(ws_v1_resource_path_tuple('school', id) + nested_resources_and_query)
+          uri.query = encode_query(query) unless query.nil? || query.empty?
+        }
+      end
+
+      def tuple_to_path(tuple)
+        tuple.join('/')
+      end
+
+      def ws_v1_resource_path_tuple(resource, id = nil)
+        resource_path_tuple(resource, id).unshift(WS_V1_NAMESPACE)
+      end
+
+      def ws_v1_resource_path(resource, id = nil)
+        tuple_to_path ws_v1_resource_path_tuple(resource, id)
+      end
+    end
+  end
+end

data/lib/old_school/api/utils.rb

@@ -0,0 +1,198 @@
+require 'typhoeus'
+require 'json'
+
+module OldSchool
+
+  class ResponseError < StandardError; end
+  class MissingRequiredField < ResponseError; end
+  class AlreadyExists < ResponseError; end
+
+  class API
+    module Utils
+      attr_accessor :id, :secret, :url_factory
+
+      def resource_metadata
+        @resource_metadata ||= hash_from_response(get(@url_factory.metadata_url),'metadata')
+      end
+
+      def token
+        return @token unless @token.nil?
+        response = Typhoeus.post(
+          @url_factory.access_token_url,
+          userpwd: "#{@id}:#{@secret}",
+          params: {
+            grant_type: 'client_credentials'
+          })
+
+        @token = hash_from_response(response, 'access_token')
+      end
+
+      def token=(token)
+        @token = token
+      end
+
+      def collection_from_response(response, keys = nil)
+        as_array hash_from_response!(response, keys) { [] }
+      end
+
+      def hash_from_response(response, keys = nil)
+        hash_from_response!(response, keys) do |body, key|
+          raise ResponseError, "\"#{key}\" key not in response object:\n #{response.body}:\nfrom original:\n#{response.inspect.to_s}" unless body.has_key?(key)
+        end
+      end
+
+      def hash_from_response!(response, keys)
+        keys = as_array keys
+        validate_response response
+        body = parse_json response
+
+        while keys.size > 0
+          key = keys.shift
+          if body.has_key?(key)
+            body = body[key]
+          else
+            return yield(body, key) if block_given?
+            return nil
+          end
+        end
+
+        body
+      end
+
+      def hash_without_nil_values(hash)
+        hash.to_hash.delete_if{ |k,v| v.nil? }
+      end
+
+      def parse_json(response)
+        begin
+          body = JSON.parse(response.body)
+        rescue JSON::ParserError
+          raise ResponseError, "Could not parse body as JSON: #{response.body}"
+        end
+      end
+
+      def parse_error(response)
+        error = parse_json(response)["errorMessage"]
+        begin
+          msg = "#{error["message"]} ("
+          msg += "#{error["errors"]["resource"]}#{error["errors"]["field"] ? "." : ""}#{error["errors"]["field"]}"
+          msg +=": #{error["errors"]["code"]})"
+          return [error["errors"]["code"], msg]
+        rescue
+          return ["ERROR", response.body]
+        end
+      end
+
+      def validate_response(response)
+        if response.success?
+          return
+        elsif response.timed_out?
+          raise ResponseError, 'HTTP request timed out'
+        elsif response.code == 0
+          raise ResponseError, response.return_message
+        else
+          reason = extract_from_response_options(response, :response_headers)
+          raise ResponseError, "HTTP request failed: #{response.code}:\n#{reason}"
+        end
+      end
+
+      def extract_from_response_options(response, key)
+        begin
+          return response.options[key]
+        rescue
+          return nil
+        end
+      end
+
+      def default_headers
+        {
+          Authorization: "Bearer #{token}",
+          Accept: 'application/JSON',
+          'Content-Type'=>'application/JSON'
+        }
+      end
+
+      def get(uri)
+        Typhoeus.get(
+          make_sane_uri(uri),
+          headers: default_headers
+        )
+      end
+
+      def get_wait(uri)
+        Typhoeus::Request.new(
+          make_sane_uri(uri),
+          method: :get,
+          headers: default_headers)
+      end
+
+      def put(uri, body)
+        Typhoeus.put(
+          make_sane_uri(uri),
+          headers: default_headers,
+          body: body
+        )
+      end
+
+      def delete(uri)
+        Typhoeus.delete(
+          make_sane_uri(uri),
+          headers: default_headers
+        )
+      end
+
+      def post(uri, body)
+        Typhoeus.post(
+          make_sane_uri(uri),
+          headers: default_headers,
+          body: body
+        )
+      end
+
+      def make_sane_uri(uri)
+        if /\Ahttps?/.match(uri)
+          uri
+        else
+          @url_factory.merge_with_base(uri)
+        end
+      end
+
+      def get_with_pagination_url(resource, num_items, &uri_proc)
+        return [] if num_items == 0 #if paginating for zero items, just return an empty list
+
+        #calculate page size based on
+        page_size = resource_metadata["#{resource}_max_page_size"]
+        pages = (num_items - 1) / page_size + 1
+
+        results = get_many((1..pages), ["#{resource}s", resource], uri_proc)
+        results.values.flatten
+      end
+
+      def as_array(item)
+        return item.clone if item.is_a?(Array)
+        return [] if item.nil?
+        return [item]
+      end
+
+      def get_many(items, keys, uri_proc, complete_proc = nil)
+        hydra = Typhoeus::Hydra.hydra
+        requests = []
+        items.each do |item|
+          uri = uri_proc.call(item)
+          request = get_wait(uri)
+          request.on_complete {|response| complete_proc.call(response)} unless complete_proc.nil?
+          requests << [item, request]
+          hydra.queue request
+        end
+
+        hydra.run
+
+        responses = {}
+        requests.each do |request|
+          responses[request[0]] = hash_from_response(request[1].response, keys)
+        end
+        responses
+      end
+    end
+  end
+end

data/lib/old_school/core_ext.rb

@@ -0,0 +1,6 @@
+require_relative 'core_ext/object'
+
+module OldSchool
+  module CoreExt
+  end
+end

data/lib/old_school/core_ext/object.rb

@@ -0,0 +1,23 @@
+require 'virtus/model'
+
+module OldSchool
+  module CoreExt
+    module Object
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def virtus_model?
+        self.class.virtus_model?
+      end
+
+      module ClassMethods
+        def virtus_model?
+          ancestors.include?(Virtus::Model::Core)
+        end
+      end
+    end
+  end
+end
+
+Object.send(:include, OldSchool::CoreExt::Object)

data/lib/old_school/csv.rb

@@ -0,0 +1,7 @@
+require_relative 'csv/header_row'
+require_relative 'csv/content_row'
+
+module OldSchool
+  module CSV
+  end
+end

data/lib/old_school/csv/content_row.rb

@@ -0,0 +1,38 @@
+module OldSchool
+  module CSV
+    class ContentRow
+      def self.for(model)
+        new(model).to_csv
+      end
+
+      def initialize(model)
+        @model = model
+        @public_attributes = model.publicly_readable_attributes
+      end
+
+      def to_csv
+        @public_attributes.map{|attribute|
+          values_for(attribute)
+        }.flatten
+      end
+
+      private
+
+      def values_for(attribute)
+        primitive = attribute.primitive
+        value = @model.public_send(attribute.name)
+        raise 'TODO: figure out how to handle Array and Hash attributes in CSV conversion' if Array == primitive || Hash == primitive
+
+        primitive.virtus_model? ? values_from_nested_model(value, primitive) : value
+      end
+
+      def values_from_nested_model(value, primitive)
+        if value.nil?
+          Array.new(primitive.publicly_readable_attributes.length)
+        else
+          ContentRow.for(value)
+        end
+      end
+    end
+  end
+end

data/lib/old_school/csv/header_row.rb

@@ -0,0 +1,34 @@
+module OldSchool
+  module CSV
+    class HeaderRow
+      def self.for(klass)
+        new(klass).to_csv
+      end
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def to_csv
+        @klass.publicly_readable_attributes.map{|attribute|
+          column_headers_for(attribute)
+        }.flatten
+      end
+
+      private
+
+      def column_headers_for(attribute)
+        primitive = attribute.primitive
+        raise 'TODO: figure out how to handle Array and Hash attributes in CSV conversion' if Array == primitive || Hash == primitive
+
+        primitive.virtus_model? ? columns_for_nested_model(attribute) : attribute.name.to_s
+      end
+
+      def columns_for_nested_model(attribute)
+        HeaderRow.for(attribute.primitive).map{|nested_header|
+          [attribute.name, nested_header].join('.')
+        }
+      end
+    end
+  end
+end

data/lib/old_school/models/assignment.rb

@@ -0,0 +1,26 @@
+module OldSchool
+  class Assignment
+
+    include Virtus.model
+
+    attribute :id,                      Integer
+    attribute :name,                    String
+    attribute :abbreviation,            String
+    attribute :description,             String
+    attribute :date_assignment_due,     Date #YYYY-MM-DD
+    attribute :category,                String
+    attribute :extra_credit_points,     Integer
+    attribute :include_final_grades,    Boolean
+    attribute :points_possible,         Integer
+    attribute :publish_scores,          Boolean
+    attribute :publish_state,           String # PUBLISH_NEVER,
+              # PUBLISH_IMMEDIATELY, PUBLISH_ON_DUE_DATE,
+              # PUBLISH_ON_DUE_DATE, PUBLISH_ON_SPECIFIC_DATE,
+              # PUBLISH_DAYS_BEFORE_DUE
+    attribute :publish_days_before_due, Integer
+    attribute :publish_specific_date,   Date #YYYY-MM-DD
+    attribute :scoring_type,            String #POINTS, PERCENTAGE, LETTERGRADE
+    attribute :weight,                  Float
+
+  end
+end

data/lib/old_school/models/assignment_score.rb

@@ -0,0 +1,17 @@
+module OldSchool
+  class AssignmentScore
+
+    include Virtus.model
+
+    attribute :student_id, String
+    attribute :score_entered, String
+    attribute :points_possible, Integer
+    attribute :comment, String
+    attribute :collected, Boolean
+    attribute :missing, Boolean
+    attribute :exempt, Boolean
+    attribute :turned_in_late, Boolean
+    attribute :scoring_type, String # POINTS, PERCENTAGE, LETTERGRADE
+
+  end
+end

data/lib/old_school/models/contact_info.rb

@@ -0,0 +1,15 @@
+module OldSchool
+  class ContactInfo
+
+    include Virtus.model
+
+    def initialize(arg, *args)
+      if arg != ''
+        super
+      end
+    end
+
+    attribute :email, String
+
+  end
+end

data/lib/old_school/models/course.rb

@@ -0,0 +1,12 @@
+module OldSchool
+  class Course
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :course_number, String
+    attribute :course_name, String
+
+    attribute :school_id, String
+  end
+end

data/lib/old_school/models/demographics.rb

@@ -0,0 +1,13 @@
+module OldSchool
+  class Demographics
+
+    include Virtus.model
+
+    attribute :gender, String
+    attribute :birth_date, DateTime
+    attribute :district_entry_date, DateTime
+    attribute :project_graduation_year, String
+    attribute :ssn, String
+
+  end
+end

data/lib/old_school/models/name.rb

@@ -0,0 +1,11 @@
+module OldSchool
+  class Name
+
+    include Virtus.model
+
+    attribute :last_name, String
+    attribute :first_name, String
+    attribute :middle_name, String
+
+  end
+end

data/lib/old_school/models/school.rb

@@ -0,0 +1,17 @@
+
+module OldSchool
+  class School
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :school_number, String
+    attribute :state_province_id, String
+    attribute :low_grade, Integer
+    attribute :high_grade, Integer
+    attribute :alternate_school_number, Integer
+    #attribute :assistant_principal, AssistantPrincipal
+
+  end
+end

data/lib/old_school/models/section.rb

@@ -0,0 +1,14 @@
+module OldSchool
+  class Section
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :school_id, Integer
+    attribute :course_id, Integer
+    attribute :term_id, Integer
+    attribute :section_number, Integer
+    attribute :expression, String
+    attribute :staff_id, Integer
+  end
+end

data/lib/old_school/models/section_enrollment.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+module OldSchool
+  class SectionEnrollment
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :section_id, Integer
+    attribute :student_id, Integer
+    attribute :entry_date, DateTime
+    attribute :exit_date, DateTime
+    attribute :dropped, Boolean
+
+    def future?
+      return true if entry_date > Date.today
+      return false
+    end
+
+    def past?
+      return true if exit_date > Date.today
+      return false
+    end
+  end
+end

data/lib/old_school/models/staff.rb

@@ -0,0 +1,26 @@
+require_relative 'name'
+
+module OldSchool
+  class Staff
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :local_id, String
+    attribute :admin_username, String
+    attribute :teacher_username, String
+    attribute :name, Name
+    #TODO attribute :phones, Phones
+    #TODO attribute :schedule_setup, String
+    #TODO attribute :school_enrollment, String
+
+    attribute :school_id, Integer
+    def login_id
+        if !self.admin_username && !self.teacher_username
+            return nil
+        end
+        return self.teacher_username if self.teacher_username != nil
+        return self.admin_username
+    end
+  end
+end

data/lib/old_school/models/student.rb

@@ -0,0 +1,27 @@
+require_relative 'name'
+require_relative 'contact_info'
+require_relative 'demographics'
+
+module OldSchool
+  class Student
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :local_id, String
+    attribute :state_province_id, String
+    attribute :student_username, String
+    #TODO attribute :addresses, Address
+    #TODO attribute :alerts, Alerts
+    #TODO attribute :contact, Contact
+    attribute :contact_info, ContactInfo # TODO figure out blank string issues
+    attribute :demographics, Demographics
+    #TODO attribute :ethnicity_race, EthnicityRace
+    attribute :name, Name
+    #TODO attribute :phones, Phones
+    #TODO attribute :schedule_setup, String
+    #TODO attribute :school_enrollment, String
+
+    attribute :school_id, Integer
+  end
+end

data/lib/old_school/models/term.rb

@@ -0,0 +1,15 @@
+module OldSchool
+  class Term
+
+    include Virtus.model
+
+    attribute :id, Integer
+    attribute :school_id, Integer
+    attribute :start_year, Integer
+    attribute :portion, Integer
+    attribute :start_date, DateTime
+    attribute :end_date, DateTime
+    attribute :abbreviation, String
+    attribute :name, String
+  end
+end

data/lib/old_school/version.rb

@@ -0,0 +1,3 @@
+module OldSchool
+  VERSION = '0.0.5'
+end

data/lib/old_school/virtus_ext.rb

@@ -0,0 +1,7 @@
+require_relative 'virtus_ext/class_methods'
+require_relative 'virtus_ext/model'
+
+module OldSchool
+  module VirtusExt
+  end
+end

data/lib/old_school/virtus_ext/class_methods.rb

@@ -0,0 +1,18 @@
+require 'virtus'
+require 'old_school/csv'
+
+module OldSchool
+  module VirtusExt
+    module ClassMethods
+      def publicly_readable_attributes
+        @attribute_set.select(&:public_reader?)
+      end
+
+      def csv_header
+        OldSchool::CSV::HeaderRow.for(self)
+      end
+    end
+  end
+end
+
+Virtus::ClassMethods.send(:include, OldSchool::VirtusExt::ClassMethods)

data/lib/old_school/virtus_ext/model.rb

@@ -0,0 +1,20 @@
+require 'virtus'
+require 'old_school/csv'
+
+module OldSchool
+  module VirtusExt
+    module Model
+      module Core
+        def publicly_readable_attributes
+          self.class.publicly_readable_attributes
+        end
+
+        def to_csv
+          OldSchool::CSV::ContentRow.for(self)
+        end
+      end
+    end
+  end
+end
+
+Virtus::Model::Core.send(:include, OldSchool::VirtusExt::Model::Core)

data/old_school.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/old_school/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'old_school'
+  gem.date = '2013-01-10'
+  gem.summary = 'Ruby Gem for a Powerful SIS'
+  gem.description = 'Provides an interface to work with a Powerful SIS REST API'
+  gem.authors = ['kaiged']
+  gem.email = 'kaiged@gmail.com'
+  gem.homepage = 'https://github.com/kaiged/old_school'
+
+  gem.version = OldSchool::VERSION
+
+  gem.files = %w[old_school.gemspec README.md]
+  gem.files += Dir.glob("lib/**/*")
+
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'typhoeus', '>= 0.6.7'
+  gem.add_dependency 'json', '>=1.8.1'
+  gem.add_dependency 'virtus'
+
+  gem.add_development_dependency 'debugger'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: old_school
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- kaiged
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides an interface to work with a Powerful SIS REST API
+email: kaiged@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- old_school.gemspec
+- README.md
+- lib/old_school/api/url_factory.rb
+- lib/old_school/api/utils.rb
+- lib/old_school/api.rb
+- lib/old_school/core_ext/object.rb
+- lib/old_school/core_ext.rb
+- lib/old_school/csv/content_row.rb
+- lib/old_school/csv/header_row.rb
+- lib/old_school/csv.rb
+- lib/old_school/models/assignment.rb
+- lib/old_school/models/assignment_score.rb
+- lib/old_school/models/contact_info.rb
+- lib/old_school/models/course.rb
+- lib/old_school/models/demographics.rb
+- lib/old_school/models/name.rb
+- lib/old_school/models/school.rb
+- lib/old_school/models/section.rb
+- lib/old_school/models/section_enrollment.rb
+- lib/old_school/models/staff.rb
+- lib/old_school/models/student.rb
+- lib/old_school/models/term.rb
+- lib/old_school/version.rb
+- lib/old_school/virtus_ext/class_methods.rb
+- lib/old_school/virtus_ext/model.rb
+- lib/old_school/virtus_ext.rb
+- lib/old_school.rb
+homepage: https://github.com/kaiged/old_school
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for a Powerful SIS
+test_files: []
+has_rdoc: