reserved_subdomain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b946c00cb63fbfe39ad7f7dd2ad0e7b52a230d7211fda09c7f704c5992e0529
+  data.tar.gz: 78c931d69d132e534dd0cff37ac714e393f467b6bd4aeab93c3e2a96d6136b75
+SHA512:
+  metadata.gz: 6aeb84bdd1db6ad923aa25cb1f7419ca63e958fd7551261a19fef8b3a2f51f7722a0cc415e5f137990422f2b2187c2f4fb118805fdf1cfe0c9f0d382cebd8b21
+  data.tar.gz: 57412ff3901d113ee036d369665350febdbeed325f8ec3b2c3adbbfe3af6f688330efd4390fbe79d73f1efa67a6ffb0fed4b80d62663449790ae33e862ecf5f3

data/.gitignore

@@ -0,0 +1,54 @@
+.byebug_history
+Gemfile.local
+Gemfile.lock
+*.local
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--profile

data/.rubocop.yml

@@ -0,0 +1,45 @@
+---
+require: rubocop-rspec
+
+AllCops:
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2
+  Exclude:
+    - bin/*
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
+Naming/FileName:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov-console'
+end
+
+local_gemfile = 'Gemfile.local'
+eval(File.read(local_gemfile)) if File.exist?(local_gemfile) # rubocop:disable Security/Eval

data/Gemfile.local.example

@@ -0,0 +1,11 @@
+# Copy this file to a file named Gemfile.local to add these gems to your dev toolset
+# Feel free to modify Gemfile.local to suit your own preferences
+group :development do
+  gem 'github_changelog_generator'
+  gem 'gem-release'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rake'
+  gem 'rubocop'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dominic Sayers
+
+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,35 @@
+# ReservedSubdomain
+[![Gem Version](https://badge.fury.io/rb/reserved_subdomain.svg)](https://rubygems.org/gems/reserved_subdomain)
+[![Gem downloads](https://img.shields.io/gem/dt/reserved_subdomain.svg)](https://rubygems.org/gems/reserved_subdomain)
+[![Build Status](https://travis-ci.org/dominicsayers/reserved_subdomain.svg?branch=master)](https://travis-ci.org/dominicsayers/reserved_subdomain)
+[![Maintainability](https://api.codeclimate.com/v1/badges/53c0395f76bc52f53b60/maintainability)](https://codeclimate.com/github/dominicsayers/reserved_subdomain/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/53c0395f76bc52f53b60/test_coverage)](https://codeclimate.com/github/dominicsayers/reserved_subdomain/test_coverage)
+[![Dependency Status](https://dependencyci.com/github/dominicsayers/reserved_subdomain/badge)](https://dependencyci.com/github/dominicsayers/reserved_subdomain)
+[![security](https://hakiri.io/github/dominicsayers/reserved_subdomain/master.svg)](https://hakiri.io/github/dominicsayers/reserved_subdomain/master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5aeeb051546b4ecc9f0c78317d8c6af8)](https://www.codacy.com/app/dominicsayers/reserved_subdomain)
+
+ReservedSubdomain is a Ruby gem that checks whether a proposed subdomain should be a reserved name.
+
+It checks for common patterns such as `www` or `mail`. It checks all gTLDs. It checks some common language and country codes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reserved_subdomain'
+```
+
+## Usage
+
+```ruby
+ReservedSubdomain.new('www').reserved? # => true
+```
+
+## Configuration
+
+Each time you use ReservedSubdomain it loads the list of reserved names from a file. This can be slow if you're doing these checks frequently.
+
+In this case you can set the environment variable `RESERVED_SUBDOMAIN_PRELOAD` to "true" and the list will be preloaded.
+
+Of course if you preload the list it will stay memory-resident and take up a significant amount of room. Your call.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  nil
+end

data/bin/build_literals

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'open-uri'
+require 'reserved_subdomain'
+
+def write_file(content, filename)
+  filepath = File.join(__dir__, '..', 'lib', 'reserved_subdomain', 'literals', filename)
+  File.open(filepath, 'w') { |f| f.write content.join("\n") }
+end
+
+# Remove existing literals that exist in content
+def remove_literals(content)
+  literals = ReservedSubdomain::Literal.load_literals.dup
+  literals.select! { |literal| !content.include?(literal) }
+  write_file literals, 'reserved_subdomains.txt'
+end
+
+# TLDs
+uri = URI.parse('http://data.iana.org/TLD/tlds-alpha-by-domain.txt')
+tlds = uri.read.downcase.split("\n")
+remove_literals(tlds)
+
+tlds.select! do |tld|
+  (tld !~ /^#/) &&
+    !ReservedSubdomain::Prefix.new(tld).reserved? &&
+    !ReservedSubdomain::Pattern.new(tld).reserved?
+end
+
+write_file tlds, 'tlds.txt'
+
+# Country codes
+# TODO: Find source of ISO-3166-1 country codes and add them to the list of literals
+filepath = File.join(__dir__, '..', 'lib', 'reserved_subdomain', 'literals', 'iso-3166-1.txt')
+country_codes = File.read(filepath).split("\n").compact
+remove_literals(country_codes)
+
+# Language codes
+# TODO: Find a source of ISO-639 language codes and add them to the list of literals
+filepath = File.join(__dir__, '..', 'lib', 'reserved_subdomain', 'literals', 'iso-639-1.txt')
+language_codes = File.read(filepath).split("\n").compact
+remove_literals(language_codes)

data/bin/console

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec irb -I lib -r rubygems -r reserved_subdomain.rb

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/reserved_subdomain.rb

@@ -0,0 +1,15 @@
+require 'reserved_subdomain/literal'
+require 'reserved_subdomain/pattern'
+require 'reserved_subdomain/prefix'
+
+class ReservedSubdomain
+  attr_reader :subdomain
+
+  def initialize(subdomain)
+    @subdomain = subdomain
+  end
+
+  def reserved?
+    Prefix.new(subdomain).reserved? || Pattern.new(subdomain).reserved? || Literal.new(subdomain).reserved?
+  end
+end

data/lib/reserved_subdomain/literal.rb

@@ -0,0 +1,46 @@
+class ReservedSubdomain
+  class Literal
+    class << self
+      # If the env var is set then we pre-load all the reserved literals into
+      # a big array. This makes checking for reserved subdomains quicker but at
+      # the expense of keeping the big array in memory.
+      #
+      # If you're only checking for reserved subdomains when a user creates a
+      # new account then it may be better to load the literals from the file
+      # each time.
+      def literals
+        @literals ||= ENV['RESERVED_SUBDOMAIN_PRELOAD'] ? load_literals : nil
+      end
+
+      def load_literals
+        literals_files.map { |filename| File.read(filename).split("\n") }.compact.flatten
+      end
+
+      private
+
+      def literals_files
+        Dir.glob(File.join(literals_directory, '*'))
+      end
+
+      def literals_directory
+        @literals_directory ||= File.join(__dir__, 'literals')
+      end
+    end
+
+    attr_reader :subdomain
+
+    def initialize(subdomain)
+      @subdomain = subdomain
+    end
+
+    def reserved?
+      literals.include? subdomain
+    end
+
+    private
+
+    def literals
+      self.class.literals || self.class.load_literals
+    end
+  end
+end

data/lib/reserved_subdomain/literals/iso-3166-1.txt

@@ -0,0 +1,2 @@
+gb
+us

data/lib/reserved_subdomain/literals/iso-639-1.txt

@@ -0,0 +1,2 @@
+de
+en

data/lib/reserved_subdomain/literals/reserved_subdomains.txt

@@ -0,0 +1,588 @@
+a
+about
+abuse
+abuseaccount
+abuseaccounts
+access
+account
+accounts
+activate
+add
+address
+adm
+admin
+administration
+administrator
+administrators
+adserver
+adv
+advertising
+affiliate
+affiliates
+agenda
+ajax
+alpha
+an
+anon
+anonymous
+api
+apps
+arabic
+archive
+archives
+asset
+assets
+atom
+auth
+authentication
+autoconfig
+autodiscover
+availability
+avatar
+awadhi
+azerbaijani
+b
+b2b
+backup
+backups
+banner
+banners
+bbs
+bengali
+beta
+better
+bhojpuri
+billing
+bin
+blogs
+board
+bookmark
+bookmarks
+bots
+broadcast-ip
+bug
+bugs
+burmese
+c
+cache
+cadastro
+calendar
+camo
+campaign
+cancel
+cart
+cdn
+cgi
+changelog
+checkout
+chinese
+citrix
+client
+cliente
+clients
+cms
+code
+codereview
+comercial
+comment
+comments
+communities
+compras
+config
+configuration
+connect
+content
+contest
+contributors
+control
+coppa
+copyright
+corp
+cp
+cpanel
+create
+crm
+cs
+css
+cssproxy
+customise
+customize
+cvs
+d
+dashboard
+dbadmin
+dd
+delete
+demo
+designer
+destroy
+devel
+develop
+developer
+developers
+development
+dir
+direct_messages
+diversity
+dmca
+doc
+documentation
+domain
+downloads
+dreamwidth
+drupal
+dutch
+dw
+e
+e-mail
+ecommerce
+edit
+editor
+edits
+eh
+embed
+embedded
+employment
+eng
+english
+enterprise
+event
+example
+examplecommunity
+exampleopenid
+examplesyn
+examplesyndicated
+exampleusername
+explore
+extranet
+f
+facebook
+faq
+faqs
+farsi
+favorite
+favorites
+favourite
+favourites
+fax
+fb
+feed
+feeds
+file
+files
+firewall
+fleet
+fleets
+flog
+follow
+followers
+following
+forms
+forums
+foto
+french
+friend
+friends
+fs
+fw
+g
+gadget
+gadgets
+gan
+gate
+gateway
+general
+german
+get
+gis
+gist
+git
+github
+go
+groups
+guest
+guides
+gujarati
+hack
+hakka
+hausa
+hindi
+home
+homepage
+hostmaster
+hostname
+hpg
+html
+http
+httpd
+https
+i
+icon
+icons
+idea
+ideas
+idp
+image
+images
+imap
+img
+inbox
+index
+indice
+information
+intra
+intranet
+invitations
+invite
+ip
+ipad
+ipfixe
+iphone
+ipv4
+irc
+italian
+jabber
+japanese
+javanese
+javascript
+jinyu
+job
+js
+json
+kannada
+kb
+knowledge-base
+knowledgebase
+korean
+lab
+labs
+language
+languages
+ldap
+legacy
+lib
+library
+libs
+links
+linux
+list
+lists
+livejournal
+lj
+lms
+local
+localhost
+log
+loghost
+login
+logout
+logs
+loopback
+m
+mailadmin
+mailer
+mailhost
+mailing
+mailman
+mailserver
+main
+maithili
+malayalam
+manage
+manager
+mandarin
+maps
+marathi
+master
+member
+members
+memories
+memory
+merchandise
+message
+messages
+messenger
+microblog
+microblogs
+min-nan
+mine
+mirror
+mis
+mob
+mobilemail
+monitor
+monitoring
+moodle
+movies
+mp3
+mrtg
+msg
+msn
+mssql
+music
+musicas
+mysql
+nagios
+named
+network-ip
+newsletter
+nick
+nickname
+noc
+notes
+noticias
+oa
+oauth
+oauth_clients
+offers
+official
+old
+oldmail
+openid
+operator
+order
+orders
+organizations
+origin
+oriya
+outlook
+owa
+p
+pager
+pages
+paid
+panel
+panjabi
+partner
+password
+payment
+payments
+pbx
+pda
+perl
+pgsql
+photoalbum
+php
+phpmyadmin
+pic
+picture
+plans
+plugin
+plugins
+policy
+polish
+pop
+pop3
+popular
+portal
+portuguese
+postfix
+postmaster
+posts
+preview
+principles
+privacy
+private
+product
+production
+products
+profile
+project
+projects
+proxy
+public
+purge
+put
+python
+random
+recruitment
+redirect
+register
+registration
+relay
+remote
+remove
+replies
+repo
+reports
+research
+romanian
+root
+router
+rss
+rt
+ruby
+russian
+s
+sales
+sample
+samples
+sandbox
+schools
+script
+scripts
+send
+seo
+serbo-croatian
+service
+sessions
+setting
+settings
+setup
+sftp
+share
+sharepoint
+signin
+signup
+sindhi
+sip
+sitebuilder
+sitemap
+sites
+sms
+soporte
+sp
+spam
+spanish
+speedtest
+sports
+sql
+ss
+ssh
+ssl
+ssladmin
+ssladministrator
+sslwebmaster
+sso
+ssytem
+staff
+stage
+staging
+start
+stat
+statistics
+stats
+status
+stores
+stories
+streaming
+student
+styleguide
+styles
+subdomain
+subscribe
+subscriptions
+sunda
+suporte
+survey
+svn
+syn
+syndicated
+sysadmin
+sysadministrator
+system
+t
+tablet
+tablets
+tag
+tags
+tamil
+task
+tasks
+teams
+telnet
+telugu
+temp
+terms
+termsofservice
+teste
+testing
+tests
+thai
+theme
+themes
+thumbs
+ticket
+time
+tmp
+todo
+tool
+tos
+tour
+tp
+trac
+track
+tracker
+tracking
+translations
+trends
+ts
+turkish
+twitter
+twittr
+ukrainian
+unfollow
+unsubscribe
+up
+update
+updates
+upgrade
+upgrades
+upi
+upload
+urdu
+url
+usage
+user
+username
+usernames
+users
+usuario
+v
+vendas
+videos
+vietnamese
+visitor
+vod
+voip
+volunteer
+volunteers
+vps
+w
+w3
+wap
+webconf
+webdisk
+webmail
+webmaster
+websites
+webstats
+whm
+widget
+widgets
+wifi
+wordpress
+workshop
+wp
+wu
+ww
+ww1
+ww2
+ww3
+wws
+wwws
+wwww
+xfn
+xiang
+xml
+xmpp
+xmppSuggest
+xpg
+yaml
+yml
+yoruba
+yourdomain
+yourname
+yoursite
+yourusername
+yu