swot-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4d6bc77cb526656be8cfd79b2617c57f59cd03a5d3b0ab10ebd8acdebc70d04
+  data.tar.gz: 50bc525d978231cba12d9ab1bb45ab1a81bf88688da2a14001b65fcd5c6a2aa1
+SHA512:
+  metadata.gz: 0f58f873100c5091f7c0189fe240ff6143952a17f2d80f9b363c4f5ab9b75d1a65e11ffa410dd3c6a396dd37b8141889542cab1f0465dd7875d37b9365a9d4f5
+  data.tar.gz: e568e25362a5506b3b3df13c2ee28d8a815f3d1d59123bd64f9106d971e248c0454aee9023099cf75d5fcefd35225f7b793af105f3fc9e456ee24b547a5998a3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+#### Institution/School Name 
+{Name Here}
+
+#### Instiution/School Website
+{Website URL}
+
+#### Email Users
+
+*Please place an x between the square brackets if yes*
+- [ ] Students
+- [ ] Academic/Teaching Staff
+- [ ] Other/Support Staff
+- [ ] Alumni
+
+#### Education Levels
+
+*Please place an x between the square brackets if yes*
+
+- [ ] Post-graduate research
+- [ ] Graduate School
+- [ ] College (University) or Undergraduate School or equivalent
+- [ ] Community College or equivalent
+- [ ] High School or equivalent
+- [ ] Elementary School or equivalent

data/.github/workflows/ruby.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'  # Fetches all submodules recursively
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/update_domains.yml

@@ -0,0 +1,31 @@
+name: Update Submodules
+
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Runs every day at midnight
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    - name: Update submodules
+      run: |
+        git submodule update --remote
+        git config --global user.name 'Dave Kimura'
+        git config --global user.email 'dave@k-innovations.net'
+
+    - name: Commit and push changes
+      run: |
+        git commit -am "Updated submodules"
+        git push

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+Gemfile.lock
+*.gem
+.bundle
+.idea

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "data"]
+	path = data
+	url = https://github.com/JetBrains/swot.git

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing to Swot
+
+##### Updating the database
+
+https://github.com/jetbrains/swot is the canonical source of truth for the list of domains.
+If you want to add a new domain, please submit a pull request there. This database is updated
+periodically based on the information in that repository.
+
+##### What will not be accepted
+
+Any pull request that is touching the `lib/domains` directory will be
+rejected. This is because the contents of that directory are automatically generated
+from the canonical source of truth.
+
+##### What will be accepted
+
+A pull request that improves the parsing functionality or adds new features to the
+gem will be accepted. Please make sure to include tests for any new functionality.

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'public_suffix'
+gem 'naughty_or_nice', "~> 2.0"
+
+group :development do
+  gem "nokogiri", "~> 1.5"
+  gem "rake", "~> 13.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 2.2"
+  gem "minitest", "~> 4.7.5"
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Lee Reilly, JetBrains, Dave Kimura
+
+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,117 @@
+# Swot :apple:
+
+[![Ruby](https://github.com/kobaltz/swot/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/kobaltz/swot/actions/workflows/ruby.yml) [![Update Submodules](https://github.com/kobaltz/swot/actions/workflows/update_domains.yml/badge.svg?branch=main)](https://github.com/kobaltz/swot/actions/workflows/update_domains.yml) [![Gem Version](https://badge.fury.io/rb/swot.svg)](http://badge.fury.io/rb/swot)
+
+If you have a product or service and offer **academic discounts**, there's a good chance there's some manual component to the approval process. Perhaps `.edu` email addresses are automatically approved because, for the most part at least, they're associated with American post-secondary educational institutions. Perhaps `.ac.uk` email addresses are automatically approved because they're guaranteed to belong to British universities and colleges. Unfortunately, not every country has an education-specific TLD (Top Level Domain) and plenty of schools use `.com` or `.net`.
+
+Swot is a community-driven or crowdsourced library for verifying that domain names and email addresses are tied to a legitimate university of college - more specifically, an academic institution providing higher education in tertiary, quaternary or any other kind of post-secondary education in any country in the world.
+
+**Pop quiz:** Which of the following domain names should be eligible for an academic discount? `stanford.edu`, `america.edu`, `duep.edu`, `gla.ac.uk`, `unizar.es`, `usask.ca`, `hil.no`, `unze.ba`, `fu-berlin.de`, `ecla.de`, `bvb.de`, `lsmu.com`. Answers at the foot of the page.
+
+### Installation
+
+Swot is a Ruby gem, so you'll need a little Ruby-fu to get it working. Simply
+
+`gem install swot`
+
+Or add this to your `Gemfile` before doing a `bundle install`:
+
+`gem 'swot'`
+
+## Requirements
+
+- Ruby >= 2.0
+
+### Usage
+
+#### Verify Email Addresses
+
+```ruby
+Swot::is_academic? 'lreilly@stanford.edu'           # true
+Swot::is_academic? 'lreilly@strath.ac.uk'           # true
+Swot::is_academic? 'lreilly@soft-eng.strath.ac.uk'  # true
+Swot::is_academic? 'pedro@ugr.es'                   # true
+Swot::is_academic? 'lee@uottawa.ca'                 # true
+Swot::is_academic? 'lee@leerilly.net'               # false
+```
+
+#### Verify Domain Names
+
+```ruby
+Swot::is_academic? 'harvard.edu'              # true
+Swot::is_academic? 'www.harvard.edu'          # true
+Swot::is_academic? 'http://www.harvard.edu'   # true
+Swot::is_academic? 'http://www.github.com'    # false
+Swot::is_academic? 'http://www.rangers.co.uk' # false
+```
+
+#### Find School Names
+
+```ruby
+Swot::school_name 'lreilly@cs.strath.ac.uk'
+# => "University of Strathclyde"
+
+Swot::school_name 'http://www.stanford.edu'
+# => "Stanford University"
+```
+
+### Contributing to Swot
+
+Contributions welcome! Please see the [contribution guidelines](CONTRIBUTING.md) for details on how to add, update, or delete schools. Code contributions and ports to different languages welcome too.
+
+**Thanks** to the following people for their contributions:
+@blutack, @captn3m0, @chrishunt, @johndbritton, @johnotander, @pborreli, @rcurtis, @vikhyat,.
+
+**Special thanks** to @weppos for the [public_suffix](https://github.com/weppos/publicsuffix-ruby) gem :metal:
+
+### Known Issues
+
+* You can search by email and domain names only. You cannot search by IP.
+* You don't know if the email address belongs to a student, faculty, staff member, alumni, or a contractor.
+* There may be a few false positives, missing institutions... maybe even a couple of typos. Contributions welcome!
+
+**Please note:** just because someone has verified that they own `lreilly@stanford.edu` does *not* mean that they're a student. They could be faculty, staff, alumnni, or maybe even an external contractor. If you're suddenly getting a lot of traffic from websites like [FatWallet](http://www.fatwallet.com) or [SlickDeals](http://www.slickdeals.net), you might want to find out why. If you're suddenly getting a lot of requests from a particular school, you should look into that too. It may be good business, word of mouth, or someone may have found a loophole. Swot gives you a *high confidence level* - not a guarantee. I recommend putting some controls in place or at least monitor how it's doing from time to time.
+
+### What is a swot?
+
+According to [UrbanDictionary](http://www.urbandictionary.com/define.php?term=swot) :blue_book:
+
+> A word used by morons to insult a person of superior academic abilities.
+
+or
+
+> [verb] To Swot; Revision undertaken preceding an examination.
+
+or
+
+> [backronym] Stupid Waste of Time
+
+### Pop Quiz Answers
+
+Hopefully, you'll be surprised by some of this:
+
+| Domain | Academic? | Comments |
+|--------|-----------|----------|
+|`stanford.edu`|:heavy_check_mark:|OK, this was an easy one so you could get at least *one* right|
+|`america.edu`|:heavy_multiplication_x:| Prior to October 29th 2001, anyone could register a `.edu` domain name ([details](https://en.wikipedia.org/wiki/.edu#Grandfathered_uses)) |
+|`duep.edu`|:heavy_check_mark:| Alfred Nobel University is a *Ukranian* University *in the Ukraine* i.e. not in the USA :us: |
+|`gla.ac.uk`|:heavy_check_mark:|Glasgow University in Scotland|
+|`unizar.es`|:heavy_check_mark:|The University of Zaragoza in Spain|
+|`usask.ca`|:heavy_check_mark:|The University of Saskatchewan in Canada|
+|`hil.no`|:heavy_check_mark:|Lillehammer University College in Norway|
+|`unze.ba`|:heavy_check_mark:|University of Zenica in Bosnia and Herzegovina|
+|`fu-berlin.de`|:heavy_check_mark:|Free University of Berlin in Germany|
+|`ecla.de`|:heavy_check_mark:|ECLA of Bard is a state recognized liberal arts university in Berlin, Germany |
+|`bvb.de`|:heavy_multiplication_x:|It's a soccer team from Germany|
+|`lsmu.com`|:heavy_check_mark:| Lugansk State Medical University in the Ukraine |
+
+If you verified this by visiting all of the websites, how long did it take you? Did you have fun? Imagine you had to do this 10 - 100 times every day. Now you know a little something about the inspiration for Swot. Swot can verify them all in a fraction of a second and remove a :poop: part of someone's job.
+
+### See Also
+
+* [gman](https://github.com/benbalter/gman) - like swot, but for government emails
+* [swotphp](https://github.com/mdwheele/swotphp) - PHP port of Swot
+* [swot-js](https://github.com/theotow/swot-js) - JS port of Swot
+* [swot-simple](https://github.com/mapbox/swot-simple) - JS port of Swot
+* [swot-clj](https://github.com/ipavl/swot-clj) - Clojure port of Swot
+* [swot](https://github.com/abadojack/swot) - Go port of Swot

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0