uri_format_validator 0.1.0

data/lib/uri_format_validator/validators/uri_format_validator.rb

@@ -0,0 +1,166 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "active_model"
+require "uri"
+require "active_support/core_ext"
+require "net/http"
+require "resolv"
+
+module UriFormatValidator
+  module Validators
+    #
+    # TODO: documentation
+    #
+    class UriFormatValidator < ::ActiveModel::EachValidator
+      SCHEMES = %w[
+        aaa aaas about acap acct cap cid coap coaps crid data dav dict dns
+        example file ftp geo go gopher h323 http https iax icap im imap info ipp
+        ipps iris iris.beep iris.lwz iris.xpc iris.xpcs jabber ldap mailto mid
+        msrp msrps mtqp mupdate news nfs ni nih nntp opaquelocktoken pkcs11 pop
+        pres reload rtsp rtsps rtspu service session shttp sieve sip sips sms
+        snmp soap.beep soap.beeps stun stuns tag tel telnet tftp thismessage tip
+        tn3270 turn turns tv urn vemmi vnc ws wss xcon xcon-userid xmlrpc.beep
+        xmlrpc.beeps xmpp z39.50r z39.50s
+      ].freeze
+
+      # Examples: http://www.rubular.com/r/Xy4iNY2ztf
+      RESERVED_DOMAINS = %r{
+        (\.(test|example|invalid|localhost)$)|
+        ((^|\.)example\.(...?)(\...)?$)
+      }x
+
+      def initialize(options)
+        @schemes =
+          case options[:scheme]
+          when :all then SCHEMES
+          when nil then %w[http https]
+          else options[:scheme]
+          end
+
+        options[:message] ||= I18n.t("errors.messages.invalid_uri")
+        super(options)
+      end
+
+      def validate_each(record, attribute, value)
+        success = catch(STOP_VALIDATION) do
+          do_checks(value.to_s)
+          true
+        end
+        success || set_failure_message(record, attribute)
+      end
+
+      private
+
+      STOP_VALIDATION = Object.new.freeze
+
+      def do_checks(uri_string)
+        uri = string_to_uri(uri_string)
+        fail_unless uri
+
+        if accept_relative_uris?
+          validate_domain_absense(uri)
+        else
+          validate_domain(uri_string)
+          validate_against_options(uri, :authority, :scheme, :retrievable)
+        end
+
+        validate_against_options(uri, :path, :query, :fragment)
+      end
+
+      # Warning!  The +URI+ method behaviour is inconsistent across VMs.
+      # For instance, Rubinius allows leading and trailing spaces.  Non-nil
+      # return value doesn't guarantee that URI is indeed well-formed.
+      def string_to_uri(uri_string)
+        URI(uri_string)
+      rescue URI::InvalidURIError
+        nil
+      end
+
+      def set_failure_message(record, attribute)
+        record.errors[attribute] << options[:message]
+      end
+
+      def fail_if(condition)
+        throw STOP_VALIDATION if condition
+      end
+
+      def fail_unless(condition)
+        fail_if !condition
+      end
+
+      def validate_domain(uri)
+        fail_unless uri =~ regexp
+      end
+
+      def validate_against_options(uri, *option_keys_list)
+        option_keys_list.each do |option_name|
+          next unless options.key?(option_name)
+          send(:"validate_#{option_name}", options[option_name], uri)
+        end
+      end
+
+      def validate_scheme(_option, uri)
+        scheme = uri.scheme
+        if @schemes.is_a?(Regexp)
+          fail_if scheme !~ @schemes
+        else
+          fail_unless @schemes.include?(scheme)
+        end
+      end
+
+      def validate_path(option, uri)
+        path = uri.path
+        fail_if option == true  && path == "/" || path == ""
+        fail_if option == false && path != "/" && path != ""
+        fail_if option.is_a?(Regexp) && path !~ option
+      end
+
+      def validate_query(option, uri)
+        fail_unless uri.query.present? == option
+      end
+
+      def validate_fragment(option, uri)
+        fail_unless uri.fragment.present? == option
+      end
+
+      def validate_authority(option, uri)
+        fail_if option.is_a?(Regexp) && uri.host !~ option
+        fail_if option.is_a?(Array) && !option.include?(uri.host)
+
+        if option.is_a?(Hash) && option[:allow_reserved] == false
+          check_reserved_domains(uri)
+        end
+      end
+
+      def validate_retrievable(option, uri)
+        fail_unless Reacher.new(uri).retrievable? if option
+      end
+
+      def accept_relative_uris?
+        options.key?(:authority) && options[:authority] == false
+      end
+
+      def validate_domain_absense(uri)
+        fail_if uri.host.present?
+      end
+
+      def check_reserved_domains(uri)
+        fail_if uri.host =~ RESERVED_DOMAINS
+      end
+
+      def regexp
+        protocol =
+          if @schemes.is_a?(Regexp)
+            "(#{@schemes.source})://"
+          else
+            "(#{@schemes.join('|')})://"
+          end
+
+        %r{^#{
+          protocol
+        }[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$}iux
+      end
+    end
+  end
+end

data/lib/uri_format_validator/validators.rb

@@ -0,0 +1,16 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "uri_format_validator/validators/uri_format_validator"
+require "uri_format_validator/validators/helper_methods"
+
+module UriFormatValidator
+  module Validators
+    extend ActiveSupport::Concern
+
+    included do
+      extend  HelperMethods
+      include HelperMethods
+    end
+  end
+end

data/lib/uri_format_validator/version.rb

@@ -0,0 +1,6 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+module UriFormatValidator
+  VERSION = "0.1.0".freeze
+end

data/lib/uri_format_validator.rb

@@ -0,0 +1,14 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "uri_format_validator/version"
+require "uri_format_validator/localization"
+require "uri_format_validator/reacher"
+require "uri_format_validator/validators"
+
+# This is a placeholder...
+module UriFormatValidator
+  # Your code goes here...
+end
+
+ActiveModel::Validations.include UriFormatValidator::Validators

data/uri_format_validator.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "uri_format_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "uri_format_validator"
+  spec.version       = UriFormatValidator::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Library for validating urls in Rails"
+  spec.description   = "Library for validating urls in Rails"
+  spec.homepage      = "https://github.com/riboseinc/uri_format_validator"
+  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.required_ruby_version = ">= 2.2.2"
+
+  spec.add_runtime_dependency "activemodel", ">= 4.0.0", "< 6"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: uri_format_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: Library for validating urls in Rails
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.adoc
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- ROADMAP.adoc
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- examples/basic.rb
+- gemfiles/common.gemfile
+- gemfiles/rails-4.0.gemfile
+- gemfiles/rails-4.1.gemfile
+- gemfiles/rails-4.2.gemfile
+- gemfiles/rails-5.0.gemfile
+- gemfiles/rails-5.1.gemfile
+- gemfiles/rails-head.gemfile
+- lib/uri_format_validator.rb
+- lib/uri_format_validator/locale/en.yml
+- lib/uri_format_validator/locale/pl.yml
+- lib/uri_format_validator/localization.rb
+- lib/uri_format_validator/reacher.rb
+- lib/uri_format_validator/validators.rb
+- lib/uri_format_validator/validators/helper_methods.rb
+- lib/uri_format_validator/validators/uri_format_validator.rb
+- lib/uri_format_validator/version.rb
+- uri_format_validator.gemspec
+homepage: https://github.com/riboseinc/uri_format_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Library for validating urls in Rails
+test_files: []