gscholar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fec59a3b6b44a6050886d596cd8f3b3a72c8863
+  data.tar.gz: f393420400d2963d3650e7934410e7939688cc60
+SHA512:
+  metadata.gz: f8278c5ed8e3d5313b72d5728cc71d7de56f2b8549fe32d8419bfdcd73788b1bad98bd8b3d3a40ec006ce7b84e82e6bbb9e9bd3a5a0cc36a8a42fcbbc1e55f9a
+  data.tar.gz: 3d605ecff90282092385acaa6d4f5e283b15fe3e150c9f3d7b6c4d28aec17ef99bf129d7097f24842dae1c83170cb85e2db6ccbda06c5351bcacf9fec35951c5

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "mechanize"
+gem "bibtex-ruby"
+gem 'citeproc-ruby'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "simplecov"
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Zifei Tong
+
+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,19 @@
+= gscholar
+
+A library for fetching author, paper and citation information for Google Scholar.
+
+== Contributing to gscholar
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Zifei Tong. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gscholar"
+  gem.homepage = "http://github.com/5kg/gscholar"
+  gem.license = "MIT"
+  gem.summary = %Q{A library for fetching information form Google Scholar}
+  gem.description = %Q{A library for fetching author, paper and citation information for Google Scholar}
+  gem.email = "soariez@gmail.com"
+  gem.authors = ["Zifei Tong"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gscholar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/gscholar.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "gscholar"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zifei Tong"]
+  s.date = "2013-12-31"
+  s.description = "A library for fetching author, paper and citation information for Google Scholar"
+  s.email = "soariez@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "gscholar.gemspec",
+    "lib/gscholar.rb",
+    "lib/gscholar/citation.rb",
+    "lib/gscholar/paper.rb",
+    "lib/gscholar/utils.rb",
+    "lib/gscholar/utils/fetcher.rb",
+    "lib/gscholar/utils/lazy_proxy.rb",
+    "test/helper.rb",
+    "test/test_fetcher.rb",
+    "test/test_lazy_proxy.rb",
+    "test/test_paper.rb"
+  ]
+  s.homepage = "http://github.com/5kg/gscholar"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
+  s.summary = "A library for fetching information form Google Scholar"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mechanize>, [">= 0"])
+      s.add_runtime_dependency(%q<bibtex-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<citeproc-ruby>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<mechanize>, [">= 0"])
+      s.add_dependency(%q<bibtex-ruby>, [">= 0"])
+      s.add_dependency(%q<citeproc-ruby>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mechanize>, [">= 0"])
+    s.add_dependency(%q<bibtex-ruby>, [">= 0"])
+    s.add_dependency(%q<citeproc-ruby>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/lib/gscholar/citation.rb

@@ -0,0 +1,48 @@
+require 'bibtex'
+
+module GScholar
+
+  module Citeable
+    def self.included(base)
+      base.class_exec do
+        def __bib
+          @__bib ||= BibTeX.parse(bibtex.to_s).first
+        end
+      end
+    end
+
+    def citation(style)
+      CiteProc.process __bib.to_citeproc, :style => style
+    end
+
+    def title
+      __bib.title.to_s
+    end
+
+    def author
+      __bib.author.map(&:to_s)
+    end
+
+    def year
+      __bib.year.to_i
+    end
+  end
+
+  class Citation
+    include Citeable
+
+    attr_reader :id, :bibtex
+    alias_method :to_s, :bibtex
+
+    def initialize(id)
+      @id = id
+      @bibtex = Utils::LazyProxy.new { Utils.fetch(bibtex_url).body }
+    end
+
+    private
+    def bibtex_url
+      "http://scholar.google.com/scholar.bib?q=info:#{@id}:scholar.google.com/&output=citation"
+    end
+  end
+
+end

data/lib/gscholar/paper.rb

@@ -0,0 +1,45 @@
+require 'bibtex'
+
+module GScholar
+  class Paper
+    include GScholar::Citeable
+
+    attr_reader :id, :bibtex
+    alias_method :to_s, :bibtex
+
+    CITATION_PER_PAGE = 20
+
+    def initialize(id)
+      @id = id
+      @bibtex = Utils::LazyProxy.new { Utils.fetch(bibtex_url).body }
+    end
+
+    def cited
+      @cited ||= Utils.fetch(cluster_url).body[/>Cited by (\d+)<\/a>/, 1].to_i
+    end
+
+    def citations(range = nil)
+      rst = []
+      rst += Utils.fetch(citations_url(rst.size)).links_with(:text => "Related articles").
+               map {|link| Citation.new(link.href[/related:([^:]+):/, 1]) } until rst.size == cited
+      rst
+    end
+
+    private
+    def bibtex_url
+      "http://scholar.google.com/scholar.bib?q=info:#{key}:scholar.google.com/&output=citation"
+    end
+
+    def cluster_url
+      "http://scholar.google.com/scholar?cluster=#{@id}"
+    end
+
+    def citations_url(start = 0)
+      "http://scholar.google.com/scholar?cites=#{@id}&num=20&start=#{start}"
+    end
+
+    def key
+      @key ||= Utils.fetch(cluster_url).link_with(:text => "Related articles").href[/related:([^:]+):/, 1]
+    end
+  end
+end

data/lib/gscholar/utils/fetcher.rb

@@ -0,0 +1,23 @@
+require 'mechanize'
+
+module GScholar
+  module Utils
+
+    class Fetcher
+      def initialize
+        @cache = {}
+        @agent = Mechanize.new
+
+        # hack to enable BibTeX download
+        scisig = @agent.get('http://scholar.google.com/scholar_settings').
+                   form_with(:action => "/scholar_setprefs").field_with(:name => 'scisig').value
+        @agent.get("http://scholar.google.com/scholar_setprefs?scisig=#{scisig}&num=20&scis=yes&scisf=4&instq=&save=")
+      end
+
+      def fetch(url)
+        @cache[url] ||= @agent.get(url)
+      end
+    end
+
+  end
+end

data/lib/gscholar/utils/lazy_proxy.rb

@@ -0,0 +1,14 @@
+module GScholar
+  module Utils
+    class LazyProxy < BasicObject
+      def initialize(&block)
+        @initializer = block
+      end
+
+      def method_missing(method, *args, &block)
+        @obj ||= @initializer.call
+        @obj.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/gscholar/utils.rb

@@ -0,0 +1,11 @@
+require 'gscholar/utils/fetcher'
+require 'gscholar/utils/lazy_proxy'
+
+module GScholar
+  module Utils
+    def self.fetch(url)
+      @fetcher ||= Fetcher.new
+      @fetcher.fetch(url)
+    end
+  end
+end

data/lib/gscholar.rb

@@ -0,0 +1,3 @@
+require 'gscholar/utils'
+require 'gscholar/citation'
+require 'gscholar/paper'

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gscholar'
+
+class Test::Unit::TestCase
+end
+
+require 'pry'

data/test/test_fetcher.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestFetcher < Test::Unit::TestCase
+  should "successfully fetch 'http://scholar.google.com/'" do
+    page = GScholar::Utils.fetch('http://scholar.google.com/')
+    assert_not_nil page
+    assert_equal "200", page.code
+    assert_equal "Google Scholar", page.title
+  end
+
+  should "successfully set cookie" do
+    GScholar::Utils.fetch('http://scholar.google.com/')
+    page = GScholar::Utils.fetch('http://scholar.google.com/scholar_settings')
+    assert_not_nil page
+
+    # When in absence of cookies, the response should contains a '.gs_alrt' div
+    # with "Your cookies seem to be disabled." warning inside.
+    assert page.search('.gs_alrt').empty?
+  end
+
+  should "use cached page when refetch a url" do
+    id = GScholar::Utils.fetch('http://scholar.google.com/').__id__
+    assert_equal id, GScholar::Utils.fetch('http://scholar.google.com/').__id__
+  end
+end

data/test/test_lazy_proxy.rb

@@ -0,0 +1,35 @@
+require 'helper'
+require 'gscholar/utils/lazy_proxy'
+
+class LazyString
+  def initialize(&block)
+    @str = GScholar::Utils::LazyProxy.new &block
+  end
+
+  def split(*args, &block)
+    @str.send :split, *args, &block
+  end
+
+  def gsub(*args, &block)
+    @str.send :gsub, *args, &block
+  end
+end
+
+class TestLazyProxy < Test::Unit::TestCase
+  should "successfully initialize object lazily" do
+   obj = nil
+
+   assert_nothing_raised { obj = LazyString.new { raise "Lazy object initialized" } }
+   assert_not_nil(obj)
+   # wait for ruby 2.1 release
+   #assert_raise_with_message(RuntimeError, "Lazy object initialized") { obj.foo }
+   assert_raise(RuntimeError) { obj.split }
+  end
+
+  should "successfully delegate method call" do
+   obj = LazyString.new { "a simple string" }
+   assert_equal(obj.split.length, 3)
+   assert_equal(obj.gsub("simple ", ""), "a string")
+   assert_equal(obj.gsub("simple") {|match| match.upcase }, "a SIMPLE string")
+  end
+end

data/test/test_paper.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+# Helmer, Scott, et al. Curious george: The ubc semantic robot vision system. Vol. 2. Technical Report AAAI-WS-08-XX, AAAI Technical Report Series, 2007.
+PAPER_0 = '8322442812667615406'
+# Maxwell, Bruce A., Brian M. Leighton, and Leah R. Perlmutter. "A Responsive Vision System to Support Human-Robot Interaction."
+PAPER_1 = '778988983414467064'
+
+class TestPaper < Test::Unit::TestCase
+  def setup
+    @p0, @p1 = GScholar::Paper.new(PAPER_0), GScholar::Paper.new(PAPER_1)
+  end
+
+  should "successfully get number of citation" do
+    assert_equal(@p0.cited, 1)
+    assert_equal(@p1.cited, 0)
+  end
+
+  should "successfully get paper information" do
+    assert_equal(@p0.title, "Curious george: The ubc semantic robot vision system")
+
+    assert_equal(@p0.year, 2007)
+
+    author = @p1.author
+    assert_equal(author.length, 3)
+    assert_equal(author[0], "Maxwell, Bruce A")
+
+    assert_not_nil(@p1.to_s['maxwellresponsive'])
+  end
+
+  should "successfully get paper citations" do
+    c0 = @p0.citations
+    assert_equal(c0.size, 1)
+    assert_equal(c0.first.title, "A Responsive Vision System to Support Human-Robot Interaction")
+
+    c1 = @p1.citations
+    assert_equal(c1.size, 0)
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: gscholar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zifei Tong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for fetching author, paper and citation information for Google
+  Scholar
+email: soariez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- gscholar.gemspec
+- lib/gscholar.rb
+- lib/gscholar/citation.rb
+- lib/gscholar/paper.rb
+- lib/gscholar/utils.rb
+- lib/gscholar/utils/fetcher.rb
+- lib/gscholar/utils/lazy_proxy.rb
+- test/helper.rb
+- test/test_fetcher.rb
+- test/test_lazy_proxy.rb
+- test/test_paper.rb
+homepage: http://github.com/5kg/gscholar
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A library for fetching information form Google Scholar
+test_files: []