alephant-scout 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 426febd1ef7d655e339a07a119386a521b5c58a3
-  data.tar.gz: ada16f35afc2d6b2e8f4e60636cd3637824a59a0
+  metadata.gz: 85b78e083608aaed93af7260ac8161a2b98fc790
+  data.tar.gz: f0ad36b38085673ef343c9de31dd3630258a7743
 SHA512:
-  metadata.gz: cbdcf4bcf6d8d18e58d985224425c0218359d79bda29ceee61c284b7beda5aff3e612f655f7ec8396fe9cb0dcfb1f02b3e1067917d662cf49130837835bbe52a
-  data.tar.gz: 72a91040e69b017d1c2c7169ef9e9f1abae2a9bdb42c70b374a1b74140a9368b606d24d5f2199fb7a0333e56f8ba89f5f9a8dc166eb3e2301c7239f43cc00331
+  metadata.gz: ef71e5fd065d54f3005f4ec9c1ce2e6713c736f6bb679d11052f7dbfc8066ade82855f6415f7c7ddae75e9ece7aab048ec9b8383cc2a7619e7445bbfab0d4815
+  data.tar.gz: 566c5d263ae1c292c4b24b7cdc4b7413945712c0c55888437a8a3da460c24222784ce7e746f04bee15a43aad895080c2089ffb55d4467e6437b0c39522e7e059

data/README.md

@@ -1,5 +1,7 @@
 # Alephant::Scout
 
+[![Gem Version](https://badge.fury.io/rb/alephant-scout.svg)](http://badge.fury.io/rb/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.
@@ -23,33 +25,17 @@ Or install it yourself as:
 ```rb
 require 'alephant-scout'
 
+Alephant::Scout::Url.valid? 'http://bbc.co.uk/persian/world'
 # => 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)
-
+Alephant::Scout::Url.valid? 'http://bbc.co.uk/batman'
 # => 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
+1. [Fork it!](https://github.com/bbc-news/alephant-scout/fork)
+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](https://github.com/bbc-news/alephant-scout/pulls).

data/Rakefile

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

data/alephant-scout.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.1"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "rake-rspec"
 
   spec.add_runtime_dependency "httparty", "~> 0.13.1"
   spec.add_runtime_dependency "alephant-logger"

data/lib/alephant/scout/url.rb

@@ -2,9 +2,9 @@ require "httparty"
 
 module Alephant
   module Scout
-    class Url
-      def valid?(url_to_scout)
-        HTTParty.head(url_to_scout).code == 200
+    module Url
+      def self.valid?(url)
+        HTTParty.head(url).code == 200
       rescue
         false
       end

data/lib/alephant/scout/version.rb

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

data/spec/integration/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../spec_helper'

data/spec/integration/url_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Alephant::Scout::Url do
+  describe '.valid?' do
+    context 'using a valid URL' do
+      let(:url) { 'http://bbc.co.uk/persian/world' }
+      specify { expect(described_class.valid? url).to be }
+    end
+
+    context 'using an invalid URL' do
+      let(:url) { 'http://bbc.co.uk/batman' }
+      specify { expect(described_class.valid? url).to be false}
+    end
+  end
+end

data/spec/url_spec.rb

@@ -1,30 +1,43 @@
 require 'spec_helper'
 
 describe Alephant::Scout::Url do
-  describe ".valid?(url)" do
+  describe '.valid?' 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
+
+    context 'using a valid URL' do
+      let(:url) { 'http://a-valid-url.com' }
+      before do
+        allow(HTTParty).to receive(:head).once.with(url).and_return(response)
+        allow(response).to receive(:code).once.and_return(200)
+      end
+      specify { expect(described_class.valid? url).to be }
     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
+    context 'using a valid URL with a server error' do
+      let(:url) { 'http://a-valid-url.com/error' }
+      before do
+        allow(HTTParty).to receive(:head).once.with(url).and_return(response)
+        allow(response).to receive(:code).once.and_return(500)
+      end
+      specify { expect(described_class.valid? url).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
+     context 'using a valid URL with a missing resource' do
+      let(:url) { 'http://a-valid-url.com/missing.gif' }
+      before do
+        allow(HTTParty).to receive(:head).once.with(url).and_return(response)
+        allow(response).to receive(:code).once.and_return(404)
+      end
+      specify { expect(described_class.valid? url).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
+     context 'using an invalid URL' do
+      let(:url) { 'http://an-invalid-url.com' }
+      before do
+        allow(HTTParty).to receive(:head).once.with(url).and_return(response)
+        allow(response).to receive(:code).once.and_return(500)
+      end
+      specify { expect(described_class.valid? url).to be false}
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-scout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - C. Oliver Godby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
         version: '0'
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: rake-rspec
+  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
@@ -97,6 +139,8 @@ files:
 - lib/alephant/scout.rb
 - lib/alephant/scout/url.rb
 - lib/alephant/scout/version.rb
+- spec/integration/spec_helper.rb
+- spec/integration/url_spec.rb
 - spec/spec_helper.rb
 - spec/url_spec.rb
 homepage: ''
@@ -124,5 +168,7 @@ signing_key:
 specification_version: 4
 summary: '"Scout URLs to see if they are valid"'
 test_files:
+- spec/integration/spec_helper.rb
+- spec/integration/url_spec.rb
 - spec/spec_helper.rb
 - spec/url_spec.rb