uri_format_validator 0.1.0

data/.travis.yml

@@ -0,0 +1,45 @@
+sudo: false
+dist: trusty
+language: ruby
+
+before_install:
+  - gem install bundler -v 1.15.4
+
+script:
+  - bundle exec rspec
+
+rvm:
+  - "2.4"
+  - "2.3"
+  - "2.2.2"
+  - "ruby-head"
+  - "rbx-3"
+  - "jruby"
+  - "jruby-head"
+
+gemfile:
+  - gemfiles/rails-5.1.gemfile
+
+matrix:
+  include:
+    - rvm: "2.4"
+      gemfile: gemfiles/rails-head.gemfile
+
+    - rvm: "2.4"
+      gemfile: gemfiles/rails-5.0.gemfile
+
+    - rvm: "2.4"
+      gemfile: gemfiles/rails-4.2.gemfile
+
+    # Test Rails 4.0–4.1 against Ruby 2.3
+    - rvm: "2.3"
+      gemfile: gemfiles/rails-4.1.gemfile
+
+    - rvm: "2.3"
+      gemfile: gemfiles/rails-4.0.gemfile
+
+  allow_failures:
+    - rvm: "ruby-head"
+    - rvm: "jruby-head"
+    - rvm: "jruby"
+    - gemfile: gemfiles/rails-head.gemfile

data/CHANGELOG.adoc

@@ -0,0 +1,9 @@
+== Not released yet
+
+== 1.0.0
+
+* Improve error message in English, add Polish translation
+* First useful version
+* Rails 4 & 5 compatibility
+* Basic options for constraining URI components
+* Basic validations for URL reachability

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 jeffrey.lau@ribose.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in uri_format_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ribose Inc.
+
+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.adoc

@@ -0,0 +1,138 @@
+= UriFormatValidator
+
+image:https://img.shields.io/gem/v/uri_format_validator.svg[
+	Gem Version, link="https://rubygems.org/gems/uri_format_validator"]
+image:https://img.shields.io/travis/riboseinc/uri_format_validator/master.svg[
+	Build Status, link="https://travis-ci.org/riboseinc/uri_format_validator"]
+image:https://img.shields.io/codeclimate/github/riboseinc/uri_format_validator.svg[
+	"Code Climate", link="https://codeclimate.com/github/riboseinc/uri_format_validator"]
+image:https://img.shields.io/codecov/c/github/riboseinc/uri_format_validator.svg[
+	"Test Coverage", link="https://codecov.io/gh/riboseinc/uri_format_validator"]
+
+== Introduction
+
+This gem provides URI field validator for Rails' Active Model.
+
+UriFormatValidator requires Active Model 4+.  It is tested against MRI 2.2.2+,
+JRuby, and Rubinius in their recent versions.
+
+== Getting started
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'uri_format_validator'
+----
+
+Then install by executing `bundle install`.  You may now define validations
+in your models, like that:
+
+[source,ruby]
+----
+class User < ActiveRecord::Base
+  validates :home_site_url, uri_format: true
+end
+----
+
+For your convenience, an old-fashioned validation helper is also provided:
+
+[source,ruby]
+----
+class User < ActiveRecord::Base
+  validates_uri_format_of :home_site_url
+end
+----
+
+== Validation options
+
+=== URI component constraints
+
+You can specify constraints on URI components: scheme, authority, path, query,
+and fragment.
+
+[source,ruby]
+----
+validates :home_site_url, uri_format: { scheme: /https?/ }
+validates :home_site_url, uri_format: { scheme: %w[ssh telnet] }
+
+validates :home_site_url, uri_format: { authority: /\.example\./ }
+validates :home_site_url, uri_format: { authority: %w[example.com example.test] }
+
+# require path component (`/` is not enough)
+validates :home_site_url, uri_format: { path: true }
+# disallow presence of path component
+validates :home_site_url, uri_format: { path: false }
+# match path against regular expression
+validates :home_site_url, uri_format: { path: /regexp/ }
+
+# require query component
+validates :home_site_url, uri_format: { query: true }
+# disallow presence of query component
+validates :home_site_url, uri_format: { query: false }
+
+# require fragment component
+validates :home_site_url, uri_format: { fragment: true }
+# disallow presence of fragment component
+validates :home_site_url, uri_format: { fragment: false }
+----
+
+When `scheme` option is unspecified, only http and https are allowed.
+
+=== Relative URIs
+
+By default, only absolute URIs are valid.  Specify `authority: false` option
+to allow relative and disallow absolute URLs:
+
+[source,ruby]
+----
+validates :home_site_url, uri_format: { authority: false }
+----
+
+=== Reachable URLs
+
+With `retrievable` options, you can ensure that URL indeed points to some
+resource.  A HTTP HEAD request will be performed to that URL, and it must result
+with 2xx status code.  Otherwise, given value is considered invalid.
+
+[source,ruby]
+----
+validates :home_site_url, uri_format: { retrievable: true }
+----
+
+=== Error messages
+
+You can also override the default error message:
+
+[source,ruby]
+----
+validates :my_url_attribute, uri_format: true, message: 'is not a valid URL'
+----
+
+Alternatively, you can provide your own localization string for
+`errors.messages.invalid_uri` key.
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run
+`bundle exec rake install`. To release a new version, update the version
+number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and
+push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/riboseinc/uri_format_validator. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the http://contributor-covenant.org[Contributor
+Covenant] code of conduct.
+
+== License
+
+The gem is available as open source under the terms of the
+http://opensource.org/licenses/MIT[MIT License].

data/ROADMAP.adoc

@@ -0,0 +1,151 @@
+= Roadmap
+
+== Basic options
+
+=== Examples
+
+[source,ruby]
+----
+  # default case
+  validates :my_url, url: true
+
+  # allow nil
+  validates :my_url, url: {allow_nil: true}
+
+  # allow blank
+  validates :my_url, url: {allow_blank: true}
+----
+
+== URL
+
+We'd like uri_format_validator to support
+https://tools.ietf.org/html/rfc3986#appendix-B[RFC 3986],
+with the option to impose a constraint on the URI scheme, e.g. to only `http` &
+`https`.
+
+Next step could introduce options to impose constraints on these as well:
+
+  authority = $4
+  path      = $5
+  query     = $7
+  fragment  = $9
+
+NOTE: _Copied from https://tools.ietf.org/html/rfc3986#appendix-B[RFC 3986]_
+
+=== Constraints
+
+Constraints for the above fields (`authority`, `path`, `query`, `fragment`)
+could be either presence or a match.
+
+=== Authority
+
+Within the `authority` portion, the following could be made optional,
+prohibited, etc.:
+
+* `username`
+* `password`
+* `port`
+
+==== Examples
+
+[source,ruby]
+----
+  # require absence of fragment
+  validates :my_url, url: {fragment: false}
+
+  # require presence of path
+  validates :my_url, url: {path: true}
+
+  # require authority format to match a regex
+  validates :my_url, url: {authority: %r{(?:.+\.)*example.com}}
+
+  # require absense of authority (?!)
+  validates :my_url, url: {authority: false}
+
+  # require presense of authority (?!)
+  validates :my_url, url: {authority: true}
+
+  # require authority to match against a specific array
+  validates :my_url, url: {authority: %w[https://google.co.uk https://google.com]}
+----
+
+=== Schemes
+
+To add an option to validate according to the list at:
+https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
+
+==== Examples
+
+[source,ruby]
+----
+  # match against the IANA list above
+  validates :my_url, url: {scheme: :all}
+
+  # match against a specific array
+
+  # todo
+  # replace with "in" and symbols
+  # validates :my_url, url: {scheme: {in: [:ftp, :http, :https]}}
+
+  validates :my_url, url: {scheme: %w[ftp http https]}
+
+  # match against a regex
+
+  # todo
+  # not needed; remove?
+  validates :my_url, url: {scheme: /myscheme[0-9]/}
+----
+
+== Rails
+
+To support Rails 4 and 5.
+
+== Reachability
+
+To add an option to test for the given URL to see if it's reachable, or if the
+domain is resolvable.
+
+=== Examples
+
+[source,ruby]
+----
+  # domain name resolvable
+  validates :my_url, url: {resolvable: true}
+
+  # host is reachable
+  validates :my_url, url: {reachable: true}
+
+  # full URL document returns 2xx HTTP status code
+  validates :my_url, url: {retrievable: true}
+----
+
+
+== Reserved
+
+* `.test`
+* `.example`
+* `.invalid`
+* `.localhost`
+
+http://www.faqs.org/rfcs/rfc2606.html
+
+=== Examples
+
+[source,ruby]
+----
+  # allow reserved authorities to be entered
+  # default behaviour
+  validates :my_url, url: {allow_reserved: true}
+
+  # disallow reserved authorities to be entered
+  validates :my_url, url: {allow_reserved: false}
+----
+
+== I18n
+
+To internationalize the error message strings to `de`, `en-UK`, `en-US`, `es`,
+`fr`, `ja`, `ko`, `nl`, `pt-BR`, `ru`, `zh-CN`, `zh-TW`, etc.
+
+== (DONE) Travis CI
+
+Add Travis CI badge to `README`.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uri_format_validator"
+
+# 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/rake

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

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/examples/basic.rb

@@ -0,0 +1,5 @@
+class MyModel
+  validates :favourite_website_url, uri_format: { resolvability: :retrievable }
+  validates :resume_cv_url, uri_format: { resolvability: :reachable }
+  validates :friend_website_url, uri_format: { scheme: %w[http https ftp] }
+end

data/gemfiles/common.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'codecov', require: false, group: :test
+gem 'rubocop', require: false
+gem 'simplecov', require: false, group: :test

data/gemfiles/rails-4.0.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', '~> 4.0.0'

data/gemfiles/rails-4.1.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', '~> 4.1.0'

data/gemfiles/rails-4.2.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', '~> 4.2.0'

data/gemfiles/rails-5.0.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', '~> 5.0.0'

data/gemfiles/rails-5.1.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', '~> 5.1.0'

data/gemfiles/rails-head.gemfile

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../common.gemfile', __FILE__))
+
+gem 'activemodel', github: 'rails/rails'

data/lib/uri_format_validator/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      invalid_uri: 'is not a valid URI'

data/lib/uri_format_validator/locale/pl.yml

@@ -0,0 +1,4 @@
+pl:
+  errors:
+    messages:
+      invalid_uri: 'nie jest poprawnym URI'

data/lib/uri_format_validator/localization.rb

@@ -0,0 +1,10 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "i18n"
+
+# :nodoc:
+module UriFormatValidator
+  files = Dir[File.join(File.dirname(__FILE__), "locale/*.yml")]
+  I18n.load_path.concat(files)
+end

data/lib/uri_format_validator/reacher.rb

@@ -0,0 +1,37 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "net/http"
+
+module UriFormatValidator
+  # Reacher is a minimalist net client which purpose is to determine whether
+  # given URL is resolvable, host is reachable, and content is retrievable.
+  class Reacher
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    # Tests whether given +url+ is retrievable, that is making a HEAD request
+    # results with 2xx status code.
+    def retrievable?
+      head_response.is_a?(Net::HTTPSuccess)
+    end
+
+    private
+
+    def head_response
+      Net::HTTP.start(url.hostname, url.port, use_ssl: use_ssl?) do |http|
+        http.request_head(url)
+      end
+    rescue
+      # FIXME The rescue-all clause should be replaced with sth specific
+      nil
+    end
+
+    def use_ssl?
+      url.scheme == "https"
+    end
+  end
+end

data/lib/uri_format_validator/validators/helper_methods.rb

@@ -0,0 +1,19 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "active_model"
+
+module UriFormatValidator
+  module Validators
+    module HelperMethods
+      # Encapsulates the pattern of wanting to validate an URL.
+      #
+      #   class Post < ActiveRecord::Base
+      #     validates_uri_format_of :permalink
+      #   end
+      def validates_uri_format_of(*attr_names)
+        validates_with UriFormatValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end