seo_site_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37c0b7a623751d4a4f6a536a42eb92ef0c2ee174
+  data.tar.gz: c1d9dd1b2200c28858efae4081a6e2329467cf30
+SHA512:
+  metadata.gz: 8501485f6a53388ddb994f8dc6dea2ea99adb1e8a5f1b74dd09f3c1a7e4d6e8ae3d463cdfd681fbc3bcfcf9e626cbe9cd3ee81b6120f8d00b88ccf92a9d797d1
+  data.tar.gz: 09d96eb1120adb77d22cfcfb6c166e3ee4457cd8b061c307aa8b1bc7f3e35c8c3e93c6dc5f0a81303a690149b973b7b1e9328a250ab96d208ca04aa2c776a8af

data/.gitignore

@@ -0,0 +1,32 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.csv
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ijonas Kisselbach
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ijonas Kisselbach
+
+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,35 @@
+# seo_site_check
+
+A command-line utilty that provides a report to help webmasters improve website SEO.
+
+The report produced in CSV-format is a breakdown of all the webpages encountered on a site together with their title and H1->H6 tags.
+Very simple, but I find I'm always tuning this information on my sites. Hope it helps you too.
+
+![Image of SEO Site Report](https://raw.githubusercontent.com/ijonas/seo_site_check/master/assets/seo_site_check_screenshot.jpg)
+
+## Installation
+
+SEO Site Check is meant to be run as a command line utility. To install on OSX and Unix-based systems:
+
+    $ gem install seo_site_check
+
+## Usage
+
+Running SEO Site check only requires the URL of the homepage of the site you're checking:
+
+    $ seo_site_check http://www.ijonas.com
+
+which will produce an seo-site-check-report.csv file in your current folder.
+
+You can override the file path and name by specifying an additional parameter:
+
+    $ seo_site_check http://www.ijonas.com /tmp/sitereport.csv
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ijonas/seo_site_check. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seo_site_check"
+
+# 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

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_site_check

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "seo_site_check"
+require "cobweb"
+require "csv"
+
+
+homepage = ARGV.first
+output_file = ARGV.length > 1 ? ARGV[1] : "seo-site-check-report.csv"
+
+crawler = CobwebCrawler.new(
+  debug: false,
+  valid_mime_types: ['text/*']
+)
+
+url_headings = {}
+hdrs = %w(h1 h2 h3 h4 h5 h6)
+htag_counts = {}
+hdrs.each {|h| htag_counts[h] = 0}
+
+def cleanup_hdr(hdr)
+  val = hdr.strip.gsub("\n", " ")
+  val = "EMPTY" if val.empty?
+  val
+end
+
+crawler.crawl(homepage) do |page|
+  if page[:mime_type]=="text/html"
+    puts page[:url]
+
+    doc = Nokogiri::HTML(page[:body])
+    headers = {
+      title: cleanup_hdr(doc.xpath("//title").first.content)
+    }
+    hdrs.each do |htag|
+      tags = doc.xpath("//#{htag}").map(&:content).map{|c|cleanup_hdr c}
+      tags = ["EMPTY"] if tags.empty?
+      headers[htag] = tags
+      htag_counts[htag] = tags.length if tags.length > htag_counts[htag]
+    end
+    url_headings[page[:url]] = headers
+  end
+end
+CSV.open(output_file, "wb") do |csv|
+  hdr_row = ["url", "title"]
+  hdrs.each do |hdr|
+    no_occs = htag_counts[hdr]
+    hdr_row.concat( [].fill(hdr,0..no_occs-1) )
+  end
+  csv << hdr_row
+  url_headings.each do |url, headers|
+    row = [ url, headers[:title] ]
+    hdrs.each do |hdr|
+      no_hdr_occs = htag_counts[hdr]
+      prepped_row = [].fill("",0..no_hdr_occs-1)
+      headers[hdr].each_with_index {|hv, i| prepped_row[i] = hv }
+      row.concat(prepped_row)
+    end
+    csv << row
+  end
+end
+puts "Finished. See #{output_file}"

data/lib/seo_site_check.rb

@@ -0,0 +1,5 @@
+require "seo_site_check/version"
+
+module SeoSiteCheck
+  # Your code goes here...
+end

data/lib/seo_site_check/version.rb

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

data/seo_site_check.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seo_site_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seo_site_check"
+  spec.version       = SeoSiteCheck::VERSION
+  spec.authors       = ["Ijonas Kisselbach"]
+  spec.email         = ["ijonas@ijonas.com"]
+
+  spec.summary       = %q{Provides a report to help webmasters improve website SEO.}
+  spec.description   = %q{Provides a report to help webmasters improve website SEO. Makes it easy for webmasters to see a breakdown of URLs and all the title and H1-H6 tags on their site.}
+  spec.homepage      = "https://github.com/ijonas/seo_site_check"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", '~> 5.8'
+
+  spec.add_dependency 'cobweb', '~> 1.1'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: seo_site_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ijonas Kisselbach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-12 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: cobweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provides a report to help webmasters improve website SEO. Makes it easy
+  for webmasters to see a breakdown of URLs and all the title and H1-H6 tags on their
+  site.
+email:
+- ijonas@ijonas.com
+executables:
+- seo_site_check
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/seo_site_check_screenshot.jpg
+- bin/console
+- bin/setup
+- exe/seo_site_check
+- lib/seo_site_check.rb
+- lib/seo_site_check/version.rb
+- seo_site_check.gemspec
+homepage: https://github.com/ijonas/seo_site_check
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Provides a report to help webmasters improve website SEO.
+test_files: []