adomain 0.1.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f12152322fbc0b75e36dcfc4dcc05497cdd16e1f47082949f42ee2af9bebae12
-  data.tar.gz: 2f267c665cb5ec0084a9d4752e57763a95f169b34719b4a478622f39ba5c7ece
+  metadata.gz: 07e8678866573d16ab4fc9fe09ed4ac489ee494d7135cc66fd60ddf14141ae80
+  data.tar.gz: 94e364cc3d2fa19e59291ae1cc2b6483754817d2b8af39afd5881ad06d648ecc
 SHA512:
-  metadata.gz: c5ad2bed3658959228d70d592ebf9e6d34d3d14a3b928f945e1dfd916ea1f751a32a3c60fb342bff1e1a4385a9b034a97dd877a0e8ea5a3ecc2e6acf6e725d80
-  data.tar.gz: 5a8c239d1972737ecb21d6b15d7e64f4c806933d505f75d289aa42ccd3b34b65ea338d8995ecf65202ff70b9345f8c12be02d3880455f6fdf83857ebfff1169f
+  metadata.gz: afab2fa4bbaea7a7c4528d4bf5a92035cd92ba4739d4bc4a39e519f6ad549e8d17d4d8ac912c8a17460db8d50a9ab75b318ae2fb0299b022d808beb5f2c208f9
+  data.tar.gz: 5ee96ec92e589778e02969a22dff12ac98439024af534196daee14a37bf8a2a7580e2e590514436dc35848e92dd1e18d1c88665e2f90bb1ed7c1447651f58779

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adomain (0.1.1)
+    adomain (0.2.3)
       addressable (~> 2.5)
       logger
 
@@ -13,20 +13,20 @@ GEM
     diff-lcs (1.3)
     logger (1.4.1)
     public_suffix (4.0.1)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
 
 PLATFORMS
   ruby
@@ -34,8 +34,8 @@ PLATFORMS
 DEPENDENCIES
   adomain!
   bundler (~> 1.16)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -13,10 +13,12 @@ Adomain["https://www.xyz.com"]
 # => "xyz.com"
 ```
 
-Adomain returns the URL host, stripping 'www' by default, scheming your URL if necessary (with "https://").
-Optionally, you can strip subdomains or keep 'www' subdomains -- see below.
+Adomain returns the URL host, stripping 'www' by default,
+scheming your URL if necessary (with "https://").
+Optionally, you can strip subdomains or keep 'www' subdomains – see below.
 
-[`Addressable::URI.parse`](https://github.com/sporkmonger/addressable#example-usage) performs the parsing.
+[`Addressable::URI.parse`](https://github.com/sporkmonger/addressable#example-usage)
+performs the parsing.
 
 ## Other methods and options
 
@@ -41,36 +43,62 @@ Adomain.domain "http://abc.xyz.com" # => "xyz.com"
 Adomain.subdomain_www "http://www.xyz.com" # => "www.xyz.com"
 ```
 
+### Domain options
+
 Optionally, each method accepts boolean values,
 allowing you to contort the method to do something other
 than what it says it does. Don't do this, unless you want to.
 
-### A gotcha: Adomain returns nil for some invalid values
+#### A gotcha: Adomain returns nil for some invalid values
 
-Because Adomain adds a scheme to any string passed to it
-Addressable does not error out. So, Adomain returns nil
-when presented with otherwise-valid strings
-for which Addressable cannot find a domain.
+Because Adomain adds a scheme to any string passed to it,
+schemeless-but-otherwise valid strings do not raise errors.
+Additionally, Adomain rescues InvalidURIError errors,
+and instead returns nil.
 
 ```ruby
 Adomain["hola"]     # => nil
 Adomain["::::::::"] # => nil
-Adomain[""]         # => Addressable::URI::InvalidURIError
-Adomain["{}"]       # => Addressable::URI::InvalidURIError
-Gem::Version.new(Adomain::VERSION) >= Gem::Version.new(0.2) # => false
+Adomain[""]         # => nil
+Adomain["{}"]       # => nil
 ```
 
-#### WARNING: All InvalidURIError will be caught in >= version 0.2
+#### NOTE: InvalidURIError are now caught in >= version 0.2
 
-When 0.2 is released, `Addressable::URI::InvalidURIError`s will be caught
-and ignored. Nil will be returned.
+With 0.2 `Addressable::URI::InvalidURIError`s are now caught
+and ignored. Nil is returned.
 
 ```ruby
 Gem::Version.new(Adomain::VERSION) >= Gem::Version.new(0.2) # => true
 Adomain["hola"]     # => nil
 Adomain["::::::::"] # => nil
-Adomain[""]         # => nil
-Adomain["{}"]       # => nil
+Adomain[""]         # => nil (formerly raised a Addressable::URI::InvalidURIError)
+Adomain["{}"]       # => nil (formerly raised a Addressable::URI::InvalidURIError)
+```
+
+### Convenience Addressable passthroughs
+
+These methods are simply passed through to parsed
+Addressable URI objects, and respond accordingly.
+These are presented for your convenience, and will track with
+your version of Addressable.
+
+```ruby
+Adomain.path "http://www.xyz.com/pages/123" # => "/pages/123"
+Adomain.path "{{{{{" # => "{{{{{"
+Adomain.scheme "http://www.xyz.com/pages/123" # => "http"
+Adomain.scheme "harrison:ford" # => "harrison"
+Adomain.query_values "https://maximumfun.org/donate?amt=20USD" # => {"amt"=>"20USD"}
+Adomain.query_values "google.com?q=gagh.biz" # => {"q"=>"gagh.biz"}
+```
+
+However, they are rescued from InvalidURIError,
+like in other parts of the gem.
+
+```ruby
+Adomain.path "::::::::::::" #=> nil
+Adomain.scheme "::::::::::::" #=> nil
+Adomain.query_values "::::::::::::" #=> nil
 ```
 
 ## Installation
@@ -89,16 +117,23 @@ Or install it yourself as:
 
 ## Development
 
-File bugs against the GitHub issue tracker and pull requests to match, where possible.
+File bugs against the GitHub issue tracker and pull requests to match,
+where possible.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/samnissen/adomain. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/samnissen/adomain. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Adomain project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adomain/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Adomain project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/samnissen/adomain/blob/master/CODE_OF_CONDUCT.md).

data/adomain.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "addressable", "~> 2.5"

data/lib/adomain.rb

@@ -4,14 +4,6 @@ require "logger"
 
 class Adomain
   class << self
-
-    ADDRESSABLE_WARNING = %{
-      WARNING: breaking change planned:
-        Adomain will catch Addressable::URI::InvalidURIError.
-        This error will be caught in version 0.2.
-        Any code relying on the error will break.
-    }.gsub(/\s+/, ' ').strip
-
     # [] is a convenience method to subdomain the URL,
     # or optionally domain or subdomain_www.
     #   Adomain["http://abc.xyz.com"]               # => "abc.xyz.com"
@@ -49,6 +41,37 @@ class Adomain
       subdomain(string, true)
     end
 
+    # scheme is a wrapper around Addressable::URI's scheme
+    # it is only included for convenience
+    def scheme(string)
+      Addressable::URI.parse(string).scheme
+    rescue Addressable::URI::InvalidURIError => e
+      nil
+    end
+
+    # path is a wrapper around Addressable::URI's path
+    # with a major difference -- it removes the domain components
+    # from the string, if the domain is parseable. This is because
+    # Addressable leaves it in, for reasons I can't understand.
+    def path(string)
+      if self.subdomain_www(string)
+        substring = /\A#{Regexp.quote(self.subdomain_www(string))}/
+        Addressable::URI.parse(string).path.gsub(substring, '')
+      else
+        Addressable::URI.parse(string).path
+      end
+    rescue Addressable::URI::InvalidURIError => e
+      nil
+    end
+
+    # query_values is a wrapper around Addressable::URI's query_values
+    # it is only included for convenience
+    def query_values(string)
+      Addressable::URI.parse(string).query_values
+    rescue Addressable::URI::InvalidURIError => e
+      nil
+    end
+
     private
       # parse_for_domain accepts one hash of arguments that allow
       # changes to the parsing behavior of domains
@@ -85,9 +108,7 @@ class Adomain
 
         return domain
       rescue Addressable::URI::InvalidURIError => e
-        logger.warn ADDRESSABLE_WARNING
-
-        raise e
+        nil
       end
 
       def logger

data/lib/adomain/version.rb

@@ -1,3 +1,3 @@
 class Adomain
-  VERSION = "0.1.2"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adomain
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Sam Nissen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple, uncomplicated, schemed domain parsing using Addressable