linksta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 258c58c07cfc7e86b2b7246c78bcf846b9536716
+  data.tar.gz: a3967cbe9b049c0de5ec97a0e29093d58ff74613
+SHA512:
+  metadata.gz: 583139f151dcd1d111a5fb459f9bf448d6c46951376889b1bbad1278035bc16e1d78465841b39ce0eb7511c8be52a9ead185cfcbc0c573a20ae7acabd4cf70e5
+  data.tar.gz: df11fa88a0b0f84636a364cf367ee3aa22a445f496715807265ab611aaaa488fca7a4b9717695e2485ce68a21a6dd4579b296b114c73599d79a514b78bc32701

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.xml
+
+*.iml
+
+.idea/.name

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at anthony.kaluuma@bbc.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in linksta.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    linksta (0.1.0)
+      thor
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.1.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    thor (0.20.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  linksta!
+  pry
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anthony Kalu Uma 
+
+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,91 @@
+# Linkey
+
+[![gem_version.png](https://img.shields.io/gem/v/linkey.svg)](https://rubygems.org/gems/linkey) [![gem_downloads.png](https://img.shields.io/gem/dt/linkey.svg)](https://rubygems.org/gems/linkey) [![travis.png](https://img.shields.io/travis/DaveBlooman/linkey/master.svg)](https://travis-ci.org/DaveBlooman/linkey) [![code_climate.png](https://img.shields.io/codeclimate/github/DaveBlooman/linkey.svg)](https://codeclimate.com/github/DaveBlooman/linkey)
+
+**Link checker for BBC Radio & Music 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.
+
+There are 4 parts to this tool, the URL, the base URL, the regex and the filename.  
+
+* **URL** is the page that you want to check for broken links, e.g `www.bbc.co.uk/radi04`
+* **Base URL** is used with the relative URL from the regex to create a full URL, e.g `www.bbc.co.uk`
+* **Regex** is the point of the URL that you want to keep from the regex, e.g `bbc.co.uk/radio/new`, specifying `/radio` would create `/radio/new`.  
+* **Filename** is markdown (.md) file where all the page links are stored, this can be useful for manual checks, e.g `file.md`
+
+## Installation
+
+    gem install linkey
+
+## Usage
+
+### Command Line
+
+```
+linkey check <url> <base_url> <regex> <filename>
+```
+
+**Examples**
+
+```
+linkey check http://www.bbc.co.uk/radio http://www.bbc.co.uk/radio radio.md
+```
+
+```
+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 `Status is 200 for <URL>` or `Status is NOT GOOD for <URL>`.
+
+### Script It
+
+```ruby
+require 'linkey'
+
+url = 'http://www.live.bbc.co.uk/radio'
+base = 'http://www.live.bbc.co.uk'
+reg = '/radio'
+filename = 'arabic.md'
+
+page = Linkey::SaveLinks.new(url, filename)
+status = Linkey::CheckResponse.new(url, base, reg, filename)
+
+page.capture_links
+status.check_links
+```
+
+### 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.  In some situations, we are deploying applications that we don't want public facing, so ensuring they 404 is essential.  There is a status code option to allow a specific status code to be set against a group of URL's, ensuring builds fail if the right code conditions are met.
+
+```
+linkey smoke test.yaml
+```
+
+Example YAML Config:
+
+```yaml
+base: 'http://www.bbc.co.uk'
+
+concurrency: 100
+
+headers:
+ -
+   X-content-override: 'https://example.com'
+
+status_code: 200
+
+paths:
+  - /radio
+  - /radio/new
+```
+
+Via a Ruby script:
+
+```ruby
+require 'linkey'
+
+tests = Linkey::Checker.new("path/to.yaml")
+tests.smoke
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "linksta"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/linksta

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+begin
+  require "linksta/cli"
+  Linksta::CLI.start
+rescue Interrupt
+  puts "\nQuitting..."
+  exit 1
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/linksta/cli.rb

@@ -0,0 +1,30 @@
+require "thor"
+require "linksta"
+
+class Linkey::CLI < Thor
+  include Thor::Actions
+
+  desc "scan", "Save some URL's"
+  def scan(url, filename)
+    html = Linkey::SaveLinks.new(url, filename)
+    html.capture_links
+  end
+
+  desc "status", "checks links for errors"
+  def status(url, base, reg, filename)
+    status = Linkey::CheckResponse.new(url, base, reg, filename)
+    status.check_links
+  end
+
+  desc "check URL Base_URL Regex File", "A full linksta job"
+  def check(url, base, reg, filename)
+    scan(url, filename)
+    status(url, base, reg, filename)
+  end
+
+  desc "smoke [path/to/file]", "A linksta job using predetermined URL's"
+  def smoke(file)
+    check = Linkey::Checker.new(file)
+    check.smoke
+  end
+end

data/lib/linksta/javascript/snap.js

@@ -0,0 +1,88 @@
+var system = require('system');
+var page = require('webpage').create();
+var fs = require('fs');
+
+var url = system.args[1];
+var lastRequestTimeout;
+var finalTimeout;
+var currentRequests = 0;
+
+// You can place custom headers here, example below.
+// page.customHeaders = {
+
+//      'X-Candy-OVERRIDE': 'https://api.live.bbc.co.uk/',
+//      'X-Country': 'cn'
+
+//  };
+
+// If you want to set a cookie, just add your details below in the following way.
+
+phantom.addCookie({
+    'name': 'ckns_policy',
+    'value': '111',
+    'domain': '.bbc.co.uk'
+});
+phantom.addCookie({
+    'name': 'locserv',
+    'value': '1#l1#i=6691484:n=Oxford+Circus:h=e@w1#i=8:p=London@d1#1=l:2=e:3=e:4=2@n1#r=40',
+    'domain': '.bbc.co.uk'
+});
+
+var checkLinks = function checkLinks () {
+    page.evaluate(function() {
+        var anchorsArray = Array.prototype.slice.call(document.querySelectorAll("a"));
+
+        anchorsArray.forEach(function(anchor) {
+            console.log(anchor.pathname);
+        });
+
+        window.callPhantom();
+    });
+};
+
+var debouncedCheckFinish = function debouncedCheckFinish () {
+    clearTimeout(lastRequestTimeout);
+    clearTimeout(finalTimeout);
+
+    if (currentRequests < 1) {
+        clearTimeout(finalTimeout);
+        lastRequestTimeout = setTimeout(function() {
+            // Page has finished loading all resources
+            // Do stuff here
+            checkLinks();
+        }, 1000);
+    }
+
+    finalTimeout = setTimeout(function() {
+        // Page is tired of waiting for resources to load
+        // Exit but do stuff anyway
+
+        checkLinks();
+    }, 9000);
+};
+
+page.onResourceRequested = function(req) {
+    currentRequests += 1;
+};
+
+page.onResourceReceived = function(res) {
+    if (res.stage === 'end') {
+        currentRequests -= 1;
+        debouncedCheckFinish();
+    }
+};
+
+page.onConsoleMessage = function(msg) {
+    console.log(msg);
+};
+
+page.onCallback = function() {
+    phantom.exit();
+};
+
+page.open(url, function(status) {
+    if (status === 'fail') {
+        console.error('Couldn\'t load url');
+        phantom.exit(1);
+    }
+});

data/lib/linksta/version.rb

@@ -0,0 +1,3 @@
+module Linksta
+  VERSION = "0.1.0"
+end

data/lib/linksta.rb

@@ -0,0 +1,158 @@
+require "linksta/version"
+require "yaml"
+require "typhoeus"
+
+module Linksta
+  autoload :CLI, "linksta/cli"
+
+  class CheckResponse
+    attr_accessor :url, :base, :reg, :file_name
+
+    def initialize(url, base, reg, file_name)
+      @url = url
+      @base = base
+      @reg = reg
+      @file_name = file_name
+    end
+
+    def check_links
+      links_list = File.read(file_name).split(",")
+      links(links_list)
+    end
+
+    def links(links)
+      links.each do |url_links|
+        scan(url_links)
+      end
+    end
+
+    def scan(page_links)
+      urls = page_links.scan(/^#{Regexp.quote(reg)}(?:|.+)?$/)
+      Getter.new(urls, base, 100, 200, {}).check
+    end
+  end
+
+  class SaveLinks
+    attr_accessor :url, :file_name
+
+    def initialize(url, file_name)
+      @url = url
+      @file_name = file_name
+    end
+
+    def js_file
+      File.expand_path("linksta/javascript/snap.js", File.dirname(__FILE__))
+    end
+
+    def capture_links
+      puts `phantomjs "#{js_file}" "#{url}" > "#{file_name}"`
+    end
+  end
+
+  class Checker
+    attr_accessor :config
+
+    def initialize(config)
+      @config = YAML.load(File.open("#{config}"))
+    end
+
+    def base
+      config["base"]
+    end
+
+    def concurrency
+      config["concurrency"] ? config["concurrency"] : 100
+    end
+
+    def status_code
+      config["status_code"] ? config["status_code"] : 200
+    end
+
+    def smoke
+      urls = config["paths"]
+      options = config["headers"]
+      headers = Hash[*options]
+      Getter.new(urls, base, concurrency, status_code, { :headers => headers }).check
+    end
+  end
+
+  class Getter
+    def initialize(paths, base, concurrency, status, headers)
+      @paths       = paths
+      @base        = base
+      @headers     = headers
+      @status      = status
+
+      @hydra = Typhoeus::Hydra.new(:max_concurrency => concurrency)
+    end
+
+    def check
+      puts "Checking..."
+
+      paths.each do |path|
+        begin
+          Typhoeus::Request.new(url(path), options).tap do |req|
+            req.on_complete { |r| parse_response(r, status) }
+            hydra.queue req
+          end
+        rescue URI::InvalidURIError
+          puts "Error with URL #{path}, please check config."
+        end
+      end
+
+      hydra.run
+      check_for_broken
+    end
+
+    private
+
+    attr_reader :base, :headers, :paths, :status, :concurrency, :hydra
+
+    def check_for_broken
+      puts "Checking"
+      if output.empty?
+        puts 'URL\'s are good, All Done!'
+        exit 0
+      else
+        puts "Buddy, you got a bad link"
+        puts output
+        exit 1
+      end
+    end
+
+    def make_request(url, status, status_code)
+      if status != status_code
+        puts "Status is NOT GOOD for #{url}, response is #{status}"
+        output << url
+      else
+        puts "Status is #{status} for #{url}"
+      end
+    end
+
+    def options
+      {
+          :followlocation => true,
+          :ssl_verifypeer => false,
+          :headers        => headers[:headers]
+      }
+    end
+
+    def output
+      @output ||= []
+    end
+
+    def parse_response(resp, status)
+      make_request(
+          resp.options[:effective_url],
+          resp.code,
+          status
+      )
+    rescue
+      puts "Unable to get status code"
+    end
+
+    def url(path)
+      "#{base}#{path}"
+    end
+  end
+end

data/linksta.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "linksta/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "linksta"
+  spec.version       = Linksta::VERSION
+  spec.authors       = ["CAP Testers"]
+  spec.email         = ["anthony.kaluuma@bbc.co.uk"]
+  spec.summary       = "linksta"
+  spec.description   = "linksta"
+  spec.homepage      = "https://www.test.bbc.co.uk/radio/play/live:radio1"
+  spec.license       = "Apache 2"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "typhoeus"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/linksta_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe Linksta do
+  it "has a version number" do
+    expect(Linksta::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "linksta"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: linksta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CAP Testers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: linksta
+email:
+- anthony.kaluuma@bbc.co.uk
+executables:
+- console
+- linksta
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/linksta
+- bin/setup
+- lib/linksta.rb
+- lib/linksta/cli.rb
+- lib/linksta/javascript/snap.js
+- lib/linksta/version.rb
+- linksta.gemspec
+- spec/linksta_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.test.bbc.co.uk/radio/play/live:radio1
+licenses:
+- Apache 2
+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.6.12
+signing_key: 
+specification_version: 4
+summary: linksta
+test_files: []