swot2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1238e39d86b32f158e9fe26bed39741f0c1d0b165c94f8ce18da0a7f87ba8ed2
+  data.tar.gz: 929896f389bd41686ce8e154382c6bef96daad3eeb5a74ca458c85c44d2e5a68
+SHA512:
+  metadata.gz: a47cb9bb06d4ecfcf518728cb67c5a5e5ea953d6de4f5df59bb7780bca6297360e7ff113fd04a0dcbdfa9b6e0c13b9a150ff6481585746e15681dca4520f2107
+  data.tar.gz: 3bf248384c720215dd2b5fe6f0abc5618de67ffacecbd3fe1c0838517c306dbe8c683f30eaddd45a98eab7eee278849ca656b43f2bf4df28b4c04a58a5b8e185

data/.document

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

data/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to Swot
+
+#### Data Contributions
+
+* All of the school data is stored in a simple filesystem data structure under `lib/domains`.
+* The directories are nested to match domain parts, starting with the [TLD](http://en.wikipedia.org/wiki/Top-level_domain) (Top Level Domain), then [SLDs](http://en.wikipedia.org/wiki/Second-level_domain) (Second Level Domains) beneath them, etc.
+* There's a text file named after the school's domain, nested below the appropriate directory, e.g. `strath.ac.uk` would be listed as `lib/domains/uk/ac/strath.txt`.
+* The contents of that file are simply the school name, e.g. `University of Strathclyde`.
+* The [working example for University of Strathclyde](https://github.com/leereilly/swot/blob/master/lib/domains/uk/ac/strath.txt) :eyes:
+* Here's what the data structure looks like:
+
+```
+[-] lib
+    [-] domains
+        [-] edu
+            [+] harvard
+            [+] stanford
+        [-] uk
+            [-] ac
+                [+] strath
+```
+
+##### Adding a School
+
+Let's say you want to add the [Stanford University](http://www.stanford.edu/). We'd simply create a file at `lib/domains/edu/stanford.txt` containing the text `Stanford University`. You can safely ignores subdomain like `www`, `cis`, whatever. You can see the actual file [here](https://github.com/leereilly/swot/blob/master/lib/domains/edu/stanford.txt).
+
+#### Updating a School Name
+
+Change the file contents of the appropriate file.
+
+#### Deleting a School Name
+
+A simple `git rm` on the approriate file will do the trick.
+
+#### Code Contributions
+
+This was literally my first Ruby gem, so please keep that in mind when you're looking at the code :trollface:
+
+* Check out the latest [master](https://github.com/leereilly/swot/tree/master).
+* Take a look through the [open pull requests](https://github.com/leereilly/swot/issues) in case someone else has already contributed something similar.
+* Fork the project.
+* Start a topic branch of your own.
+* Commit and push away. Don't forget the tests!
+* Submit a pull request.
+* :boom: You've contributed to open source!
+
+```
+     ____________________________________________________
+    |.==================================================,|
+    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
+    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
+    ||  I WILL MERGE AND REVIEW PULL REQUESTS QUICKLY   ||
+    ||  I .----.ERG,                                    ||
+    ||   / ><   \  /                                    ||
+    ||  |        |/\                                    ||
+    ||   \______//\/                                    ||
+    ||   _(____)/ /                                     ||
+    ||__/ ,_ _  _/______________________________________||
+    '===\___\_) |========================================'
+         |______|
+         |  ||  |
+         |__||__|
+         (__)(__)
+```

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", "~> 10.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.5"
+  gem "jeweler", "~> 1.8"
+  gem "minitest", "~> 4.7.5"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Lee Reilly
+
+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:
+
+[![Build Status](https://api.travis-ci.org/leereilly/swot.svg)](https://travis-ci.org/leereilly/swot) [![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,101 @@
+# 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 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference for more options
+  gem.name                  = 'swot'
+  gem.homepage              = 'https://github.com/leereilly/swot'
+  gem.license               = 'MIT'
+  gem.summary               = 'Identify email addresses or domains names that belong to colleges or universities.'
+  gem.description           = 'Identify email addresses or domains names that belong to colleges or universities. Help automate the process of approving or rejecting academic discounts.'
+  gem.email                 = 'lee@leereilly.net'
+  gem.authors               = ['Lee Reilly']
+
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.0')
+  gem.files.exclude *%w(.gitignore .travis.yml .ruby-version)
+  gem.test_files            = gem.files.grep(/^test/)
+
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+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
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "swot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :add, :sld, :tld, :name do |t, args|
+  file_path = "#{File.expand_path(__FILE__+'/..')}/lib/domains/#{args.tld}/#{args.sld}"
+  if File.exists?(file_path)
+    puts "already exists"
+  elsif
+    begin
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.open( file_path, "w" ) do |contents|
+        contents.print args.name
+      end
+      `git add #{file_path}`
+      `git commit -m "Add #{args.name}"`
+      puts "commit successful"
+    rescue
+      puts "commit failed"
+    end
+  end
+end
+
+task :quackit_import do
+  require 'nokogiri'
+  require 'open-uri'
+  require_relative File.join('lib', 'swot', 'academic_tlds')
+
+  new_domains = Set.new
+  doc = Nokogiri::HTML(open('http://www.quackit.com/domain-names/country_domain_extensions.cfm'))
+  doc.css('#content li').each do |li|
+    desc = li.content.split(/\s+-\s+/, 2)[1]
+    if desc =~ /academic|education|school/i
+      domain_el = li.at_css('b')
+      # some lines have more than one domain listed
+      domains = domain_el.content.split(/\s*\/\s*/)
+      domains.each do |domain|
+        # remove leading space
+        domain = domain.strip.sub(/\A\./, '')
+        unless Swot::ACADEMIC_TLDS.include?(domain)
+          # print out for manual review
+          puts "#{domain} - #{desc.strip.gsub(/\s+/, ' ')}"
+          new_domains << domain
+        end
+      end
+    end
+  end
+
+  puts "\nNEW DOMAINS (#{new_domains.size}):\n\n"
+
+  new_domains.each do |domain|
+    puts domain
+  end
+end

data/VERSION

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

data/lib/domains/ac/mdx.txt

@@ -0,0 +1 @@
+Middlesex University Dubai

data/lib/domains/ac/ukh.txt

@@ -0,0 +1 @@
+University of Kurdistan - Hawler

data/lib/domains/ac/unw.txt

@@ -0,0 +1 @@
+University of NorthWest

data/lib/domains/ac/uod.txt

@@ -0,0 +1 @@
+University of Dohuk (Kurdistan Region)

data/lib/domains/ad/uda.txt

@@ -0,0 +1 @@
+University of Andorra

data/lib/domains/ae/ac/adu.txt

@@ -0,0 +1 @@
+Abu Dhabi University

data/lib/domains/ae/ac/ajman.txt

@@ -0,0 +1 @@
+Ajman University of Science & Technology

data/lib/domains/ae/ac/alainuniversity.txt

@@ -0,0 +1 @@
+Alain University of Science and Technology

data/lib/domains/ae/ac/buid.txt

@@ -0,0 +1 @@
+British University in Dubai

data/lib/domains/ae/ac/gmu.txt

@@ -0,0 +1 @@
+Gulf Medical University

data/lib/domains/ae/ac/hct.txt

@@ -0,0 +1 @@
+Higher Colleges of Technology

data/lib/domains/ae/ac/ittihad.txt

@@ -0,0 +1 @@
+Ittihad University

data/lib/domains/ae/ac/ku.txt

@@ -0,0 +1 @@
+Khalifa University of Science, Technology and Research

data/lib/domains/ae/ac/masdar.txt

@@ -0,0 +1 @@
+Masdar University Of Science And Technology

data/lib/domains/ae/ac/pi.txt

@@ -0,0 +1 @@
+The Petroleum Institute

data/lib/domains/ae/ac/sharjah.txt

@@ -0,0 +1 @@
+University of Sharjah

data/lib/domains/ae/ac/uaeu.txt

@@ -0,0 +1 @@
+United Arab Emirates University

data/lib/domains/ae/ac/ud.txt

@@ -0,0 +1 @@
+University Of Dubai

data/lib/domains/ae/ac/uowdubai.txt

@@ -0,0 +1 @@
+University of Wollongong - Dubai Campus

data/lib/domains/ae/ac/zu.txt

@@ -0,0 +1 @@
+Zayed University

data/lib/domains/ae/agu.txt

@@ -0,0 +1 @@
+Al Ghurair University

data/lib/domains/ae/alhosnu.txt

@@ -0,0 +1 @@
+Alhosn University

data/lib/domains/ae/aue.txt

@@ -0,0 +1 @@
+American University in the Emirates

data/lib/domains/ae/sorbonne.txt

@@ -0,0 +1 @@
+Paris-Sorbonne University Abu Dhabi

data/lib/domains/af/edu/auaf.txt

@@ -0,0 +1 @@
+American University of Afghanistan

data/lib/domains/af/edu/bakhtar.txt

@@ -0,0 +1 @@
+Bakhtar University

data/lib/domains/af/edu/kardan.txt

@@ -0,0 +1 @@
+Kardan University

data/lib/domains/af/edu/kmu.txt

@@ -0,0 +1 @@
+Kabul Medical University

data/lib/domains/af/edu/ku.txt

@@ -0,0 +1 @@
+Kabul University

data/lib/domains/ag/uhsa.txt

@@ -0,0 +1 @@
+University of Health Sciences Antigua

data/lib/domains/al/edu/epoka.txt

@@ -0,0 +1 @@
+Epoka University