naughty_or_nice 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d85f51a7bb462630a5fa8145a88ebff5e51aed7
-  data.tar.gz: 67c413c0373ed0dd8516c33f07c0852dca6e79a6
+  metadata.gz: 99393247edb23d92e4d1ddebb5a3a62b71c8179c
+  data.tar.gz: afc4922b88c3789f860fc95a8fcf26037d83bd7b
 SHA512:
-  metadata.gz: d8a2b4b6a128bc0cbd5194281552941e17948f9db74e42081c26729b1d56d05cf61d1a3f55bc5de348868755e711361241df4f83d66634419522795ed9fa377d
-  data.tar.gz: a19f454d60ca1406921622c01ce20b45cb292f567530e320a8317b1a6f66c1d64015e09380b2f3e30a52477bff14a28d3bf3894028fd24ae1a5f5c9e09f2f6dc
+  metadata.gz: e9c88f8fc3407466c321177f0a6074b797aba84dcb5be52f1b78e5a124e7ed51b21560ea03333e9a58cedd0f5bf2a79e7b8b55a9382d916cee854d171a7bb15e
+  data.tar.gz: 3f9cde45e96febf46407d91efa40c3e3484c01f337c781bc11f6720ee5482cefa041a4c5cbb6c22f184ba01a168b333b2cd0bc604fab5a8233c5aacdb0df3f12

data/README.md

@@ -8,14 +8,16 @@ Naughty or Nice simplifies the process of extracting domain information from a d
 
 Naughty or Nice doesn't do too much on its own. Out of the box, it can extract a domain from a domain-like string, and can verify that it is, in fact, a valid domain. It does this by leveraging the power of [Addressable](https://github.com/sporkmonger/addressable), the [Public Suffix List](http://publicsuffix.org/), and the associated [Ruby Gem](https://github.com/weppos/publicsuffix-ruby).
 
-The true power of Naughty or Nice comes when you extended it into a child class.
+The true power of Naughty or Nice comes when you include it into your own class.
 
-## Extending Naughty or Nice
+## Implementing Naughty or Nice
 
 Let's say you have a list of three domains, `foo.com`, `bar.com`, and `foobar.com`. You'd spec out a class like so:
 
 ```ruby
-class Checker < NaughtyOrNice
+class Checker
+
+  include NaughtyOrNice
   DOMAINS = %w[foo.com bar.com foobar.com]
 
   def valid?
@@ -26,9 +28,9 @@ end
 
 That's it! Just overwrite the `valid?` method and Naughty or Nice takes care of the rest.
 
-## Using the extended class
+## Using the included methods
 
-There are a handful of magic methods that your child class automatically gets. You can throw any domain-like string at your new `Checker` class, and figure out if it's on the list. Here's a few examples:
+There are a handful of magic methods that your class automatically gets. You can throw any domain-like string at your new `Checker` class, and figure out if it's on the list. Here's a few examples:
 
 ```ruby
 Checker.valid? "foo.com" #=> true

data/lib/naughty_or_nice/version.rb

@@ -0,0 +1,3 @@
+module NaughtyOrNice
+  VERSION = "1.0.0"
+end

data/lib/naughty_or_nice.rb

@@ -1,13 +1,8 @@
 require 'public_suffix'
 require "addressable/uri"
+require_relative './naughty_or_nice/version'
 
-class NaughtyOrNice
-
-  class << self
-    def valid?(text)
-      self.new(text).valid?
-    end
-  end
+module NaughtyOrNice
 
   # Source: http://bit.ly/1n2X9iv
   EMAIL_REGEX = %r{
@@ -48,8 +43,24 @@ class NaughtyOrNice
         $
       }xi
 
-  def initialize(text)
-    @text = text.to_s.downcase.strip
+  module ClassMethods
+    def valid?(text)
+      self.new(text).valid?
+    end
+  end
+
+  # Ruby idiom that allows `include` to create class methods
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def initialize(domain)
+    if domain.is_a?(PublicSuffix::Domain)
+      @domain_parts = domain
+      @text = domain.to_s
+    else
+      @text = domain.to_s.downcase.strip
+    end
   end
 
   # Parse the domain from the input string
@@ -83,7 +94,7 @@ class NaughtyOrNice
   #
   # Returns boolean true if a valid domain, otherwise false
   def valid?
-    PublicSuffix.valid?(domain)
+    !!(domain_parts && domain_parts.valid?)
   end
 
   # Is the input text in the form of a valid email address?
@@ -99,9 +110,11 @@ class NaughtyOrNice
   #
   # Returns the domain object or nil, but no errors, never an error
   def domain_parts
-    PublicSuffix.parse domain
-  rescue PublicSuffix::DomainInvalid
-    nil
+    @domain_parts ||= begin
+      PublicSuffix.parse domain
+    rescue PublicSuffix::DomainInvalid, PublicSuffix::DomainNotAllowed
+      nil
+    end
   end
 
   def inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naughty_or_nice
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
@@ -92,6 +92,7 @@ files:
 - README.md
 - Rakefile
 - lib/naughty_or_nice.rb
+- lib/naughty_or_nice/version.rb
 homepage: http://github.com/benbalter/naughty_or_nice
 licenses:
 - MIT