adomain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 057dab1acf9fcec5da26e74a69faba47d194903868d4161865ae413d3cd3bec2
+  data.tar.gz: 7d79d23505f21e6d14efbc37405806e4226a96f572cf1265d052a53097935368
+SHA512:
+  metadata.gz: 2e18609978403dd5e74130fc5f3ab4215fbb4d0f3cdf4170a88fb60431a1d741466e57701e559e438a047d14af073e30e6254833e76a30e23c575d147ff8f15c
+  data.tar.gz: 69201c5cb5ba94e739785be68109e29ee47d11171db5bcacf9f1c9c31840778357731438fc4a8a79628ea304e3d002a6edf830108387a2f3c656ceda814216d1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Gem builds
+adomain-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at samuel.nissen@rakuten.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in adomain.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    adomain (0.1.0)
+      addressable (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adomain!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sam Nissen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Adomain
+
+Simplified domain parsing
+
+```ruby
+Adomain["abc.xyz.com/path&key=value"]
+# => "abc.xyz.com"
+
+Adomain["https://abc.xyz.com"]
+# => "abc.xyz.com"
+
+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.
+
+[`Addressable::URI.parse`](https://github.com/sporkmonger/addressable#example-usage) performs the parsing.
+
+## Other methods and options
+
+`[]` is an alias for `Adomain.subdomain()`
+
+```ruby
+Adomain["http://abc.xyz.com"] == Adomain.subdomain("http://abc.xyz.com")
+# => true
+```
+
+Adomain only has a few other public methods:
+
+### Stripping all subdomains
+
+```ruby
+Adomain.domain "http://abc.xyz.com" # => "xyz.com"
+```
+
+### Keeping all subdomains, including 'www'
+
+```ruby
+Adomain.subdomain_www "http://www.xyz.com" # => "www.xyz.com"
+```
+
+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
+
+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.
+
+```ruby
+Adomain["hola"]     # => nil
+Adomain["::::::::"] # => nil
+Adomain[""]         # => Addressable::URI::InvalidURIError
+Adomain["{}"]       # => Addressable::URI::InvalidURIError
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adomain'
+```
+
+Or install it yourself as:
+
+    $ gem install adomain
+
+
+
+## Development
+
+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.
+
+## License
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/adomain.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "adomain/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "adomain"
+  spec.version       = Adomain::VERSION
+  spec.authors       = ["Sam Nissen"]
+  spec.email         = ["samuel.nissen@rakuten.com"]
+
+  spec.summary       = %q{Simple, uncomplicated, schemed domain parsing using Addressable}
+  spec.homepage      = "https://github.com/samnissen/adomain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "addressable", "~> 2.5"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adomain"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adomain/version.rb

@@ -0,0 +1,3 @@
+class Adomain
+  VERSION = "0.1.0"
+end

data/lib/adomain.rb

@@ -0,0 +1,80 @@
+require "adomain/version"
+require "addressable/uri"
+
+class Adomain
+  class << self
+    # [] is a convenience method to subdomain the URL,
+    # or optionally domain or subdomain_www.
+    #   Adomain["http://abc.xyz.com"]               # => "abc.xyz.com"
+    #   Adomain["http://abc.xyz.com", true]         # => "xyz.com"
+    #   Adomain["http://www.xyz.com", false, true]  # => "www.xyz.com"
+    #   Adomain["http://abc.xyz.com", false, false] # => "abc.xyz.com"
+    def [](string, domain = false, www = false)
+      domain(string, domain, www)
+    end
+
+    # domain is the base method for only the domain from parse_for_domain
+    #   Adomain.domain "http://www.xyz.com" # => "xyz.com"
+    #   Adomain.domain "http://abc.xyz.com" # => "xyz.com"
+    #   Adomain.domain "http://xyz.com"     # => "xyz.com"
+    def domain(string, domain = true, www = false)
+      opts = { :keep_www => www, :strip_subdomain => domain }
+      parse_for_domain(string, opts)
+    end
+
+    # subdomain is a convenience method for the domain with
+    # any subdomain except "www" from parse_for_domain
+    #   Adomain.subdomain "http://www.xyz.com" # => "xyz.com"
+    #   Adomain.subdomain "http://abc.xyz.com" # => "abc.xyz.com"
+    #   Adomain.subdomain "http://xyz.com"     # => "xyz.com"
+    def subdomain(string, www = false)
+      domain(string, false, www)
+    end
+
+    # subdomain_www is a convenience method for the domain with
+    # any subdomain including "www" from parse_for_domain
+    #   Adomain.subdomain_www "http://www.xyz.com" # => "www.xyz.com"
+    #   Adomain.subdomain_www "http://abc.xyz.com" # => "abc.xyz.com"
+    #   Adomain.subdomain_www "http://xyz.com"     # => "xyz.com"
+    def subdomain_www(string)
+      subdomain(string, true)
+    end
+
+    private
+      # parse_for_domain accepts one hash of arguments that allow
+      # changes to the parsing behavior of domains
+      # opts defaults to
+      #   opts = {
+      #     :keep_www => false,
+      #     :strip_subdomain => false
+      #   }
+      # parse_for_domain returns the domain, whose exact details will
+      # depend on the opts hash, found in the string, or nil if the
+      # provided string does not contain a valid domain.
+      def parse_for_domain(string, opts = {})
+        # normalize the string for domain parsing
+        raw = string.strip
+
+        # Add a scheme to the string in case it has none,
+        # because it is required for parsing well with URI
+        copy   = "https://#{raw}" unless "#{raw}".match("://")
+        copy ||= raw
+
+        # Strip the top www subdomain unless user opted out.
+        copy   = copy.gsub(/:\/\/www\./i, "://") unless opts[:keep_www]
+
+        # Parse the string
+        uri = Addressable::URI.parse(copy)
+
+        # The string did not contain a parsable domain.
+        return nil if uri.domain.nil?
+
+        # choose between the domain without the subdomain,
+        # or the whole host, which contains the subdomain.
+        domain   = uri.domain if opts[:strip_subdomain]
+        domain ||= uri.host
+
+        return domain
+      end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: adomain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Nissen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: 
+email:
+- samuel.nissen@rakuten.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- adomain.gemspec
+- bin/console
+- bin/setup
+- lib/adomain.rb
+- lib/adomain/version.rb
+homepage: https://github.com/samnissen/adomain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Simple, uncomplicated, schemed domain parsing using Addressable
+test_files: []