get_seo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dda93265c8b01fe546e13f323e06a8c49a0b66c9
+  data.tar.gz: 00111bb888d7f2ec966d6871dc3bf4ce07832998
+SHA512:
+  metadata.gz: e0d1671ef63e0f5592a304fcf25d8bce9119fb0b3112e144b9293a5e6c5d7559cadc8276f33d15fabaa96bfc483f5735889aa5e2880f76c00cf397821957b40e
+  data.tar.gz: f518660843d0b68f4871fdd6e9b4d4b4a72fd38b8b43b85e6014dc3289aa72eb016be610e957fcf119e42de5071df6301fbad6d7e7f1cbf67833c86c58c5de40

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dom.mckellar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dom McKellar
+
+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,87 @@
+# GetSeo
+
+[GetSeo](https://rubygems.org/gems/get_seo) is a CLI built in ruby. It allows you to quickly and easily inspect various SEO metrics from any website. Simply enter the url of a website you’d like to inspect, select the SEO metric you wish to retrieve, and your results will be displayed in the terminal.
+
+---
+
+## Installation
+
+### Option (1)
+
+* Add this line to your application's Gemfile:
+
+`gem 'get_seo'`
+
+* Run bundle from your terminal
+
+`$ bundle`
+
+### Option (2)
+
+Install the gem on your local system:
+
+`$ gem install get_seo`
+
+---
+
+## CLI Usage
+
+###  Go to the project directory:
+
+`$ cd get_seo/`
+
+### Begin a GetSeo session:
+
+`$ ruby bin/get-seo`
+
+or alternatively
+
+`$ ./bin/get-seo`
+
+###### Note: You may receive a `Permission Denied` error. Fix it by doing the following:
+
+##### (step 1)
+`$ cd bin/`
+
+##### (step 2)
+`$ ls -lah`
+
+* Assuming your `get-seo` file doesn't have the following permission(s): `-rwxr-xr-x`
+
+##### (step 3)
+`$ chmod +x get-seo`
+
+##### (step 4)
+`$ ls -lah` will verify your changes took effect
+
+---
+
+## 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).
+
+---
+
+## Creator
+
+### Dominic McKellar
+
+* Website: [domckellar.com](http://domckellar.com/)
+
+* Blog: [newme.io](http://newme.io/)
+
+* Github: [@Dom-Mc](https://github.com/Dom-Mc)
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/get_seo. 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](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/_config.yml

@@ -0,0 +1,3 @@
+theme: jekyll-theme-cayman
+title: Dom McKellar | GetSeo
+description: GetSeo was created by Dominic McKellar. It's a CLI built in Ruby that allows you to quickly and easily inspect various SEO metrics from any website.

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "get_seo"
+
+require "pry"
+Pry.start

data/bin/get-seo

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# NOTE: loads main library
+require "get_seo"
+
+# NOTE: call to start program (file located in lib/get_seo/cli.rb)
+GetSeo::CLI.new.run_program

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/get_seo.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'get_seo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "get_seo"
+  spec.version       = GetSeo::VERSION
+  spec.author        = ["Dom McKellar"]
+  spec.email         = ["dom.mckellar@gmail.com"]
+
+  spec.summary       = %q{Quickly and easily inspect various SEO metrics from any website.}
+  spec.description   = %q{GetSeo allows you to avoid browser extensions and immediately fetch SEO various SEO metrics. Simply enter the url of a website you’d like to inspect, select the SEO metric you'd like to retrieve, and GetSeo will display your results via the terminal.}
+  spec.homepage      = "http://newme.io/get_seo/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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"]
+
+  # Development
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "require_all", "~> 1.3", ">= 1.3.3"
+
+  # Production
+  spec.add_dependency "nokogiri", "~> 1.6"
+end

data/lib/get_seo.rb

@@ -0,0 +1,8 @@
+#Will act as our environment file
+require 'open-uri'
+require 'nokogiri'
+require 'pry'
+
+require_relative 'get_seo/version'
+require_relative 'get_seo/seo'
+require_relative 'get_seo/cli'

data/lib/get_seo/cli.rb

@@ -0,0 +1,146 @@
+#CLI Controller
+class GetSeo::CLI
+
+  attr_accessor :protocal, :start_of_program, :seo_data
+
+  def initialize
+    @start_of_program = true
+  end
+
+  def run_program
+    welcome_message
+    check_requested_protocal
+    get_seo_info
+    seo_menu if start_of_program
+    goodbye_message
+  end
+
+  private
+
+    def check_requested_protocal
+      loop do
+        line_break
+        puts "Check the webpage you would like to inspect and find out if it uses 'http' or 'https'?",
+        "-To select 'http' (Enter 1)",
+        "-To select 'https' (Enter 2)"
+
+        requested_protocal = gets.strip.downcase
+
+        if requested_protocal == '1' || requested_protocal == 'http'
+          self.protocal = 'http://'
+          break
+        elsif requested_protocal == '2' || requested_protocal == 'https'
+          self.protocal = 'https://'
+          break
+        else
+          section_break
+          puts "\t*Sorry but '#{requested_protocal}' is not a valid option.*"
+          section_break
+        end
+      end
+    end
+
+    def get_seo_info
+      line_break
+      puts "In order to retrieve SEO information, please enter the domain of the webpage you would like to inspect (i.e. example.com):"
+
+      print protocal # 'http://' or 'https://'
+      requested_url = gets.strip.downcase
+
+      # NOTE: Throw an exception if website cannote be accessed
+      begin
+
+        self.seo_data = GetSeo::Seo.setup(protocal + requested_url)
+
+      rescue
+
+        section_break
+        puts "\t*There seems to be an issue with the domain you entered.*",
+        "\t*Please double check the url and try again.*"
+        section_break
+
+        run_program
+      end
+    end
+
+    def seo_menu
+      # NOTE: pervent seo_menu from running again after "exit"
+      self.start_of_program = false
+
+      loop do
+
+        2.times { line_break }
+        puts "What information would you like to retrieve?:",
+        "- Title Tag (Enter 1)",
+        "- Description Meta Tag' (Enter 2)",
+        "- Keyword Meta Tag (Enter 3)",
+        "- h1 Heading Tag(s) (Enter 4)",
+        "- h2 Heading Tag(s) (Enter 5)",
+        "- h3 Heading Tag(s) (Enter 6)",
+        "- Image Alt Attribute(s)' (Enter 7)",
+        "- Exit the program (Enter 'exit' or 'quit')"
+
+        user_selection = gets.strip.downcase
+
+        case user_selection
+        when '1'
+          print_seo_data(seo_data.title, "Title Tag")
+        when '2'
+          print_seo_data(seo_data.description, "Description Meta Tag")
+        when '3'
+          print_seo_data(seo_data.keywords, "Keywords Meta Tag")
+        when '4'
+          print_seo_data(seo_data.heading1, "h1 Heading Tag(s)")
+        when '5'
+          print_seo_data(seo_data.heading2, "h2 Heading Tag(s)")
+        when '6'
+          print_seo_data(seo_data.heading3, "h3 Heading Tag(s)")
+        when '7'
+          print_seo_data(seo_data.img_alt_attribute, "Image Alt Attribute(s)")
+        when 'exit', 'quit'
+          break
+        else
+          section_break
+          puts "\t*Sorry but '#{user_selection}' is invalid, please select another option.*"
+          section_break
+        end
+      end
+
+    end
+
+    def welcome_message
+      line_break
+      puts "Welcome to SEO. Ok enough chitchat, let's get to work!"
+    end
+
+    def goodbye_message
+      line_break
+      puts "Great SEO work! Job well done."
+      line_break
+    end
+
+    def print_seo_data(data_attr, name)
+      section_break
+      puts "\t*#{name.upcase}*"
+      section_break
+
+      if data_attr.empty?
+        puts "\t*#{name} - Not found on page.*"
+      else
+        data_attr.each do |value|
+          puts "* #{value}"
+        end
+      end
+    end
+
+    def section_break
+      line_break
+      70.times { print '*' }
+      line_break
+    end
+
+    def line_break
+      puts "\n"
+    end
+
+end

data/lib/get_seo/seo.rb

@@ -0,0 +1,50 @@
+class GetSeo::Seo
+
+  attr_accessor :heading1, :heading2, :heading3, :keywords, :title, :description, :img_alt_attribute
+
+  def self.setup(url)
+    html = Nokogiri::HTML(open(url))
+    seo = self.new
+
+    seo.heading1 = html.search("h1").map do |h1|
+      h1.text.strip.gsub(/\s+/, " ")
+    end.reject(&:empty?)
+
+    seo.heading2 = html.search("h2").map do |h2|
+      h2.text.strip.gsub(/\s+/, " ")
+    end.reject(&:empty?)
+
+    seo.heading3 = html.search("h3").map do |h3|
+      h3.text.strip.gsub(/\s+/, " ")
+    end.reject(&:empty?)
+
+    seo.title = []
+    if title = html.at("title")&.text
+      seo.title << title.strip unless title.empty?
+    end
+
+    seo.keywords = []
+    if keywords = (html.at("meta[name='keywords']") &&
+                   html.at("meta[name='keywords']")['content'])
+
+      keywords.split(',').each do |keyword|
+         stripped_word = keyword.strip
+         seo.keywords << stripped_word unless stripped_word.empty?
+      end
+    end
+
+    seo.description = []
+    if description = (html.at("meta[name='description']") &&
+                      html.at("meta[name='description']")['content'])
+
+      seo.description << description unless description.empty?
+    end
+
+    seo.img_alt_attribute = html.search('img').map do |img|
+        img['alt']&.strip
+    end.compact.reject!(&:empty?)
+
+    seo
+  end
+
+end

data/lib/get_seo/version.rb

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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: get_seo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dom McKellar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: GetSeo allows you to avoid browser extensions and immediately fetch SEO
+  various SEO metrics. Simply enter the url of a website you’d like to inspect, select
+  the SEO metric you'd like to retrieve, and GetSeo will display your results via
+  the terminal.
+email:
+- dom.mckellar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- _config.yml
+- bin/console
+- bin/get-seo
+- bin/setup
+- get_seo.gemspec
+- lib/get_seo.rb
+- lib/get_seo/cli.rb
+- lib/get_seo/seo.rb
+- lib/get_seo/version.rb
+homepage: http://newme.io/get_seo/
+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.8
+signing_key: 
+specification_version: 4
+summary: Quickly and easily inspect various SEO metrics from any website.
+test_files: []