the_big_username_blacklist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d3a58c008fbe17846a4df1966a8897a6250f379
+  data.tar.gz: 4a5ba6a6086f9e0a46df45b73985cf3d91dee270
+SHA512:
+  metadata.gz: 712f59af0c00af715f9649b5bf16169be779d1791f961550455d056ac7ecb2e7e0c719ad13e9c5b7b43b2e34c188071f87078fe6ead71f2f0adf2b3f16a8e9a8
+  data.tar.gz: dde1f10281e69bc5314cb831504e4d7f6f6b42db6f823dc64a687cae5e1975ce3760e10d61b4b974ae0c1e2063d5a10dd79aec67f4b5e48d8f514b5c4d26e38e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/.rspec
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_big_username_blacklist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Takashi Uesugi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# TheBigUsernameBlacklist
+
+This library lets you validate usernames against a blacklist. The blacklist data is based on the data from The-Big-Username-Blacklist and contains privilege, programming terms, section names, financial terms and actions.
+
+see also...
+- https://github.com/marteinn/The-Big-Username-Blacklist
+- https://pypi.python.org/pypi/the_big_username_blacklist
+- https://www.npmjs.com/package/the-big-username-blacklist
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'the_big_username_blacklist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install the_big_username_blacklist
+
+## Usage
+
+Validating a username is easy, if the word is in the blacklist, return False (validation failed), otherwise True.
+Example:
+
+```
+> require 'the_big_username_blacklist'
+> TheBigUsernameBlacklist.valid? 'martin'
+true
+>  TheBigUsernameBlacklist.valid? 'root'
+false
+```
+
+
+If you want to use it as instance method, it's easy.
+Example:
+
+```ruby
+class YourClass
+  include TheBigUsernameBlacklist
+end
+
+YourClass.new.username_valid?('martin')
+```
+
+
+You want to add optional blacklist, you can use configuration on rails initializer
+Example: `config/initializers/the_big_username_blacklist.rb`
+
+```ruby
+TheBigUsernameBlacklist.configure do |config|
+  config.optional_usernames = %w(james)
+end
+```
+
+```ruby
+TheBigUsernameBlacklist.valid? 'james' # => false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/the_big_username_blacklist/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec 'irb -r the_big_username_blacklist -I ./lib'
+end

data/data/list.txt

@@ -0,0 +1,204 @@
+about
+account
+account
+add
+admin
+administration
+administrator
+advertise
+affiliate
+affiliates
+ajax
+api
+app
+apps
+auth
+backup
+billing
+billings
+blog
+blogs
+bookmark
+bookmarks
+cache
+campaign
+careers
+cart
+change
+checkout
+comment
+comments
+compose
+config
+connect
+contact
+contest
+cookies
+create
+deals
+delete
+disconnect
+docs
+documentation
+download
+downvote
+edit
+enterprise
+error
+event
+events
+exception
+exit
+false
+faq
+features
+feed
+feedback
+feeds
+feeds
+follow
+follower
+followers
+following
+forgot
+forgot-password
+forum
+forums
+friend
+friends
+group
+groups
+head
+header
+help
+home
+host
+hosting
+hostmaster
+htpasswd
+investors
+invitations
+invite
+invite
+invites
+invoice
+issues
+jobs
+join
+json
+learn
+load
+local
+login
+logout
+lost-password
+mail
+marketing
+marketplace
+master
+message
+messages
+moderator
+modify
+more
+my
+new
+news
+newsletter
+newsletters
+next
+nil
+none
+null
+oauth
+offer
+offers
+online
+openid
+order
+orders
+owner
+page
+pages
+partners
+passwd
+password
+pay
+payment
+plans
+popular
+postmaster
+poweruser
+previous
+privacy
+product
+profile
+profiles
+put
+quota
+redirect
+register
+remove
+replies
+reply
+request
+request-password
+reset
+reset-password
+response
+review
+reviews
+root
+rootuser
+rss
+rules
+save
+search
+security
+select
+session
+sessions
+settings
+share
+shift
+shop
+signup
+sitemap
+sort
+ssl
+stats
+status
+store
+subscribe
+sudo
+super
+superuser
+support
+sync
+system
+tag
+tags
+team
+terms
+terms-of-use
+topic
+topics
+tour
+translations
+true
+undefined
+unfollow
+unsubscribe
+update
+user
+username
+var
+view
+void
+vote
+website
+widget
+widgets
+write
+www
+you

data/lib/the_big_username_blacklist.rb

@@ -0,0 +1,42 @@
+require 'the_big_username_blacklist/version'
+require 'the_big_username_blacklist/data'
+require 'the_big_username_blacklist/configuration'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+module TheBigUsernameBlacklist
+  def username_valid?(username)
+    TheBigUsernameBlacklist.valid?(username)
+  end
+
+  def self.valid?(username)
+    !(data.match?(username) || optional_data.match?(username))
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class << self
+    private
+
+    def data
+      @data ||= Data.default
+    end
+
+    def optional_data
+      return @optional_data if defined? @optional_data
+      if config.optional_usernames && config.optional_usernames.is_a?(Array)
+        return @optional_data = Data.new(config.optional_usernames)
+      end
+      @optional_data = Data.new([])
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/the_big_username_blacklist/configuration.rb

@@ -0,0 +1,5 @@
+module TheBigUsernameBlacklist
+  class Configuration
+    attr_accessor :optional_usernames
+  end
+end

data/lib/the_big_username_blacklist/data.rb

@@ -0,0 +1,19 @@
+module TheBigUsernameBlacklist
+  class Data
+    def self.default
+      file_path = File.expand_path('../../../data/list.txt', __FILE__)
+      usernames = File.open(file_path, 'r').read.split("\n")
+      new(usernames)
+    end
+
+    def initialize(usernames)
+      @usernames = usernames.each_with_object({}) do |username, hash|
+        hash[username] = true
+      end
+    end
+
+    def match?(username)
+      @usernames[username] || false
+    end
+  end
+end

data/lib/the_big_username_blacklist/version.rb

@@ -0,0 +1,3 @@
+module TheBigUsernameBlacklist
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+require 'the_big_username_blacklist'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/the_big_username_blacklist/configure_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+describe TheBigUsernameBlacklist do
+  describe '.configure' do
+    before do
+      TheBigUsernameBlacklist.configure { |c| c.optional_usernames = %w(james) }
+    end
+
+    context 'class method' do
+      subject { TheBigUsernameBlacklist.valid?(username) }
+      context 'matched username' do
+        let(:username) { 'administrator' }
+        it { should be false }
+      end
+
+      context 'matched optional username' do
+        let(:username) { 'james' }
+        it { should be false }
+      end
+
+      context 'unmatched username' do
+        let(:username) { 'ababa' }
+        it { should be true }
+      end
+    end
+
+    context 'instance method' do
+      let(:test_class) { Struct.new(:hoge) { include TheBigUsernameBlacklist } }
+      subject { test_class.new.username_valid?(username) }
+
+      context 'matched username' do
+        let(:username) { 'administrator' }
+        it { should be false }
+      end
+
+      context 'matched optional username' do
+        let(:username) { 'james' }
+        it { should be false }
+      end
+
+      context 'unmatched username' do
+        let(:username) { 'ababa' }
+        it { should be true }
+      end
+    end
+  end
+end

data/spec/the_big_username_blacklist/data_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+module TheBigUsernameBlacklist
+  describe 'Data' do
+    describe '#match?' do
+      subject { TheBigUsernameBlacklist::Data.default.match?(username) }
+
+      context 'matched username' do
+        let(:username) { 'administrator' }
+        it { should be true }
+      end
+
+      context 'unmatched username' do
+        let(:username) { 'ababa' }
+        it { should be false }
+      end
+    end
+  end
+end

data/spec/the_big_username_blacklist/user_valid_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+describe TheBigUsernameBlacklist do
+  describe '#user_valid?' do
+    let(:test_class) { Struct.new(:hoge) { include TheBigUsernameBlacklist } }
+    subject { test_class.new.username_valid?(username) }
+
+    context 'matched username' do
+      let(:username) { 'administrator' }
+      it { should be false }
+    end
+
+    context 'unmatched username' do
+      let(:username) { 'ababa' }
+      it { should be true }
+    end
+  end
+end

data/spec/the_big_username_blacklist/valid_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+describe TheBigUsernameBlacklist do
+  describe '.valid?' do
+    subject { TheBigUsernameBlacklist.valid?(username) }
+    context 'matched username' do
+      let(:username) { 'administrator' }
+      it { should be false }
+    end
+
+    context 'unmatched username' do
+      let(:username) { 'jamess' }
+      it { should be true }
+    end
+  end
+end

data/the_big_username_blacklist.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_big_username_blacklist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'the_big_username_blacklist'
+  spec.version       = TheBigUsernameBlacklist::VERSION
+  spec.authors       = ['Takashi Uesugi']
+  spec.email         = ['tksuesg@gmail.com']
+  spec.summary       = %q{This library lets you validate usernames against a blacklist.}
+  spec.description   = %q{This library lets you validate usernames against a blacklist. The blacklist data is based on the data from The-Big-Username-Blacklist and contains privilege, programming terms, section names, financial terms and actions.
+
+see also...
+- https://github.com/marteinn/The-Big-Username-Blacklist
+- https://pypi.python.org/pypi/the_big_username_blacklist
+- https://www.npmjs.com/package/the-big-username-blacklist
+}
+  spec.homepage      = 'https://github.com/unlearned/the_big_username_blacklist'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: the_big_username_blacklist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takashi Uesugi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
+description: |
+  This library lets you validate usernames against a blacklist. The blacklist data is based on the data from The-Big-Username-Blacklist and contains privilege, programming terms, section names, financial terms and actions.
+
+  see also...
+  - https://github.com/marteinn/The-Big-Username-Blacklist
+  - https://pypi.python.org/pypi/the_big_username_blacklist
+  - https://www.npmjs.com/package/the-big-username-blacklist
+email:
+- tksuesg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/list.txt
+- lib/the_big_username_blacklist.rb
+- lib/the_big_username_blacklist/configuration.rb
+- lib/the_big_username_blacklist/data.rb
+- lib/the_big_username_blacklist/version.rb
+- spec/spec_helper.rb
+- spec/the_big_username_blacklist/configure_spec.rb
+- spec/the_big_username_blacklist/data_spec.rb
+- spec/the_big_username_blacklist/user_valid_spec.rb
+- spec/the_big_username_blacklist/valid_spec.rb
+- the_big_username_blacklist.gemspec
+homepage: https://github.com/unlearned/the_big_username_blacklist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This library lets you validate usernames against a blacklist.
+test_files:
+- spec/spec_helper.rb
+- spec/the_big_username_blacklist/configure_spec.rb
+- spec/the_big_username_blacklist/data_spec.rb
+- spec/the_big_username_blacklist/user_valid_spec.rb
+- spec/the_big_username_blacklist/valid_spec.rb