chess-pub-api-client 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/README.md +19 -10
- data/chess-pub-api-client.gemspec +2 -2
- data/documentation/logo.png +0 -0
- data/lib/chess_pub_api_client/version.rb +1 -1
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 77f1bfdbf725f88a75965f51e03bdbb23439b47d14a021add16841f9592d773b
|
4
|
+
data.tar.gz: bef679c8027156d7afbe4dbeb5103fa3c978a6de39e5a1334eb86a194762678d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a406308ac8687f4dd81d3abb39ab8cf9f201f12494c57b1116a3481672ba9dd72b6a23d6024c84d0280fe64c5abbbe735eb4343559c91c207e00342310a25bf
|
7
|
+
data.tar.gz: f278a55102ebdc8328f5efd82e5032b08016e4ebd36c536d1238e6d79933bb6c69bc4976730cae4aa463a6f087176b01cd319c42b83bbf8a29b42b85e7d207a3
|
data/.gitignore
CHANGED
data/README.md
CHANGED
@@ -1,15 +1,20 @@
|
|
1
|
-
# Chess::Pub::Api
|
2
1
|
|
3
|
-
|
2
|
+
<div align="center">
|
3
|
+
<image width="400" align="center"src="https://raw.githubusercontent.com/chrismaltais/chess-pub-api-client/master/documentation/logo.png"/><br/>
|
4
|
+
</div>
|
4
5
|
|
5
|
-
|
6
|
+
<p align="center">Unofficial Ruby client for the Chess.com Published Data API</p>
|
7
|
+
|
8
|
+
## Overview
|
9
|
+
|
10
|
+
[chess-pub-api-client](https://rubygems.org/gems/chess-pub-api-client) is an unofficial Ruby client for the [Chess.com Published Data REST API](https://www.chess.com/news/view/published-data-api). It's built with zero non-development dependencies to ensure your application remains lightweight.
|
6
11
|
|
7
12
|
## Installation
|
8
13
|
|
9
14
|
Add this line to your application's Gemfile:
|
10
15
|
|
11
16
|
```ruby
|
12
|
-
gem 'chess-pub-api'
|
17
|
+
gem 'chess-pub-api-client'
|
13
18
|
```
|
14
19
|
|
15
20
|
And then execute:
|
@@ -18,21 +23,25 @@ And then execute:
|
|
18
23
|
|
19
24
|
Or install it yourself as:
|
20
25
|
|
21
|
-
$ gem install chess-pub-api
|
26
|
+
$ gem install chess-pub-api-client
|
22
27
|
|
23
28
|
## Usage
|
24
29
|
|
25
|
-
|
30
|
+
Using the client is easy:
|
26
31
|
|
27
|
-
|
32
|
+
```ruby
|
33
|
+
require 'chess-pub-api-client'
|
28
34
|
|
29
|
-
|
35
|
+
# Check if a player is online
|
36
|
+
ChessPubApiClient.get_player_online_status("steezymalteezy") # Returns a hash of the parsed JSON result
|
30
37
|
|
31
|
-
|
38
|
+
# Get a player's current Daily Chess games where it's their turn to move
|
39
|
+
ChessPubApiClient.get_player_current_games_to_move("steezymalteezy") # Returns a hash of the parsed JSON result
|
40
|
+
```
|
32
41
|
|
33
42
|
## Contributing
|
34
43
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
44
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/chrismaltais/chess-pub-api-client.
|
36
45
|
|
37
46
|
## License
|
38
47
|
|
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
|
|
9
9
|
spec.authors = ["Chris Maltais"]
|
10
10
|
spec.email = ["chris.maltais@hotmail.ca"]
|
11
11
|
|
12
|
-
spec.summary = "Unofficial Ruby client for the Chess.com
|
13
|
-
spec.description = "Unofficial Ruby client for Chess.com's
|
12
|
+
spec.summary = "Unofficial Ruby client for the Chess.com Published Data REST API."
|
13
|
+
spec.description = "Unofficial Ruby client for Chess.com's Published Data REST API. Zero dependencies."
|
14
14
|
spec.homepage = "https://github.com/chrismaltais/chess-pub-api"
|
15
15
|
spec.license = "MIT"
|
16
16
|
|
Binary file
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: chess-pub-api-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Chris Maltais
|
@@ -94,7 +94,8 @@ dependencies:
|
|
94
94
|
- - ">="
|
95
95
|
- !ruby/object:Gem::Version
|
96
96
|
version: '0'
|
97
|
-
description: Unofficial Ruby client for Chess.com's
|
97
|
+
description: Unofficial Ruby client for Chess.com's Published Data REST API. Zero
|
98
|
+
dependencies.
|
98
99
|
email:
|
99
100
|
- chris.maltais@hotmail.ca
|
100
101
|
executables: []
|
@@ -111,6 +112,7 @@ files:
|
|
111
112
|
- bin/console
|
112
113
|
- bin/setup
|
113
114
|
- chess-pub-api-client.gemspec
|
115
|
+
- documentation/logo.png
|
114
116
|
- lib/chess_pub_api_client.rb
|
115
117
|
- lib/chess_pub_api_client/chess_pub_api_client.rb
|
116
118
|
- lib/chess_pub_api_client/version.rb
|
@@ -136,5 +138,5 @@ requirements: []
|
|
136
138
|
rubygems_version: 3.0.3
|
137
139
|
signing_key:
|
138
140
|
specification_version: 4
|
139
|
-
summary: Unofficial Ruby client for the Chess.com
|
141
|
+
summary: Unofficial Ruby client for the Chess.com Published Data REST API.
|
140
142
|
test_files: []
|