No commit activity in last 3 years
No release in over 3 years
Unofficial Ruby client for Chess.com's Published Data REST API. Zero dependencies.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.17
~> 5.0
>= 0
~> 10.0
~> 6.0.0
 Project Readme


Unofficial Ruby client for the Chess.com Published Data API

Overview

HitCount

chess-pub-api-client is an unofficial Ruby client for the Chess.com Published Data REST API. It's built with zero non-development dependencies to ensure your application remains lightweight.

Installation

Add this line to your application's Gemfile:

gem 'chess-pub-api-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chess-pub-api-client

Usage

Using the client is easy:

require 'chess-pub-api-client'

# Check if a player is online
ChessPubApiClient.get_player_online_status("steezymalteezy") # Returns a hash of the parsed JSON result

# Get a player's current Daily Chess games where it's their turn to move
ChessPubApiClient.get_player_current_games_to_move("steezymalteezy") # Returns a hash of the parsed JSON result

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chrismaltais/chess-pub-api-client.

License

The gem is available as open source under the terms of the MIT License.