chess-pub-api-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb494ae55e361cbe76ed8c75df7932e48361176e2982b282502b64c9a2b87df2
-  data.tar.gz: e890053f14953ccac60bf2c028abe2434ab20d37e7a1bec55f59d9efaefb0fe8
+  metadata.gz: 77f1bfdbf725f88a75965f51e03bdbb23439b47d14a021add16841f9592d773b
+  data.tar.gz: bef679c8027156d7afbe4dbeb5103fa3c978a6de39e5a1334eb86a194762678d
 SHA512:
-  metadata.gz: 62c06bb789f50d69120f91a8752784c6a78e3c3b1475d15210a37f4cbcd6bdd2e4a805d00dc99fc6dc8de8ba30fa42cee6c973a806f0622264db2f6ecab5f6c9
-  data.tar.gz: c52189b1bdf4e1a8a9e8db046c08538df2b35e62f2d99a5888d24327cad6ef5e6d964dbd65bf599a9e0cbee7145b146aed77d49382a89e877aa00e90c06b2737
+  metadata.gz: 4a406308ac8687f4dd81d3abb39ab8cf9f201f12494c57b1116a3481672ba9dd72b6a23d6024c84d0280fe64c5abbbe735eb4343559c91c207e00342310a25bf
+  data.tar.gz: f278a55102ebdc8328f5efd82e5032b08016e4ebd36c536d1238e6d79933bb6c69bc4976730cae4aa463a6f087176b01cd319c42b83bbf8a29b42b85e7d207a3

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /vendor/*
+*.gem

data/README.md

@@ -1,15 +1,20 @@
-# Chess::Pub::Api
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chess/pub_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+<div align="center">
+    <image width="400" align="center"src="https://raw.githubusercontent.com/chrismaltais/chess-pub-api-client/master/documentation/logo.png"/><br/>
+</div>
 
-TODO: Delete this and the text above, and describe your gem
+<p align="center">Unofficial Ruby client for the Chess.com Published Data API</p>
+
+## Overview
+
+[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.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'chess-pub-api'
+gem 'chess-pub-api-client'
 ```
 
 And then execute:
@@ -18,21 +23,25 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install chess-pub-api
+    $ gem install chess-pub-api-client
 
 ## Usage
 
-TODO: Write usage instructions here
+Using the client is easy:
 
-## Development
+```ruby
+require 'chess-pub-api-client'
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Check if a player is online
+ChessPubApiClient.get_player_online_status("steezymalteezy") # Returns a hash of the parsed JSON result
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# 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/[USERNAME]/chess-pub-api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrismaltais/chess-pub-api-client.
 
 ## License
 

data/chess-pub-api-client.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chris Maltais"]
   spec.email         = ["chris.maltais@hotmail.ca"]
 
-  spec.summary       = "Unofficial Ruby client for the Chess.com Public Data REST API."
-  spec.description   = "Unofficial Ruby client for Chess.com's Public Data REST API. Zero dependencies."
+  spec.summary       = "Unofficial Ruby client for the Chess.com Published Data REST API."
+  spec.description   = "Unofficial Ruby client for Chess.com's Published Data REST API. Zero dependencies."
   spec.homepage      = "https://github.com/chrismaltais/chess-pub-api"
   spec.license       = "MIT"
 

data/lib/chess_pub_api_client/version.rb

@@ -1,4 +1,4 @@
 module ChessPubApiClient
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chess-pub-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Maltais
@@ -94,7 +94,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Unofficial Ruby client for Chess.com's Public Data REST API. Zero dependencies.
+description: Unofficial Ruby client for Chess.com's Published Data REST API. Zero
+  dependencies.
 email:
 - chris.maltais@hotmail.ca
 executables: []
@@ -111,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - chess-pub-api-client.gemspec
+- documentation/logo.png
 - lib/chess_pub_api_client.rb
 - lib/chess_pub_api_client/chess_pub_api_client.rb
 - lib/chess_pub_api_client/version.rb
@@ -136,5 +138,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Unofficial Ruby client for the Chess.com Public Data REST API.
+summary: Unofficial Ruby client for the Chess.com Published Data REST API.
 test_files: []