meibo 0.1.0

data/lib/meibo/roster.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'zip'
+require 'csv'
+
+module Meibo
+  class Roster
+    class << self
+      def from_file(file_path, profile: BaseProfile)
+        Reader.open(file_path, profile: profile) do |reader|
+          begin
+            manifest = reader.manifest
+          rescue CsvFileNotFoundError
+            raise NotSupportedError, 'OneRoster 1.0はサポートしていません'
+          rescue
+            raise NotSupportedError, "#{Meibo::Manifest.filename}の読み込みに失敗しました"
+          end
+
+          validate_manifest_version(manifest.manifest_version)
+          validate_oneroster_version(manifest.oneroster_version)
+          validate_supported_processing_mode(manifest)
+          processing_modes = Meibo::Manifest::PROCESSING_MODES
+          validate_absent_files(reader, manifest.filenames(processing_mode: processing_modes[:absent]))
+          validate_bulk_files(reader, manifest.filenames(processing_mode: processing_modes[:bulk]))
+
+          new(manifest_properties: manifest.to_h, profile: profile, **reader.load_bulk_files).tap(&:check_semantically_consistent)
+        end
+      end
+
+      private
+
+      def validate_absent_files(reader, absent_filenames)
+        absent_filenames.each do |absent_filename|
+          next unless reader.file_entry?(absent_filename)
+
+          raise NotSupportedError, "#{absent_filename}が存在します"
+        end
+      end
+
+      def validate_bulk_files(reader, bulk_filenames)
+        bulk_filenames.each do |bulk_filename|
+          next if reader.file_entry?(bulk_filename)
+
+          raise NotSupportedError, "#{bulk_filename}が存在しません"
+        end
+      end
+
+      def validate_manifest_version(manifest_version)
+        return if manifest_version == Meibo::Manifest::MANIFEST_VERSION
+
+        raise NotSupportedError, "manifest.version: #{manifest_version}はサポートしていません"
+      end
+
+      def validate_oneroster_version(oneroster_version)
+        return if oneroster_version == Meibo::Manifest::ONEROSTER_VERSION
+
+        raise NotSupportedError, "oneroster.version: #{oneroster_version}はサポートしていません"
+      end
+
+      def validate_supported_processing_mode(manifest)
+        return if manifest.file_attributes(processing_mode: Meibo::Manifest::PROCESSING_MODES[:delta]).empty?
+
+        raise NotSupportedError, 'DELTAはサポートしていません'
+      end
+    end
+
+    attr_reader :profile, :manifest_properties, :academic_sessions, :classes, :courses, :demographics, :enrollments, :organizations, :roles, :user_profiles, :users
+
+    def initialize(profile: BaseProfile, manifest_properties: {}, academic_sessions: [], classes: [], courses: [], demographics: [], enrollments: [], organizations: [], roles: [], user_profiles: [], users: [])
+      @profile = profile
+      @manifest_properties = manifest_properties
+      @academic_sessions = AcademicSessionSet.new(academic_sessions)
+      @organizations = OrganizationSet.new(organizations)
+      @courses = CourseSet.new(courses, academic_session_set: @academic_sessions, organization_set: @organizations)
+      @classes = ClassroomSet.new(classes, academic_session_set: @academic_sessions, course_set: @courses, organization_set: @organizations)
+      @users = UserSet.new(users, organization_set: @organizations)
+      @demographics = DemographicSet.new(demographics, user_set: @users)
+      @user_profiles = UserProfileSet.new(user_profiles, user_set: @users)
+      @roles = RoleSet.new(roles, organization_set: @organizations, user_set: @users, user_profile_set: @user_profiles)
+      @enrollments = EnrollmentSet.new(enrollments, classroom_set: @classes, organization_set: @organizations, user_set: @users)
+    end
+
+    def check_semantically_consistent
+      [
+        academic_sessions,
+        classes,
+        courses,
+        demographics,
+        enrollments,
+        organizations,
+        roles,
+        user_profiles,
+        users
+      ].each(&:check_semantically_consistent)
+    end
+
+    def write(path)
+      Zip::File.open(path, ::Zip::File::CREATE) do |zipfile|
+        manifest = build_manifest
+        zipfile.get_output_stream(::Meibo::Manifest.filename) do |f|
+          f.puts ::Meibo::Manifest.header_fields.to_csv
+          manifest.to_a.each do |row|
+            f.puts row.to_csv
+          end
+        end
+        file_properties.each do |file_attribute, processing_mode|
+          next if processing_mode.absent?
+
+          klass = profile.data_model_for(file_attribute)
+          filename = Manifest.filename_for(file_attribute)
+          data = data_for(file_attribute)
+          zipfile.get_output_stream(filename) do |f|
+            f.puts klass.header_fields.to_csv
+            data.each do |row|
+              f.puts row.to_csv(write_converters: klass.write_converters)
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def build_manifest
+      new_manifest_properties = file_properties.merge(manifest_properties)
+      Meibo::Manifest.build_from_default(**new_manifest_properties)
+    end
+
+    def data_for(file_attribute)
+      data_method = {
+        file_academic_sessions: :academic_sessions,
+        file_classes: :classes,
+        file_courses: :courses,
+        file_demographics: :demographics,
+        file_enrollments: :enrollments,
+        file_orgs: :organizations,
+        file_roles: :roles,
+        file_user_profiles: :user_profiles,
+        file_users: :users
+      }[file_attribute]
+      public_send(data_method)
+    end
+
+    def file_properties
+      {
+        file_academic_sessions: procesing_mode(academic_sessions),
+        file_classes: procesing_mode(classes),
+        file_courses: procesing_mode(courses),
+        file_demographics: procesing_mode(demographics),
+        file_enrollments: procesing_mode(enrollments),
+        file_orgs: procesing_mode(organizations),
+        file_roles: procesing_mode(roles),
+        file_user_profiles: procesing_mode(user_profiles),
+        file_users: procesing_mode(users)
+      }
+    end
+
+    def procesing_mode(data)
+      if data.empty?
+        Meibo::Manifest::PROCESSING_MODES[:absent]
+      else
+        Meibo::Manifest::PROCESSING_MODES[:bulk]
+      end
+    end
+  end
+end

data/lib/meibo/user.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Meibo
+  class User
+    USER_ID_FORMAT_REGEXP = /\A\{[^:\}]+:[^\}]+\}\z/
+
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        enabled_user: 'enabledUser',
+        username: 'username',
+        user_ids: 'userIds',
+        given_name: 'givenName',
+        family_name: 'familyName',
+        middle_name: 'middleName',
+        identifier: 'identifier',
+        email: 'email',
+        sms: 'sms',
+        phone: 'phone',
+        agent_sourced_ids: 'agentSourcedIds',
+        grades: 'grades',
+        password: 'password',
+        user_master_identifier: 'userMasterIdentifier',
+        resource_sourced_ids: 'resourceSourcedIds',
+        preferred_given_name: 'preferredGivenName',
+        preferred_middle_name: 'preferredMiddleName',
+        preferred_family_name: 'preferredFamilyName',
+        primary_org_sourced_id: 'primaryOrgSourcedId',
+        pronouns: 'pronouns'
+      }.freeze,
+      converters: {
+        boolean: [:enabled_user].freeze,
+        datetime: [:date_last_modified].freeze,
+        list: [:user_ids, :agent_sourced_ids, :grades, :resource_sourced_ids].freeze,
+        required: [:sourced_id, :enabled_user, :username, :given_name, :family_name].freeze,
+        status: [:status].freeze,
+        user_ids: [:user_ids].freeze
+      }.freeze
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, enabled_user: nil, username:, user_ids: nil, given_name:, family_name:, middle_name: nil, identifier: nil, email: nil, sms: nil, phone: nil, agent_sourced_ids: [], grades: nil, password: nil, user_master_identifier: nil, resource_sourced_ids: nil, preferred_given_name: nil, preferred_middle_name: nil, preferred_family_name: nil, primary_org_sourced_id: nil, pronouns: nil, kana_given_name: nil, kana_family_name: nil, kana_middle_name: nil, home_class: nil, **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @enabled_user = enabled_user
+      @username = username
+      @user_ids = user_ids
+      @given_name = given_name
+      @family_name = family_name
+      @middle_name = middle_name
+      @identifier = identifier
+      @email = email
+      @sms = sms
+      @phone = phone
+      @agent_sourced_ids = agent_sourced_ids
+      @grades = grades
+      @password = password
+      @user_master_identifier = user_master_identifier
+      @resource_sourced_ids = resource_sourced_ids
+      @preferred_given_name = preferred_given_name
+      @preferred_middle_name = preferred_middle_name
+      @preferred_family_name = preferred_family_name
+      @primary_org_sourced_id = primary_org_sourced_id
+      @pronouns = pronouns
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/user_profile.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Meibo
+  class UserProfile
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        user_sourced_id: 'userSourcedId',
+        profile_type: 'profileType',
+        vendor_id: 'vendorId',
+        application_id: 'applicationId',
+        description: 'description',
+        credential_type: 'credentialType',
+        username: 'username',
+        password: 'password'
+      },
+      converters: {
+        datetime: [:date_last_modified],
+        required: [:sourced_id, :user_sourced_id, :profile_type, :vendor_id, :credential_type, :username],
+        status: [:status]
+      }
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, user_sourced_id:, profile_type:, vendor_id:, application_id: nil, description: nil, credential_type:, username:, password: nil, **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @user_sourced_id = user_sourced_id
+      @profile_type = profile_type
+      @vendor_id = vendor_id
+      @application_id = application_id
+      @description = description
+      @credential_type = credential_type
+      @username = username
+      @password = password
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/user_profile_set.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Meibo
+  class UserProfileSet < DataSet
+    def initialize(data, user_set:)
+      super(data)
+      @user_set = user_set
+    end
+
+    def check_semantically_consistent
+      super
+
+      each do |user_profile|
+        @user_set.find_by_sourced_id(user_profile.user_sourced_id)
+      end
+    end
+  end
+end

data/lib/meibo/user_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Meibo
+  class UserSet < DataSet
+    def initialize(data, organization_set:)
+      super(data)
+      @organization_set = organization_set
+    end
+
+    def check_semantically_consistent
+      super
+
+      each do |user|
+        if user.primary_org_sourced_id
+          @organization_set.find_by_sourced_id(user.primary_org_sourced_id)
+        end
+
+        user.agent_sourced_ids.each do |agent_sourced_id|
+          find_by_sourced_id(agent_sourced_id)
+        end
+      end
+    end
+  end
+end

data/lib/meibo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Meibo
+  VERSION = "0.1.0"
+end

data/lib/meibo.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/meibo/errors.rb")
+loader.ignore("#{__dir__}/meibo/factory_bot")
+loader.setup
+
+require_relative "meibo/version"
+require_relative "meibo/errors"
+
+module Meibo
+  CSV_ENCODING = 'UTF-8'
+  ENUM_EXT_PATTERN = /\Aext:[a-zA-Z0-9\.\-_]+\z/
+end
+
+loader.eager_load

data/meibo.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/meibo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "meibo"
+  spec.version = Meibo::VERSION
+  spec.authors = ["Seiei Miyagi"]
+  spec.email = ["hanachin@gmail.com"]
+
+  spec.summary = "Meibo is a ruby library for OneRoster CSV Binding Japan Profile."
+  spec.homepage = "https://github.com/hanachin/meibo"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hanachin/meibo"
+  spec.metadata["changelog_uri"] = "https://github.com/hanachin/meibo/blob/meibo/v#{Meibo::VERSION}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/meibo.rbs

@@ -0,0 +1,4 @@
+module Meibo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: meibo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seiei Miyagi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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: zeitwerk
+  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'
+description:
+email:
+- hanachin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/meibo.rb
+- lib/meibo/academic_session.rb
+- lib/meibo/academic_session_set.rb
+- lib/meibo/base_profile.rb
+- lib/meibo/builder.rb
+- lib/meibo/builder/academic_session_builder.rb
+- lib/meibo/builder/base_builder.rb
+- lib/meibo/builder/classroom_builder.rb
+- lib/meibo/builder/course_builder.rb
+- lib/meibo/builder/demographic_builder.rb
+- lib/meibo/builder/enrollment_builder.rb
+- lib/meibo/builder/organization_builder.rb
+- lib/meibo/builder/role_builder.rb
+- lib/meibo/builder/user_builder.rb
+- lib/meibo/builder/user_profile_builder.rb
+- lib/meibo/classroom.rb
+- lib/meibo/classroom_set.rb
+- lib/meibo/converter.rb
+- lib/meibo/course.rb
+- lib/meibo/course_set.rb
+- lib/meibo/data_model.rb
+- lib/meibo/data_set.rb
+- lib/meibo/demographic.rb
+- lib/meibo/demographic_set.rb
+- lib/meibo/enrollment.rb
+- lib/meibo/enrollment_set.rb
+- lib/meibo/errors.rb
+- lib/meibo/factory_bot/academic_session.rb
+- lib/meibo/factory_bot/all.rb
+- lib/meibo/factory_bot/classroom.rb
+- lib/meibo/factory_bot/course.rb
+- lib/meibo/factory_bot/demographic.rb
+- lib/meibo/factory_bot/enrollment.rb
+- lib/meibo/factory_bot/manifest.rb
+- lib/meibo/factory_bot/memory_package.rb
+- lib/meibo/factory_bot/organization.rb
+- lib/meibo/factory_bot/role.rb
+- lib/meibo/factory_bot/user.rb
+- lib/meibo/factory_bot/user_profile.rb
+- lib/meibo/japan_profile.rb
+- lib/meibo/japan_profile/academic_session.rb
+- lib/meibo/japan_profile/classroom.rb
+- lib/meibo/japan_profile/course.rb
+- lib/meibo/japan_profile/demographic.rb
+- lib/meibo/japan_profile/enrollment.rb
+- lib/meibo/japan_profile/organization.rb
+- lib/meibo/japan_profile/role.rb
+- lib/meibo/japan_profile/user.rb
+- lib/meibo/japan_profile/user_profile.rb
+- lib/meibo/manifest.rb
+- lib/meibo/manifest/processing_mode.rb
+- lib/meibo/organization.rb
+- lib/meibo/organization_set.rb
+- lib/meibo/reader.rb
+- lib/meibo/role.rb
+- lib/meibo/role_set.rb
+- lib/meibo/roster.rb
+- lib/meibo/user.rb
+- lib/meibo/user_profile.rb
+- lib/meibo/user_profile_set.rb
+- lib/meibo/user_set.rb
+- lib/meibo/version.rb
+- meibo.gemspec
+- sig/meibo.rbs
+homepage: https://github.com/hanachin/meibo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/hanachin/meibo
+  source_code_uri: https://github.com/hanachin/meibo
+  changelog_uri: https://github.com/hanachin/meibo/blob/meibo/v0.1.0/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: Meibo is a ruby library for OneRoster CSV Binding Japan Profile.
+test_files: []