prompt-sanitizer 0.1.0

data/lib/prompt_sanitizer.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "prompt_sanitizer/version"
+
+module PromptSanitizer
+  class Error              < StandardError; end
+  class ConfigurationError < Error; end
+  class ModeError          < Error; end
+
+  # Raised when on_detect: :block and PII is found.
+  # @example
+  #   rescue PromptSanitizer::PIIDetectedError => e
+  #     e.entities  # => Array<DetectedEntity>
+  class PIIDetectedError < Error
+    attr_reader :entities
+
+    def initialize(entities)
+      @entities = entities
+      types = entities.map { |e| e.entity_type }.uniq.join(", ")
+      super("PII detected and blocked (types: #{types})")
+    end
+  end
+
+  # ── Configuration ──────────────────────────────────────────────────────────
+
+  class Configuration
+    # Detection mode: :fast, :smart, :full
+    attr_accessor :mode
+
+    # NER backend (used in :smart / :full mode): :informers, :mitie
+    attr_accessor :ner_backend
+
+    # NER model variant: "distilbert" (66 MB, default) or "bert-base" (110 MB)
+    attr_accessor :ner_model
+
+    # Vault persistence: :memory (default), :rails_cache, :active_record
+    attr_accessor :vault_store
+
+    # Audit log backend: :none (default), :memory, :active_record
+    attr_accessor :audit_log
+
+    # Locale for synthetic replacements (Faker locale string, e.g. "en", "fr")
+    attr_accessor :locale
+
+    def initialize
+      @mode        = :fast
+      @ner_backend = :informers
+      @ner_model   = "distilbert"
+      @vault_store = :memory
+      @audit_log   = :none
+      @locale      = "en"
+    end
+  end
+
+  # ── Global helpers ──────────────────────────────────────────────────────────
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # PromptSanitizer.configure do |config|
+    #   config.mode = :smart
+    # end
+    def configure
+      yield configuration
+    end
+
+    # Returns (and memoises) a Sanitizer built from the global configuration.
+    # Safe to call from multiple threads once initialised.
+    def sanitizer
+      @sanitizer ||= Sanitizer.new(
+        mode:        configuration.mode,
+        ner_backend: configuration.ner_backend,
+        ner_model:   configuration.ner_model,
+        audit_log:   configuration.audit_log,
+        locale:      configuration.locale
+      )
+    end
+
+    # Reset global state — intended for use in tests only.
+    def reset!
+      @configuration = nil
+      @sanitizer     = nil
+    end
+  end
+end
+
+# Auto-require remaining library files (loaded after the module is defined
+# so they can reference PromptSanitizer constants without forward-ref errors).
+require_relative "prompt_sanitizer/entities"
+require_relative "prompt_sanitizer/modes"
+require_relative "prompt_sanitizer/result"
+require_relative "prompt_sanitizer/vault"
+require_relative "prompt_sanitizer/engines/regex_engine"
+require_relative "prompt_sanitizer/engines/secrets_engine"
+require_relative "prompt_sanitizer/engines/ner_engine"
+require_relative "prompt_sanitizer/synthetic"
+require_relative "prompt_sanitizer/audit/base"
+require_relative "prompt_sanitizer/audit/memory_audit_log"
+require_relative "prompt_sanitizer/session"
+require_relative "prompt_sanitizer/sanitizer"
+
+# Rails integrations — loaded only when Rails is present.
+if defined?(Rails)
+  require_relative "prompt_sanitizer/railtie"
+  require_relative "prompt_sanitizer/integrations/middleware"
+  require_relative "prompt_sanitizer/integrations/action_controller"
+  require_relative "prompt_sanitizer/integrations/active_job"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: prompt-sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeslor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !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: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  A lightweight, production-ready PII sanitizer built specifically for LLM
+  pipelines. Detects and redacts emails, phone numbers, SSNs, credit cards,
+  API keys, JWTs, AWS credentials, and more before prompts reach any model
+  API. Supports bidirectional sanitization (strip before, restore after) and
+  multi-turn session vaults. Zero cloud calls. GDPR & HIPAA ready.
+email:
+- hi@jeslor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/generators/prompt_sanitizer/install_generator.rb
+- lib/generators/prompt_sanitizer/templates/initializer.rb
+- lib/prompt_sanitizer.rb
+- lib/prompt_sanitizer/audit/base.rb
+- lib/prompt_sanitizer/audit/memory_audit_log.rb
+- lib/prompt_sanitizer/engines/ner_engine.rb
+- lib/prompt_sanitizer/engines/regex_engine.rb
+- lib/prompt_sanitizer/engines/secrets_engine.rb
+- lib/prompt_sanitizer/entities.rb
+- lib/prompt_sanitizer/integrations/action_controller.rb
+- lib/prompt_sanitizer/integrations/active_job.rb
+- lib/prompt_sanitizer/integrations/middleware.rb
+- lib/prompt_sanitizer/modes.rb
+- lib/prompt_sanitizer/railtie.rb
+- lib/prompt_sanitizer/result.rb
+- lib/prompt_sanitizer/sanitizer.rb
+- lib/prompt_sanitizer/session.rb
+- lib/prompt_sanitizer/synthetic.rb
+- lib/prompt_sanitizer/vault.rb
+- lib/prompt_sanitizer/version.rb
+homepage: https://www.jeslor.com/prompt-sanitizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.jeslor.com/prompt-sanitizer
+  source_code_uri: https://github.com/jeslor/prompt-sanitizer/tree/main/packages/ruby
+  changelog_uri: https://github.com/jeslor/prompt-sanitizer/blob/main/packages/ruby/CHANGELOG.md
+  bug_tracker_uri: https://github.com/jeslor/prompt-sanitizer/issues
+  documentation_uri: https://rubydoc.info/gems/prompt-sanitizer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Bidirectional PII sanitizer for LLM pipelines — Ruby edition
+test_files: []