biostars-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dcc1371156fdb28a3cfbbf68094ac8b4234f158
-  data.tar.gz: 1aaf45aec2a61f9146842411e1ffaa9c1c29f1d0
+  metadata.gz: 1ba1ddcea8f491e08e5e1b830e213368990fd4de
+  data.tar.gz: a14247dffbb10069c5b1aaaa28a11dfe2b33c07f
 SHA512:
-  metadata.gz: e796dc7315ec723f6d631b0890a1014d6ddf6aac37b9733416a5b4849d9b0606d6f2b90cdec0ff65d56d5e4582d114c0de5ac11f0739ca1ece6a947504a474a4
-  data.tar.gz: 5b2787d29bf15756c8b6044c937bf33d1cf6fd117370c2d68e7b6ee65824c9efe12f48386de9a3a0cfa11907456b49427bef4aa4757930d39447f689b2969013
+  metadata.gz: 586ac77c6f9aca06b141e7615c1da4db24d23276ade04b4f2d1289cb3fa789f0db6383b1ffceea8b079f1e4076bac9e3ad25fabf96b45bcfefa934933dc8256e
+  data.tar.gz: eac00ed50f23bdee27aabe090d3bcc2d917df9ef6bb3df4193bb5328d951b11cc9eddecb2d649e9a9711a77374ea8c022b5e2e9a5bb551657a8584aa285867d4

data/README.md

@@ -50,7 +50,7 @@ latest_votes = latest_info.all_votes
 ## Documentation
 
 * API - https://www.biostars.org/info/api/
-* Rubydoc - http://www.rubydoc.info/github/arian-amador/biostars-api
+* Rubydoc - http://www.rubydoc.info/github/arian-amador/biostars-api/API
 
 ## Contributing
 

data/lib/biostars/api.rb

@@ -12,7 +12,14 @@ require "api/user"
 require "api/post"
 require "api/vote"
 
+# API wrapper for https://www.biostars.org public API
+# @see https://www.biostars.org/info/api/
+# @author Arian Amador <arian@arianamador.com>
 module Biostars
+
+  # API wrapper for https://www.biostars.org public API
+  # @see https://www.biostars.org/info/api/
+  # @author Arian Amador <arian@arianamador.com>
   module API
 
     # Used for API requests

data/lib/biostars/api/post.rb

@@ -1,5 +1,8 @@
 module Biostars
   module API
+
+    # General info about a post.
+    # @author Arian Amador <arian@arianamador.com>
     class Post
 
       # @return [Fixnum] number of answers.

data/lib/biostars/api/stats.rb

@@ -1,5 +1,9 @@
 module Biostars
 	module API
+
+		# Statistics as of the Nth day after day-0 (the day of the first ever post) or
+		# statistics as of the given date.
+		# @author Arian Amador <arian@arianamador.com>
 		class Stats
 
       # @return [Fixnum] total number of answers as of the given day/date.
@@ -90,16 +94,18 @@ module Biostars
 
 				# Statistics as of the given date.
 				#
-				# @param date [Date] Date object for specific date.
+				# @param year [Fixnum] year to search for
+				# @param month [Fixnum] month to search for
+				# @param day [Fixnum] day to search for
 				# @return [Stats] returns a Stats object.
-				# @raise [Biostars::StatsError] if the date passed is not a valid Date.
-				def find_by_date(date=Date.today-1)
-					raise Biostars::StatsError unless date.is_a? Date
+				# @raise [Biostars::StatsError] if the variables passed are not valid Fixnum
+				def find_by_date(year=Date.today.year, month=Date.today.month, day=(Date.today.day-1))
+					raise Biostars::StatsError unless year.is_a?(Fixnum) || month.is_a?(Fixnum) || day.is_a?(Fixnum)
 
 					url = "stats/date/%s/%s/%s" % [
-						date.year,
-						sprintf('%02d', date.month),
-						sprintf('%02d', date.day),
+						year,
+						sprintf('%02d', month),
+						sprintf('%02d', day),
 					]
 
 					find url

data/lib/biostars/api/traffic.rb

@@ -1,5 +1,8 @@
 module Biostars
 	module API
+
+    # Number of post views over the last 60 min filtered by unique IPs.
+    # @author Arian Amador <arian@arianamador.com>
   	class Traffic
 
       # @return [String] the current date, ISO 8601 format.

data/lib/biostars/api/user.rb

@@ -1,6 +1,10 @@
 module Biostars
 	module API
+
+		# General info about a user.
+		# @author Arian Amador <arian@arianamador.com>
 		class User
+			
 			# @return [String] the date the user joined the website, as the number of days ago
 			attr_reader :date_joined 
 

data/lib/biostars/api/version.rb

@@ -1,6 +1,6 @@
 module Biostars
   module API
   	# Biostars::API Version
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/biostars/api/vote.rb

@@ -1,5 +1,8 @@
 module Biostars
 	module API
+
+		# General info about a vote.
+		# @author Arian Amador <arian@arianamador.com>
 		class Vote
 
 			# @return [String] author name.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biostars-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Arian Amador