capsium 0.1.1 → 0.2.0

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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-05 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: json
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,19 +66,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
@@ -112,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
@@ -178,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
@@ -220,65 +175,12 @@ 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.12.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-- !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'
-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'
+- open.source@ribose.com
 executables:
 - capsium
 extensions: []
@@ -289,50 +191,66 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - README.adoc
 - Rakefile
 - bin/console
 - bin/setup
 - capsium.gemspec
 - exe/capsium
-- images/005df7415a331c466ad2d9a42efdd212b6f42fe50b5fd3b3174c86c706f58244.png
-- images/0374025b3af99b8a473282c8cbbf9fcd29573cf41e586982f328f86c0690f43d.png
-- images/0bb4da785be40ef58e219470ebccb979325928b75453dc46bac23c6ee8a7a7cb.png
-- images/6aa294dccc81af594aacbe804e7ddffdc17eacc28357338108aea5d021d831ff.png
-- images/72dd3fbf3f4b475e27a0e7fb8137c475c32c41f8d222bcf62d6a9ccf102d9532.png
-- images/8772b6961d169738d7b0fa0b669b06fc2f40632d4c62586c7634fc17b93182a3.png
-- images/a998d842405933d45723606ff3f70162ec95b4ef30db25464a366184fd08fb9b.png
-- images/aa8980547e8c003d33273ab4d80e62da7f317bd7581b293c06d67f5331f24f31.png
-- images/bb78a872b539e0e9b2d80dee58acbb688f3f2727b324a5bf8bf417a69d94a166.png
-- images/c48fc83b17725d85fbb64d971196ebfccd8c5c757fe6aa5845303f6e315879b6.png
-- images/f08ef07308d08119ac2124bb7428c8bef17ef1ca70045696604d6e83015a9b91.png
-- images/f7514206111b695647eae9adfcf498ba3e0ff83ecfe25f3fc3ed8e9f04c5c726-1.png
-- images/f7514206111b695647eae9adfcf498ba3e0ff83ecfe25f3fc3ed8e9f04c5c726.png
 - 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/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
-homepage: https://github.com/metanorma/capsium
+- 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
 metadata:
-  homepage_uri: https://github.com/metanorma/capsium
-  source_code_uri: https://github.com/metanorma/capsium
-  changelog_uri: https://github.com/metanorma/capsium/releases
-post_install_message:
+  homepage_uri: https://github.com/capsiums/capsium
+  source_code_uri: https://github.com/capsiums/capsium
+  changelog_uri: https://github.com/capsiums/capsium/releases
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -340,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.4.10
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Capsium
+summary: Packager and reactor for Capsium packages (.cap)
 test_files: []

data/lib/capsium/protector.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-# lib/capsium/protector.rb
-require "openssl"
-require "base64"
-require "json"
-
-module Capsium
-  class Protector
-    def initialize(package, encryption_metadata = nil, digital_signature_metadata = nil)
-      @package = package
-      @encryption_metadata = encryption_metadata
-      @digital_signature_metadata = digital_signature_metadata
-    end
-
-    def apply_encryption_and_sign
-      encrypted_file = apply_encryption if @encryption_metadata
-      sign_package(encrypted_file) if @digital_signature_metadata
-    end
-
-    def verify_signature
-      signature_data = JSON.parse(File.read(signature_file_path))
-      public_key = OpenSSL::PKey::RSA.new(File.read(public_key_path))
-      digest = OpenSSL::Digest.new(signature_data["algorithm"])
-      data = combined_data
-      signature = Base64.decode64(signature_data["signature"])
-
-      public_key.verify(digest, signature, data)
-    end
-
-    private
-
-    def apply_encryption
-      encryption = @encryption_metadata
-      data = File.read(File.join(@package.path, Package::ENCRYPTED_PACKAGING_FILE))
-      cipher = OpenSSL::Cipher.new(encryption[:algorithm])
-      cipher.encrypt
-      key = cipher.random_key
-      iv = cipher.random_iv
-
-      encrypted_data = cipher.update(data) + cipher.final
-      encrypted_file = File.join(@package.path, "#{@package.name}.enc")
-
-      File.open(encrypted_file, "wb") do |f|
-        f.write(iv)
-        f.write(encrypted_data)
-      end
-
-      save_encryption_key(key, encryption[:keyManagement])
-      encrypted_file
-    end
-
-    def save_encryption_key(key, key_management)
-      case key_management
-      when "secure"
-        # Implement secure key storage mechanism
-        File.write(File.join(@package.path, "encryption_key.secure"), Base64.encode64(key))
-      else
-        raise "Unknown key management strategy: #{key_management}"
-      end
-    end
-
-    def sign_package(encrypted_file)
-      key = OpenSSL::PKey::RSA.new(@digital_signature_metadata[:keyLength])
-      data = combined_data(encrypted_file)
-      digest = OpenSSL::Digest.new(@digital_signature_metadata[:algorithm])
-      signature_data = key.sign(digest, data)
-
-      signature_json = {
-        algorithm: @digital_signature_metadata[:algorithm],
-        certificateType: @digital_signature_metadata[:certificateType],
-        signature: Base64.encode64(signature_data)
-      }
-
-      File.write(signature_file_path, JSON.pretty_generate(signature_json))
-      File.write(public_key_path, key.public_key.to_pem)
-    end
-
-    def combined_data(encrypted_file = nil)
-      metadata_content = File.read(File.join(@package.path, Package::METADATA_FILE))
-      signature_content = File.read(signature_file_path).sub(/"signature": ".*"/, '"signature": ""')
-      package_enc_content = File.read(encrypted_file || File.join(@package.path, "#{@package.name}.enc"))
-
-      metadata_content + signature_content + package_enc_content
-    end
-
-    def signature_file_path
-      File.join(@package.path, @digital_signature_metadata[:signatureFile])
-    end
-
-    def public_key_path
-      File.join(@package.path, "public_key.pem")
-    end
-  end
-end