link_scout 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a5385d9f9549c8b8781318a881af58d531c4d3d
+  data.tar.gz: 14467356a96a98f2abd51a2cddaec3cfcc327e42
+SHA512:
+  metadata.gz: 98b5ceaaad56e63c6f3487b36221fe016fb5b0e0afda9ae73c548342eb7cd9788976f7b2dde664603ff7afbad03239e081060f370e6393e69b4dcf1ae58da271
+  data.tar.gz: 7c0a4c89890112826b999330ddd05a2ce168483e561607b57a92220c733bfff41a73c8423e41c45b2f4e650e2462edfe813f12c1596fa21d6eb9189b0a943570

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.4.1
+before_install: gem install bundler -v 1.16.1

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 mike.peuerboeck@savings-united.com. 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,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in link_scout.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry', '~> 0.11'
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    link_scout (0.0.1)
+      rack (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rack (2.0.4)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      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.1)
+    safe_yaml (1.0.4)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  link_scout!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mike Peuerböck
+
+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,73 @@
+# LinkScout
+
+Welcome to LinkScout gem!
+
+LinkScout helps users to find broken links by analysing response code or body.
+
+It can take single or multiple URLs as input making it easy to handle link checking in larger batches.
+It can also follow links through redirect chains making sure links eventually work for your users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'link_scout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install link_scout
+
+## Usage
+  ```ruby
+  options = {
+    success: 200,
+    follow: true,
+    limit: 1,
+    target: 'http://target.com',
+    deeplink_param: 'deeplink',
+    pattern: /abc/i,
+    antipattern: /cde/i,
+  }
+  ```
+  ### Single URLS
+  ```ruby
+    LinkScout::run(url, options)
+  ```
+
+  ```ruby
+    LinkScout::run(url: url, option: value)
+  ```
+
+  ### Multiple with shared options
+  ```ruby
+    LinkScout::run([url, url1, url2], options)
+  ```
+
+  ### Multiple with individual options
+  ```ruby
+    LinkScout::run([{ url: url }, { url: url1, option: value }])
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pcvg/link_scout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LinkScout project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pcvg/link_scout/blob/master/CODE_OF_CONDUCT.md).

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 "link_scout"
+
+# 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/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/link_scout.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+require 'uri'
+
+require "link_scout/runner"
+require "link_scout/version"
+require "link_scout/errors"
+
+module LinkScout
+  # takes URLs and options as input and returns a boolean when URL leads to a successful response (true) or not (false).
+  # If an array of URLs is provided LinkScout returns the result as an Array like [[url, boolean],[url, boolena]]
+  #
+  # Expects options with the following keys:
+  # - url | URL - The URL to be checked ( only needed when multiple URLS with different options should be checked)
+  # - success | String, Array - (Default: 200) - Array of HTTP Status Codes that are considered as successfull, eg. 200,202
+  # - follow | Boolean (Default: true) - Follow all redirects and return checks only if the last response is successfull or not
+  # - limit | Integer (Default: 10) - Max. number of redirects to follow
+  # - target | URL - If provided check if the final response ended at the target url
+  # - deeplink_param | String - a param in the url that is considered to be the deeplink, if deeplink_param is found deeplink option is set automatically
+  # - pattern | Regex - Return "success" if a given pattern can be found on the response.body, e.g. /^my-pattern/ig
+  # - antipattern | Regex - Return "fail" if a given pattern can be found on the response.body, e.g. /^my-anti-pattern/ig
+  def self.run(*args)
+    LinkScout::Runner.new(args).run
+  end
+end
+

data/lib/link_scout/errors.rb

@@ -0,0 +1,7 @@
+module LinkScout
+  # Raised whenever the given params dont match the expected input.
+  class InvalidUsageError < RuntimeError; end
+
+  # Raised on Redirect Loops
+  class RedirectLoopError < ArgumentError; end
+end

data/lib/link_scout/runner.rb

@@ -0,0 +1,193 @@
+module LinkScout
+  class Runner
+    DEFAULT_OPTIONS = {
+      success: 200,
+      limit: 10,
+      follow: true
+    }
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      case
+      when single?(@args)
+        @options = merge_defaults(@args[1])
+        @options[:url] = @args[0]
+        run_single
+      when single_hash?(@args)
+        @options = merge_defaults(@args[0])
+        run_single
+      when multiple_shared?(@args)
+        @options = merge_defaults(@args[1])
+        run_multiple_shared(@args[0])
+      when multiple_individual?(@args)
+        run_multiple(@args[0])
+      else
+        raise InvalidUsageError,  'Invalid usage of LinkScout::run. Please consult the README for help'
+      end
+    end
+
+    private
+
+    def merge_defaults(options)
+      return DEFAULT_OPTIONS unless options.is_a?(Hash)
+
+      DEFAULT_OPTIONS.merge(options)
+    end
+
+    # Fetches uri_str and tries limit times in case of redirections.
+    # @return response
+    def fetch(uri_str, limit=nil)
+      # set starting limit if limit is not set
+      limit ||= @options[:limit].to_i
+      retry_count ||= 2
+
+      # keeps track of previous url in case redirects are done
+      @final_uri ||= nil
+
+      raise RedirectLoopError, 'HTTP redirect too deep for ' + uri_str if limit == 0
+
+      #uri_str = response['location']
+      url = URI.parse(sanitize_uri(uri_str))
+      req = Net::HTTP::Get.new(url, user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181 Safari/537.36')
+      response = Net::HTTP.start(url.host, url.port, use_ssl: url.scheme == 'https', read_timeout: 30) { |http| http.request(req) }
+
+      @final_uri = uri_str
+
+      case response
+      when Net::HTTPRedirection
+        return response unless follow_redirects?
+        fetch(response['location'], limit - 1)
+      else
+        response
+      end
+
+    rescue Errno::ETIMEDOUT
+      [response, true]
+    rescue Net::ReadTimeout => e
+      retry_count -= 1
+      p "Net::ReadTimeout - retry #{retry_count} fetch url " + uri_str and retry if retry_count > 0
+
+      [response, true]
+    rescue NoMethodError => e
+      [response, true]
+    rescue SocketError
+      retry_count -= 1
+      p "SocketError - retry #{retry_count} fetch url " + uri_str and retry if retry_count > 0
+
+      [response, true]
+    rescue URI::InvalidURIError
+      [response, true]
+    end
+
+    def sanitize_uri(uri_str)
+      return scheme_and_domain(@final_uri) if ['/', '//'].include? uri_str
+      return scheme_and_domain(@final_uri) + uri_str if uri_str.start_with?('/')
+      return scheme_and_domain(@final_uri) + uri_str if uri_str.start_with?('?')
+
+      uri_str
+    end
+
+    def scheme_and_domain(uri_str)
+      uri = URI.parse(uri_str)
+      uri.path  = ''
+      uri.query = nil
+
+      # ensure that multiple relative redirects still know their domain
+      if uri.to_s == ''
+        return @last_scheme_and_domain
+      end
+
+      @last_scheme_and_domain = uri.to_s
+    end
+
+    def successfull_response?(response, invalid=false)
+      !invalid && \
+      status_code_success?(response) && \
+      pattern_success?(response, :pattern) && \
+      pattern_success?(response, :antipattern) && \
+      target_success? && \
+      deeplink_success?
+    end
+
+    def follow_redirects?
+      @options[:follow] == true
+    end
+
+    def status_code_success?(response)
+      [*@options[:success]].map(&:to_s).include?(response.code)
+    end
+
+    def target_success?
+      return true if @options[:target].nil?
+      @final_uri == @options[:target]
+    end
+
+    def deeplink_success?
+      return true if @options[:deeplink_param].nil?
+      uri = URI.parse(@options[:url])
+      params = Rack::Utils.parse_nested_query(uri.query)
+      @final_uri == params[@options[:deeplink_param]]
+    end
+
+    # checks response body against given pattern options:
+    # - in any case its a success if the pattern type is not set
+    # - in case of :pattern its a success if the content does match
+    # - in case of :antipattern its a success if the content does NOT match.
+    #
+    # @params response, type
+    # @return Bool
+    def pattern_success?(response, type)
+      return true if @options[type].nil?
+      success = @options[type].match?(response.body)
+
+      return !success if type == :antipattern
+      success
+    end
+
+    # Usage:
+    # LinkScout::run(url, options)
+    def single?(args)
+      args[0].is_a?(String)
+    end
+
+    # Usage:
+    # LinkScout::run(url: url)
+    def single_hash?(args)
+      args[0].is_a?(Hash) && !args[0][:url].nil?
+    end
+
+    # Usage:
+    # LinkScout::run([url: url, url: url1], options)
+    def multiple_individual?(args)
+      args[0].is_a?(Array) && args[0][0].is_a?(Hash)
+    end
+
+    # Usage:
+    # LinkScout::run([url, url1], options)
+    def multiple_shared?(args)
+      args[0].is_a?(Array) && args[0].first.is_a?(String)
+    end
+
+    def run_single
+      successfull_response?(*fetch(@options[:url]))
+    end
+
+    def run_multiple(sets)
+      sets.map do |set|
+        @options = merge_defaults(set)
+        [set[:url], run_single]
+      end
+    end
+
+    def run_multiple_shared(urls)
+      urls.map do |url|
+        @options[:url] = url
+
+        [url, run_single]
+      end
+    end
+  end
+end

data/lib/link_scout/version.rb

@@ -0,0 +1,3 @@
+module LinkScout
+  VERSION = "0.0.2"
+end

data/lib/tasks/link_scout_tasks.rake

@@ -0,0 +1,11 @@
+namespace :link_scout do
+  # Rake task to run LinkScout on a single URL
+  desc "Run LinkScout"
+  task :single do
+
+  end
+
+  # Rake task to run LinkScout on multiple URL's
+  task :multiple do
+  end
+end

data/link_scout.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "link_scout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "link_scout"
+  spec.version       = LinkScout::VERSION
+  spec.authors       = ["Mike Peuerböck", "Ain Tohvri"]
+  spec.email         = ["mike.peuerboeck@savings-united.com", "ain.tohvri@savings-united.com"]
+  spec.summary       = %q{LinkScout helps users to find broken links by analysing response code or body.}
+  spec.homepage      = "https://github.com/pcvg/link_scout"
+  spec.license       = "MIT"
+  spec.description = <<description
+    LinkScout helps users to find broken links by analysing response code or body.
+description
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: link_scout
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mike Peuerböck
+- Ain Tohvri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: "    LinkScout helps users to find broken links by analysing response
+  code or body.\n"
+email:
+- mike.peuerboeck@savings-united.com
+- ain.tohvri@savings-united.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/link_scout.rb
+- lib/link_scout/errors.rb
+- lib/link_scout/runner.rb
+- lib/link_scout/version.rb
+- lib/tasks/link_scout_tasks.rake
+- link_scout.gemspec
+homepage: https://github.com/pcvg/link_scout
+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.6.12
+signing_key: 
+specification_version: 4
+summary: LinkScout helps users to find broken links by analysing response code or
+  body.
+test_files: []