Ruby client for the Folding@home API
Need more historical data? Try out extreme_overclocking_client
Install and add to Gemfile:
bundle add folding_at_home_clientInstall without bundler:
gem install folding_at_home_client# Fetch count of users
FoldingAtHomeClient::Users.count
# Fetch top users of all-time
FoldingAtHomeClient::Users.top
# Fetch top users from a specific month
FoldingAtHomeClient::Users.top(month: 1, year: 2018)
# Fetch daily users (unique based on name and team_id, not user id)
# Caches the TXT file and limits fetching to every 3 hours
# Optional: filepath, limit, name, order, page, per_page, position, sort_by, team_id
FoldingAtHomeClient::Users.daily
FoldingAtHomeClient::Users.daily(sort_by: :name, order: :desc)
FoldingAtHomeClient::Users.daily(limit: 5)
FoldingAtHomeClient::Users.daily(page: 1, per_page: 5)
FoldingAtHomeClient::Users.daily(name: 'Anonymous')
FoldingAtHomeClient::Users.daily(team_id: 0)
FoldingAtHomeClient::Users.daily(name: 'Anonymous', team_id: 0)
FoldingAtHomeClient::Users.daily(position: 10)
FoldingAtHomeClient::Users.daily(filepath: 'my_daily_user_summary.txt')id = 2
name = "name"
passkey = "passkey"
team_id = 0
# Create a user
# Required: id or name
user = FoldingAtHomeClient::User.new(id: id)
user = FoldingAtHomeClient::User.new(name: name)
user = FoldingAtHomeClient::User.new(id: id, name: name)
# Fetch a user's stats, including teams
# Required: id or name
# Optional: passkey, team_id
user = user.find_by(id: id)
user = user.find_by(name: name)
user = user.find_by(id: id, name: name)
user = user.find_by(id: id, passkey: passkey)
user = user.find_by(id: id, team_id: team_id)
user = user.find_by(id: id, passkey: passkey, team_id: team_id)
# Fetch a user's list of teams
# Note: Suffixed with "_lookup" since teams is a class attribute
# Required: id or name
# Optional: passkey
teams = user.teams_lookup
teams = user.teams_lookup(passkey: passkey)
# Fetch a user's list of contributed projects
# Required: name
projects = user.projects
# Fetch a user's bonus stats
# Required: name
# Optional: passkey
bonuses = user.bonuses
bonuses = user.bonuses(passkey: passkey)# Fetch count of teams
FoldingAtHomeClient::Teams.count
# Fetch top teams from a specific month
FoldingAtHomeClient::Teams.top(month: 1, year: 2018)id = 1
# Fetch a team
# Required: id or name
team = FoldingAtHomeClient::Team.find_by(id: id)
# Fetch a teams's members
# Required: id
members = FoldingAtHomeClient::Team.new(id: id).members# Fetch all projects
FoldingAtHomeClient::Projects.allid = 2968
project = FoldingAtHomeClient::Project.new(id: id)
# Fetch a project
# Required: id
project = project.lookup
# Fetch a project's contributors
# Required: id
contributors = project.contributors
# Fetch a project's description
# Required: description_id
description = project.description# Fetch all descriptions
descriptions = FoldingAtHomeClient::Descriptions.allid = 195
# Fetch a description
# Required: id
description = FoldingAtHomeClient::Description.new(id: id).lookup# Fetch all managers
managers = FoldingAtHomeClient::Managers.allid = 326
# Fetch a manager
# Required: id
manager = FoldingAtHomeClient::Manager.new(id: id).lookup# Fetch all causes
causes = FoldingAtHomeClient::Causes.all# Fetch all GPUs
gpus = FoldingAtHomeClient::GPUs.allvendor = 4318
device = 5
# Fetch a GPUs
# Required: device, vendor
gpu = FoldingAtHomeClient::GPU.find_by(vendor: vendor, device: device)Currently only GET endpoints are supported. It's not exhaustive because some endpoints aren't particularly useful in terms of what they return compared to other endpoints.
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports, feature requests, and pull requests are welcome.