gman 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,12 @@
 # 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).
+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). It does this by leveraging the power of the [Public Suffix List](http://publicsuffix.org/), and the associated [Ruby Gem](https://github.com/weppos/publicsuffix-ruby).
+
+You could theoretically [use regex](https://gist.github.com/benbalter/6147066), but either you'll a bunch of false positives, or your regex will be insanely complicated. `gov.uk`, may be valid, for example, but `gov.fr` is not (it's `gouv.fr`, for what it's worth).
+
+The solution? Use Public Suffix to verify that it's a valid public domain, then maintain [a crowd-sourced sub-list of known global government and military domains](https://github.com/benbalter/gman/blob/master/lib/domains.yml). It should cover all US and international, government and military domains for both email and website verification.
+
+See a domains that's missing or one that shouldn't be there? [We'd love you to contribute](CONTRIBUTING.md).
 
 ## Installation
 
@@ -17,21 +23,21 @@ Or add this to your `Gemfile` before doing a `bundle install`:
 ### Verify email addresses
 
 ```ruby
-Gman::is_government? "foo@bar.gov" #true
-Gman::is_government? "foo@bar.com" #false
+Gman.valid? "foo@bar.gov" #true
+Gman.valid? "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
+Gman.valid? "http://foo.bar.gov" #true
+Gman.valid? "foo.bar.gov" #true
+Gman.valid? "foo.gov" #true
+Gman.valid? "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.
+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
 

data/gman.gemspec

@@ -2,9 +2,9 @@ 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.version = "0.0.2"
   s.authors = ["Ben Balter"]
-  s.date = "2013-08-23"
+  s.date = "2013-08-30"
   s.email = "ben.balter@github.com"
   s.homepage = "https://github.com/benbalter/gman"
   s.licenses = ["MIT"]

data/lib/gman.rb

@@ -3,7 +3,7 @@ require 'yaml'
 
 module Gman
 
-  VERSION='0.0.1'
+  VERSION='0.0.2'
 
   class << self
 
@@ -16,7 +16,7 @@ module Gman
     #   "http://foo.bar.gov"
     #
     # Returns boolean true if a government domain
-    def is_government?(text)
+    def valid?(text)
       return false if text.nil?
       text.strip!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix