google-scholar 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGM2NTE5Njc2ZTYxODM1NGQxNTI4ODg3MzY3ZmVmNzlhNjJiMjhmMA==
+  data.tar.gz: !binary |-
+    ZGRlYzQ3MDc3MGEyMGUwMGQ4NDAyM2QwNzFlNzUzY2Q2MmNmZTBjYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjE0YzY2NjA5YjBlNDBiODI4N2VkMmFkNDZjYmI5OGEyYzEyNjA2ZjdlMjk2
+    YzljNWRkMTlmZTE4N2I2YzIyMmQ4M2UzMGIzYTQzMWIzMzc0MTMzNDJjODEx
+    NzYxODQ4ZmVkMzY1M2M0ZTBlNjY0ZjBmY2Y2Mjg3ODg5YmEzYjE=
+  data.tar.gz: !binary |-
+    Y2Q2MDJiMjFiMWY5MDg5MjIwMDFjMWNkMWU0YWEyODZlMzIzMWVkNjEzZTNk
+    ZWE1YmQxYjIzODMzNDJjZjA4MjJkY2U3ODRiMmMzNjdiZWI2OTM0Y2FhYWIy
+    YWUxYjcyYjFhMGZlZTQxNjk1ZDE2MWYyNDRiYzRjMzQ5NGZkMWY=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*

data/.rspec

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :cli => "--color --format documentation" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Trey Terrell
+
+MIT License
+
+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,29 @@
+# Google::Scholar
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-scholar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-scholar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 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/google-scholar.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google/scholar/version'
+require 'rbconfig'
+Gem::Specification.new do |spec|
+  spec.name          = "google-scholar"
+  spec.version       = Google::Scholar::VERSION
+  spec.authors       = ["Trey Terrell"]
+  spec.email         = ["trey.terrell@oregonstate.edu"]
+  spec.description   = %q{Google Scholar interface. Currently only works for Author searches.}
+  spec.summary       = %q{Google Scholar interface. Currently only works for Author searches.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri', '~> 1.5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'guard', '~> 1.8.0'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+end

data/lib/google/scholar.rb

@@ -0,0 +1,29 @@
+require "google/scholar/version"
+require "google/scholar/base"
+require "google/scholar/scraper"
+require "google/scholar/document"
+require "google/scholar/author"
+require "google/scholar/author_search"
+require "google/scholar/author_enumerator"
+require "google/scholar/article_summary"
+require "google/scholar/article_enumerator"
+require "google/scholar/document/authors_document"
+require "google/scholar/document/authors_profile_document"
+require 'cgi'
+module Google
+  module Scholar
+    def self.google_root
+      "scholar.google.com"
+    end
+    def self.http_scheme
+      "http://"
+    end
+    def self.google_url
+      "#{self.http_scheme}#{self.google_root}"
+    end
+    # @TODO May want to move this to AuthorSearch.
+    def self.author_search_url(author)
+      "#{self.http_scheme}#{self.google_root}/citations?view_op=search_authors&hl=en&mauthors=#{::CGI::escape("author:\"#{author}\"")}"
+    end
+  end
+end

data/lib/google/scholar/article_enumerator.rb

@@ -0,0 +1,32 @@
+require 'enumerator'
+module Google
+  module Scholar
+    class ArticleEnumerator
+      include Enumerable
+      def initialize(scraper)
+        @scraper = scraper
+        @documents = scraper.documents
+        self
+      end
+      def each
+        current_document = @documents.first
+        i = 1
+        while(current_document)
+          current_document.articles.each {|article| yield(article)}
+          if(@documents.length > i)
+            current_document = @documents[i]
+          else
+            if(@scraper.has_more_pages?)
+              @scraper.load_next_page
+              @documents = @scraper.documents
+              current_document = @documents[i]
+            else
+              current_document = nil
+            end
+          end
+          i += 1
+        end
+      end
+    end
+  end
+end

data/lib/google/scholar/article_summary.rb

@@ -0,0 +1,27 @@
+module Google
+  module Scholar
+    class ArticleSummary
+      def initialize(doc)
+        @document = doc
+      end
+      def title
+        @title ||= @document.css("#col-title a:first").text
+      end
+      def authors
+        @authors ||= @document.css("#col-title span:first").text
+      end
+      def publisher
+        @publisher ||= @document.css("#col-title span:last").text
+      end
+      def citations
+        @citations ||= @document.css("#col-citedby a:first").text.to_i
+      end
+      def year
+        @year ||= @document.css("#col-year").text.to_i
+      end
+      def full_article_url
+        @full_article_url ||= "#{Google::Scholar.google_url}#{@document.css("#col-title a:first").attr("href").text}"
+      end
+    end
+  end
+end

data/lib/google/scholar/author.rb

@@ -0,0 +1,31 @@
+require 'nokogiri'
+module Google
+  module Scholar
+    class Author
+      def initialize(document)
+        @summary_doc = document
+      end
+      def name
+        @name ||= @summary_doc.css("td:last a:first").text.strip.gsub('\n','')
+      end
+      def citation_count
+        @citation_count ||= @summary_doc.css("td:last").children.reject{|x| !x.text?}.last.text.split(" ").last.to_i
+      end
+      def author_url
+        @author_url ||= "#{Google::Scholar.google_url}#{@summary_doc.css("td:last a").first.attr("href")}&pagesize=100"
+      end
+      def full_profile
+        @full_profile ||= Google::Scholar::Scraper.new(author_url).documents.first
+      end
+      def citations
+        full_profile.css("#stats td.cit-data").first.text.to_i
+      end
+      def id
+        @id ||= @summary_doc.css("td:last a:first").attr("href").to_s.match(/user=(.*)&/)[1]
+      end
+      def articles
+        @articles ||= Google::Scholar::ArticleEnumerator.new(Google::Scholar::Scraper.new(nil,self.full_profile))
+      end
+    end
+  end
+end

data/lib/google/scholar/author_enumerator.rb

@@ -0,0 +1,32 @@
+require 'enumerator'
+module Google
+  module Scholar
+    class AuthorEnumerator
+      include Enumerable
+      def initialize(scraper)
+        @scraper = scraper
+        @documents = scraper.documents
+        self
+      end
+      def each
+        current_document = @documents.first
+        i = 1
+        while(current_document)
+          current_document.authors.each {|author| yield(author)}
+          if(@documents.length > i)
+            current_document = @documents[i]
+          else
+            if(@scraper.has_more_pages?)
+              @scraper.load_next_page
+              @documents = @scraper.documents
+              current_document = @documents[i]
+            else
+              current_document = nil
+            end
+          end
+          i += 1
+        end
+      end
+    end
+  end
+end

data/lib/google/scholar/author_search.rb

@@ -0,0 +1,10 @@
+module Google
+  module Scholar
+    class AuthorSearch < Google::Scholar::Base
+      def authors
+        return unless @scraper.documents.first.kind_of?(Google::Scholar::AuthorsDocument)
+        @authors ||= Google::Scholar::AuthorEnumerator.new(@scraper)
+      end
+    end
+  end
+end

data/lib/google/scholar/base.rb

@@ -0,0 +1,15 @@
+module Google
+  module Scholar
+    class Base
+      attr_accessor :scraper
+      def initialize(url)
+        @scraper = Google::Scholar::Scraper.new(url)
+        self
+      end
+      def self.search_author(author)
+        url = Google::Scholar.author_search_url(author)
+        Google::Scholar::AuthorSearch.new(url)
+      end
+    end
+  end
+end

data/lib/google/scholar/document.rb

@@ -0,0 +1,31 @@
+module Google
+  module Scholar
+    class Document
+      attr_reader :document
+      def initialize(nokogiri_document)
+        @document = nokogiri_document
+      end
+      def method_missing(meth, *args, &block)
+        if(@document.respond_to?(meth))
+          return @document.send(meth,*args,&block)
+        else
+          super
+        end
+      end
+      def has_next_page?
+        @document.css('.cit-dgb .cit-dark-link').each do |link|
+          return true if link.content.include?("Next")
+        end
+        return false
+      end
+      def next_page_url
+        return nil unless self.has_next_page?
+        @document.css('.cit-dgb .cit-dark-link').each do |link|
+          if(link.content.include?("Next"))
+            return "#{Google::Scholar.google_url}#{link.attr("href")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/scholar/document/authors_document.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+require 'open-uri'
+module Google
+  module Scholar
+    class AuthorsDocument < Document
+      def valid?
+        validity = !self.content.downcase.index("authors").nil?
+        validity = false if !self.content.downcase.index("didn't match any").nil?
+        validity
+      end
+      def authors_count
+        self.css('.g-unit').length
+      end
+      def authors(force=false)
+        return @authors if @authors && !force
+        @authors = []
+        self.css('.g-unit').each {|author| @authors << Google::Scholar::Author.new(author)}
+        @authors
+      end
+      def last_author
+        authors.last
+      end
+    end
+  end
+end

data/lib/google/scholar/document/authors_profile_document.rb

@@ -0,0 +1,14 @@
+require 'nokogiri'
+require 'open-uri'
+module Google
+  module Scholar
+    class AuthorsProfileDocument < Document
+      def articles(force=false)
+        return @citations if @citations && !force
+        @citations = []
+        self.css(".cit-table tr.item").each {|row| @citations << Google::Scholar::ArticleSummary.new(row)}
+        return @citations
+      end
+    end
+  end
+end

data/lib/google/scholar/scraper.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+require 'open-uri'
+module Google
+  module Scholar
+    class Scraper
+      attr_accessor :documents
+      def initialize(url,initial_document=nil)
+        @documents = []
+        @documents << initial_document if initial_document
+        @documents << self.class.load_url(url) if url
+        self
+      end
+      def self.class_lookup(url="")
+        arguments = url.split("?")
+        arguments = arguments[1].split("&") if arguments.length > 1
+        if(arguments.include?("view_op=search_authors"))
+          return Google::Scholar::AuthorsDocument
+        end
+        if(arguments.any?{|x| x.include?("user=")})
+          return Google::Scholar::AuthorsProfileDocument
+        end
+        return Google::Scholar::Document
+      end
+      def valid?
+        @documents.each do |document|
+          return false unless document.valid?
+        end
+        return true
+      end
+      def load_next_page
+        return unless self.has_more_pages?
+        @documents << self.class.load_url(@documents.last.next_page_url)
+      end
+      def self.load_url(url)
+        uri = URI(url)
+        raise "Invalid scheme for #{url}" if uri.scheme.nil? || !%w{http https}.any?{|scheme| uri.scheme == scheme}
+        return class_lookup(url).new(Nokogiri::HTML(open(url)))
+      end
+      def has_more_pages?
+        @documents.last.has_next_page?
+      end
+    end
+  end
+end