swot 0.2.13 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a49ff2011c0bce368851e99dd4b455d8b1cfcca5
+  data.tar.gz: 1d7fc4c436b7c369f182c5666fab45fe5c17cf2b
+SHA512:
+  metadata.gz: 32318f590856ba9d84770e72becbcf372c4bc308a859048d9beac32fc40dd99e523c531ca55db991b37b95eebc88fd42b9a9f2592e2f97f9cf3077798a365619
+  data.tar.gz: ca9f2c2aa0c681316f617b0d1d5d09f2c281f2517d9bee6b4bf3875e5f512e05f6da5d04f887e4aa2d9298b78468917fc4fc1fd8f24605b51ddd7c3a8b3aac68

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -6,6 +6,6 @@ group :development do
   gem "rake", "~> 10.0.4"
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.2.1"
+  gem "bundler", "~> 1.5.0"
   gem "jeweler", "~> 1.8.3"
 end

data/README.md

@@ -1,5 +1,7 @@
 # Swot :apple:
 
+[![Build Status](https://api.travis-ci.org/leereilly/swot.png)](https://travis-ci.org/leereilly/swot) ![](https://badge.fury.io/rb/swot.png)
+
 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.
@@ -51,10 +53,10 @@ Swot::school_name 'http://www.stanford.edu'
 
 ### Contributing to Swot
 
-Contributions welcome! Please see the [contribution guidelines](CONTRIBUTING.md) for details on how to add, update, or delete schools. Code contributions welcome too. Ports to different languages welcome too.
+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, @johndbritton, @johnotander, @pborreli, @rcurtis, @vikhyat,.
+@blutack, @captn3m0, @chrishunt, @johndbritton, @johnotander, @pborreli, @rcurtis, @vikhyat,.
 
 **Special thanks** to @weppos for the [public_suffix](https://github.com/weppos/publicsuffix-ruby) gem :metal:
 
@@ -100,3 +102,8 @@ Hopefully, you'll be surprised by some of this:
 |`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
+

data/lib/domains/ac.in/becs

@@ -0,0 +1 @@
+Bengal Engineering and Science University

data/lib/domains/ac.uk/southwales

@@ -0,0 +1 @@
+University of South Wales

data/lib/domains/at/fadi

@@ -0,0 +1 @@
+BRG Fadingerstraße Linz, Austria

data/lib/domains/ca/saultcollege

@@ -0,0 +1,2 @@
+Sault College of Applied Arts & Technology
+

data/lib/domains/fr/eurecom

@@ -0,0 +1 @@
+Institut EURECOM

data/lib/swot.rb

@@ -1,7 +1,7 @@
 require 'public_suffix'
 
 module Swot
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 
   # These top-level domains are guaranteed to be academic institutions.
   ACADEMIC_TLDS = {
@@ -123,6 +123,13 @@ module Swot
     'vic.edu.au' => 1,
   }
 
+  # These are domains that snuck into the edu registry,
+  # but don't pass the education sniff test
+  # Note: domain must be a direct match
+  BLACKLIST = [
+    'si.edu',
+  ]
+
   class << self
 
     # Figure out if an email or domain belongs to academic institution.
@@ -131,12 +138,13 @@ module Swot
     #  false otherwise.
     def is_academic?(text)
       return false if text.nil?
-      text.strip!
       begin
         domain = get_domain(text)
         return false if domain.nil?
 
-        if ACADEMIC_TLDS[domain.tld]
+        if BLACKLIST.include? domain.name
+          false
+        elsif ACADEMIC_TLDS[domain.tld]
           true
         elsif match_academic_domain?(domain)
           true
@@ -157,11 +165,7 @@ module Swot
     #
     # Returns a string with the institution name; nil if nothing is found.
     def get_institution_name(text)
-      text.strip!
-      text.downcase!
-      text = text.split("@")[1] if text.include? "@"
-      domain = PublicSuffix.parse(text)
-      name_from_academic_domain(domain)
+      name_from_academic_domain(get_domain(text))
     end
     alias_method :school_name, :get_institution_name
 
@@ -170,7 +174,7 @@ module Swot
     # Returns true if the domain name belongs to a known academic institution;
     #  false otherwise.
     def match_academic_domain?(domain)
-      File.exists?("#{File.expand_path(__FILE__+'/..')}/domains/#{domain.tld}/#{domain.sld}")
+      File.exists?(get_path(domain))
     end
 
     # Figure out the institutions' name based on the domain name.
@@ -178,10 +182,7 @@ module Swot
     # Return the institution name, or nil if not found.
     def name_from_academic_domain(domain)
       begin
-        file = File.open("#{File.expand_path(__FILE__+'/..')}/domains/#{domain.tld}/#{domain.sld}", "rb")
-        contents = file.read
-        contents.strip!
-        return contents
+        File.read(get_path(domain), :mode => "rb", :external_encoding => "UTF-8").strip
       rescue
         return nil
       end
@@ -191,17 +192,20 @@ module Swot
     #
     # Returns a string with the FQDN; nil if there's an error.
     def get_domain(text)
-      text.strip!
-      return false if text.nil?
-      text.downcase!
-      text = text.split("@")[1] if text.include? "@"
+      PublicSuffix.parse text.strip.downcase.match(domain_regex).captures.first
+    rescue
+      return nil
+    end
 
-      begin
-        domain = PublicSuffix.parse(text)
-        return domain
-      rescue
-        return nil
-      end
+    def get_path(domain)
+      File.join(File.dirname(__FILE__), "domains", domain.tld, domain.sld)
+    end
+
+    private
+
+    # http://rubular.com/r/uW2GqSxvqD
+    def domain_regex
+      /([^@\/:]+)[:\d]*$/
     end
   end
-end
+end

data/swot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "swot"
-  s.version = "0.2.13"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lee Reilly"]
-  s.date = "2013-05-28"
+  s.date = "2014-04-01"
   s.description = "email helpers"
   s.email = "lee@leereilly.net"
   s.extra_rdoc_files = [
@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
-    ".rbenv-version",
+    ".ruby-version",
+    ".travis.yml",
     "CONTRIBUTING.md",
     "Gemfile",
     "LICENSE.txt",
@@ -331,6 +332,7 @@ Gem::Specification.new do |s|
     "lib/domains/ac.il/weizmann",
     "lib/domains/ac.il/wgalil",
     "lib/domains/ac.il/yvc",
+    "lib/domains/ac.in/becs",
     "lib/domains/ac.in/bitmesra",
     "lib/domains/ac.in/bits-pilani",
     "lib/domains/ac.in/daiict",
@@ -1257,6 +1259,7 @@ Gem::Specification.new do |s|
     "lib/domains/ac.uk/soas",
     "lib/domains/ac.uk/solent",
     "lib/domains/ac.uk/soton",
+    "lib/domains/ac.uk/southwales",
     "lib/domains/ac.uk/ssees",
     "lib/domains/ac.uk/st-and",
     "lib/domains/ac.uk/st-patricks",
@@ -1355,6 +1358,7 @@ Gem::Specification.new do |s|
     "lib/domains/asso.fr/essca",
     "lib/domains/asso.fr/fupl",
     "lib/domains/asso.fr/ict-toulouse",
+    "lib/domains/at/fadi",
     "lib/domains/at/fh-burgenland",
     "lib/domains/at/fh-hagenberg",
     "lib/domains/at/fh-joanneum",
@@ -1672,6 +1676,7 @@ Gem::Specification.new do |s|
     "lib/domains/ca/rrc",
     "lib/domains/ca/ryerson",
     "lib/domains/ca/sait",
+    "lib/domains/ca/saultcollege",
     "lib/domains/ca/sfu",
     "lib/domains/ca/stfx",
     "lib/domains/ca/stmarys",
@@ -6331,6 +6336,7 @@ Gem::Specification.new do |s|
     "lib/domains/fr/essec",
     "lib/domains/fr/estp",
     "lib/domains/fr/eudil",
+    "lib/domains/fr/eurecom",
     "lib/domains/fr/hec",
     "lib/domains/fr/hei",
     "lib/domains/fr/icam",
@@ -7695,25 +7701,25 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/leereilly/swot"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "2.0.14"
   s.summary = "email helpers"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<public_suffix>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["~> 10.0.4"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.5.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
       s.add_dependency(%q<public_suffix>, [">= 0"])
       s.add_dependency(%q<rake>, ["~> 10.0.4"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.5.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
@@ -7721,7 +7727,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>, ["~> 10.0.4"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.5.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
   end
 end

data/test/test_swot.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'helper'
 
 class TestEmail < Test::Unit::TestCase
@@ -21,8 +22,8 @@ class TestEmail < Test::Unit::TestCase
     assert_equal Swot::is_academic?('stanford.edu'),                  true
     assert_equal Swot::is_academic?('slac.stanford.edu'),             true
     assert_equal Swot::is_academic?('www.stanford.edu'),              true
-    #assert_equal Swot::is_academic?('http://www.stanford.edu'),       true
-    #assert_equal Swot::is_academic?('http://www.stanford.edu:9393'), true
+    assert_equal Swot::is_academic?('http://www.stanford.edu'),       true
+    assert_equal Swot::is_academic?('http://www.stanford.edu:9393'),  true
     assert_equal Swot::is_academic?('strath.ac.uk'),                  true
     assert_equal Swot::is_academic?('soft-eng.strath.ac.uk'),         true
     assert_equal Swot::is_academic?('ugr.es'),                        true
@@ -46,10 +47,21 @@ class TestEmail < Test::Unit::TestCase
 
   should "returns name of valid institution" do
     assert_equal Swot::get_institution_name('lreilly@cs.strath.ac.uk'), "University of Strathclyde"
+    assert_equal Swot::get_institution_name('lreilly@fadi.at'), "BRG Fadingerstraße Linz, Austria"
+  end
+
+  should "returns nil when institution invalid" do
+    assert_equal Swot::get_institution_name('foo@shop.com'), nil
   end
 
   should "test aliased methods" do
     assert_equal Swot::academic?('stanford.edu'), true
     assert_equal Swot::school_name('lreilly@cs.strath.ac.uk'), "University of Strathclyde"
   end
+
+  should "fail blacklisted domains" do
+    ["si.edu", " si.edu ", "imposter@si.edu"].each do |domain|
+      assert_equal false, Swot::is_academic?(domain), "#{domain} should be denied"
+    end
+  end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: swot
 version: !ruby/object:Gem::Version
-  version: 0.2.13
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Lee Reilly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,23 +69,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -116,7 +103,8 @@ extra_rdoc_files:
 - README.md
 files:
 - .document
-- .rbenv-version
+- .ruby-version
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -429,6 +417,7 @@ files:
 - lib/domains/ac.il/weizmann
 - lib/domains/ac.il/wgalil
 - lib/domains/ac.il/yvc
+- lib/domains/ac.in/becs
 - lib/domains/ac.in/bitmesra
 - lib/domains/ac.in/bits-pilani
 - lib/domains/ac.in/daiict
@@ -1355,6 +1344,7 @@ files:
 - lib/domains/ac.uk/soas
 - lib/domains/ac.uk/solent
 - lib/domains/ac.uk/soton
+- lib/domains/ac.uk/southwales
 - lib/domains/ac.uk/ssees
 - lib/domains/ac.uk/st-and
 - lib/domains/ac.uk/st-patricks
@@ -1453,6 +1443,7 @@ files:
 - lib/domains/asso.fr/essca
 - lib/domains/asso.fr/fupl
 - lib/domains/asso.fr/ict-toulouse
+- lib/domains/at/fadi
 - lib/domains/at/fh-burgenland
 - lib/domains/at/fh-hagenberg
 - lib/domains/at/fh-joanneum
@@ -1770,6 +1761,7 @@ files:
 - lib/domains/ca/rrc
 - lib/domains/ca/ryerson
 - lib/domains/ca/sait
+- lib/domains/ca/saultcollege
 - lib/domains/ca/sfu
 - lib/domains/ca/stfx
 - lib/domains/ca/stmarys
@@ -6429,6 +6421,7 @@ files:
 - lib/domains/fr/essec
 - lib/domains/fr/estp
 - lib/domains/fr/eudil
+- lib/domains/fr/eurecom
 - lib/domains/fr/hec
 - lib/domains/fr/hei
 - lib/domains/fr/icam
@@ -7792,29 +7785,25 @@ files:
 homepage: http://github.com/leereilly/swot
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4255369170415974051
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: email helpers
 test_files: []

data/.rbenv-version

@@ -1 +0,0 @@
-1.9.3-p194