alephant-scout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 426febd1ef7d655e339a07a119386a521b5c58a3
+  data.tar.gz: ada16f35afc2d6b2e8f4e60636cd3637824a59a0
+SHA512:
+  metadata.gz: cbdcf4bcf6d8d18e58d985224425c0218359d79bda29ceee61c284b7beda5aff3e612f655f7ec8396fe9cb0dcfb1f02b3e1067917d662cf49130837835bbe52a
+  data.tar.gz: 72a91040e69b017d1c2c7169ef9e9f1abae2a9bdb42c70b374a1b74140a9368b606d24d5f2199fb7a0333e56f8ba89f5f9a8dc166eb3e2301c7239f43cc00331

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.8

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alephant-scout.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Oliver Godby
+
+MIT License
+
+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,55 @@
+# Alephant::Scout
+
+This is a gem to allow Alephant based applications to check the validity of an arbitrary URL / URI
+before enqueuing messages to render content based on the content of said URL / URI, thereby protecting
+render nodes from having to handle bogus URLs / URIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alephant-scout'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alephant-scout
+
+## Usage
+
+```rb
+require 'alephant-scout'
+
+# => true
+
+good_url = 'http://www.bbc.co.uk/persian/world'
+
+# => "http://www.bbc.co.uk/persian/world"
+
+bad_url = 'http://www.bbc.co.uk/persian/lobster-hatstand'
+
+# => "http://www.bbc.co.uk/persian/lobster-hatstand"
+
+url_scout = Alephant::Scout::Url.new()
+
+# = > #<Alephant::Scout::Url:[ObjectId]>
+
+url_scout.valid?(good_url)
+
+# => true
+
+url_scout.valid?(bad_url)
+
+# => false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/scout'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alephant-scout.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alephant/scout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alephant-scout"
+  spec.version       = Alephant::Scout::VERSION
+  spec.authors       = ["C. Oliver Godby"]
+  spec.email         = ["oliver.godby02@bbc.co.uk"]
+  spec.description   = %q{"Scout URLs to see if they are valid"}
+  spec.summary       = %q{"Scout URLs to see if they are valid"}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "httparty", "~> 0.13.1"
+  spec.add_runtime_dependency "alephant-logger"
+  spec.add_runtime_dependency "alephant-support"
+end

data/lib/alephant/scout/url.rb

@@ -0,0 +1,13 @@
+require "httparty"
+
+module Alephant
+  module Scout
+    class Url
+      def valid?(url_to_scout)
+        HTTParty.head(url_to_scout).code == 200
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/alephant/scout/version.rb

@@ -0,0 +1,5 @@
+module Alephant
+  module Scout
+    VERSION = "0.0.1"
+  end
+end

data/lib/alephant/scout.rb

@@ -0,0 +1,2 @@
+require "alephant/scout/version"
+require "alephant/scout/url"

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__),"..", "lib")
+
+require 'alephant/scout'

data/spec/url_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Alephant::Scout::Url do
+  describe ".valid?(url)" do
+    let(:response) { double('HTTParty::Response') }
+    it "is a valid url" do
+      allow(response).to receive(:code).and_return(200)
+      allow(HTTParty).to receive(:head).and_return(response)
+      expect(subject.valid?('http://www.avalidurl.com')).to be true
+    end
+
+    it "is a valid url with an issue" do
+      allow(response).to receive(:code).and_return(500)
+      allow(HTTParty).to receive(:head).and_return(response)
+      expect(subject.valid?('http://www.notavalidurl.com')).to be false
+    end
+
+    it "is an invalid URL - i.e. host is resolved but resource does not exist" do
+      allow(response).to receive(:code).and_return(404)
+      allow(HTTParty).to receive(:head).and_return(response)
+      expect(subject.valid?('http://www.avalidurl.com/but/a/nonexistent/resource')).to be false
+    end
+
+    it "is an invalid host - i.e. no DNS resolution" do
+      allow(response).to receive(:code).and_return(500)
+      allow(HTTParty).to receive(:head).and_raise("Hostname not found")
+      expect(subject.valid?('test://www.notavalidurl.test')).to be false
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: alephant-scout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- C. Oliver Godby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: httparty
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-logger
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-support
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+description: '"Scout URLs to see if they are valid"'
+email:
+- oliver.godby02@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alephant-scout.gemspec
+- lib/alephant/scout.rb
+- lib/alephant/scout/url.rb
+- lib/alephant/scout/version.rb
+- spec/spec_helper.rb
+- spec/url_spec.rb
+homepage: ''
+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.1.9
+signing_key:
+specification_version: 4
+summary: '"Scout URLs to see if they are valid"'
+test_files:
+- spec/spec_helper.rb
+- spec/url_spec.rb