chess-pub-api-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb494ae55e361cbe76ed8c75df7932e48361176e2982b282502b64c9a2b87df2
+  data.tar.gz: e890053f14953ccac60bf2c028abe2434ab20d37e7a1bec55f59d9efaefb0fe8
+SHA512:
+  metadata.gz: 62c06bb789f50d69120f91a8752784c6a78e3c3b1475d15210a37f4cbcd6bdd2e4a805d00dc99fc6dc8de8ba30fa42cee6c973a806f0622264db2f6ecab5f6c9
+  data.tar.gz: c52189b1bdf4e1a8a9e8db046c08538df2b35e62f2d99a5888d24327cad6ef5e6d964dbd65bf599a9e0cbee7145b146aed77d49382a89e877aa00e90c06b2737

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/*

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chess-pub-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    chess-pub-api-client (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.4)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    vcr (6.0.0)
+    webmock (3.10.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  chess-pub-api-client!
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  vcr (~> 6.0.0)
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Chris Maltais
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chess-pub-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chess-pub-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chess-pub-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chess/pub_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chess-pub-api-client.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chess_pub_api_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chess-pub-api-client"
+  spec.version       = ChessPubApiClient::VERSION
+  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.homepage      = "https://github.com/chrismaltais/chess-pub-api"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr", "~> 6.0.0"
+  spec.add_development_dependency "webmock"
+end

data/lib/chess_pub_api_client.rb

@@ -0,0 +1,9 @@
+require "chess_pub_api_client/version"
+
+module Chess
+  module PubApi
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+

data/lib/chess_pub_api_client/chess_pub_api_client.rb

@@ -0,0 +1,188 @@
+require 'net/http'
+require 'json'
+
+module ChessPubApiClient
+  class << self
+    def get_player(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_titled_players(title)
+      uri = URI("https://api.chess.com/pub/titled/#{title}")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_stats(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/stats")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+    
+    def get_player_online_status(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/is-online")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_current_games(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/games")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_current_games_to_move(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/games/to-move")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_games_archives(username, year: nil, month: nil)
+      if year && month
+        uri = URI("https://api.chess.com/pub/player/#{username}/games/#{year}/#{month}")
+      else
+        uri = URI("https://api.chess.com/pub/player/#{username}/games/archives")
+      end
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_games_archives_pgn(username, year: nil, month: nil)
+      # TODO: Set appropriate headers required here
+      uri = URI("https://api.chess.com/pub/player/#{username}/games/#{year}/#{month}/pgn")
+      res = Net::HTTP.get_response(uri)
+      case res.code
+      when "200"
+        return res.body
+      else
+        raise StandardError.new("Error. HTTP Status Code: #{res.code}. JSON body: #{res.body}")
+      end
+    end
+
+    def get_player_clubs(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/clubs")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_matches(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/matches")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_player_tournaments(username)
+      uri = URI("https://api.chess.com/pub/player/#{username}/tournaments")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_club(url_id)
+      uri = URI("https://api.chess.com/pub/club/#{url_id}")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_club_members(url_id)
+      uri = URI("https://api.chess.com/pub/club/#{url_id}/members")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_club_matches(url_id)
+      uri = URI("https://api.chess.com/pub/club/#{url_id}/matches")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_tournament(url_id, round: nil, group: nil)
+      if round && group
+        uri = URI("https://api.chess.com/pub/tournament/#{url_id}/#{round}/#{group}")
+      elsif round 
+        uri = URI("https://api.chess.com/pub/tournament/#{url_id}/#{round}")
+      else
+        uri = URI("https://api.chess.com/pub/tournament/#{url_id}")
+      end
+
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_team_match(id, board: nil)
+      if board
+        uri = URI("https://api.chess.com/pub/match/#{id}/#{board}")
+      else
+        uri = URI("https://api.chess.com/pub/match/#{id}")
+      end
+
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_team_live_match(id, board: nil)
+      if board
+        uri = URI("https://api.chess.com/pub/match/live/#{id}/#{board}")
+      else
+        uri = URI("https://api.chess.com/pub/match/live/#{id}")
+      end
+      
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_country(iso)
+      uri = URI("https://api.chess.com/pub/country/#{iso}")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_country_players(iso)
+      uri = URI("https://api.chess.com/pub/country/#{iso}/players")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_country_clubs(iso)
+      uri = URI("https://api.chess.com/pub/country/#{iso}/clubs")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_daily_puzzle
+      uri = URI("https://api.chess.com/pub/puzzle")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_daily_puzzle_random
+      uri = URI("https://api.chess.com/pub/puzzle/random")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+    
+    def get_streamers
+      uri = URI("https://api.chess.com/pub/streamers")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+
+    def get_leaderboards
+      uri = URI("https://api.chess.com/pub/leaderboards")
+      res = Net::HTTP.get_response(uri)
+      handle_response(res)
+    end
+    
+    private
+
+    def handle_response(response)
+      case response.code
+      when "200"
+        return JSON.parse(response.body, symbolize_names: true)
+      else
+        raise StandardError.new("Error. HTTP Status Code: #{response.code}. JSON body: #{response.body}")
+      end
+    end
+  end
+end

data/lib/chess_pub_api_client/version.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: chess-pub-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Maltais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial Ruby client for Chess.com's Public Data REST API. Zero dependencies.
+email:
+- chris.maltais@hotmail.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chess-pub-api-client.gemspec
+- lib/chess_pub_api_client.rb
+- lib/chess_pub_api_client/chess_pub_api_client.rb
+- lib/chess_pub_api_client/version.rb
+homepage: https://github.com/chrismaltais/chess-pub-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby client for the Chess.com Public Data REST API.
+test_files: []