linkey 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 968870da0a318f9d9136453879f4711336f281c5
-  data.tar.gz: 6a65ad66c24f6277ad62a3508069a90e29d49170
+  metadata.gz: 5e96ab8c59be65fdcffbbfe438034e1be3b1a0cd
+  data.tar.gz: 1cbad9d0f4e0e5c52ff744a0dad9ddc9a0a6142f
 SHA512:
-  metadata.gz: 650ca4da7bbbd3814f97b8d4147f47fc17e1771dfab224a1a234b3f5ea56f63e1939039fce2a1b29f0fbe7846e579249f24e176149f23ee06084d2885b6c2622
-  data.tar.gz: 268556e7fc4227e2b06dbaef445c62ee23a93c9ed713fae38cad7ab5c45343d828492c7532b3ffc055fa24dd38e737e014bbb1580aa46b597569ed6dfd4e0a12
+  metadata.gz: 83963de13343fe98bd2325436d1fe57e8ad392199dea6023da4869e8abc43fc6f5576eb2bec4fb1f5e43fbaa8d2e4cdc3b261e79a2567be5639301eec04c2338
+  data.tar.gz: 661d450cd63434c01a64ad259fb327e6af67f0d2e60448af29f35a95692bfb483401df2d8093615af6ccdee6dbe2ca6be62aa4f629c4be6e49abce969962f270

data/README.md

@@ -4,20 +4,22 @@ Linkey
 
 Link checker for BBC News/WS Sites
 
-The idea is to quickly check a page for broken links by doing a status check on all the relative URL's on the page. 
+The idea is to quickly check a page for broken links by doing a status check on all the relative URL's on the page.
 
 There are 4 parts to this tool, the URL, the base URL, the regex and the filename.  
 
-The URL is the page that you want to check for broken links, e.g www.bbc.co.uk/news/uk-29928282   
+The URL is the page that you want to check for broken links, e.g www.bbc.co.uk/news/uk-29928282
 The Base URL is used with the relative URL from the regex to create a full URL, e.g www.bbc.co.uk  
 The regex is the point of the URL that you want to keep from the regex, e.g bbc.co.uk/news/uk, specifying /news would create /news/uk.  
 The filename is .md file where all the page links are stored, this can be useful for manual checks, e.g file.md
 
-Install 
+Install
 
 `gem install linkey`
 
-To use run 
+## Command line usage
+
+To use run
 
 ```
 linkey check URL BASEURL /regex Filename
@@ -29,16 +31,33 @@ linkey check http://www.live.bbc.co.uk/arabic http://www.live.bbc.co.uk /arabic
 ```
 Another
 
-```ruby
+```
 linkey check http://www.theguardian.com/technology/2014/feb/15/year-of-code-needs-reboot-teachers http://theguardian.com /technology news.md
 ```
 Output
 
-Once running, you'll see either a 200 with 
+Once running, you'll see either a 200 with
 `Status is 200 for URL`
-or 
+or
 `Status is NOT GOOD for URL`
 
+## From a file
+
+If you have a lot of URLs that you want to check all the time using from a file is an alternative option.  This will utilise the smoke option, then point to a YAML file with the extension.
+
+```
+linkey smoke test.yaml
+```
+
+Example yaml file
+```yaml
+base: 'http://www.bbc.co.uk'
+
+paths:
+  - /news
+  - /news/uk
+```
+
 Script it
 ```ruby
 

data/bin/linkey

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-require 'bundler/setup'
 
 begin
   require 'linkey/cli'

data/lib/linkey/checker.rb

@@ -0,0 +1,19 @@
+require 'linkey'
+require 'open-uri'
+require 'yaml'
+
+class Linkey::Checker < Linkey::CheckResponse
+
+  def initialize(config)
+    @smoke_urls = YAML::load(File.open("#{config}"))
+  end
+
+  def base
+    @smoke_urls['base']
+  end
+
+  def smoke
+    urls = @smoke_urls['paths']
+    status(urls)
+  end
+end

data/lib/linkey/cli.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'linkey/html'
 require 'linkey/ping'
+require 'linkey/checker'
 
 class Linkey::CLI < Thor
   include Thor::Actions
@@ -22,4 +23,10 @@ class Linkey::CLI < Thor
     scan(url, filename)
     status(url, base, reg, filename)
   end
+
+  desc "smoke [path/to/file]", "A linkey job using predetermined URL's"
+  def smoke(file)
+    check = Linkey::Checker.new(file)
+    check.smoke
+  end
 end

data/lib/linkey/version.rb

@@ -1,3 +1,3 @@
 module Linkey
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linkey
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dave Blooman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -40,6 +40,7 @@ files:
 - README.md
 - bin/linkey
 - lib/linkey.rb
+- lib/linkey/checker.rb
 - lib/linkey/cli.rb
 - lib/linkey/html.rb
 - lib/linkey/javascript/snap.js