meibo 0.1.0

data/lib/meibo/japan_profile/user.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class User < ::Meibo::User
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map.merge(
+          kana_given_name: 'metadata.jp.kanaGivenName',
+          kana_family_name: 'metadata.jp.kanaFamilyName',
+          kana_middle_name: 'metadata.jp.kanaMiddleName',
+          home_class: 'metadata.jp.homeClass'
+        ).freeze,
+        converters: superclass.converters
+      )
+
+      # NOTE: enabled_userは必須ではないが固定
+      def initialize(enabled_user: true, kana_given_name: nil, kana_family_name: nil, kana_middle_name: nil, home_class: nil, **other_fields)
+        super(enabled_user: enabled_user, **other_fields)
+        @kana_given_name = kana_given_name
+        @kana_family_name = kana_family_name
+        @kana_middle_name = kana_middle_name
+        @home_class = home_class
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/user_profile.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    UserProfile = ::Meibo::UserProfile
+  end
+end

data/lib/meibo/japan_profile.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    include BaseProfile
+
+    BUILDERS = {
+      academic_session: Builder::AcademicSessionBuilder.create(AcademicSession),
+      class: Builder::ClassroomBuilder.create(Classroom),
+      course: Builder::CourseBuilder.create(Course),
+      demographic: Builder::DemographicBuilder.create(Demographic),
+      enrollment: Builder::EnrollmentBuilder.create(Enrollment),
+      org: Builder::OrganizationBuilder.create(Organization),
+      role: Builder::RoleBuilder.create(Role),
+      user: Builder::UserBuilder.create(User),
+      user_profile: Builder::UserProfileBuilder.create(UserProfile)
+    }
+
+    DATA_MODELS = {
+      file_academic_sessions: Meibo::JapanProfile::AcademicSession,
+      file_classes: Meibo::JapanProfile::Classroom,
+      file_courses: Meibo::JapanProfile::Course,
+      file_demographics: Meibo::JapanProfile::Demographic,
+      file_enrollments: Meibo::JapanProfile::Enrollment,
+      file_orgs: Meibo::JapanProfile::Organization,
+      file_roles: Meibo::JapanProfile::Role,
+      file_user_profiles: Meibo::JapanProfile::UserProfile,
+      file_users: Meibo::JapanProfile::User
+    }
+
+    def self.builder_for(key)
+      BUILDERS[key]
+    end
+
+    def self.data_model_for(file_attribute)
+      DATA_MODELS[file_attribute]
+    end
+  end
+end

data/lib/meibo/manifest/processing_mode.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Manifest
+    class ProcessingMode
+      attr_reader :mode
+
+      def initialize(mode)
+        @mode = mode
+        freeze
+      end
+
+      def absent?
+        @mode == 'absent'
+      end
+
+      def bulk?
+        @mode == 'bulk'
+      end
+
+      def delta?
+        @mode == 'delta'
+      end
+
+      def ==(other)
+        if other.is_a?(ProcessingMode)
+          @mode == other.mode
+        elsif other.is_a?(String)
+          to_s == other
+        else
+          false
+        end
+      end
+
+      def to_s
+        @mode
+      end
+    end
+  end
+end

data/lib/meibo/manifest.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Manifest
+    MANIFEST_VERSION = '1.0'
+    ONEROSTER_VERSION = '1.2'
+
+    PROCESSING_MODES = {
+      absent: ProcessingMode.new('absent'),
+      bulk: ProcessingMode.new('bulk'),
+      delta: ProcessingMode.new('delta')
+    }.freeze
+
+    PROPERTY_NAME_TO_ATTRIBUTE_MAP = {
+      'manifest.version' => :manifest_version,
+      'oneroster.version' => :oneroster_version,
+      'file.academicSessions' => :file_academic_sessions,
+      'file.categories' => :file_categories,
+      'file.classes' => :file_classes,
+      'file.classResources' => :file_class_resources,
+      'file.courses' => :file_courses,
+      'file.courseResources' => :file_course_resources,
+      'file.demographics' => :file_demographics,
+      'file.enrollments' => :file_enrollments,
+      'file.lineItemLearningObjectiveIds' => :file_line_item_learning_objective_ids,
+      'file.lineItems' => :file_line_items,
+      'file.lineItemScoreScales' => :file_line_item_score_scales,
+      'file.orgs' => :file_orgs,
+      'file.resources' => :file_resources,
+      'file.resultLearningObjectiveIds' => :file_result_learning_objective_ids,
+      'file.results' => :file_results,
+      'file.resultScoreScales' => :file_result_score_scales,
+      'file.roles' => :file_roles,
+      'file.scoreScales' => :file_score_scales,
+      'file.userProfiles' => :file_user_profiles,
+      'file.userResources' => :file_user_resources,
+      'file.users' => :file_users,
+      'source.systemName' => :source_system_name,
+      'source.systemCode' => :source_system_code
+    }.freeze
+    ATTRIBUTE_TO_PROPERTY_NAME_MAP = PROPERTY_NAME_TO_ATTRIBUTE_MAP.to_h {|property_name, attribute| [attribute, property_name] }.freeze
+
+    # NOTE: 想定値
+    DEFAULT_VALUES = {
+      manifest_version: MANIFEST_VERSION,
+      oneroster_version: ONEROSTER_VERSION,
+      file_academic_sessions: PROCESSING_MODES[:bulk],
+      file_categories: PROCESSING_MODES[:absent],
+      file_classes: PROCESSING_MODES[:bulk],
+      file_class_resources: PROCESSING_MODES[:absent],
+      file_courses: PROCESSING_MODES[:bulk],
+      file_course_resources: PROCESSING_MODES[:absent],
+      file_demographics: PROCESSING_MODES[:bulk],
+      file_enrollments: PROCESSING_MODES[:bulk],
+      file_line_item_learning_objective_ids: PROCESSING_MODES[:absent],
+      file_line_items: PROCESSING_MODES[:absent],
+      file_line_item_score_scales: PROCESSING_MODES[:absent],
+      file_orgs: PROCESSING_MODES[:bulk],
+      file_resources: PROCESSING_MODES[:absent],
+      file_result_learning_objective_ids: PROCESSING_MODES[:absent],
+      file_results: PROCESSING_MODES[:absent],
+      file_result_score_scales: PROCESSING_MODES[:absent],
+      file_roles: PROCESSING_MODES[:bulk],
+      file_score_scales: PROCESSING_MODES[:absent],
+      file_user_profiles: PROCESSING_MODES[:bulk],
+      file_user_resources: PROCESSING_MODES[:absent],
+      file_users: PROCESSING_MODES[:bulk]
+    }.freeze
+
+    attr_reader :manifest_version, :oneroster_version, :file_academic_sessions, :file_categories, :file_classes, :file_class_resources, :file_courses, :file_course_resources, :file_demographics, :file_enrollments, :file_line_item_learning_objective_ids, :file_line_items, :file_line_item_score_scales, :file_orgs, :file_resources, :file_result_learning_objective_ids, :file_results, :file_result_score_scales, :file_roles, :file_score_scales, :file_user_profiles, :file_user_resources, :file_users, :source_system_name, :source_system_code
+
+    def self.build_from_default(**custom_properties)
+      new(**Manifest::DEFAULT_VALUES.merge(custom_properties))
+    end
+
+    def self.filename
+      'manifest.csv'
+    end
+
+    attribute_name_to_header_field_map = {
+      property_name: 'propertyName',
+      value: 'value'
+    }
+    header_fields = attribute_name_to_header_field_map.values
+    define_singleton_method(:header_fields) { header_fields }
+    DataModel.define_header_converters(self, attribute_name_to_header_field_map)
+
+    def self.attribute_to_property_name(attribute)
+      ATTRIBUTE_TO_PROPERTY_NAME_MAP.fetch(attribute)
+    end
+
+    def self.filename_for(attribute)
+      property_name = attribute_to_property_name(attribute)
+
+      raise Meibo::Error, "#{property_name}はファイルのプロパティではありません" unless property_name.start_with?('file.')
+
+      property_name.split('file.', 2).last + '.csv'
+    end
+
+    def self.parse(csv)
+      properties = CSV.parse(csv, encoding: Meibo::CSV_ENCODING, headers: true, header_converters: header_converters)
+      new(**properties.to_h {|property| [PROPERTY_NAME_TO_ATTRIBUTE_MAP.fetch(property[:property_name]), property[:value]] })
+    end
+
+    def initialize(manifest_version:, oneroster_version:, file_academic_sessions:, file_categories:, file_classes:, file_class_resources:, file_courses:, file_course_resources:, file_demographics:, file_enrollments:, file_line_item_learning_objective_ids:, file_line_items:, file_line_item_score_scales:, file_orgs:, file_resources:, file_result_learning_objective_ids:, file_results:, file_result_score_scales:, file_roles:, file_score_scales:, file_user_profiles:, file_user_resources:, file_users:, source_system_name: nil, source_system_code: nil)
+      @manifest_version = manifest_version
+      @oneroster_version = oneroster_version
+      @file_academic_sessions = file_academic_sessions
+      @file_categories = file_categories
+      @file_classes = file_classes
+      @file_class_resources = file_class_resources
+      @file_courses = file_courses
+      @file_course_resources = file_course_resources
+      @file_demographics = file_demographics
+      @file_enrollments = file_enrollments
+      @file_line_item_learning_objective_ids = file_line_item_learning_objective_ids
+      @file_line_items = file_line_items
+      @file_line_item_score_scales = file_line_item_score_scales
+      @file_orgs = file_orgs
+      @file_resources = file_resources
+      @file_result_learning_objective_ids = file_result_learning_objective_ids
+      @file_results = file_results
+      @file_result_score_scales = file_result_score_scales
+      @file_roles = file_roles
+      @file_score_scales = file_score_scales
+      @file_user_profiles = file_user_profiles
+      @file_user_resources = file_user_resources
+      @file_users = file_users
+      @source_system_name = source_system_name
+      @source_system_code = source_system_code
+    end
+
+    def filenames(processing_mode:)
+      file_attributes(processing_mode: processing_mode).map do |attribute|
+        self.class.filename_for(attribute)
+      end
+    end
+
+    def file_attributes(processing_mode:)
+      PROPERTY_NAME_TO_ATTRIBUTE_MAP.values.filter_map do |attribute|
+        attribute.start_with?('file_') && public_send(attribute) == processing_mode.to_s && attribute
+      end
+    end
+
+    def deconstruct
+      to_a
+    end
+
+    def deconstruct_keys(_keys)
+      to_h
+    end
+
+    def to_a
+      PROPERTY_NAME_TO_ATTRIBUTE_MAP.map do |property_name, attribute|
+        [property_name, public_send(attribute)]
+      end
+    end
+
+    def to_h
+      PROPERTY_NAME_TO_ATTRIBUTE_MAP.values.to_h {|attribute| [attribute, public_send(attribute)] }
+    end
+  end
+end

data/lib/meibo/organization.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Organization
+    TYPES = {
+      department: 'department',
+      school: 'school',
+      district: 'district',
+      local: 'local',
+      state: 'state',
+      national: 'national'
+    }.freeze
+
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        name: 'name',
+        type: 'type',
+        identifier: 'identifier',
+        parent_sourced_id: 'parentSourcedId'
+      },
+      converters: {
+        datetime: [:date_last_modified],
+        enum: { type: [*TYPES.values, ENUM_EXT_PATTERN].freeze },
+        required: [:sourced_id, :name, :type],
+        status: [:status]
+      }
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, name:, type:, identifier: nil, parent_sourced_id: (type == TYPES[:district] ? 'NULL' : nil), **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @name = name
+      @type = type
+      @identifier = identifier
+      @parent_sourced_id = parent_sourced_id
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/organization_set.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Meibo
+  class OrganizationSet < DataSet
+    def check_semantically_consistent
+      super
+
+      each do |organization|
+        next unless organization.parent_sourced_id
+
+        find_by_sourced_id(organization.parent_sourced_id)
+      end
+    end
+  end
+end

data/lib/meibo/reader.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'zip'
+
+module Meibo
+  class Reader
+    def self.open(file_path, profile: BaseProfile)
+      Zip::File.open(file_path) do |zipfile|
+        yield new(zipfile: zipfile, profile: profile)
+      end
+    end
+
+    attr_reader :profile, :zipfile
+
+    def initialize(zipfile:, profile:)
+      @profile = profile
+      @zipfile = zipfile
+    end
+
+    def academic_sessions
+      each_academic_session.to_a
+    end
+
+    def classes
+      each_class.to_a
+    end
+
+    def courses
+      each_course.to_a
+    end
+
+    def demographics
+      each_demographic.to_a
+    end
+
+    def enrollments
+      each_enrollment.to_a
+    end
+
+    def organizations
+      each_organization.to_a
+    end
+
+    def roles
+      each_role.to_a
+    end
+
+    def users
+      each_user.to_a
+    end
+
+    def user_profiles
+      each_user_profile.to_a
+    end
+
+    def each_academic_session(&block)
+      read_data(:file_academic_sessions, &block)
+    end
+
+    def each_class(&block)
+      read_data(:file_classes, &block)
+    end
+
+    def each_course(&block)
+      read_data(:file_courses, &block)
+    end
+
+    def each_demographic(&block)
+      read_data(:file_demographics, &block)
+    end
+
+    def each_enrollment(&block)
+      read_data(:file_enrollments, &block)
+    end
+
+    def each_organization(&block)
+      read_data(:file_orgs, &block)
+    end
+
+    def each_role(&block)
+      read_data(:file_roles, &block)
+    end
+
+    def each_user_profile(&block)
+      read_data(:file_user_profiles, &block)
+    end
+
+    def each_user(&block)
+      read_data(:file_users, &block)
+    end
+
+    def manifest
+      @manifest ||= begin
+        filename = Meibo::Manifest.filename
+        raise CsvFileNotFoundError, "#{filename} not found" unless file_entry?(filename)
+
+        csv = @zipfile.read(filename)
+        Meibo::Manifest.parse(csv)
+      end
+    end
+
+    def load_bulk_files
+      bulk_file_attributes = manifest.file_attributes(processing_mode: Meibo::Manifest::PROCESSING_MODES[:bulk])
+      {
+        file_academic_sessions: :academic_sessions,
+        file_classes: :classes,
+        file_courses: :courses,
+        file_demographics: :demographics,
+        file_enrollments: :enrollments,
+        file_orgs: :organizations,
+        file_roles: :roles,
+        file_users: :users,
+        file_user_profiles: :user_profiles
+      }.filter_map {|file_attribute, data_method|
+        if bulk_file_attributes.include?(file_attribute)
+          [data_method, public_send(data_method).to_a]
+        end
+      }.to_h
+    end
+
+    def file_entry?(filename)
+      @zipfile.get_entry(filename).file?
+    rescue Errno::ENOENT
+      false
+    end
+
+    private
+
+    def read_data(file_attribute, &block)
+      filename = Manifest.filename_for(file_attribute)
+      raise CsvFileNotFoundError, "#{filename} not found" unless file_entry?(filename)
+
+      csv = @zipfile.read(filename)
+      profile.data_model_for(file_attribute).parse(csv, &block)
+    end
+  end
+end

data/lib/meibo/role.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Role
+    TYPES = {
+      primary: 'primary',
+      secondary: 'secondary'
+    }.freeze
+
+    ROLES = {
+      aide: 'aide',
+      counselor: 'counselor',
+      district_administrator: 'districtAdministrator',
+      guardian: 'guardian',
+      parent: 'parent',
+      principal: 'principal',
+      proctor: 'proctor',
+      relative: 'relative',
+      site_administrator: 'siteAdministrator',
+      student: 'student',
+      system_administrator: 'systemAdministrator',
+      teacher: 'teacher'
+    }.freeze
+
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        user_sourced_id: 'userSourcedId',
+        role_type: 'roleType',
+        role: 'role',
+        begin_date: 'beginDate',
+        end_date: 'endDate',
+        org_sourced_id: 'orgSourcedId',
+        user_profile_sourced_id: 'userProfileSourcedId'
+      }.freeze,
+      converters: {
+        date: [:begin_date, :end_date].freeze,
+        datetime: [:date_last_modified].freeze,
+        required: [:sourced_id, :user_sourced_id, :role_type, :role, :org_sourced_id].freeze,
+        enum: {
+          role: [*ROLES.values, ENUM_EXT_PATTERN].freeze,
+          role_type: TYPES.values.freeze
+        }.freeze,
+        status: [:status].freeze
+      }.freeze
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, user_sourced_id:, role_type:, role:, begin_date: nil, end_date: nil, org_sourced_id:, user_profile_sourced_id: nil, **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @user_sourced_id = user_sourced_id
+      @role_type = role_type
+      @role = role
+      @begin_date = begin_date
+      @end_date = end_date
+      @org_sourced_id = org_sourced_id
+      @user_profile_sourced_id = user_profile_sourced_id
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/role_set.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Meibo
+  class RoleSet < DataSet
+    def initialize(data, organization_set:, user_set:, user_profile_set:)
+      super(data)
+      @organization_set = organization_set
+      @user_set = user_set
+      @user_profile_set = user_profile_set
+    end
+
+    def check_semantically_consistent
+      super
+
+      each do |role|
+        @organization_set.find_by_sourced_id(role.org_sourced_id)
+        @user_set.find_by_sourced_id(role.user_sourced_id)
+
+        if role.user_profile_sourced_id
+          @user_profile_set.find_by_sourced_id(role.user_profile_sourced_id)
+        end
+      end
+    end
+  end
+end