gman 7.0.5 → 8.0.0

data/docs/README.md

@@ -4,7 +4,7 @@
 
 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 will also provide you with metadata about the domain, such as the country, state, city, or agency, where applicable. It does this by leveraging the power of [Naughty or Nice](https://github.com/benbalter/naughty_or_nice), 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 get 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/config/domains.txt). It should cover all US and international, government and military domains for both email and website verification.
+You could theoretically [use regex](https://gist.github.com/benbalter/6147066), but either you'll get 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/main/config/domains.txt). 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).
 
@@ -18,6 +18,8 @@ Or add this to your `Gemfile` before doing a `bundle install`:
 
 `gem 'gman'`
 
+Gman requires Ruby 3.2 or newer.
+
 ## Usage
 
 ### In general

data/lib/gman/domain_list.rb

@@ -2,7 +2,7 @@
 
 class Gman
   class DomainList
-    COMMENT_REGEX = %r{//[/\s]*(.*)$}i.freeze
+    COMMENT_REGEX = %r{//[/\s]*(.*)$}i
 
     attr_writer :data, :path, :contents
 

data/lib/gman/identifier.rb

@@ -26,7 +26,7 @@ class Gman
   def_hash_delegator :dotgov_listing, :Agency
   def_hash_delegator :dotgov_listing, :Organization
   def_hash_delegator :dotgov_listing, :City
-  def_hash_delegator :dotgov_listing, :"Domain Type"
+  def_hash_delegator :dotgov_listing, :'Domain Type'
   private :domain_type
 
   def type
@@ -45,7 +45,7 @@ class Gman
   def state
     if matches
       matches[4].upcase
-    elsif dotgov_listing['State']
+    elsif dotgov_listing && dotgov_listing['State']
       dotgov_listing['State']
     elsif list_category
       matches = list_category.match(/usagov([A-Z]{2})/)
@@ -60,7 +60,7 @@ class Gman
   def federal?
     return false unless dotgov_listing
 
-    domain_type =~ /^Federal Agency/i
+    domain_type.to_s.match?(/^Federal/i)
   end
 
   def city?
@@ -87,7 +87,7 @@ class Gman
     if matches
       matches[1] == 'state'
     elsif dotgov_listing
-      domain_type == 'State/Local Govt'
+      ['State/Local Govt', 'State'].include?(domain_type)
     else
       false
     end
@@ -108,14 +108,14 @@ class Gman
   private
 
   def list_category
-    @list_category ||= begin
-      match = Gman.list.public_suffix_list.find(domain.to_s)
-      return unless match
+    return @list_category if defined?(@list_category)
 
-      regex = %r{// ([^\n]+)\n?[^/]*\n#{Regexp.escape(match.value)}\n}im
-      matches = Gman.list.contents.match(regex)
-      matches[1] if matches
-    end
+    match = Gman.list.public_suffix_list.find(domain.to_s)
+    return @list_category = nil unless match
+
+    regex = %r{// ([^\n]+)\n?[^/]*\n#{Regexp.escape(match.value)}\n}im
+    matches = Gman.list.contents.match(regex)
+    @list_category = matches ? matches[1] : nil
   end
 
   def matches
@@ -128,9 +128,7 @@ class Gman
     return @dotgov_listing if defined? @dotgov_listing
     return unless dotgov?
 
-    @dotgov_listing = Gman.dotgov_list.find do |listing|
-      listing['Domain Name'].casecmp("#{domain.sld}.gov").zero?
-    end
+    @dotgov_listing = Gman.dotgov_index["#{domain.sld}.gov".downcase]
   end
 
   class << self
@@ -138,6 +136,11 @@ class Gman
       @dotgov_list ||= CSV.read(dotgov_list_path, headers: true)
     end
 
+    # Hash of lowercase domain name => dotgov listing, for constant-time lookup
+    def dotgov_index
+      @dotgov_index ||= dotgov_list.to_h { |listing| [listing['Domain Name'].downcase, listing] }
+    end
+
     private
 
     def dotgov_list_path

data/lib/gman/importer.rb

@@ -8,7 +8,7 @@ require 'resolv'
 require 'logger'
 require 'swot'
 require_relative '../gman'
-require_relative './domain_list'
+require_relative 'domain_list'
 
 class Gman
   class Importer

data/lib/gman/locality.rb

@@ -33,7 +33,7 @@ class Gman
       |
         (#{Regexp.union(LOCALITY_DOMAINS)})\.[a-z-]+
       )\.(#{Regexp.union(STATES)})\.us
-    /x.freeze
+    /x
 
     def self.valid?(domain)
       !domain.to_s.match(Locality::REGEX).nil?

data/lib/gman/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Gman
-  VERSION = '7.0.5'
+  VERSION = '8.0.0'
 end

data/lib/gman.rb

@@ -43,12 +43,9 @@ class Gman
   #
   # Returns boolean true if a government domain
   def valid?
-    @valid ||= begin
-      return false unless valid_domain?
-      return false if academic?
+    return @valid if defined?(@valid)
 
-      locality? || public_suffix_valid?
-    end
+    @valid = valid_domain? && (locality? || public_suffix_valid?)
   end
 
   def locality?
@@ -58,14 +55,18 @@ class Gman
   private
 
   def valid_domain?
-    @valid_domain ||= !domain.nil? && !academic?
+    !domain.nil? && !academic?
   end
 
   def academic?
-    @academic ||= domain && Gman.academic_list.valid?(to_s)
+    return @academic if defined?(@academic)
+
+    @academic = !domain.nil? && Gman.academic_list.valid?(to_s)
   end
 
   def public_suffix_valid?
-    @public_suffix_valid ||= Gman.list.valid?(to_s)
+    return @public_suffix_valid if defined?(@public_suffix_valid)
+
+    @public_suffix_valid = Gman.list.valid?(to_s)
   end
 end

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: gman
 version: !ruby/object:Gem::Version
-  version: 7.0.5
+  version: 8.0.0
 platform: ruby
 authors:
 - Ben Balter
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: iso_country_codes
   requirement: !ruby/object:Gem::Requirement
@@ -66,146 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: mechanize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: parallel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: swot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: |2
       A ruby gem to check if the owner of a given email address is working for
       THE MAN.
@@ -216,34 +75,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/config.yml"
-- ".github/funding.yml"
-- ".github/no-response.yml"
-- ".github/release-drafter.yml"
-- ".github/settings.yml"
-- ".github/stale.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - bin/gman
 - bin/gman_filter
 - config/domains.txt
 - config/vendor/academic.txt
 - config/vendor/dotgovs.csv
-- docs/CODE_OF_CONDUCT.md
-- docs/CONTRIBUTING.md
 - docs/README.md
-- docs/SECURITY.md
-- docs/_config.yml
-- gman.gemspec
 - lib/gman.rb
 - lib/gman/country_codes.rb
 - lib/gman/domain_list.rb
@@ -251,68 +89,26 @@ files:
 - lib/gman/importer.rb
 - lib/gman/locality.rb
 - lib/gman/version.rb
-- script/add
-- script/alphabetize
-- script/bootstrap
-- script/cibuild
-- script/console
-- script/dedupe
-- script/profile
-- script/prune
-- script/reconcile-us
-- script/release
-- script/vendor
-- script/vendor-federal-de
-- script/vendor-gov-list
-- script/vendor-municipal-de
-- script/vendor-nl
-- script/vendor-public-suffix
-- script/vendor-se
-- script/vendor-swot
-- script/vendor-us
-- spec/fixtures/domains.txt
-- spec/fixtures/obama.txt
-- spec/gman/bin_spec.rb
-- spec/gman/country_code_spec.rb
-- spec/gman/domain_list_spec.rb
-- spec/gman/domains_spec.rb
-- spec/gman/identifier_spec.rb
-- spec/gman/importer_spec.rb
-- spec/gman/locality_spec.rb
-- spec/gman_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/benbalter/gman
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Check if a given domain or email address belong to a governemnt entity
-test_files:
-- spec/fixtures/domains.txt
-- spec/fixtures/obama.txt
-- spec/gman/bin_spec.rb
-- spec/gman/country_code_spec.rb
-- spec/gman/domain_list_spec.rb
-- spec/gman/domains_spec.rb
-- spec/gman/identifier_spec.rb
-- spec/gman/importer_spec.rb
-- spec/gman/locality_spec.rb
-- spec/gman_spec.rb
-- spec/spec_helper.rb
+summary: Check if a given domain or email address belong to a government entity
+test_files: []

data/.github/CODEOWNERS

@@ -1,3 +0,0 @@
-# Require @benbalter's :+1: for changes to the .github repo-config files
-# mainly due to https://github.com/probot/settings privilege escalation
-.github/* @benbalter

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-### Describe the bug
-
-A clear and concise description of what the bug is.
-
-### Steps to reproduce the behavior
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-### Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-### Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-### Additional context
-
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,21 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-### Is your feature request related to a problem? Please describe the problem you're trying to solve.
-
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-### Describe the solution you'd like
-
-A clear and concise description of what you want to happen.
-
-### Describe alternatives you've considered
-
-A clear and concise description of any alternative solutions or features you've considered.
-
-### Additional context
-
-Add any other context or screenshots about the feature request here.

data/.github/config.yml

@@ -1,23 +0,0 @@
-# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Configuration for update-docs - https://github.com/behaviorbot/update-docs
-updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
-
-# Configuration for request-info - https://github.com/behaviorbot/request-info
-requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
-requestInfoLabelToAdd: more-information-needed
-
-# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
-#newIssueWelcomeComment: >
-#  Welcome!
-
-# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
-newPRWelcomeComment: Welcome! Congrats on your first pull request to Gman. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/benbalter/gman/blob/master/docs/CONTRIBUTING.md).
-
-# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
-firstPRMergeComment: "Congrats on getting your first pull request to Gman merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/benbalter/gman/issues), especially those [labeled `help wanted`](https://github.com/benbalter/gman/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."
-
-# Bug workaround
-contact_links: []

data/.github/funding.yml

@@ -1 +0,0 @@
-patreon: benbalter

data/.github/no-response.yml

@@ -1,15 +0,0 @@
-# Configuration for probot-no-response - https://github.com/probot/no-response
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Number of days of inactivity before an Issue is closed for lack of response
-daysUntilClose: 14
-# Label requiring a response
-responseRequiredLabel: more-information-needed
-# Comment to post when closing an Issue for lack of response. Set to `false` to disable
-closeComment: >
-  This issue has been automatically closed because there has been no response
-  to our request for more information from the original author. With only the
-  information that is currently in the issue, we don't have enough information
-  to take action. Please reach out if you have or find the answers we need so
-  that we can investigate further.

data/.github/release-drafter.yml

@@ -1,4 +0,0 @@
-template: |
-  ## What's Changed
-
-  $CHANGES

data/.github/settings.yml

@@ -1,33 +0,0 @@
-# Repository settings set via https://github.com/probot/settings
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-repository:
-  has_issues: true
-  has_wiki: false
-  has_projects: false
-  has_downloads: false
-
-labels:
-  - name: help wanted
-    oldname: help-wanted
-    color: 0e8a16
-  - name: more-information-needed
-    color: d93f0b
-  - name: bug
-    color: b60205
-  - name: feature
-    color: 1d76db
-  - name: good first issue
-    color: "5319e7"
-
-# Not currently implemented by probot/settings, but manually implemented in script/deploy
-branch_protection:
-  restrictions: null
-  enforce_admins: false
-  required_status_checks:
-    strict: true
-    contexts:
-      - "continuous-integration/travis-ci"
-  required_pull_request_reviews:
-    require_code_owner_reviews: true

data/.github/stale.yml

@@ -1,29 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-# Note: Please Don't edit this file directly.
-# Edit https://github.com/benbalter/shared-community-files instead.
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 60
-
-# Number of days of inactivity before a stale Issue or Pull Request is closed
-daysUntilClose: 7
-
-# Issues or Pull Requests with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-
-# Label to use when marking as stale
-staleLabel: wontfix
-
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
-closeComment: false
-
-# Limit to only `issues` or `pulls`
-# only: issues

data/.gitignore

@@ -1,6 +0,0 @@
-*.gem
-.bundle
-tmp
-Gemfile.lock
-/almanak.overheid.nl
-spec/examples.txt

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,33 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - config/**/*
-    - vendor/**/*
-
-Style/Documentation:
-  Enabled: false
-
-Metrics/AbcSize:
-  Exclude:
-    - lib/gman/importer.rb
-
-Metrics/ClassLength:
-  Exclude:
-    - lib/gman/importer.rb
-    - test/**/*
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Exclude:
-    - lib/gman/identifier.rb