capsium 0.1.2 → 0.2.0

data/sig/capsium/package/security_config.rbs

@@ -0,0 +1,57 @@
+module Capsium
+  class Package
+    # The "integrityChecks" object of security.json: SHA-256 checksums
+    # keyed by package-relative path.
+    class IntegrityChecks
+      ALGORITHMS: Array[String]
+
+      attr_accessor checksum_algorithm: String
+      attr_accessor checksums: Hash[String, String]
+
+      def initialize: (?checksum_algorithm: String? checksum_algorithm,
+                       ?checksums: Hash[String, String] checksums) -> void
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+
+    # The "digitalSignatures" object of security.json (parsed only;
+    # signing is a later phase).
+    class DigitalSignatures
+      attr_accessor public_key: String?
+      attr_accessor signature_file: String?
+
+      def initialize: (?public_key: String? public_key,
+                       ?signature_file: String? signature_file) -> void
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+
+    # The "security" object of security.json.
+    class SecurityData
+      attr_accessor integrity_checks: IntegrityChecks?
+      attr_accessor digital_signatures: DigitalSignatures?
+
+      def initialize: (?integrity_checks: IntegrityChecks? integrity_checks,
+                       ?digital_signatures: DigitalSignatures? digital_signatures) -> void
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+
+    # Canonical security.json model (generated at pack time).
+    class SecurityConfig
+      attr_accessor security: SecurityData?
+
+      def initialize: (?security: SecurityData? security) -> void
+
+      def self.from_json: (String json) -> instance
+
+      def checksums: () -> Hash[String, String]
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/capsium/package/storage.rbs

@@ -0,0 +1,28 @@
+module Capsium
+  class Package
+    # Loads and writes storage.json and instantiates its datasets
+    # (ARCHITECTURE.md section 5).
+    class Storage
+      attr_reader path: String
+      attr_reader config: StorageConfig
+      attr_reader datasets: Array[Dataset]
+
+      def initialize: (String path) -> void
+
+      def data_sets: () -> Hash[String, DatasetConfig]
+
+      def load_datasets: () -> Array[Dataset]
+
+      def dataset: (String name) -> Dataset?
+
+      def dataset_names: () -> Array[String]
+
+      def empty?: () -> bool
+
+      def save_to_file: (?String output_path) -> void
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/capsium/package/storage_config.rbs

@@ -0,0 +1,61 @@
+module Capsium
+  class Package
+    # A single dataset entry (ARCHITECTURE.md section 5): schema-backed
+    # file (via "source") or SQLite ("databaseFile" + "table").
+    class DatasetConfig
+      FORMATS: Hash[String, String]
+      SCHEMA_TYPES: Array[String]
+
+      attr_accessor source: String?
+      attr_accessor schema_file: String?
+      attr_accessor schema_type: String?
+      attr_accessor database_file: String?
+      attr_accessor table: String?
+
+      def initialize: (?source: String? source, ?schema_file: String? schema_file,
+                       ?schema_type: String? schema_type,
+                       ?database_file: String? database_file,
+                       ?table: String? table) -> void
+
+      def format: () -> String
+
+      def sqlite?: () -> bool
+
+      def backing_file: () -> String
+
+      def to_dataset: (String name, String package_path) -> Dataset
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+
+    # The "storage" object holding the dataSets map.
+    class StorageData
+      attr_accessor data_sets: Hash[String, DatasetConfig]
+
+      def initialize: (?data_sets: Hash[String, DatasetConfig] data_sets) -> void
+
+      def data_sets_from_json: (StorageData model, untyped value) -> void
+
+      def data_sets_to_json: (StorageData model, Hash[String, untyped] doc) -> void
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+
+    # Canonical storage.json model. The legacy array form is normalized
+    # on read; writers emit only the canonical form.
+    class StorageConfig
+      attr_accessor storage: StorageData?
+
+      def initialize: (?storage: StorageData? storage) -> void
+
+      def self.from_json: (String json) -> instance
+
+      def data_sets: () -> Hash[String, DatasetConfig]
+
+      def to_json: (*untyped args) -> String
+      def to_hash: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/capsium/package/validator.rbs

@@ -0,0 +1,29 @@
+module Capsium
+  class Package
+    # Validates a package directory or .cap file against the canonical
+    # schemas (ARCHITECTURE.md sections 2-6) and reports one result per
+    # check. Used by `capsium package validate`.
+    class Validator
+      EXTERNAL_REFERENCE_PATTERN: Regexp
+      TEXT_CONTENT_MIME: Regexp
+
+      # One named validation check with its problems; ok when messages
+      # is empty.
+      class CheckResult
+        attr_reader name: String
+        attr_reader ok: bool
+        attr_reader messages: Array[String]
+
+        def initialize: (name: String name, ok: bool ok, messages: Array[String] messages) -> void
+
+        def ok?: () -> bool
+      end
+
+      def initialize: (String package_path) -> void
+
+      def run: () -> Array[CheckResult]
+
+      def valid?: () -> bool
+    end
+  end
+end

data/sig/capsium/package.rbs

@@ -0,0 +1,53 @@
+module Capsium
+  # A Capsium package loaded from a directory or a .cap file
+  # (ARCHITECTURE.md section 1).
+  class Package
+    MANIFEST_FILE: String
+    METADATA_FILE: String
+    STORAGE_FILE: String
+    ROUTES_FILE: String
+    SECURITY_FILE: String
+    CONTENT_DIR: String
+    DATA_DIR: String
+
+    attr_reader name: String
+    attr_reader path: String
+    attr_reader manifest: Manifest
+    attr_reader metadata: Metadata
+    attr_reader routes: Routes
+    attr_reader storage: Storage
+    attr_reader security: Security
+    attr_reader load_type: Symbol
+
+    def initialize: (String | Pathname path, ?load_type: Symbol? load_type) -> void
+
+    def prepare_package: (Pathname path) -> (String | Pathname)
+
+    def solidify: () -> void
+
+    def decompress_cap_file: (String | Pathname file_path) -> String
+
+    def load_package: () -> void
+
+    # Removes the temporary extraction directory of a .cap-loaded
+    # package; a no-op for directory loads.
+    def cleanup: () -> void
+
+    def datasets: () -> Array[Dataset]
+
+    # The .cap file this package was loaded from, or nil when loaded
+    # from a directory.
+    def cap_file_path: () -> String?
+
+    def content_files: () -> Array[String]
+
+    def determine_load_type: (String | Pathname path) -> Symbol
+
+    # Verifies the package against security.json (ARCHITECTURE.md
+    # section 6). Returns a list of typed errors; empty when no
+    # security.json is present or all checksums match.
+    def verify_integrity: () -> Array[Security::ChecksumMismatch | Security::MissingFile | Security::UncheckedFile]
+
+    def verify_integrity!: () -> void
+  end
+end

data/sig/capsium/packager.rbs

@@ -0,0 +1,23 @@
+module Capsium
+  # Packs a package directory into a .cap file (generating
+  # security.json) and unpacks .cap files with zip-slip protection.
+  class Packager
+    class FileAlreadyExistsError < StandardError
+    end
+
+    # Raised when a .cap archive contains an entry whose name would be
+    # written outside the destination directory (zip-slip).
+    class UnsafeEntryError < Capsium::Error
+    end
+
+    DRIVE_LETTER_PATTERN: Regexp
+
+    def pack: (Package package, ?Hash[Symbol, untyped] options) -> String
+
+    def unpack: (String cap_file_path, String destination) -> void
+
+    def compress_package: (Package package, String cap_file) -> void
+
+    def relative_path_current: (String absolute_path) -> String
+  end
+end

data/sig/capsium/reactor/introspection.rbs

@@ -0,0 +1,31 @@
+module Capsium
+  class Reactor
+    # Monitoring HTTP API reports for the package this reactor serves
+    # (ARCHITECTURE.md section 7).
+    class Introspection
+      METADATA_PATH: String
+      ROUTES_PATH: String
+      CONTENT_HASHES_PATH: String
+      CONTENT_VALIDITY_PATH: String
+      PATHS: Array[String]
+
+      attr_reader package: Package
+
+      def initialize: (Package package) -> void
+
+      def endpoint?: (String path) -> bool
+
+      # The report body for an introspection endpoint, or nil when the
+      # path is not an introspection endpoint.
+      def report_for: (String path) -> Hash[Symbol, untyped]?
+
+      def metadata_report: () -> Hash[Symbol, untyped]
+
+      def routes_report: () -> Hash[Symbol, untyped]
+
+      def content_hashes_report: () -> Hash[Symbol, untyped]
+
+      def content_validity_report: () -> Hash[Symbol, untyped]
+    end
+  end
+end

data/sig/capsium/reactor.rbs

@@ -0,0 +1,30 @@
+module Capsium
+  # Rack-free WEBrick reactor: serves the package routes plus the
+  # Monitoring HTTP API (ARCHITECTURE.md section 7) and reloads the
+  # package on filesystem changes.
+  class Reactor
+    DEFAULT_PORT: Integer
+    DEFAULT_CACHE_CONTROL: String
+
+    attr_reader package: Package
+    attr_reader package_path: String
+    attr_reader routes: Package::Routes
+    attr_reader port: Integer
+    attr_reader cache_control: String?
+    attr_reader server: untyped
+    attr_reader server_thread: Thread?
+    attr_reader introspection: Introspection
+
+    def initialize: (package: Package | String package, ?port: Integer port,
+                     ?cache_control: String? cache_control,
+                     ?do_not_listen: bool do_not_listen) -> void
+
+    def serve: () -> untyped
+
+    def handle_request: (untyped request, untyped response) -> untyped
+
+    def mount_routes: () -> void
+
+    def restart_server: () -> Thread
+  end
+end

data/sig/capsium.rbs

@@ -1,4 +1,6 @@
 module Capsium
+  class Error < StandardError
+  end
+
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capsium
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: cssminify
-  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: csv
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: htmlcompressor
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: html-proofer
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,47 +66,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: lutaml-model
   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: json-schema
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '0.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '0.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
@@ -140,44 +103,22 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.2
-- !ruby/object:Gem::Dependency
-  name: scss_lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: shale
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 2.3.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -206,20 +147,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: uglifier
-  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: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -248,91 +175,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.58'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.58'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Capsium
+description: 'Capsium facilitates the creation, management and deployment of content
+  packages with ease. This gem provides a structured way to handle content, data,
+  and metadata for various applications: it packages them into .cap files and serves
+  them over HTTP.'
 email:
 - open.source@ribose.com
 executables:
@@ -345,8 +191,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - README.adoc
 - Rakefile
 - bin/console
@@ -355,24 +203,46 @@ files:
 - exe/capsium
 - lib/capsium.rb
 - lib/capsium/cli.rb
+- lib/capsium/cli/convert.rb
+- lib/capsium/cli/package.rb
+- lib/capsium/cli/reactor.rb
+- lib/capsium/converters.rb
 - lib/capsium/converters/jekyll.rb
 - lib/capsium/package.rb
 - lib/capsium/package/dataset.rb
-- lib/capsium/package/dataset_config.rb
 - lib/capsium/package/manifest.rb
 - lib/capsium/package/manifest_config.rb
 - lib/capsium/package/metadata.rb
 - lib/capsium/package/metadata_config.rb
 - lib/capsium/package/routes.rb
 - lib/capsium/package/routes_config.rb
+- lib/capsium/package/security.rb
+- lib/capsium/package/security_config.rb
 - lib/capsium/package/storage.rb
 - lib/capsium/package/storage_config.rb
+- lib/capsium/package/validator.rb
 - lib/capsium/packager.rb
-- lib/capsium/protector.rb
 - lib/capsium/reactor.rb
+- lib/capsium/reactor/introspection.rb
 - lib/capsium/thor_ext.rb
 - lib/capsium/version.rb
 - sig/capsium.rbs
+- sig/capsium/package.rbs
+- sig/capsium/package/dataset.rbs
+- sig/capsium/package/manifest.rbs
+- sig/capsium/package/manifest_config.rbs
+- sig/capsium/package/metadata.rbs
+- sig/capsium/package/metadata_config.rbs
+- sig/capsium/package/routes.rbs
+- sig/capsium/package/routes_config.rbs
+- sig/capsium/package/security.rbs
+- sig/capsium/package/security_config.rbs
+- sig/capsium/package/storage.rbs
+- sig/capsium/package/storage_config.rbs
+- sig/capsium/package/validator.rbs
+- sig/capsium/packager.rbs
+- sig/capsium/reactor.rbs
+- sig/capsium/reactor/introspection.rbs
 homepage: https://github.com/capsiums/capsium
 licenses:
 - MIT
@@ -380,7 +250,7 @@ metadata:
   homepage_uri: https://github.com/capsiums/capsium
   source_code_uri: https://github.com/capsiums/capsium
   changelog_uri: https://github.com/capsiums/capsium/releases
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -388,15 +258,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Capsium
+summary: Packager and reactor for Capsium packages (.cap)
 test_files: []