obscenity-plus 1.0.1

data/test/test_rack.rb

@@ -0,0 +1,207 @@
+require 'helper'
+require 'rack/mock'
+require 'obscenity/rack'
+
+class TestRack < Test::Unit::TestCase
+
+  context "Rack::Obscenity" do
+    setup do
+      @env     = {}
+      @body    = 'hello'
+      @status  = 200
+      @headers = { 'Content-Type' => 'text/plain' }
+      @app     = lambda { |env| [@status, @headers, [@body]] }
+    end
+
+    def mock_env(options = {})
+      @env = Rack::MockRequest.env_for('/', options)
+    end
+
+    def middleware(options = {})
+      Rack::Obscenity.new(@app, options)
+    end
+
+    def get(params = {})
+      { 'QUERY_STRING' => Rack::Utils.build_query(params) }
+    end
+
+    def get_response_params
+      Rack::Utils.parse_query(@env['QUERY_STRING'], "&")
+    end
+
+    def post(params = {})
+      { 'rack.input' => StringIO.new(Rack::Utils.build_query(params)) }
+    end
+
+    def post_response_params
+      Rack::Utils.parse_query(@env['rack.input'].read, "&")
+    end
+
+    def assert_success_response(status, headers, body)
+      assert_equal @status, status
+      assert_equal @headers, headers
+      assert_equal [@body], body
+    end
+
+    context "default configuration" do
+      should "not evaluate the profanity of parameters" do
+        app = middleware
+        status, headers, body = app.call(mock_env)
+        assert_success_response status, headers, body
+      end
+    end
+
+    context "rejecting requests" do
+      should "not reject if parameter values don't contain profanity" do
+        app = middleware(reject: true)
+        status, headers, body = app.call(mock_env(get(foo: 'bar')))
+        assert_success_response status, headers, body
+      end
+
+      should "reject if GET parameter values contain profanity" do
+        app = middleware(reject: true)
+        status, headers, body = app.call(mock_env(get(foo: 'bar', baz: 'shit')))
+        assert_equal 422, status
+        assert_equal [''], body
+      end
+
+      should "reject if POST parameter values contain profanity" do
+        app = middleware(reject: true)
+        status, headers, body = app.call(mock_env(post(foo: 'bar', baz: 'ass')))
+        assert_equal 422, status
+        assert_equal [''], body
+      end
+
+      should "reject if given parameter values contain profanity" do
+        app = middleware(reject: { params: [:foo] })
+        [ get(foo: 'ass', baz: 'shit'),
+          post(foo: 'ass').merge(get(foo: 'nice', baz: 'shit'))
+        ].each do |options|
+          status, headers, body = app.call(mock_env(options))
+          assert_equal 422, status
+          assert_equal [''], body
+        end
+      end
+
+      should "not reject if other parameter values contain profanity" do
+        app = middleware(reject: { params: [:foo] })
+        status, headers, body = app.call(mock_env(get(foo: 'nice', baz: 'shit')))
+        assert_success_response status, headers, body
+      end
+
+      should "reject if parameter values contain profanity" do
+        app = middleware(reject: { params: :all })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_equal 422, status
+        assert_equal [''], body
+      end
+
+      should "reject if parameter values contain profanity and display a custom message" do
+        app = middleware(reject: { message: "We don't accept profanity" })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_equal 422, status
+        assert_equal ["We don't accept profanity"], body
+      end
+
+      should "reject if parameter values contain profanity and render a custom file" do
+        app = middleware(reject: { path: "test/static/422.html" })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_equal 422, status
+        assert_equal ["We don't accept profanity"], body
+      end
+
+      should "reject parameter values when they're a hash and contain profanity" do
+        app = middleware(reject: true)
+        status, headers, body = app.call(mock_env(get(foo: 'clean', bar: {one: 'ass'})))
+        assert_equal 422, status
+        assert_equal [''], body
+      end
+    end
+
+    context "sanitizing requests" do
+      should "not sanitize if parameter values don't contain profanity" do
+        app = middleware(sanitize: true)
+        status, headers, body = app.call(mock_env(get(foo: 'bar')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal 'bar', request_params['foo']
+      end
+
+      should "sanitize if GET parameter values contain profanity" do
+        app = middleware(sanitize: true)
+        status, headers, body = app.call(mock_env(get(foo: 'bar', baz: 'shit')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal 'bar', request_params['foo']
+        assert_equal '$@!#%', request_params['baz']
+      end
+
+      should "sanitize if POST parameter values contain profanity" do
+        app = middleware(sanitize: true)
+        status, headers, body = app.call(mock_env(post(foo: 'bar', baz: 'ass')))
+        assert_success_response status, headers, body
+        request_params = post_response_params
+        assert_equal 'bar', request_params['foo']
+        assert_equal '$@!#%', request_params['baz']
+      end
+
+      should "not sanitize if other parameter values contain profanity" do
+        app = middleware(sanitize: { params: [:foo] })
+        status, headers, body = app.call(mock_env(get(foo: 'nice', baz: 'shit')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal 'nice', request_params['foo']
+        assert_equal 'shit', request_params['baz']
+      end
+
+      should "sanitize if parameter values contain profanity" do
+        app = middleware(sanitize: { params: :all })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '$@!#%', request_params['foo']
+      end
+
+      should "sanitize the title using the :garbled replacement" do
+        app = middleware(sanitize: { replacement: :garbled })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '$@!#%', request_params['foo']
+      end
+
+      should "sanitize the title using the :stars replacement" do
+        app = middleware(sanitize: { replacement: :stars })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '***', request_params['foo']
+      end
+
+      should "sanitize the title using the :vowels replacement" do
+        app = middleware(sanitize: { replacement: :vowels })
+        status, headers, body = app.call(mock_env(get(foo: 'ass')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '*ss', request_params['foo']
+      end
+
+      should "sanitize the title using the :nonconsonants replacement" do
+        app = middleware(sanitize: { replacement: :nonconsonants })
+        status, headers, body = app.call(mock_env(get(foo: '5hit')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '*h*t', request_params['foo']
+      end
+
+      should "sanitize the title using a custom replacement" do
+        app = middleware(sanitize: { replacement: "[censored]" })
+        status, headers, body = app.call(mock_env(get(foo: 'text with ass')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal 'text with [censored]', request_params['foo']
+      end
+    end
+  end
+
+end

data/test/test_test.rb

@@ -0,0 +1,17 @@
+#first test of the gem and rspec
+require 'rails_helper'
+
+RSpec.describe Dummy::BaseModel, type: :model do
+  before do
+    Obscenity.configure do |config|
+      config.blacklist   = ["badword"]
+      config.replacement = :stars
+    end
+  end
+
+  it "validates profanity in the title" do
+    model = Dummy::BaseModel.new(title: "This is a badword")
+    expect(Obscenity.profane?(model.title)).to be true
+    expect(Obscenity.sanitize(model.title)).to eq "This is a *******"
+  end
+end

data/test/test_version.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class TestVersion < Test::Unit::TestCase
+
+  should "return the correct product version" do
+    assert_equal '1.0.2', Obscenity::VERSION
+  end
+
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: obscenity-plus
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ropetow
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Obscenity is a profanity filter gem for Ruby, Rails (through ActiveModel),
+  and Rack middleware.
+email: ropetow@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- config/blacklist.yml
+- config/international.yml
+- lib/obscenity.rb
+- lib/obscenity/active_model.rb
+- lib/obscenity/base.rb
+- lib/obscenity/config.rb
+- lib/obscenity/error.rb
+- lib/obscenity/rack.rb
+- lib/obscenity/rspec_matcher.rb
+- lib/obscenity/version.rb
+- test/helper.rb
+- test/static/422.html
+- test/test_active_model.rb
+- test/test_base.rb
+- test/test_config.rb
+- test/test_obscenity.rb
+- test/test_rack.rb
+- test/test_test.rb
+- test/test_version.rb
+homepage: http://github.com/ropetow/obscenity-plus
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+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: An updated profanity filter in Jan 2025. Forked from the Obscenity gem.
+test_files: []