serpentor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5721a6706eed45c3475593f1cfa63dd63588b6ac
+  data.tar.gz: d9b86743d7b7b3ec18b3fcff88968db9731ba698
+SHA512:
+  metadata.gz: d2ac8c9a40ace6baad68c70f1a865f20928d962441523d85e21441c6468fdada7ba48cd99bdeb82e29252cc07713150bfb62cf318e19454c669e8b86d9b337db
+  data.tar.gz: bf6ad6b0edd645de468082791eb083d49ab3b837b98f67b0bce73116621ea0538ad93a6a7234eb962c906c340410ed08a9012380e00593bffff677ee9874ffa6

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,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nick Plante
+
+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,55 @@
+# Serpentor
+
+Simple utility to check search engine result rankings for a given set of keywords.
+Right now only Google search is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serpentor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serpentor
+
+## Usage
+
+Run an individual keyword test:
+
+```ruby
+rank = Serpentor::Rank.check('SOSV', 'sosv.com')
+puts "Rank is #{rank.value} (#{rank.url})"
+```
+
+Or configure a bulk keyword test:
+
+```ruby
+config = Serpentor.configure do |config|
+  config.keywords = ["keyword1", "keyword2"]
+  config.host = "my-site.com"
+  config.limit = 10 # only care if result is on first page
+end
+
+results = Serpentor.rank
+results.each do |res|
+  puts "Rank for '#{res.keyword}' is #{res.rank || 'N/A'} (#{res.url})"
+end
+```
+
+The first 5 pages (50 results) are checked by default. You can further limit
+that number, for example, if you only care about first page results.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/serpentor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+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 "serpentor"
+
+# 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/lib/serpentor.rb

@@ -0,0 +1,43 @@
+require "serpentor/config"
+require "serpentor/rank"
+require "serpentor/version"
+
+require "google-search"
+
+module Serpentor
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Config.new
+    yield(configuration)
+  end
+
+  def self.rank(options={})
+    keywords = options[:keywords]
+    host = options[:host]
+    limit = options[:limit]
+
+    if configuration
+      keywords ||= configuration.keywords
+      host ||= configuration.host
+      limit ||= configuration.limit
+    end
+
+    if keywords.nil? || host.nil?
+      raise ArgumentError.new("keywords and host required")
+    end
+
+    results = []
+    rank_options = {}
+    rank_options[:limit] = limit if limit
+    keywords = [keywords] if keywords.is_a?(String)
+
+    keywords.each do |keyword|
+      results << Rank.check(keyword, host, rank_options)
+    end
+
+    results
+  end
+end

data/lib/serpentor/config.rb

@@ -0,0 +1,11 @@
+module Serpentor
+  class Config
+    attr_accessor :keywords, :host, :limit
+
+    def initialize
+      @keywords = []
+      @host = []
+      @limit = nil
+    end
+  end
+end

data/lib/serpentor/rank.rb

@@ -0,0 +1,53 @@
+module Serpentor
+  class Rank
+    attr_reader :keyword, :host, :url, :value, :requested_at
+
+    def initialize(keyword, host, options={})
+      @keyword = keyword
+      @host = host
+      @limit = options[:limit] || 50
+    end
+
+    class << self
+      def check(keyword, host, options={})
+        new(keyword, host, options).check
+      end
+    end
+
+    def check
+      @requested_at ||= Time.now
+      position = 1
+
+      Google::Search::Web.new(query: keyword).each_item do |res|
+        return self if !!@value || position > @limit
+
+        if URI.parse(res.uri).host == host
+          @value = position
+          @url = res.uri
+        else
+          position += 1
+        end
+      end
+
+      self
+    end
+
+    def rank
+      value
+    end
+
+    def requested?
+      !requested_at.nil?
+    end
+
+    def ranked?
+      check unless requested?
+      !value.nil?
+    end
+
+    def unranked?
+      check unless requested?
+      value.nil?
+    end
+  end
+end

data/lib/serpentor/version.rb

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

data/serpentor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serpentor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serpentor"
+  spec.version       = Serpentor::VERSION
+  spec.authors       = ["Nick Plante"]
+  spec.email         = ["nap@zerosum.org"]
+
+  spec.summary       = %q{Automates checking of Search Engine Results for a given set of keywords.}
+  spec.homepage      = "http://github.com/zapnap/serpentor"
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.22"
+  spec.add_dependency "google-search", "~> 1.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: serpentor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Plante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: google-search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- nap@zerosum.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/serpentor.rb
+- lib/serpentor/config.rb
+- lib/serpentor/rank.rb
+- lib/serpentor/version.rb
+- serpentor.gemspec
+homepage: http://github.com/zapnap/serpentor
+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.7
+signing_key: 
+specification_version: 4
+summary: Automates checking of Search Engine Results for a given set of keywords.
+test_files: []