chess_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0df6140f4d7090e9b14a2c2475c7e44d72e6691f0f103dab539646e969b37f83
+  data.tar.gz: 5efb7576c73f950267b4bf4dad1f123d2820dd14422cabdcedab767eeceafce7
+SHA512:
+  metadata.gz: 695b30a9d8c428b876ec0bbba0076551717738b78c10fbb41d7c105368aaf0c35feb9336d21e7add9218afa8863c85dc7b9a5aeb8a9ee42269a827626efd61ac
+  data.tar.gz: 8ddfb5dc83fc08edf9ead35c675823dab755daa42c112fcd5d648949a8921be3f42075dff6c32b4719d14d53a50d4ab30433b03975b0a65a1cc7d61713045683

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chess_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    chess_api (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  universal-darwin-20
+
+DEPENDENCIES
+  chess_api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Ryan Caldwell
+
+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,113 @@
+# ChessApi
+
+`chess_api` is a gem that wraps [Chess.com's Published-Data API](https://www.chess.com/news/view/published-data-api).
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chess_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chess_api
+
+## Usage
+
+To interact with the `ChessApi`, you'll first need to create a client object. You have the option of specifying a [Faraday adapter](https://lostisland.github.io/faraday/adapters/).
+
+```ruby
+client = ChessApi::Client.new
+# or
+client = ChessApi::Client.new(adapter: your_adapter_here)
+```
+
+From there, you'll be able to perform several operations:
+
+### Fetch a player on Chess.com by username
+
+```ruby
+irb(main):018:0> player = client.player.retrieve(username: "GothamChess")
+=>
+#<ChessApi::Player:0x000000013bc41198
+...
+
+irb(main):019:0> player.username
+=> "gothamchess"
+
+irb(main):020:0> player.title
+=> "IM"
+
+irb(main):021:0> player.is_streamer
+=> true
+
+irb(main):022:0> player.twitch_url
+=> "https://twitch.tv/GothamChess"
+```
+
+As you can see in the example above, you can access the fields returned by the Chess.com API through standard Ruby method syntax.
+
+### Fetching a list of players with a particular title on Chess.com
+
+```ruby
+irb(main):001:0> client.titled_player.with_title(title_abbreviation: "WGM")
+=>
+#<ChessApi::Collection:0x000000013ecc78d0
+ @data=
+  [#<ChessApi::TitledPlayer:0x000000013f175d78 @attributes=#<OpenStruct username="abrahamyan-la">>,
+   #<ChessApi::TitledPlayer:0x000000013f175620 @attributes=#<OpenStruct username="adriananikolova">>,
+   #<ChessApi::TitledPlayer:0x000000013f175260 @attributes=#<OpenStruct username="advantagelucy">>,
+   #<ChessApi::TitledPlayer:0x000000013f174ec8 @attributes=#<OpenStruct username="ahachess">>,
+   ...
+  ]
+```
+
+### Fetching a player's online status on Chess.com
+```ruby
+irb(main):001:0> client.player.online_status(username: "hikaru")
+=> false
+
+irb(main):002:0> client.player.online_status(username: "ryanjcaldwell")
+=> true
+```
+
+### Fetching the clubs that a player belongs to on Chess.com
+```ruby
+irb(main):001:0> clubs = client.player.clubs(username: "GothamChess")
+=>
+#<ChessApi::Collection:0x000000015dbe5998
+...
+
+irb(main):002:0> clubs.data.map { |club| [club.name, club.joined] }
+=>
+[["Chess.comTV", 1533262149],
+ ["Hikaru Nakamura Fan Club", 1547248727],
+ ["Chess.com Beta", 1572489771],
+ ["PRO Chess League", 1547048660],
+ ["Streamers", 1533671931],
+ ["4 Player Chess", 1533746676],
+ ["Gotham's Mob", 1528247350],
+ ["Arena Kings Championship Season 5", 1575824630],
+ ["Marshall Chess Club Official - Match Team", 1587681476],
+ ["Fiona's Fight Club", 1616428995]]
+```
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RyanJamesCaldwell/chess_api.
+
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "chess_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
+
+client = ChessApi::Client.new
+
+puts
+puts "We've created a 'client' variable as a ChessApi::Client."
+puts
+
+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/lib/chess_api/client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module ChessApi
+  class Client
+    BASE_URL = 'https://api.chess.com/pub/'
+
+    def initialize(adapter: Faraday.default_adapter)
+      @adapter = adapter
+    end
+
+    def player
+      PlayerResource.new(self)
+    end
+
+    def titled_player
+      TitledPlayerResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter @adapter
+      end
+    end
+  end
+end

data/lib/chess_api/collection.rb

@@ -0,0 +1,16 @@
+module ChessApi
+  class Collection
+    attr_reader :data
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map { |attrs| type.new(attrs) }
+      )
+    end
+
+    def initialize(data:)
+      @data = data
+    end
+  end
+end

data/lib/chess_api/error.rb

@@ -0,0 +1,3 @@
+module ChessApi
+  class Error < StandardError; end
+end

data/lib/chess_api/object.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+
+module ChessApi
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block) 
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      true
+    end
+  end
+end

data/lib/chess_api/objects/club.rb

@@ -0,0 +1,4 @@
+module ChessApi
+  class Club < Object
+  end
+end

data/lib/chess_api/objects/player.rb

@@ -0,0 +1,7 @@
+module ChessApi
+  class Player < Object
+    def self.from_response(response)
+      new(response.body)
+    end
+  end
+end

data/lib/chess_api/objects/titled_player.rb

@@ -0,0 +1,7 @@
+module ChessApi
+  class TitledPlayer < Object
+    def initialize(name)
+      super({username: name})
+    end
+  end
+end

data/lib/chess_api/resource.rb

@@ -0,0 +1,21 @@
+module ChessApi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(endpoint)
+      handle_response(client.connection.get(endpoint))
+    end
+
+    def handle_response(response)
+      raise ChessApi::Error, "An error happened while making your request" unless response.success?
+
+      response
+    end
+  end
+end

data/lib/chess_api/resources/players.rb

@@ -0,0 +1,40 @@
+module ChessApi
+  class PlayerResource < Resource
+
+    module OnlineStatus
+      ONLINE = "online",
+      OFFLINE = "offline"
+    end
+
+    def retrieve(username:)
+      @username = username
+
+      ChessApi::Player.new(
+        get_request("player/#{downcased_username}").body
+      )
+    end
+
+    def online_status(username:)
+      @username = username
+      is_online = get_request("player/#{downcased_username}/is-online").body["online"]
+
+      is_online ? OnlineStatus::ONLINE : OnlineStatus::OFFLINE
+    end
+
+    def clubs(username:)
+      @username = username
+
+      ChessApi::Collection.from_response(
+        get_request("player/#{downcased_username}/clubs"),
+        key: "clubs",
+        type: ChessApi::Club
+      )
+    end
+
+    private
+
+    def downcased_username
+      @username&.downcase
+    end
+  end
+end

data/lib/chess_api/resources/titled_players.rb

@@ -0,0 +1,11 @@
+module ChessApi
+  class TitledPlayerResource < Resource
+    def with_title(title_abbreviation:)
+      Collection.from_response(
+        get_request("titled/#{title_abbreviation&.upcase}"),
+        key: "players",
+        type: ChessApi::TitledPlayer
+      )
+    end
+  end
+end

data/lib/chess_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChessApi
+  VERSION = "0.1.0"
+end

data/lib/chess_api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'chess_api/version'
+
+module ChessApi
+  autoload :Client, 'chess_api/client'
+  autoload :Resource, 'chess_api/resource'
+  autoload :Object, 'chess_api/object'
+  autoload :Collection, 'chess_api/collection'
+  autoload :Error, 'chess_api/error'
+
+  # Objects
+  autoload :Player, 'chess_api/objects/player'
+  autoload :TitledPlayer, 'chess_api/objects/titled_player'
+  autoload :Club, 'chess_api/objects/club'
+
+  # Resources
+  autoload :PlayerResource, 'chess_api/resources/players'
+  autoload :TitledPlayerResource, 'chess_api/resources/titled_players'
+
+  def self.build_object(data, klass)
+    return data unless data.is_a?(Hash)
+    klass.new(data)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: chess_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Caldwell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: chess_api is a gem that wraps the Chess.com API.
+email:
+- ryanjcaldwell4@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/chess_api.rb
+- lib/chess_api/client.rb
+- lib/chess_api/collection.rb
+- lib/chess_api/error.rb
+- lib/chess_api/object.rb
+- lib/chess_api/objects/club.rb
+- lib/chess_api/objects/player.rb
+- lib/chess_api/objects/titled_player.rb
+- lib/chess_api/resource.rb
+- lib/chess_api/resources/players.rb
+- lib/chess_api/resources/titled_players.rb
+- lib/chess_api/version.rb
+homepage: https://github.com/RyanJamesCaldwell/chess_api
+licenses: []
+metadata:
+  homepage_uri: https://github.com/RyanJamesCaldwell/chess_api
+  source_code_uri: https://github.com/RyanJamesCaldwell/chess_api
+  changelog_uri: https://github.com/RyanJamesCaldwell/chess_api/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: chess_api is a gem that wraps the Chess.com API.
+test_files: []