google-scholar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGM2NTE5Njc2ZTYxODM1NGQxNTI4ODg3MzY3ZmVmNzlhNjJiMjhmMA==
+    OTBmNDI2ZTQ0MzljOTBhZWVlZjQ3OGI4OWUwMzBkMWExMTBlOTU3ZQ==
   data.tar.gz: !binary |-
-    ZGRlYzQ3MDc3MGEyMGUwMGQ4NDAyM2QwNzFlNzUzY2Q2MmNmZTBjYg==
+    YWE1Y2MxOGZhMjRlY2E0ZDM2MzY3ZGY3ZTBkMDE2MDY4NmJlMDE1Mg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjE0YzY2NjA5YjBlNDBiODI4N2VkMmFkNDZjYmI5OGEyYzEyNjA2ZjdlMjk2
-    YzljNWRkMTlmZTE4N2I2YzIyMmQ4M2UzMGIzYTQzMWIzMzc0MTMzNDJjODEx
-    NzYxODQ4ZmVkMzY1M2M0ZTBlNjY0ZjBmY2Y2Mjg3ODg5YmEzYjE=
+    Yjk5MzlmYjNlZGY4ZWNjOThhZTBjMThjODBhNWNlZmIzZDMyNjJiZTg4M2Fj
+    NDJjZjM0NjBkNmU0YWRhNTM3MzhhOWRhMzlhZWY3MmI1OGNjYTk1OWFiZWNj
+    ZDk2ZGZiMDdiM2ZlOTZiZGE0ZjhlMjRkNmJiMzA0NzAxY2FlZWU=
   data.tar.gz: !binary |-
-    Y2Q2MDJiMjFiMWY5MDg5MjIwMDFjMWNkMWU0YWEyODZlMzIzMWVkNjEzZTNk
-    ZWE1YmQxYjIzODMzNDJjZjA4MjJkY2U3ODRiMmMzNjdiZWI2OTM0Y2FhYWIy
-    YWUxYjcyYjFhMGZlZTQxNjk1ZDE2MWYyNDRiYzRjMzQ5NGZkMWY=
+    ZTM2ZmRkYzZlZWVjYjUxOWZmM2Y4YTYzZWI0NjIyMTMzNzY4YTExM2VhNTVm
+    YWM3NTEzMzk5MGFhNGE4ODAyMGM3NDA2N2ZkNzg1MTYxOWRjN2I5MWQyMTNh
+    MjRjYWVkOGYwNzVhMmE3ZDAwZDlmY2JlOTU2ZTA4ZDMwNDBlZGM=

data/README.md

@@ -1,6 +1,11 @@
 # Google::Scholar
 
-TODO: Write a gem description
+Google Scholar interface. Currently only works for Author searches.
+
+## WARNINGS
+
+This gem restricts its hits to Google Scholar as much as possible, but be forewarned that their page may
+restrict your hits if it starts to hit it too much. There is no built in rate limiter to this gem.
 
 ## Installation
 
@@ -18,7 +23,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Run an author search:
+
+```ruby
+results = Google::Scholar::Base.author_search("author name")
+```
+
+Get authors (as an enumerator):
+
+```ruby
+results.authors
+```
+
+Get author's article summaries (as an enumerator):
+
+```ruby
+results.authors.first.articles
+```
+
+## Future Development
+
+- Support for searching articles
+- Support for full articles (what you get when you navigate to an article's full_article_url)
+- Improved documentation
+- Rate limiter?
 
 ## Contributing
 

data/google-scholar.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/terrellt/ruby-google-scholar"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/google/scholar/version.rb

@@ -1,5 +1,5 @@
 module Google
   module Scholar
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-scholar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Trey Terrell
@@ -152,7 +152,7 @@ files:
 - spec/lib/google/scholar/scraper_spec.rb
 - spec/lib/google/scholar_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/terrellt/ruby-google-scholar
 licenses:
 - MIT
 metadata: {}