gman 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to Gman
+
+## How to contribute
+
+1. Fork the project
+2. Create a descriptive branch
+3. Make your change
+4. Submit a pull request
+
+## Code
+
+Open an issue, or submit a pull request
+
+## Domains
+
+Domains live in `./lib/domains.yml` as a bulleted list of TLDs and SLD+TLDs.
+
+Right now, the only valid government top level domains (TLDs), represent the US government and are `.gov`, and `.mil`.
+
+Secondary domains (e.g., `gov.uk`, or `mil.au`) detect non-US government entities.
+
+To add or remove a domain from the list of known government domains, simply edit the `domains.yml` file.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'public_suffix'
+
+group :development do
+  gem "rake"
+  gem "shoulda"
+  gem "rdoc"
+  gem "bundler"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Ben Balter
+
+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,38 @@
+# Gman Gem
+
+A ruby gem to check if the owner of a given email address or website is working for THE MAN (a.k.a verifies government domains).
+
+## Installation
+
+Gman is a Ruby gem, so you'll need a little Ruby-fu to get it working. Simply
+
+`gem install gman`
+
+Or add this to your `Gemfile` before doing a `bundle install`:
+
+`gem 'gman'`
+
+## Usage
+
+### Verify email addresses
+
+```ruby
+Gman::is_government? "foo@bar.gov" #true
+Gman::is_government? "foo@bar.com" #false
+```
+### Verify domain
+
+```ruby
+Gman::is_government? "http://foo.bar.gov" #true
+Gman::is_government? "foo.bar.gov" #true
+Gman::is_government? "foo.gov" #true
+Gman::is_government? "foo.biz" #false
+```
+
+## Contributing
+
+Contributions welcome! Please see [the contribution guidelines](contributing.md) for code contributions or for details on how to add, update, or delete government domains.
+
+## Credits
+
+Heavily inspired by [swot](https://github.com/leereilly/swot). Thanks @leereily!

data/Rakefile

@@ -0,0 +1,21 @@
+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 :console do
+  exec "irb -r ./lib/gman.rb"
+end

data/gman.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = "gman"
+  s.summary = "Check if a given domain or email address belong to a governemnt entity"
+  s.description = "A ruby gem to check if the owner of a given email address is working for THE MAN."
+  s.version = "0.0.1"
+  s.authors = ["Ben Balter"]
+  s.date = "2013-08-23"
+  s.email = "ben.balter@github.com"
+  s.homepage = "https://github.com/benbalter/gman"
+  s.licenses = ["MIT"]
+
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "CONTRIBUTING.md",
+    "LICENSE",
+    "lib/gman.rb",
+    "lib/domains.yml",
+    "script/build",
+    "script/release",
+    "gman.gemspec",
+    "test/helper.rb",
+    "test/test_gman.rb",
+    "Rakefile",
+    ".gitignore"
+  ]
+  s.require_paths = ["lib"]
+  s.add_dependency( "public_suffix" )
+end

data/lib/domains.yml

@@ -0,0 +1,184 @@
+---
+- fed.us
+- gc.ca
+- gob.bo
+- gob.cl
+- gob.do
+- gob.ec
+- gob.es
+- gob.gt
+- gob.hn
+- gob.mx
+- gob.pa
+- gob.pe
+- gob.pk
+- gouv.bj
+- gouv.ci
+- gouv.fr
+- gouv.ht
+- gouv.km
+- gouv.ml
+- gouv.rw
+- gouv.sn
+- gov
+- gov.ac
+- gov.ae
+- gov.af
+- gov.al
+- gov.as
+- gov.au
+- gov.az
+- gov.ba
+- gov.bb
+- gov.bf
+- gov.bh
+- gov.bm
+- gov.bo
+- gov.br
+- gov.bs
+- gov.bt
+- gov.by
+- gov.bz
+- gov.cd
+- gov.cl
+- gov.cm
+- gov.cn
+- gov.co
+- gov.cu
+- gov.cx
+- gov.dm
+- gov.do
+- gov.dz
+- gov.ec
+- gov.ee
+- gov.eg
+- gov.ge
+- gov.gg
+- gov.gh
+- gov.gi
+- gov.gn
+- gov.gr
+- gov.hk
+- gov.ie
+- gov.im
+- gov.in
+- gov.iq
+- gov.ir
+- gov.is
+- gov.it
+- gov.je
+- gov.jo
+- gov.kg
+- gov.ki
+- gov.km
+- gov.kn
+- gov.kp
+- gov.ky
+- gov.kz
+- gov.la
+- gov.lb
+- gov.lc
+- gov.lk
+- gov.lr
+- gov.lt
+- gov.lv
+- gov.ly
+- gov.ma
+- gov.me
+- gov.mg
+- gov.mk
+- gov.ml
+- gov.mn
+- gov.mo
+- gov.mr
+- gov.mu
+- gov.mv
+- gov.mw
+- gov.my
+- gov.ng
+- gov.nr
+- gov.ph
+- gov.pk
+- gov.pl
+- gov.pn
+- gov.pr
+- gov.ps
+- gov.pt
+- gov.py
+- gov.qa
+- gov.rs
+- gov.ru
+- gov.rw
+- gov.sa
+- gov.sb
+- gov.sc
+- gov.sd
+- gov.sg
+- gov.sh
+- gov.sl
+- gov.st
+- gov.sx
+- gov.sy
+- gov.tj
+- gov.tl
+- gov.tm
+- gov.tn
+- gov.to
+- gov.tt
+- gov.tw
+- gov.ua
+- gov.vc
+- gov.ve
+- gov.vn
+- gov.ws
+- gub.uy
+- mil
+- mil.ac
+- mil.ae
+- mil.al
+- mil.az
+- mil.ba
+- mil.bo
+- mil.br
+- mil.by
+- mil.cl
+- mil.cn
+- mil.co
+- mil.do
+- mil.ec
+- mil.eg
+- mil.ge
+- mil.gh
+- mil.gt
+- mil.hn
+- mil.id
+- mil.in
+- mil.iq
+- mil.jo
+- mil.kg
+- mil.km
+- mil.kr
+- mil.kz
+- mil.lv
+- mil.mg
+- mil.mv
+- mil.my
+- mil.no
+- mil.pe
+- mil.ph
+- mil.pl
+- mil.py
+- mil.qa
+- mil.ru
+- mil.rw
+- mil.sh
+- mil.st
+- mil.sy
+- mil.tj
+- mil.tm
+- mil.to
+- mil.tw
+- mil.tz
+- mil.uy
+- mil.vc
+- mil.ve

data/lib/gman.rb

@@ -0,0 +1,69 @@
+require 'public_suffix'
+require 'yaml'
+
+module Gman
+
+  VERSION='0.0.1'
+
+  class << self
+
+    # Normalizes and checks if a given string represents a governemnt domain
+    # Possible strings to test:
+    #   ".gov"
+    #   "foo.gov"
+    #   "foo@bar.gov"
+    #   "foo.gov.uk"
+    #   "http://foo.bar.gov"
+    #
+    # Returns boolean true if a government domain
+    def is_government?(text)
+      return false if text.nil?
+      text.strip!
+
+      begin
+        domain = get_domain(text)
+        return false if domain.nil?
+
+        match_government_domain?(domain)
+
+      rescue PublicSuffix::DomainInvalid => di
+        false
+
+      rescue PublicSuffix::DomainNotAllowed => dna
+        false
+      end
+
+    end
+
+    # Checks the TLD (e.g., .gov) or TLD+SLD (e.g., .gov.uk)
+    # Against list of known government domains
+    def match_government_domain?(domain)
+      domains.include?(domain.tld) || domains.include?("#{domain.tld}.#{domain.sld}")
+    end
+
+    # Parses YML domain list into an array
+    # TODO: Cache this
+    #
+    # Returns an array of TLD and TLD+SLD known government domains
+    def domains
+       YAML.load_file File.expand_path("../domains.yml", __FILE__)
+    end
+
+    # Get the FQDN name from a URL or email address.
+    #
+    # Returns a string with the FQDN; nil if there's an error.
+    # Source: https://github.com/leereilly/swot/blob/master/lib/swot.rb#L190
+    def get_domain(text)
+      PublicSuffix.parse text.downcase.match(domain_regex).captures.first
+    rescue
+      return nil
+    end
+
+    private
+
+    # Source: https://github.com/leereilly/swot/blob/master/lib/swot.rb#L202
+    def domain_regex
+      /([^@\/:]+)[:\d]*$/
+    end
+  end
+end

data/script/build

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# Propegates an initial list of best-guess government domains
+
+require "public_suffix"
+require "yaml"
+
+# https://gist.github.com/benbalter/6147066
+REGEX = /(\.g[ou]{1,2}(v|b|vt)|\.mil|\.gc|\.fed)(\.[a-z]{2})?$/i
+
+YAML_FILE = File.dirname(__FILE__) + "/../lib/domains.yml"
+domains = YAML.load_file YAML_FILE
+domains = [] unless domains
+
+PublicSuffix::List.default.each do |rule|
+  domain = nil
+
+  if rule.parts.length == 1
+    domain = rule.parts.first if ".#{rule.value}" =~ REGEX
+  else
+    domain = rule.parts.pop(2).join(".") if ".#{rule.value}" =~ REGEX
+  end
+
+  domains.push domain unless domain.nil? or domains.include? domain
+end
+
+domains = domains.sort
+File.open(YAML_FILE, 'w+') {|f| f.write(domains.to_yaml)}

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf gman-*.gem
+gem build -q gman.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls gman-*.gem | sed 's/^gman-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push gman-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gman'
+
+class Test::Unit::TestCase
+end

data/test/test_gman.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+VALID = ["foo.gov", "http://foo.mil", "foo@bar.gc.ca", "foo.gov.au", "http://www.foo.gouv.fr"]
+INVALID = ["foo.bar.com", "bar@foo.biz", "http://www.foo.biz", "foo.uk", "gov"]
+
+class TestGman < Test::Unit::TestCase
+  should "recognize government email addresses and domains" do
+    VALID.each do |test|
+      assert_equal Gman::is_government?(test), true
+    end
+    INVALID.each do |test|
+      assert_equal Gman::is_government?(test), false
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: gman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 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'
+description: A ruby gem to check if the owner of a given email address is working
+  for THE MAN.
+email: ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- CONTRIBUTING.md
+- LICENSE
+- lib/gman.rb
+- lib/domains.yml
+- script/build
+- script/release
+- gman.gemspec
+- test/helper.rb
+- test/test_gman.rb
+- Rakefile
+- .gitignore
+homepage: https://github.com/benbalter/gman
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Check if a given domain or email address belong to a governemnt entity
+test_files: []