gtools 0.0.1 → 0.0.2

data/LICENSE.txt

@@ -1,4 +1,5 @@
-Copyright (c) 2013 Kamil Kocemba
+GTools
+Copyright (c) 2013 Kamil Kocemba <kkocemba@gmail.com>
 
 MIT License
 

data/Rakefile

@@ -10,4 +10,4 @@ RDoc::Task.new do |rd|
 end
 
 task :default => :spec
-task :test => :spec
+task :test => :spec

data/gtools.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kamil@futureworkshops.com"]
   spec.description   = %{A set of Gooogle SEO tools in Ruby}
   spec.summary       = %q{Gathers statistics like PageRank, site index, page speed analysis and more.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/kkodev/gtools"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/gtools.rb

@@ -1,45 +1,84 @@
+##
+# GTools
+# Copyright (c) 2013 Kamil Kocemba <kkocemba@gmail.com>
+#
+
 require "gtools/version"
 require 'httparty'
 
 module GTools
 
+  ##
+  # Returns Google Page Rank for specified domain
+  #
+  # <tt>Note: mining Page Rank violates Google ToS.</tt>
+  #
   def self.page_rank(domain)
     url = GToolsConfiguration.tbr_host + GToolsConfiguration.tbr_query % [GMath.hash(domain), domain]
     r = HTTParty.get(url).parsed_response
     (r =~ /(\d+)$/) ? Integer($1) : nil
   end
 
+  ##
+  # Returns a dictionary of Google pagespeed analysis results for specified URL.
+  # 
+  # Notable fields: <tt>rule_results</tt>, <tt>score</tt>
+  #
   def self.pagespeed_analysis(url)
-    nil unless url
+    return nil unless valid_url url
     url = GToolsConfiguration.google_pagespeed_url % [URI.encode(url)]
     HTTParty.get(url).parsed_response["results"]
   end
 
+  ##
+  # Returns pagespeed score for specified URL.
+  # 
   def self.pagespeed_score(url)
-    nil unless url && URI.parse(url)
+    return nil unless valid_url url
     r = pagespeed_analysis(url)
     r ? r["score"] : nil
   end
 
-  def self.site_index(url)
-    nil unless url && URI.parse(url)
-    search_results "site:#{url}"
+  ##
+  # Returns estimated number of indexed pages for specified domain.
+  #
+  # <tt>Provide user_ip param to avoid ToS violation.</tt>
+  #
+  def self.site_index(url, user_ip = nil)
+    return nil unless valid_url url
+    search_results "site:#{url}", user_ip
   end
 
-  def self.site_links(url)
-    nil unless url && URI.parse(url)
-    search_results "link:#{url}"
+  ##
+  #
+  # Returns a number of results for link:domain query.
+  # This gives an overview of backlink portfolio.
+  #
+  # <tt>Note: this method is not intended to be used for accurate backlink analysis.</tt>
+  # 
+  def self.site_links(url, user_ip = nil)
+    return nil unless valid_url url
+    search_results "link:#{url}", user_ip
   end
 
-  def self.search_results(query)
-    nil unless query
+  ##
+  # Returns estimated number of results for specified search query.
+  #
+  # <tt>Provide user_ip param to avoid ToS violation.</tt>
+  #
+  def self.search_results(query, user_ip = nil)
+    return nil unless query
     url = GToolsConfiguration.google_apisearch_url % [1, URI.encode(query)]
+    url += "&userip=#{user_ip}" if user_ip
     r = HTTParty.get(url).parsed_response
     return nil unless r['responseData']
     count = r['responseData']['cursor']['estimatedResultCount']
     count ? Integer(count) : nil
   end
 
+  ##
+  # Returns Google tld suggestion based on current IP.
+  #
   def self.suggested_tld
     url = GToolsConfiguration.google_tld_url
     domain = HTTParty.get(url).parsed_response
@@ -47,12 +86,20 @@ module GTools
   end
 
   private
-  module GToolsConfiguration
+  def self.valid_url(url) # :nodoc:
+    false unless url
+    url += 'http://' unless url =~ /http:\/\//
+    !!(URI.parse(url) && url =~ URI::regexp)
+  rescue URI::InvalidURIError
+    false 
+  end
+
+  private
+  module GToolsConfiguration # :nodoc:
 
     class << self; 
       attr_accessor :google_apisearch_url, :google_pagespeed_url, :google_plusone_url, :google_tld_url, :tbr_host, :tbr_query; 
     end
-
     self.google_apisearch_url = "http://ajax.googleapis.com/ajax/services/search/web?v=1.0&rsz=%s&q=%s"
     self.google_pagespeed_url = "https://developers.google.com/_apps/pagespeed/run_pagespeed?url=%s&format=json"
     self.google_plusone_url = "https://plusone.google.com/u/0/_/+1/fastbutton?count=true&url=%s"
@@ -63,7 +110,7 @@ module GTools
   end
 
   private
-  module GMath
+  module GMath # :nodoc:
 
     class << self; attr_accessor :hash_seed; end
 

data/lib/gtools/version.rb

@@ -1,3 +1,8 @@
-module Gtools
-  VERSION = "0.0.1"
+##
+# GTools
+# Copyright (c) 2013 Kamil Kocemba <kkocemba@gmail.com>
+#
+
+module Gtools # :nodoc: all
+  VERSION = "0.0.2"
 end

data/spec/lib/gtools_spec.rb

@@ -1,9 +1,12 @@
+##
+# GTools
+# Copyright (c) 2013 Kamil Kocemba <kkocemba@gmail.com>
+#
+
 require 'spec_helper'
 
 describe GTools do
 
-  sleep_amount = 1
-
   describe :page_rank do
 
     it "should return page rank for a valid domain" do
@@ -58,15 +61,13 @@ describe GTools do
   describe :site_index do
 
     it "should return an integer for a valid domain" do
-      sleep sleep_amount
-      index = GTools.site_index 'google.com'
+      index = GTools.site_index 'google.com', '50.19.85.156'
       index.should_not be_nil
       index.should_not == 0
     end
 
-    it "should return nil for invalid domain" do
-      sleep sleep_amount
-      index = GTools.site_index 'test'
+    it "should return nil for invalid url" do
+      index = GTools.site_index '@#$%', '50.19.85.156'
       index.should be_nil
     end
 
@@ -75,15 +76,13 @@ describe GTools do
   describe :site_links do
 
     it "should return an integer for a valid domain" do
-      sleep sleep_amount
-      count = GTools.site_links 'google.com'
+      count = GTools.site_links 'google.com', '50.18.169.106'
       count.should_not be_nil
       count.should_not == 0
     end
 
-    it "should return nil for invalid domain" do
-      sleep sleep_amount
-      count = GTools.site_links 'test'
+    it "should return nil for invalid url" do
+      count = GTools.site_links '@#$%', '50.18.169.106'
       count.should be_nil
     end
 
@@ -91,18 +90,18 @@ describe GTools do
 
   describe :search_results do
 
-    it "should return an integer for a valid domain" do
-      sleep sleep_amount
-      count = GTools.search_results 'google.com'
+    it "should return an integer for a valid query" do
+      count = GTools.search_results 'lolcat', '199.59.148.82'
       count.should_not be_nil
       count.should_not == 0
     end
 
-    it "should return nil for invalid domain" do
-      sleep sleep_amount
-      count = GTools.search_results 'test'
-      count.should be_nil
+    it "should work without providing IP" do
+      count = GTools.search_results 'google.com'
+      count.should_not be_nil
+      count.should_not == 0
     end
+
   end
 
   describe :suggested_tld do

data/spec/spec_helper.rb

@@ -1 +1,6 @@
+##
+# GTools
+# Copyright (c) 2013 Kamil Kocemba <kkocemba@gmail.com>
+#
+
 require 'gtools'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gtools
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ files:
 - lib/gtools/version.rb
 - spec/lib/gtools_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/kkodev/gtools
 licenses:
 - MIT
 post_install_message: 
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4345568620700901684
+      hash: 1773892807361118976
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4345568620700901684
+      hash: 1773892807361118976
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24