twingly-url 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de58b5c64bf51bf6e4028750a38ec9953cf7d278
-  data.tar.gz: 35419a813b7be1f5971b3949cabbd8ffe5d85a8e
+  metadata.gz: e450e3b0005ae549f7465be270f474d921f1c5bd
+  data.tar.gz: 897b0ff72f7d298edd7846068d6d3ae4a0197cec
 SHA512:
-  metadata.gz: 8588aa6fb7ec19a7959bb4f14c77ec503a5d333637e6de043e1256e202e78921c4cf47d11b4b1568589293d2d56b64e322bfeaf550b7117de74f57b98c542232
-  data.tar.gz: 892b16cdfea1ca8843867e84b2a8612fc68b50eebdd6db585ef42efc58be17df38138f880a734695655ae139f7861f2a9feff7b8500a907f979d7de51ec58da3
+  metadata.gz: 56efced017c87d78a72ef97cf2d98f89c5e2329b79d9ca55440d4564b5c24edd8a95d9f3ce3bf9ff65d23ca58990269fd02c7244abe12cd686b15da061e7ab9a
+  data.tar.gz: 0fc17c60dafbbd9278f5ad1aee81553c42bf76e1734eacd45e944e2700f3770e6a0a3056630efec5c8274ed61d3ccc5e5deec95f34d079c7048390eca64e1245

data/README.md

@@ -15,10 +15,47 @@ Twingly URL tools.
 * `twingly/url/utilities` - Utilities to work with URLs
     * `Twingly::URL::Utilities.extract_valid_urls` - Returns Array of valid `Twingly::URL`
 
-## Installation
+## Getting Started
+
+Install the gem:
 
     gem install twingly-url
 
+Usage (this output was created with [`examples/url.rb`][examples]):
+
+```ruby
+require "twingly/url"
+
+url = Twingly::URL.parse("http://www.twingly.co.uk/search")
+url.scheme              # => "http"
+url.trd                 # => "www"
+url.sld                 # => "twingly"
+url.tld                 # => "co.uk"
+url.ttld                # => "uk"
+url.domain              # => "twingly.co.uk"
+url.host                # => "www.twingly.co.uk"
+url.origin              # => "http://www.twingly.co.uk"
+url.path                # => "/search"
+url.without_scheme      # => "//www.twingly.co.uk/search"
+url.valid?              # => "true"
+
+url = Twingly::URL.parse("https://admin:correcthorsebatterystaple@example.com/")
+url.scheme              # => "https"
+url.trd                 # => ""
+url.sld                 # => "example"
+url.tld                 # => "com"
+url.ttld                # => "com"
+url.domain              # => "example.com"
+url.host                # => "example.com"
+url.origin              # => "https://example.com"
+url.path                # => "/"
+url.without_scheme      # => "//admin:correcthorsebatterystaple@example.com/"
+url.userinfo            # => "admin:correcthorsebatterystaple"
+url.user                # => "admin"
+url.password            # => "correcthorsebatterystaple"
+url.valid?              # => "true"
+```
+
 ### Dependencies
 
 The gem requires libidn.
@@ -42,6 +79,10 @@ Note that this isn't a benchmark, we're using [ruby-prof] which will slow things
 
 ## Release workflow
 
+* Update the [examples] in this README if needed, generate the output with
+
+        ruby examples/url.rb
+
 * Bump the version in `lib/twingly/version.rb` in a commit, no need to push (the release task does that).
 
 * Make sure you are logged in as [twingly][twingly-rubygems] at RubyGems.org.
@@ -52,3 +93,4 @@ Note that this isn't a benchmark, we're using [ruby-prof] which will slow things
 
 [twingly-rubygems]: https://rubygems.org/profiles/twingly
 [ruby-prof]: http://ruby-prof.rubyforge.org/
+[examples]: examples/url.rb

data/lib/twingly/url.rb

@@ -100,6 +100,14 @@ module Twingly
       public_suffix_domain.tld
     end
 
+    # Many ccTLDs have a second level[1] underneath their ccTLD, use this when
+    # you don't care about the second level.
+    #
+    # [1]: https://en.wikipedia.org/wiki/Second-level_domain
+    def ttld
+      tld.split(".").last
+    end
+
     def domain
       public_suffix_domain.domain
     end

data/lib/twingly/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   class URL
-    VERSION = "4.1.0"
+    VERSION = "4.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-url
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Twingly URL tools
 email:
 - support@twingly.com