meibo 0.16.0 → 0.17.0

data/lib/meibo/roster.rb

@@ -1,34 +1,45 @@
 # frozen_string_literal: true
 
-require 'zip'
-require 'csv'
+require "zip"
+require "csv"
 
 module Meibo
   class Roster
     class << self
       def from_file(file_path, profile: Meibo.default_profile)
         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]))
+          return read_data(reader, profile)
+        end
+      end
 
-          new(manifest_properties: manifest.to_h, profile: profile, **reader.load_bulk_files).tap(&:check_semantically_consistent)
+      def from_buffer(io, profile: Meibo.default_profile)
+        Reader.open_buffer(io, profile: profile) do |reader|
+          return read_data(reader, profile)
         end
       end
 
       private
 
+      def read_data(reader, profile)
+        begin
+          manifest = reader.manifest
+        rescue CsvFileNotFoundError
+          raise NotSupportedError, "OneRoster 1.0\u306F\u30B5\u30DD\u30FC\u30C8\u3057\u3066\u3044\u307E\u305B\u3093"
+        rescue StandardError
+          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
+
       def validate_absent_files(reader, absent_filenames)
         absent_filenames.each do |absent_filename|
           next unless reader.file_entry?(absent_filename)
@@ -60,13 +71,15 @@ module Meibo
       def validate_supported_processing_mode(manifest)
         return if manifest.file_attributes(processing_mode: Meibo::Manifest::PROCESSING_MODES[:delta]).empty?
 
-        raise NotSupportedError, 'DELTAはサポートしていません'
+        raise NotSupportedError, "DELTA\u306F\u30B5\u30DD\u30FC\u30C8\u3057\u3066\u3044\u307E\u305B\u3093"
       end
     end
 
-    attr_reader :profile, :manifest_properties, :academic_sessions, :classes, :courses, :demographics, :enrollments, :organizations, :roles, :user_profiles, :users
+    attr_reader :profile, :manifest_properties, :academic_sessions, :classes, :courses, :demographics, :enrollments,
+                :organizations, :roles, :user_profiles, :users
 
-    def initialize(profile: Meibo.default_profile, manifest_properties: {}, academic_sessions: [], classes: [], courses: [], demographics: [], enrollments: [], organizations: [], roles: [], user_profiles: [], users: [])
+    def initialize(profile: Meibo.default_profile, manifest_properties: {}, academic_sessions: [], classes: [],
+                   courses: [], demographics: [], enrollments: [], organizations: [], roles: [], user_profiles: [], users: [])
       @profile = profile
       @manifest_properties = manifest_properties
       @academic_sessions = profile.data_set_for(:academic_sessions).new(academic_sessions, roster: self)
@@ -98,33 +111,43 @@ module Meibo
       ].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
+    def write_to_buffer(io)
+      Zip::File.open_buffer(io) do |zipfile|
+        write(zipfile)
+      end
+    end
+
+    def write_to_file(path)
+      Zip::File.open(path) do |zipfile|
+        write(zipfile)
+      end
+    end
+
+    private
+
+    def write(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
-        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
+      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
 
-    private
-
     def build_manifest
       new_manifest_properties = file_properties.merge(manifest_properties)
       Meibo::Manifest.build_from_default(**new_manifest_properties)

data/lib/meibo/user.rb

@@ -2,46 +2,47 @@
 
 module Meibo
   class User
-    USER_ID_FORMAT_REGEXP = /\A\{[^:\}]+:[^\}]+\}\z/
+    USER_ID_FORMAT_REGEXP = /\A\{[^:}]+:[^}]+\}\z/.freeze
 
     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'
+        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,
+        list: %i[user_ids agent_sourced_ids grades resource_sourced_ids].freeze,
+        required: %i[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, **extension_fields)
+    def initialize(sourced_id:, username:, given_name:, family_name:, status: nil, date_last_modified: nil,
+                   enabled_user: nil, user_ids: nil, 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, **extension_fields)
       @sourced_id = sourced_id
       @status = status
       @date_last_modified = date_last_modified
@@ -73,7 +74,7 @@ module Meibo
     end
 
     def agents
-      agent_sourced_ids.map {|agent_sourced_id| Meibo.current_roster.users.find(agent_sourced_id) }
+      agent_sourced_ids.map { |agent_sourced_id| Meibo.current_roster.users.find(agent_sourced_id) }
     end
 
     def demographic

data/lib/meibo/user_profile.rb

@@ -5,26 +5,27 @@ module Meibo
     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'
+        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],
+        required: %i[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)
+    def initialize(sourced_id:, user_sourced_id:, profile_type:, vendor_id:, credential_type:, username:, status: nil, date_last_modified: nil,
+                   application_id: nil, description: nil, password: nil, **extension_fields)
       @sourced_id = sourced_id
       @status = status
       @date_last_modified = date_last_modified

data/lib/meibo/user_set.rb

@@ -6,9 +6,7 @@ module Meibo
       super
 
       each do |user|
-        if user.primary_org_sourced_id
-          roster.organizations.find(user.primary_org_sourced_id)
-        end
+        roster.organizations.find(user.primary_org_sourced_id) if user.primary_org_sourced_id
 
         user.agent_sourced_ids.each do |agent_sourced_id|
           find(agent_sourced_id)

data/lib/meibo/version.rb

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

data/lib/meibo.rb

@@ -10,8 +10,8 @@ require_relative "meibo/version"
 require_relative "meibo/errors"
 
 module Meibo
-  CSV_ENCODING = 'UTF-8'
-  ENUM_EXT_PATTERN = /\Aext:[a-zA-Z0-9\.\-_]+\z/
+  CSV_ENCODING = "UTF-8"
+  ENUM_EXT_PATTERN = /\Aext:[a-zA-Z0-9.\-_]+\z/.freeze
 
   class << self
     attr_accessor :default_profile

data/meibo.gemspec

@@ -30,9 +30,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "csv", ">= 3.1.4"
   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
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: meibo
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Seiei Miyagi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.4
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -125,7 +140,8 @@ 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.16.0/CHANGELOG.md
+  changelog_uri: https://github.com/hanachin/meibo/blob/meibo/v0.17.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: