seo_report 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e43cca8581863cf2f96787c1bc7d5540e1cbbb65
+  data.tar.gz: 48da9cc13c59920b22fbfecfc64196dd1d2b1eea
+SHA512:
+  metadata.gz: b02574fbbcd9c1b22986f466e500a2b4147d7e2efdb79536f4f6ad3975e42717a9ca5c8400ec9e7080e630ee3c983c7783c215c42cbd60eeb86df94ae39fff54
+  data.tar.gz: 922908e117fd759c82e6a12a6fc035a5672f4672b324a0d9527d099bb79815d588feb32b427b2e1355a286cf0452b77be763ae4b0cff9625e0b42041c8c256e7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Reddehase
+
+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 @@
+# SeoReport
+
+seo_report is a gem that provide a binary/executable called `seo-report`. With
+this you can get a report of seo-relevant data for pretty much any URL.
+It focuses on these aspects of seo-relevance:
+
+* redirects, especially redirect-chains
+* canonical URLs
+* robots meta tags
+* title and description
+* social media data
+  * twitter-cards (twitter)
+  * open-graph (facebook)
+* microdata (schema.org), *currently only in json output*
+  
+## planned functionality
+
+* add support for structured data
+  * read in rdfa-formatted structured data
+  * (support json-ld? (embedded and linked?))
+
+## installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seo_report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seo_report
+
+## usage
+
+* `seo-report URL`
+  will provide you with a human-readable report on the command-line.
+* `seo-report --json URL`
+  will provide you with json output, that is parseable by other means (like for
+  example [jq](https://stedolan.github.io/jq/)). Be aware that the json
+  format is currently not set in stone. It is most likely to change until
+  at least version *0.2.0* is reached.
+
+## 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/0robustus1/seo_report. If you have any ideas regarding a
+bigger feature change/addition i would recommend creating an issue before
+setting down an implementing the code for a PR. This increases the chance of it
+being merged, as it allows us to have a discussion beforehand.
+
+## license
+
+The gem is available as open source under the terms of the
+[LGPL 3.0 License](http://choosealicense.com/licenses/lgpl-3.0/). A copy of the
+license is part of this repository in the *LICENSE* file.
+

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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seo_report"
+
+# 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

data/bin/setup

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

data/exe/seo-report

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "seo_report"
+require "getoptlong"
+
+options = GetoptLong.new(
+  ["--json", GetoptLong::NO_ARGUMENT],
+  ["--help", "-h", GetoptLong::NO_ARGUMENT])
+
+opts = {}
+options.each { |opt, val| opts[opt] = val }
+
+url = ARGV[0]
+if url.nil? || url.empty?
+  abort("Please provide a url to seo-report.\nUsage: seo-report URL")
+else
+  if opts["--json"]
+    SeoReport::Representation::Json.represent_with_report_for(url)
+  else
+    SeoReport::Representation::Cli.represent_with_report_for(url)
+  end
+end

data/lib/seo_report/extractions/head.rb

@@ -0,0 +1,17 @@
+module SeoReport
+  module Extractions
+    module Head
+      def extract_head(doc)
+        title = doc.xpath('//head/title').text
+        description = doc.xpath('//head/meta[@name="description"]').
+                      map { |node| node.attr("content") }
+        {
+          title: title,
+          description: unarray(description),
+        }
+      end
+    end
+
+    SeoReport::Report.register_extraction(:html, Head, :extract_head)
+  end
+end

data/lib/seo_report/extractions/microdata.rb

@@ -0,0 +1,112 @@
+module SeoReport::Extractions
+  module Microdata
+    def extract_microdata(document)
+      MicrodataExtractor.new(document).extract!
+    end
+
+    class MicrodataExtractor
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+      end
+
+      def extract!
+        document.at_xpath('/html/body').children.each do |child|
+          process(child)
+        end
+        {microdata: result_set}
+      end
+
+      protected
+      def process(child, level = 1)
+        if microdata_element?(child)
+          process_microdata(child, level)
+        else
+          child.children.each { |c| process(c, level) }
+        end
+      end
+
+      def process_microdata(child, level)
+        if microdata_scope?(child)
+          push_scope(child)
+          child.children.each { |c| process(c, level + 1) }
+          scope = wrap_scope!
+          store_as_dangling_if_necessary!(child, scope, level)
+          result_set << scope if level == 1
+        else
+          provide_data_for_itemprop(child)
+          child.children.each { |c| process(c, level) }
+        end
+      end
+
+      def store_as_dangling_if_necessary!(element, scope, level)
+        itemprop = element["itemprop"]
+        is_top_level = level == 1
+        is_assigned_with_itemprop = !itemprop.nil? && !itemprop.empty?
+        if !is_top_level && !is_assigned_with_itemprop
+          (current_scope[:@dangling_children] ||= []) << scope
+        end
+      end
+
+      def provide_data_for_itemprop(element)
+        data =
+          if element.name == "meta"
+            element["content"]
+          elsif %w(audio embed iframe img source track video).include?(element.name)
+            element["src"]
+          elsif %w(a area link).include?(element.name)
+            element["href"]
+          elsif element.name == "object"
+            element["data"]
+          elsif %w(data meter).include?(element.name)
+            element["value"]
+          else
+            element.text
+          end
+        current_scope[element["itemprop"]] = data
+      end
+
+      def push_scope(element)
+        new_scope = {
+          type: element["itemtype"]
+        }
+        if microdata_prop?(element)
+          current_scope[element["itemprop"]] = new_scope
+        end
+        scopes.push(new_scope)
+      end
+
+      def wrap_scope!
+        scopes.pop
+      end
+
+      def current_scope
+        scopes.last
+      end
+
+      def scopes
+        @scopes ||= []
+      end
+
+      def result_set
+        @result_set ||= []
+      end
+
+      def microdata_element?(element)
+        %w(itemscope itemtype itemprop).
+          any? { |attr| element.has_attribute?(attr) }
+      end
+
+      def microdata_scope?(element)
+        element.has_attribute?("itemscope")
+      end
+
+      def microdata_prop?(element)
+        element.has_attribute?("itemprop")
+      end
+    end
+
+    SeoReport::Report.register_extraction(:html, Microdata, :extract_microdata)
+  end
+end

data/lib/seo_report/extractions/opengraph.rb

@@ -0,0 +1,32 @@
+module SeoReport
+  module Extractions
+    module Opengraph
+      def extract_og(doc)
+        type = doc.xpath('//head/meta[@property="og:type"]').
+               map { |node| node.attr("content") }
+        title = doc.xpath('//head/meta[@property="og:title"]').
+                map { |node| node.attr("content") }
+        description = doc.xpath('//head/meta[@property="og:description"]').
+                      map { |node| node.attr("content") }
+        site_name = doc.xpath('//head/meta[@property="og:site_name"]').
+                    map { |node| node.attr("content") }
+        image = doc.xpath('//head/meta[@property="og:image"]').
+                map { |node| node.attr("content") }
+        url = doc.xpath('//head/meta[@property="og:url"]').
+              map { |node| node.attr("content") }
+        {
+          og: {
+            type: unarray(type),
+            title: unarray(title),
+            description: unarray(description),
+            site_name: unarray(site_name),
+            image: unarray(image),
+            url: unarray(url),
+          }
+        }
+      end
+    end
+
+    SeoReport::Report.register_extraction(:html, Opengraph, :extract_og)
+  end
+end

data/lib/seo_report/extractions/seo.rb

@@ -0,0 +1,19 @@
+module SeoReport
+  module Extractions
+    module Seo
+      def extract_robots(doc)
+        robots_tags = doc.xpath('//head/meta[@name="robots"]').
+                      map { |node| node.attr("content") }
+        {robots: robots_tags}
+      end
+
+      def extract_canonical(doc)
+        canonical = doc.xpath('//head/link[@rel="canonical"]').
+                    map { |node| node.attr("href") }
+        {canonical: unarray(canonical)}
+      end
+    end
+
+    SeoReport::Report.register_extraction(:html, Seo, :extract_robots, :extract_canonical)
+  end
+end

data/lib/seo_report/extractions/twitter.rb

@@ -0,0 +1,26 @@
+module SeoReport
+  module Extractions
+    module Twitter
+      def extract_twitter(doc)
+        card = doc.xpath('//head/meta[@name="twitter:card"]').
+               map { |node| node.attr("content") }
+        domain = doc.xpath('//head/meta[@name="twitter:domain"]').
+                 map { |node| node.attr("content") }
+        title = doc.xpath('//head/meta[@name="twitter:title"]').
+                map { |node| node.attr("content") }
+        description = doc.xpath('//head/meta[@name="twitter:description"]').
+                      map { |node| node.attr("content") }
+        {
+          twitter: {
+            card: unarray(card),
+            domain: unarray(domain),
+            title: unarray(title),
+            description: unarray(description),
+          }
+        }
+      end
+    end
+
+    SeoReport::Report.register_extraction(:html, Twitter, :extract_twitter)
+  end
+end

data/lib/seo_report/extractions.rb

@@ -0,0 +1,10 @@
+module SeoReport
+  module Extractions
+  end
+end
+
+require "seo_report/extractions/head"
+require "seo_report/extractions/seo"
+require "seo_report/extractions/twitter"
+require "seo_report/extractions/opengraph"
+require "seo_report/extractions/microdata"

data/lib/seo_report/report.rb

@@ -0,0 +1,70 @@
+require "nokogiri"
+
+module SeoReport
+  class Report
+    attr_reader :start_url, :data
+
+    def self.register_extraction(type, module_name, *method_names)
+      include module_name
+      extractions_for_type = extractions[type] ||= []
+      method_names.each { |m| extractions_for_type << m }
+    end
+
+    def self.extractions
+      @extractions ||= Hash.new([])
+    end
+
+    def initialize(start_url)
+      @start_url = start_url
+    end
+
+    def produce
+      @data = generate_report
+    end
+
+    protected
+    def generate_report
+      chain = RequestChain.new(start_url)
+      chain.perform
+      {
+        requests: chain.request_chain.map do |request|
+          {
+            request_url: request.url.to_s,
+            response_code: request.response.code.to_i
+          }.merge(generate_html_report(request))
+        end
+      }
+    end
+
+    def generate_html_report(request)
+      if request.response.is_a?(Net::HTTPOK)
+        doc = Nokogiri::HTML(request.response.body)
+        content_through_extractions({}, doc, type: :html)
+      elsif request.response.is_a?(Net::HTTPRedirection)
+        {
+          location: request.response["Location"],
+        }
+      else
+        {}
+      end
+    end
+
+    def content_through_extractions(base, document, type: :html)
+      self.class.extractions[type].reduce(base) do |current, method_name|
+        current.merge(send(method_name, document))
+      end
+    end
+
+    def unarray(array)
+      if array.respond_to?(:length) && array.respond_to?(:first)
+        if array.length <= 1
+          array.first
+        else
+          array
+        end
+      else
+        array
+      end
+    end
+  end
+end

data/lib/seo_report/representation/base.rb

@@ -0,0 +1,28 @@
+require "forwardable"
+
+module SeoReport::Representation
+  class Base
+    extend Forwardable
+
+    attr_reader :report
+    def_delegators :report, :data
+
+    def self.represent_with_report_for(url)
+      report = SeoReport::Report.new(url)
+      report.produce
+      new(report).represent
+    end
+
+    def initialize(report)
+      @report = report
+    end
+
+    def represent
+      raise NotImplementedError.new("#represent needs to be implemented by a subclass.")
+    end
+
+    def any_data_in_hash?(hash)
+      (hash || {}).select { |_, val| !val.nil? }.any?
+    end
+  end
+end

data/lib/seo_report/representation/cli.rb

@@ -0,0 +1,147 @@
+module SeoReport::Representation
+  class Cli < Base
+    def represent
+      url = data[:requests].first[:request_url]
+      puts "#{white_color('URL: ')}#{url}"
+      separator
+      data[:requests].each do |request|
+        provide_response_data(request)
+      end
+    end
+
+    protected
+    def provide_response_data(request)
+      code = request[:response_code]
+      if code == 200
+        provide_html_response(request)
+      elsif code >= 300 && code < 400
+        provide_redirection_response(request)
+      end
+    end
+
+    def provide_html_response(request)
+      code = request[:response_code]
+      separator if multiple_requests?
+      puts "#{white_color('Status: ')}#{color_for_code(code)}"
+      canonical =
+        if request[:canonical] == request[:request_url]
+          green_color(request[:canonical], bold: true)
+        else
+          red_color(request[:canonical], bold: true)
+        end
+      puts "#{white_color('Canonical: ')}#{canonical}"
+      puts "#{white_color('Title: ')}#{request[:title]}"
+      puts "#{white_color('Description: ')}#{request[:description]}"
+      provide_robots_response(request)
+      provide_twitter_response(request)
+      provide_opengraph_response(request)
+    end
+
+    def provide_redirection_response(request)
+      code = request[:response_code]
+      location =
+        if request[:location] == request[:request_url]
+          red_color(request[:location], bold: true)
+        else
+          request[:location]
+        end
+      if data[:requests].length > 1
+        puts "#{white_color('redirect')} with #{blue_color(code, bold: true)} to #{white_color(location)}"
+      else
+        puts "#{white_color('Status: ')}#{color_for_code(code)}"
+        puts "#{white_color('Location: ')}#{location}"
+      end
+    end
+
+    def provide_robots_response(request)
+      literal_tags = request[:robots].dup
+      tags = literal_tags.map(&:downcase)
+      puts "#{white_color('Robots: ')}"
+      no_robots_tag = tags.find { |t| t.match(/.*no(?:index|follow).*/) }
+      if !tags.include?("all") && no_robots_tag
+        literal_tags.delete_at(tags.find_index(no_robots_tag))
+        puts "  - #{red_color(no_robots_tag, bold: true)}"
+      elsif !tags.include?("all") && !tags.any? { |t| t.match(/index|follow/) }
+        puts "  - index, follow (#{white_color('default')})"
+      end
+      literal_tags.each do |robot_tag|
+        puts "  - #{robot_tag}"
+      end
+    end
+
+    def provide_twitter_response(request)
+      twitter = request[:twitter]
+      if any_data_in_hash?(twitter)
+        puts "#{white_color('Twitter-Card: ')}"
+        puts "  #{white_color('Card: ')}#{twitter[:card]}"
+        puts "  #{white_color('Domain: ')}#{twitter[:domain]}"
+        puts "  #{white_color('Title: ')}#{twitter[:title]}"
+        puts "  #{white_color('Description: ')}#{twitter[:description]}"
+      else
+        puts "#{white_color('Twitter-Card:')} no matching data present in response"
+      end
+    end
+
+    def provide_opengraph_response(request)
+      opengraph = request[:og]
+      if any_data_in_hash?(opengraph)
+        puts "#{white_color('OpenGraph (Facebook): ')}"
+        puts "  #{white_color('type: ')}#{opengraph[:type]}"
+        puts "  #{white_color('site_name: ')}#{opengraph[:site_name]}"
+        puts "  #{white_color('Title: ')}#{opengraph[:title]}"
+        puts "  #{white_color('Description: ')}#{opengraph[:description]}"
+        puts "  #{white_color('URL: ')}#{opengraph[:url]}"
+        puts "  #{white_color('image: ')}#{opengraph[:image]}"
+      else
+        puts "#{white_color('OpenGraph (Facebook):')} no matching data present in response"
+      end
+    end
+
+    def multiple_requests?
+      data[:requests].length > 1
+    end
+
+    def separator
+      puts "#{white_color('----------------------------------------')}"
+    end
+
+    def white(text, io = $stdout)
+      io.print(white_color(text))
+    end
+
+    def white_color(text, bold: true)
+      color_with_code(text, code: 37, bold: bold)
+    end
+
+    def green_color(text, bold: false)
+      color_with_code(text, code: 32, bold: bold)
+    end
+
+    def red_color(text, bold: false)
+      color_with_code(text, code: 31, bold: bold)
+    end
+
+    def blue_color(text, bold: false)
+      color_with_code(text, code: 34, bold: bold)
+    end
+
+    def color_with_code(text, code:, bold: false)
+      bold_val = bold ? 1 : 0
+      "\033[#{bold_val};#{code}m#{text}\033[0m"
+    end
+
+    def color_for_code(code)
+      if code == 200
+        green_color(code, bold: true)
+      elsif code > 200 && code < 300
+        white_color(code, bold: false)
+      elsif code >= 300 && code < 400
+        blue_color(code, bold: true)
+      elsif code >= 400 && code < 500
+        red_color(code, bold: false)
+      else
+        red_color(code, bold: true)
+      end
+    end
+  end
+end

data/lib/seo_report/representation/json.rb

@@ -0,0 +1,9 @@
+require "json"
+
+module SeoReport::Representation
+  class Json < Base
+    def represent
+      puts JSON(data)
+    end
+  end
+end

data/lib/seo_report/representation.rb

@@ -0,0 +1,8 @@
+module SeoReport
+  module Representation
+  end
+end
+
+require "seo_report/representation/base"
+require "seo_report/representation/cli"
+require "seo_report/representation/json"

data/lib/seo_report/request.rb

@@ -0,0 +1,39 @@
+require "net/http"
+require "net/https"
+
+module SeoReport
+  class Request
+    class Error < ::StandardError; end
+    class NoRequestPerformedYetError < Error; end
+
+    attr_reader :url, :headers
+
+    def initialize(url, headers = {})
+      @url = URI(url)
+      @headers = headers
+    end
+
+    def perform
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = url.is_a?(URI::HTTPS)
+      @response = http.request(http_request)
+    end
+
+    def request
+      if @response
+        http_request
+      else
+        raise NoRequestPerformedYetError.new(url)
+      end
+    end
+
+    def response
+      @response or raise NoRequestPerformedYetError.new(url)
+    end
+
+    protected
+    def http_request
+      @http_request ||= Net::HTTP::Get.new(url.request_uri, headers)
+    end
+  end
+end

data/lib/seo_report/request_chain.rb

@@ -0,0 +1,34 @@
+module SeoReport
+  class RequestChain
+    attr_reader :initial_request
+    attr_reader :request_chain, :terminal_request
+
+    def initialize(initial_url, headers = {})
+      @initial_request = Request.new(initial_url, headers)
+      @request_chain = [@initial_request]
+    end
+
+    def perform
+      loop do
+        last_request.perform
+        if has_redirection_response?(last_request)
+          break if request_chain.length >= 10
+          request_chain << Request.new(last_request.response["Location"])
+        else
+          @terminal_request = request_chain.last
+          break
+        end
+      end
+    end
+
+    protected
+    def last_request
+      request_chain.last
+    end
+
+    def has_redirection_response?(request)
+      code = request.response.code.to_i
+      code >= 300 && code < 400
+    end
+  end
+end

data/lib/seo_report/version.rb

@@ -0,0 +1,3 @@
+module SeoReport
+  VERSION = "0.1.1"
+end

data/lib/seo_report.rb

@@ -0,0 +1,10 @@
+require "seo_report/version"
+
+module SeoReport
+end
+
+require "seo_report/request"
+require "seo_report/request_chain"
+require "seo_report/report"
+require "seo_report/extractions"
+require "seo_report/representation"

data/seo_report.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seo_report"
+  spec.version       = SeoReport::VERSION
+  spec.authors       = ["Tim Reddehase"]
+  spec.email         = ["robustus@rightsrestricted.com"]
+
+  spec.summary       = %q{report seo relevant data for a given url}
+  spec.description   = %q{Get a report with seo relevant data for a given URL, like redirects, canonical, robots, Soc. Med. data and so on.}
+  spec.homepage      = "https://github.com/0robustus1/seo_report"
+  spec.license       = "LGPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6.8"
+  spec.add_dependency "json", "~> 2.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: seo_report
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tim Reddehase
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  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'
+description: Get a report with seo relevant data for a given URL, like redirects,
+  canonical, robots, Soc. Med. data and so on.
+email:
+- robustus@rightsrestricted.com
+executables:
+- seo-report
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/seo-report
+- lib/seo_report.rb
+- lib/seo_report/extractions.rb
+- lib/seo_report/extractions/head.rb
+- lib/seo_report/extractions/microdata.rb
+- lib/seo_report/extractions/opengraph.rb
+- lib/seo_report/extractions/seo.rb
+- lib/seo_report/extractions/twitter.rb
+- lib/seo_report/report.rb
+- lib/seo_report/representation.rb
+- lib/seo_report/representation/base.rb
+- lib/seo_report/representation/cli.rb
+- lib/seo_report/representation/json.rb
+- lib/seo_report/request.rb
+- lib/seo_report/request_chain.rb
+- lib/seo_report/version.rb
+- seo_report.gemspec
+homepage: https://github.com/0robustus1/seo_report
+licenses:
+- LGPL-3.0
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: report seo relevant data for a given url
+test_files: []