http_url_validation_improved 1.1.1

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006 Cloves Carneiro Jr (and others, such as
+Katipo Communications, Ltd. and Erik Gregg)
+
+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

@@ -0,0 +1,40 @@
+HTTP URL Validation Plugin Improved
+by Erik Gregg, Walter McGinnis, Kieran Pilkington
+
+This work is based on Erik's work, but mainly refined for the Kete application (http://kete.net.nz).
+
+Inspired by HTTP URL Validation Plugin by C. Carneiro Jr.
+========================
+
+HTTP URL Validation Improved is a Rails gem that allows you to validate a URL 
+entered in a form. It validates if the URL exists by hitting it with a HEAD 
+request.
+
+The improved version includes retries for common patterns when the head request is refused before giving a failure notice.
+
+It also looks up a SITE_URL constant to the user agent in the headers.
+
+There's also the option to also check that the URL returns content of 
+a specified type. Here’s how you can use it your model:
+
+Check for content type:
+  validates_http_url :url, :content_type => "text/html"
+
+Do not check for content type, just make sure the site is accessible:
+  validates_http_url :website
+
+Make sure there is a DNS entry for a domain
+  validates_http_domain :domain		
+# Domain must be in 'www.site.com' for or 'site.com' form.  No http://, no path.
+
+This example will make sure the value entered for the URL field points to a 
+publicly accessible HTML page, and the photo field points to an image:
+  validates_http_url :image_url, :content_type => "image"
+# :content_type checks for a matching substring, so any image will validate
+
+========================
+
+Bug reports and feedback are always welcome. 
+
+Please report them via http://github.com/kete/http_url_validation_improved
+

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "http_url_validation_improved"
+    gem.summary = %Q{a Rails gem that allows you to validate a URL 
+entered in a form}
+    gem.description = %Q{a Rails gem that allows you to validate a URL 
+entered in a form. It validates if the URL exists by hitting it with a HEAD 
+request.
+
+The improved version includes retries for common patterns when the head request is refused before giving a failure notice.
+
+It also looks up a SITE_URL constant to the user agent in the headers.
+
+Also has the option to also check that the URL returns content of 
+a specified type.}
+    gem.email = "walter@katipo.co.nz"
+    gem.homepage = "http://github.com/kete/http_url_validation_improved"
+    gem.authors = ["Erik Gregg", "Walter McGinnis", "Kieran Pilkington"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "http_url_validation_improved #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/lib/http_url_validation_improved.rb

@@ -0,0 +1,138 @@
+require 'net/http'
+require 'uri'
+require 'socket'
+
+module ActiveRecord
+  module Validations
+    module ClassMethods
+
+      # Validates a URL.
+      def validates_http_url(*attr_names)
+        configuration = {
+          :message_not_accessible => "is not accessible when we tried the link",
+          :message_wrong_content => "is not of the appropriate content type",
+          :message_moved_permanently => "has moved permanently",
+          :message_url_format => "is not formatted correctly. (Missing 'http://'?)"
+        }
+        configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
+        validates_each(attr_names, configuration) do |record, attr_name, value|
+
+          # Ignore blank URLs, these can be validated with validates_presence_of
+          if value.nil? or value.empty?
+            next
+          end
+
+          begin
+            moved_retry ||= false
+            not_allowed_retry ||= false
+            retry_without_headers ||= false
+            # Check Formatting
+            raise if not value =~ /^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$/ix
+            response = nil
+            url = URI.parse(value)
+            url.path = "/" if url.path.length < 1
+            http = Net::HTTP.new(url.host, (url.scheme == 'https') ? 443 : 80)
+            if url.scheme == 'https'
+              http.use_ssl = true
+              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
+            headers = Object.const_defined?('SITE_URL') ? { "User-Agent" => "#{SITE_URL} link checking mechanism via Ruby Net/HTTP" } : { "User-Agent" => "Ruby Net/HTTp used for link checking mechanism" }
+            response = if not_allowed_retry
+                         if retry_without_headers
+                           http.request_get(url.path) {|r|}
+                         else
+                           http.request_get(url.path, headers) {|r|}
+                         end
+                       else
+                         http.request_head(url.path, headers)
+                       end
+            # response = not_allowed_retry ? http.request_get(url.path) {|r|} : http.request_head(url.path)
+            # Comment out as you need to
+            allowed_codes = [
+                             Net::HTTPMovedPermanently,
+                             Net::HTTPOK,
+                             Net::HTTPCreated,
+                             Net::HTTPAccepted,
+                             Net::HTTPNonAuthoritativeInformation,
+                             Net::HTTPPartialContent,
+                             Net::HTTPFound,
+                             Net::HTTPTemporaryRedirect,
+                             Net::HTTPSeeOther
+                            ]
+            # If response is not allowed, raise an error
+            raise unless allowed_codes.include?(response.class)
+            # Check if the model requires a specific content type
+            unless configuration[:content_type].nil?
+              record.errors.add(attr_name, configuration[:message_wrong_content]) if response['content-type'].index(configuration[:content_type]).nil?
+            end
+          rescue
+            # Has the page moved?
+            if response.is_a?(Net::HTTPMovedPermanently)
+              unless moved_retry
+                moved_retry = true
+                value += "/" # In case webserver is just adding a /
+                retry
+              else
+                record.errors.add(attr_name, configuration[:message_moved_permanently])
+              end
+            elsif response.is_a?(Net::HTTPMethodNotAllowed) || response.is_a?(Net::HTTPInternalServerError)
+              unless not_allowed_retry
+                # Retry with a GET
+                not_allowed_retry = true
+                retry
+              else
+                if response.is_a?(Net::HTTPInternalServerError)
+                  record.errors.add(attr_name, configuration[:message_not_accessible]+". The site link in question has had a problem. Please raise the issue with them and let them know that requests to the link break when coming from the automatic link checking mechanism on this site.")
+                else
+                  record.errors.add(attr_name, configuration[:message_not_accessible]+" (GET method not allowed)")
+                end
+              end
+            elsif response.is_a?(Net::HTTPForbidden)
+              # handle requests where particular variants are forbidden
+              unless (not_allowed_retry && retry_without_headers)
+                unless not_allowed_retry
+                  # try a full request GET first (rather than just head)
+                  not_allowed_retry = true
+                  retry
+                else
+                  # try again but without headers (sometimes site refuse custom headers)
+                  # for now, at least, this does a full GET request (rather than just head)
+                  retry_without_headers = true
+                  retry
+                end
+              else
+                record.errors.add(attr_name, configuration[:message_not_accessible] + ". The website says the URL is Forbidden.")
+              end
+            else
+              # if response is nil, then it's a format issue
+              if response.nil?
+                record.errors.add(attr_name, configuration[:message_url_format])
+              else
+                # Just Plain non-accessible
+                record.errors.add(attr_name, configuration[:message_not_accessible]+". This is what the website in question returned to us: "+response.class.to_s)
+              end
+            end
+          end
+        end
+      end
+
+      def validates_http_domain(*attr_names)
+        validates_each(attr_names) do |record, attr_name, value|
+          # Set valid true on successful connect (all we need is one, one is all we need)
+          failed = true
+          possibilities = [value, "www."+value]
+          possibilities.each do |url|
+            begin
+              temp = Socket.gethostbyname(url)
+            rescue SocketError
+              next
+            end
+            failed = false
+            break
+          end
+          record.errors.add(attr_name, "cannot be resolved.") if failed
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'http_url_validation_improved'

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'http_url_validation_improved'
+
+class Test::Unit::TestCase
+end

data/test/test_http_url_validation_improved.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHttpUrlValidationImproved < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: http_url_validation_improved
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 1
+  version: 1.1.1
+platform: ruby
+authors: 
+- Erik Gregg
+- Walter McGinnis
+- Kieran Pilkington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 +12:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: |-
+  a Rails gem that allows you to validate a URL 
+  entered in a form. It validates if the URL exists by hitting it with a HEAD 
+  request.
+  
+  The improved version includes retries for common patterns when the head request is refused before giving a failure notice.
+  
+  It also looks up a SITE_URL constant to the user agent in the headers.
+  
+  Also has the option to also check that the URL returns content of 
+  a specified type.
+email: walter@katipo.co.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/http_url_validation_improved.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_http_url_validation_improved.rb
+has_rdoc: true
+homepage: http://github.com/kete/http_url_validation_improved
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a Rails gem that allows you to validate a URL  entered in a form
+test_files: 
+- test/helper.rb
+- test/test_http_url_validation_improved.rb