validates-format-of-uri 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290@mirroring_house_validates_format_of_uri --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    validates-format-of-uri (0.0.1)
+      activemodel (~> 3.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    bcrypt-ruby (3.0.0)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  validates-format-of-uri!

data/LICENSE.md

@@ -0,0 +1,25 @@
+Copyright 2011 3Crowd Technologies, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY 3Crowd Technologies, Inc. ''AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 3Crowd Technologies, Inc. OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of 3Crowd Technologies, Inc..

data/README.md

@@ -0,0 +1,19 @@
+Validates format of URI
+=======================
+An ActiveModel field validator using the URI parsing library included with ruby
+to validate that a given field matches the format of a URI as given by RFC 2396.
+See URI#parse for more information.
+
+Installation
+------------
+Add the following to your Gemfile:
+  gem 'validates-format-of-uri', '~> 0.0.1', :require => 'mirroring_house/validations/validates_format_of_uri'
+
+Restrictions
+------------
+* Does not validate existance of domain
+* Does not validate that the domain is actually registered
+
+Credits
+-------
+Many thanks to the inspiration provided by https://gist.github.com/102138

data/Rakefile

@@ -0,0 +1,20 @@
+dir = File.dirname(__FILE__)
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob("#{dir}/test/cases/**/*_test.rb").sort
+  t.warning = true
+end
+
+task :default => [:clobber, :test, :package]
+
+require 'rake/packagetask'
+require 'rubygems/package_task'
+
+spec = eval(File.read("#{dir}/validates-format-of-uri.gemspec"))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end

data/lib/mirroring_house/validations/validates_format_of_uri.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'active_model'
+
+module MirroringHouse
+  module Validations
+
+    module ValidatesFormatOfURI
+      extend ActiveSupport::Concern
+
+      module InstanceMethods
+
+        class URIFormatValidator < ActiveModel::EachValidator
+
+          MESSAGES = { :scheme => :invalid_scheme, :host_blank => :host_cannot_be_blank, :general_error => :unable_to_parse }.freeze
+          SCHEMES = [ :http, :https ].freeze
+          ALLOW_BLANK_HOST = false.freeze
+
+          RESERVED_OPTIONS = []
+
+          def initialize(options)
+            raise ArgumentError, ":schemes must be an Array of Symbols describing allowed schemes" unless options[:schemes].nil? || (options[:schemes].is_a?(Array) && options[:schemes].all?{|a| a.is_a?(Symbol)})
+            options[:schemes] ||= SCHEMES
+            options[:allow_blank_host] ||= ALLOW_BLANK_HOST
+            super
+          end
+
+          def validate_each(record, attribute, value)
+
+            errors_options = options.except(*RESERVED_OPTIONS)
+
+            begin
+
+              uri = URI.parse(value)
+
+              record.errors.add(attribute, MESSAGES[:host_blank], errors_options) if uri.host.blank? && !options[:allow_blank_host]
+              record.errors.add(attribute, MESSAGES[:scheme_invalid], errors_options) unless options[:schemes].map{|scheme| scheme.to_s}.include?(uri.scheme)
+
+            rescue URI::InvalidURIError => e
+
+              record.errors.add(attribute, MESSAGES[:general_error], errors_options)
+
+            end
+          end
+          
+        end
+
+      end
+
+      module ClassMethods
+
+        # Validates that the specified attribute parses correctly as a URI, and matches the restrictions specified.
+        #
+        # class Person < ActiveRecord::Base
+        #   validates_format_of_uri :website
+        # end
+        #
+        # Configuration options:
+        # * <tt>:schemes</tt> - An Array of Symbols describing allowed URI schemes (e.g. [ :http, :https ], to allow https:// and http:// URIs)
+        #
+        def validates_format_of_uri(*attr_names)
+          validates_with InstanceMethods::URIFormatValidator, _merge_attributes(attr_names)
+        end
+      end
+
+    end
+
+  end
+end
+
+ActiveModel::Validations.send(:include, MirroringHouse::Validations::ValidatesFormatOfURI)

data/lib/mirroring_house/validations/validates_format_of_uri/version.rb

@@ -0,0 +1,22 @@
+require 'uri/http'
+
+module MirroringHouse
+  module Validations
+
+    module ValidatesFormatOfURI
+
+      module Version
+        MAJOR = '0'
+        MINOR = '0'
+        PATCH = '1'
+
+        def self.to_standard_version_s
+          [MAJOR, MINOR, PATCH].join('.')
+        end
+
+      end
+
+    end
+
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'mirroring_house/validations/validates_format_of_uri'

data/test/cases/helper.rb

@@ -0,0 +1,9 @@
+require 'config'
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_model'
+require 'mirroring_house/validations/validates_format_of_uri'
+
+require 'test/unit'

data/test/cases/validations/validates_format_of_uri_test.rb

@@ -0,0 +1,64 @@
+require 'cases/helper'
+
+require 'models/website'
+
+class URIFormatValidationTest < ActiveModel::TestCase
+
+  def teardown
+    Website.reset_callbacks(:validate)
+  end
+
+  def test_validation_of_uri_outside_of_given_scheme_set_fails_when_scheme_not_in_given_schemes
+    Website.validates_format_of_uri :uri, :schemes => [ :http ]
+    site = Website.new(:uri => "https://example.com")
+    assert site.invalid?, "https scheme was not invalid when only http was specified as the only valid scheme. Site validations: #{site.errors.inspect} "
+  end
+
+  def test_validation_of_uri_within_given_scheme_set_succeeds_when_scheme_in_given_schemes
+    Website.validates_format_of_uri :uri, :schemes => [ :http ]
+    site = Website.new(:uri => "http://example.com")
+    assert site.valid?, "http was not a valid scheme when http was specified as a valid scheme. Site validations: #{site.errors.inspect}"
+  end
+
+  def test_validation_of_uri_succeeds_when_scheme_is_in_default_scheme_set
+    uri = URI.parse("http://example.com")
+    Website.validates_format_of_uri :uri
+    site = Website.new(:uri => uri.to_s)
+    assert MirroringHouse::Validations::ValidatesFormatOfURI::InstanceMethods::URIFormatValidator::SCHEMES.include?(uri.scheme.to_sym), "Test URI scheme was not in validator default schemes"
+    assert site.valid?, "http was not validated as a default valid scheme. Site validations: #{site.errors.inspect}"
+  end
+
+  def test_validation_of_uri_fails_when_scheme_is_not_in_default_scheme_set
+    uri = URI.parse("telnet://example.com")
+    Website.validates_format_of_uri :uri
+    site = Website.new(:uri => uri.to_s)
+    refute MirroringHouse::Validations::ValidatesFormatOfURI::InstanceMethods::URIFormatValidator::SCHEMES.include?(uri.scheme.to_sym), "Test URI scheme was included in validator default schemes"
+    refute site.valid?, "telnet was not invalidated as a default invalid scheme. Site validations: #{site.errors.inspect}"
+  end
+
+  def test_validation_of_uri_fails_when_host_is_blank_if_allow_blank_host_is_not_set
+    uri = URI.parse("http:///")
+    Website.validates_format_of_uri :uri, :allow_blank_host => false
+    site = Website.new(:uri => uri.to_s)
+    assert MirroringHouse::Validations::ValidatesFormatOfURI::InstanceMethods::URIFormatValidator::SCHEMES.include?(uri.scheme.to_sym), "Test URI scheme was not in validator default schemes"
+    refute site.valid?, "blank host was not flagged as invalid"
+  end
+
+  def test_validation_of_uri_succeeds_when_host_is_blank_if_allow_blank_host_is_set
+    uri = URI.parse("http:///")
+    Website.validates_format_of_uri :uri, :allow_blank_host => true
+    site = Website.new(:uri => uri.to_s)
+    assert MirroringHouse::Validations::ValidatesFormatOfURI::InstanceMethods::URIFormatValidator::SCHEMES.include?(uri.scheme.to_sym), "Test URI scheme was not in validator default schemes"
+    assert site.valid?, "blank host was not accepted even though allow_blank_host option was true"
+  end
+
+  def test_validation_of_uri_fails_when_host_is_blank_if_allow_blank_host_is_unspecified
+    uri = URI.parse("http:///")
+    Website.validates_format_of_uri :uri
+    site = Website.new(:uri => uri.to_s)
+    assert MirroringHouse::Validations::ValidatesFormatOfURI::InstanceMethods::URIFormatValidator::SCHEMES.include?(uri.scheme.to_sym), "Test URI scheme was not in validator default schemes"
+    refute site.valid?, "blank host was not flagged as invalid"
+  end
+
+
+end

data/test/config.rb

@@ -0,0 +1,3 @@
+TEST_ROOT = File.expand_path(File.dirname(__FILE__))
+FIXTURES_ROOT = TEST_ROOT + '/fixtures'
+SCHEMA_FILE = TEST_ROOT + '/schema.rb'

data/test/models/website.rb

@@ -0,0 +1,12 @@
+class Website
+  include ActiveModel::Validations
+
+  attr_accessor :uri
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      send "#{key}=", value
+    end
+  end
+
+end

data/validates-format-of-uri.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('./lib/mirroring_house/validations/validates_format_of_uri/version.rb')
+
+Gem::Specification.new do |gem|
+
+  gem.name = 'validates-format-of-uri'
+  gem.version = MirroringHouse::Validations::ValidatesFormatOfURI::Version.to_standard_version_s
+
+  gem.authors = ["Justin Lynn", "3Crowd Technologies, Inc. (Sponsor)"]
+  gem.email = ["eng@3crowd.com"]
+
+  gem.summary = %q{An ActiveModel wrapper for URI#parse}
+  gem.description = %q{An ActiveModel validator utilizing the built in URI parse methods to provide a rich semantic API for URI validation}
+
+  gem.homepage = 'https://github.com/mirroring-house/validates_format_of_uri'
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename f }
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.files = `git ls-files`.split("\n")
+
+  gem.require_paths = ['lib']
+
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+
+  gem.add_dependency 'activemodel', '~> 3.1.0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: validates-format-of-uri
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Lynn
+- 3Crowd Technologies, Inc. (Sponsor)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &8091000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8091000
+description: An ActiveModel validator utilizing the built in URI parse methods to
+  provide a rich semantic API for URI validation
+email:
+- eng@3crowd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/mirroring_house/validations/validates_format_of_uri.rb
+- lib/mirroring_house/validations/validates_format_of_uri/version.rb
+- rails/init.rb
+- test/cases/helper.rb
+- test/cases/validations/validates_format_of_uri_test.rb
+- test/config.rb
+- test/models/website.rb
+- validates-format-of-uri.gemspec
+homepage: https://github.com/mirroring-house/validates_format_of_uri
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: An ActiveModel wrapper for URI#parse
+test_files: []