guardrails-ruby 0.1.0

data/lib/guardrails_ruby/result.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module GuardrailsRuby
+  class Result
+    attr_reader :violations, :original_text
+
+    def initialize(original_text: nil, violations: [])
+      @original_text = original_text
+      @violations = violations
+    end
+
+    def passed?
+      @violations.empty?
+    end
+
+    def sanitized
+      redact_violation = @violations.find { |v| v.action == :redact && v.sanitized }
+      redact_violation ? redact_violation.sanitized : @original_text
+    end
+
+    def merge(other)
+      merged_violations = @violations + other.violations
+
+      # Use the most recent sanitized text as the base
+      merged_text = other.original_text || @original_text
+
+      self.class.new(
+        original_text: merged_text,
+        violations: merged_violations
+      )
+    end
+
+    def blocked?
+      @violations.any? { |v| v.action == :block }
+    end
+
+    def warnings
+      @violations.select { |v| v.action == :warn }
+    end
+
+    def redactions
+      @violations.select { |v| v.action == :redact }
+    end
+
+    def to_s
+      if passed?
+        "Result: passed"
+      else
+        "Result: #{violations.size} violation(s) - #{violations.map(&:to_s).join('; ')}"
+      end
+    end
+  end
+end

data/lib/guardrails_ruby/version.rb

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

data/lib/guardrails_ruby/violation.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GuardrailsRuby
+  class Violation
+    ACTIONS = %i[block warn redact log].freeze
+
+    attr_reader :type, :detail, :action, :severity, :matches, :sanitized
+
+    def initialize(type:, detail:, action: :block, severity: nil, matches: nil, sanitized: nil)
+      unless ACTIONS.include?(action)
+        raise ArgumentError, "Invalid action #{action.inspect}. Must be one of: #{ACTIONS.join(', ')}"
+      end
+
+      @type = type
+      @detail = detail
+      @action = action
+      @severity = severity || default_severity(action)
+      @matches = matches
+      @sanitized = sanitized
+    end
+
+    def to_s
+      "#{type}: #{detail} (action=#{action})"
+    end
+
+    def inspect
+      "#<#{self.class} type=#{type.inspect}, detail=#{detail.inspect}, action=#{action.inspect}>"
+    end
+
+    private
+
+    def default_severity(action)
+      case action
+      when :block then :high
+      when :redact then :medium
+      when :warn then :low
+      when :log then :info
+      end
+    end
+  end
+end

data/lib/guardrails_ruby.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "guardrails_ruby/version"
+require_relative "guardrails_ruby/configuration"
+require_relative "guardrails_ruby/violation"
+require_relative "guardrails_ruby/result"
+require_relative "guardrails_ruby/check"
+require_relative "guardrails_ruby/guard"
+require_relative "guardrails_ruby/middleware"
+
+# Require built-in checks
+checks_dir = File.join(__dir__, "guardrails_ruby", "checks")
+Dir[File.join(checks_dir, "*.rb")].sort.each { |f| require f }
+
+# Require redactors
+require_relative "guardrails_ruby/redactors/pii_redactor"
+require_relative "guardrails_ruby/redactors/keyword_redactor"
+
+# Require Rails integration (controller concern is always available;
+# railtie is only loaded when Rails is defined)
+require_relative "guardrails_ruby/rails/controller"
+require_relative "guardrails_ruby/rails/railtie" if defined?(::Rails::Railtie)
+
+module GuardrailsRuby
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: guardrails-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Dwi Cahyo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: webmock
+  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'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CLAUDE.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/basic.rb
+- examples/custom_check.rb
+- examples/rails_controller.rb
+- guardrails-ruby.gemspec
+- lib/guardrails_ruby.rb
+- lib/guardrails_ruby/check.rb
+- lib/guardrails_ruby/checks/competitor_mention.rb
+- lib/guardrails_ruby/checks/encoding.rb
+- lib/guardrails_ruby/checks/format.rb
+- lib/guardrails_ruby/checks/hallucinated_emails.rb
+- lib/guardrails_ruby/checks/hallucinated_urls.rb
+- lib/guardrails_ruby/checks/keyword_filter.rb
+- lib/guardrails_ruby/checks/max_length.rb
+- lib/guardrails_ruby/checks/pii.rb
+- lib/guardrails_ruby/checks/prompt_injection.rb
+- lib/guardrails_ruby/checks/relevance.rb
+- lib/guardrails_ruby/checks/topic.rb
+- lib/guardrails_ruby/checks/toxic_language.rb
+- lib/guardrails_ruby/configuration.rb
+- lib/guardrails_ruby/guard.rb
+- lib/guardrails_ruby/middleware.rb
+- lib/guardrails_ruby/rails/controller.rb
+- lib/guardrails_ruby/rails/railtie.rb
+- lib/guardrails_ruby/redactors/keyword_redactor.rb
+- lib/guardrails_ruby/redactors/pii_redactor.rb
+- lib/guardrails_ruby/result.rb
+- lib/guardrails_ruby/version.rb
+- lib/guardrails_ruby/violation.rb
+homepage: https://github.com/johannesdwicahyo/guardrails-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/johannesdwicahyo/guardrails-ruby
+  source_code_uri: https://github.com/johannesdwicahyo/guardrails-ruby
+  changelog_uri: https://github.com/johannesdwicahyo/guardrails-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Input/output validation and safety framework for LLM applications in Ruby
+test_files: []