biostars-api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ba1ddcea8f491e08e5e1b830e213368990fd4de
-  data.tar.gz: a14247dffbb10069c5b1aaaa28a11dfe2b33c07f
+  metadata.gz: 96fd9ae3ed4771bfcb5a241ca3d5c0b028bcdc88
+  data.tar.gz: fe29a2a1668be06a183b5e699c14a02c975d8028
 SHA512:
-  metadata.gz: 586ac77c6f9aca06b141e7615c1da4db24d23276ade04b4f2d1289cb3fa789f0db6383b1ffceea8b079f1e4076bac9e3ad25fabf96b45bcfefa934933dc8256e
-  data.tar.gz: eac00ed50f23bdee27aabe090d3bcc2d917df9ef6bb3df4193bb5328d951b11cc9eddecb2d649e9a9711a77374ea8c022b5e2e9a5bb551657a8584aa285867d4
+  metadata.gz: 0955537219b6efa2c53d736e5caffc5e961103b55ddcc464554de57ea7aa966930f32b1cfb591dc8eb4785e550b7ca06e742c80a86fa0272ec050e99d931854b
+  data.tar.gz: a699bfd2619354db49871556e1eaf6855c8848839d4238661101ef6ed28f28847b120ae60a7a9474f7f3a464c6632d7a7b9b627cd0d400a875ec173f21468d76

data/README.md

@@ -1,6 +1,10 @@
-# Biostars::Api   [![Gem Version](https://badge.fury.io/rb/biostars-api.svg)](http://badge.fury.io/rb/biostars-api)    [![Build Status](https://travis-ci.org/arian-amador/biostars-api.svg?style=flat)](https://travis-ci.org/arian-amador/biostars-api)    [![Inline docs ](https://inch-ci.org/github/arian-amador/biostars-api.svg?branch=master)](https://inch-ci.org/github/arian-amador/biostars-api)
+# biostars-api 
 
-A wrapper for the [Biostars.org](https://www.biostars.org/) public API.
+[![Gem Version](https://badge.fury.io/rb/biostars-api.svg)](http://badge.fury.io/rb/biostars-api)    [![Build Status](https://travis-ci.org/arian-amador/biostars-api.svg?style=flat)](https://travis-ci.org/arian-amador/biostars-api)    [![Inline docs ](https://inch-ci.org/github/arian-amador/biostars-api.svg?branch=master)](https://inch-ci.org/github/arian-amador/biostars-api)
+
+A wrapper for the [biostars.org](https://www.biostars.org/) public API.
+
+Biostars focuses on bioinformatics, computational genomics and biological data analysis. 
 
 ## Requirements
 * httparty
@@ -50,7 +54,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/API
+* Rubydoc - http://www.rubydoc.info/github/arian-amador/biostars-api/master
 
 ## Contributing
 

data/biostars-api.gemspec

@@ -1,30 +1,20 @@
 # coding: utf-8
-$:.unshift File.expand_path('../lib', __FILE__)
-require 'biostars/api/version'
+require File.expand_path('../lib/biostars/api/version', __FILE__)
 
 Gem::Specification.new do |spec|
   spec.name          = "biostars-api"
   spec.version       = Biostars::API::VERSION
   spec.authors       = ["Arian Amador"]
   spec.email         = ["arian@arianamador.com"]
-
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
-  end
-
   spec.summary       = %q{Gem wrapping biostars.org public API}
-  spec.description   = %q{Gem wrapping biostars.org public API}
+  spec.description   = spec.description
   spec.homepage      = "https://www.github.com/arian-amador/biostars-api"
   spec.license       = "MIT"
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler', '~> 1.7', '>= 1.7.9'
   spec.add_development_dependency "rake", "~> 10.0"
-  
   spec.add_development_dependency 'minitest', '~> 5.5', '>= 5.5.1'
   spec.add_development_dependency 'minitest-reporters', '~> 1.0', '>= 1.0.11'
   spec.add_development_dependency "shoulda-context", '~> 1.2', '>= 1.2.1'

data/lib/biostars/api/post.rb

@@ -82,6 +82,8 @@ module Biostars
 
       # @return [String] content.
       attr_reader :xhtml
+
+            # Instantiate the Biostars::API::Post.
             def initialize(attributes)
 			attributes.each do |k,v| 
 				instance_variable_set("@#{k}", v) unless v.nil?

data/lib/biostars/api/stats.rb

@@ -39,6 +39,7 @@ module Biostars
       # @return [Fixnum] total number of votes as of the given day/date.
 			attr_reader :votes
 
+			# Instantiate the Biostars::API::Stats.
 			def initialize(attributes)
 				attributes.each do |k,v| 
 					instance_variable_set "@#{k}", v unless v.nil?
@@ -72,54 +73,51 @@ module Biostars
 				end
 			end
 
-			class << self
-
-				# Helper method to look up stats for the prior date.
-				#
-				# @return [Stats] returns a Stats object.
-				def latest
-					find_by_date
-				end
+			# Helper method to look up stats for the prior date.
+			#
+			# @return [Stats] returns a Stats object.
+			def self.latest
+				find_by_date
+			end
 
-				# Statistics as of the Nth day after day-0 (the day of the first ever post).
-				#
-				# @param day [Date] number of days after day-0, a number.
-				# @return [Stats] returns a Stats object.
-				# @raise [Biostars::StatsError] if the day passed is not a valid Fixnum.
-				def find_by_day(day=Date.today.day)
-					raise Biostars::StatsError, "Expecting a Date Object" unless day.is_a? Fixnum
+			# Statistics as of the Nth day after day-0 (the day of the first ever post).
+			#
+			# @param day [Date] number of days after day-0, a number.
+			# @return [Stats] returns a Stats object.
+			# @raise [Biostars::StatsError] if the day passed is not a valid Fixnum.
+			def self.find_by_day(day=Date.today.day)
+				raise Biostars::StatsError, "Expecting a Date Object" unless day.is_a? Fixnum
 
-					find "stats/day/#{day}"
-				end
+				find "stats/day/#{day}"
+			end
 
-				# Statistics as of the given 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 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" % [
-						year,
-						sprintf('%02d', month),
-						sprintf('%02d', day),
-					]
-
-					find url
-				end
+			# Statistics as of the given 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 variables passed are not valid Fixnum
+			def self.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" % [
+					year,
+					sprintf('%02d', month),
+					sprintf('%02d', day),
+				]
+
+				find url
+			end
 
-				private
+			private
 
-					# Used to call the main HTTParty get but we also don't want anyone
-					# other that the class methods to call it.
-					def find(url)
-						attributes = Biostars::API.get(url)
-						attributes ? new(attributes) : raise(Biostars::StatsError)
-					end
-			end
+				# Used to call the main HTTParty get but we also don't want anyone
+				# other that the class methods to call it.
+				def self.find(url)
+					attributes = Biostars::API.get(url)
+					attributes ? new(attributes) : raise(Biostars::StatsError)
+				end
 		end
 	end
 end

data/lib/biostars/api/traffic.rb

@@ -14,6 +14,7 @@ module Biostars
       # @return [Fixnum] current date unix epoch time format.
       attr_reader :timestamp
 
+      # Instantiate the Biostars::API::Traffic.
   		def initialize(attributes)
         attributes.each do |k,v| 
           instance_variable_set "@#{k}", v unless v.nil?

data/lib/biostars/api/user.rb

@@ -23,6 +23,7 @@ module Biostars
 			# @return [Fixnum] the number of votes given by the user.
 			attr_reader :vote_count
 
+			# Instantiate the Biostars::API::User.
 			def initialize(attributes)
 				attributes.each do |k,v| 
 					instance_variable_set "@#{k}", v unless v.nil?

data/lib/biostars/api/version.rb

@@ -1,6 +1,6 @@
 module Biostars
   module API
-  	# Biostars::API Version
-    VERSION = "0.1.3"
+  	# Biostars::API Gem version.
+    VERSION = "0.1.4"
   end
 end

data/lib/biostars/api/vote.rb

@@ -26,6 +26,7 @@ module Biostars
 			# @return [Fixnum] type's identifier for this vote.
 			attr_reader :type_id
 
+			# Instantiate the Biostars::API::Vote.
 			def initialize(attributes)
 				attributes.each do |k,v| 
 					instance_variable_set "@#{k}", v unless v.nil?

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: biostars-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Arian Amador
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
@@ -218,7 +218,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
-description: Gem wrapping biostars.org public API
+description: ''
 email:
 - arian@arianamador.com
 executables: []