chess_api 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c78e242f2753aa2589aee04b883772c7882bc1236b46ec28162f89dc5aaed645
-  data.tar.gz: dfc8e49eacffee0287293523c52d505191d5f2aa9029ab8115820fe10fa09938
+  metadata.gz: 538fb045fa68b99e68f2a8aa32a020cf260a2f99cfae1161aa4cc138cdbc2953
+  data.tar.gz: fe22288ad461abcfd079c38702e682d08a4e776b5320508af821d242977ffca4
 SHA512:
-  metadata.gz: 201a748355de83873a89f02f21de3212d6539d4f3180fba40c5959436a0b4a228ab8645be65fd37b11593268651569ab7bfd203e5c286e1885d7769324fe8081
-  data.tar.gz: 191a729f1631ac462f6b572423ff704899fb275c9aef66b48aed8c0bc7e971a46a92fd00bf359d70661e5d2b57b4b04955099e7fb1ccee21562a0fd6d28420f5
+  metadata.gz: fd00b6c327fd240e2050741749f9c54677b0fc03cf286c854edc8488da863607e6c364d35098a8a7ca944b976fa9cb8b1b1f863ee14fa4e72e6459d9f78256da
+  data.tar.gz: 1ecdb2f7f4dfccfe753ffb98349f1d7cd32068645b49834570e4b0f0edbe89060d596a67456cf3f80cab7bb58871c95e701010f052eaf58f7932217d0b40dcc7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+# [0.2.1] - 2021-09-06
+
+- Added #monthly_game_archive, returns a `Collection` of `MonthlyGameArchive` objects.
+- Added daily_puzzle#retrieve and daily_puzzle#random
+- Published 0.2.0 by mistake, enjoy 0.2.1 🙂
+
+## [0.1.1] - 2021-09-05
+
 - Fixed bug where #online_status returned `["online", "offline"]` for players who are online.
 
 ## [0.1.0] - 2021-08-29

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chess_api (0.1.0)
+    chess_api (0.2.1)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 

data/README.md

@@ -99,6 +99,51 @@ irb(main):002:0> clubs.data.map { |club| [club.name, club.joined] }
  ["Fiona's Fight Club", 1616428995]]
 ```
 
+### Fetching the monthly game archive links for a player on Chess.com
+```ruby
+irb(main):001:0> result = client.monthly_game_archive.list(username: "ryanjcaldwell")
+=>
+#<ChessApi::Collection:0x0000000153351480
+...
+
+irb(main):002:0> result.data.first.url
+=> "https://api.chess.com/pub/player/ryanjcaldwell/games/2019/03"
+```
+
+### Fetching the Daily Puzzle from Chess.com
+```ruby
+irb(main):001:0> daily_puzzle = client.daily_puzzle.retrieve
+=>
+#<ChessApi::DailyPuzzle:0x000000012d98b218
+...
+
+irb(main):002:0> daily_puzzle.title
+=> "Disconnecting Connection"
+
+irb(main):003:0> daily_puzzle.pgn
+=> "[Result \"*\"]\r\n[FEN \"3rb3/5pk1/2n1pn1p/rp3Pp1/6P1/1P2B2P/2R3BK/R3N3 w - - 0 1\"]\r\n\r\n1.Rxa5 Nxa5 2.Bb6 Rd1 3.Bxa5 *"
+
+irb(main):004:0> daily_puzzle.image
+=> "https://www.chess.com/dynboard?fen=3rb3/5pk1/2n1pn1p/rp3Pp1/6P1/1P2B2P/2R3BK/R3N3%20w%20-%20-%200%201&size=2"
+```
+
+### Fetching a random Daily Puzzle from Chess.com
+```ruby
+irb(main):001:0> random_daily_puzzle = client.daily_puzzle.random
+=>
+#<ChessApi::DailyPuzzle:0x000000014740e5a0
+...
+
+irb(main):002:0> random_daily_puzzle.publish_time
+=> 1306047600
+
+irb(main):003:0> random_daily_puzzle.pgn
+=> "[Date \"????.??.??\"]\r\n[Result \"*\"]\r\n[FEN \"1B6/1p4Rp/p4kp1/8/8/8/Pr4PP/6K1 b - - 0 1\"]\r\n\r\n1...Rb1+ 2. Kf2 Kxg7\r\n*"
+
+irb(main):004:0> random_daily_puzzle.url
+=> "https://www.chess.com/forum/view/daily-puzzles/5222011---eluding-danger"
+```
+
 ## 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.

data/lib/chess_api/client.rb

@@ -19,6 +19,14 @@ module ChessApi
       TitledPlayerResource.new(self)
     end
 
+    def monthly_game_archive
+      MonthlyGameArchiveResource.new(self)
+    end
+
+    def daily_puzzle
+      DailyPuzzleResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = BASE_URL

data/lib/chess_api/input_helpers.rb

@@ -0,0 +1,11 @@
+module ChessApi
+  module InputHelpers
+    def downcased_username
+      @username&.downcase
+    end
+
+    def upcased_title_abbreviation
+      @title_abbreviation&.upcase
+    end
+  end
+end

data/lib/chess_api/objects/daily_puzzle.rb

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

data/lib/chess_api/objects/monthly_game_archive.rb

@@ -0,0 +1,7 @@
+module ChessApi
+  class MonthlyGameArchive < Object
+    def initialize(archive_url)
+      super({url: archive_url})
+    end
+  end
+end

data/lib/chess_api/resources/daily_puzzles.rb

@@ -0,0 +1,15 @@
+module ChessApi
+  class DailyPuzzleResource < Resource
+    def retrieve
+      ChessApi::DailyPuzzle.new(
+        get_request("puzzle").body
+      )
+    end
+
+    def random
+      ChessApi::DailyPuzzle.new(
+        get_request("puzzle/random").body
+      )
+    end
+  end
+end

data/lib/chess_api/resources/monthly_game_archives.rb

@@ -0,0 +1,16 @@
+module ChessApi
+  class MonthlyGameArchiveResource < Resource
+    include InputHelpers
+
+    def list(username:)
+      @username = username
+      result = get_request("player/#{downcased_username}/games/archives")
+
+      Collection.from_response(
+        result,
+        key: "archives",
+        type: ChessApi::MonthlyGameArchive
+      )
+    end
+  end
+end

data/lib/chess_api/resources/players.rb

@@ -1,5 +1,6 @@
 module ChessApi
   class PlayerResource < Resource
+    include InputHelpers
 
     module OnlineStatus
       ONLINE = "online"
@@ -30,11 +31,5 @@ module ChessApi
         type: ChessApi::Club
       )
     end
-
-    private
-
-    def downcased_username
-      @username&.downcase
-    end
   end
 end

data/lib/chess_api/resources/titled_players.rb

@@ -1,8 +1,12 @@
 module ChessApi
   class TitledPlayerResource < Resource
+    include InputHelpers
+
     def with_title(title_abbreviation:)
+      @title_abbreviation = title_abbreviation
+
       Collection.from_response(
-        get_request("titled/#{title_abbreviation&.upcase}"),
+        get_request("titled/#{upcased_title_abbreviation}"),
         key: "players",
         type: ChessApi::TitledPlayer
       )

data/lib/chess_api/version.rb

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

data/lib/chess_api.rb

@@ -4,22 +4,22 @@ 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'
+  autoload :InputHelpers, 'chess_api/input_helpers'
+  autoload :Object, 'chess_api/object'
+  autoload :Resource, 'chess_api/resource'
 
   # Objects
+  autoload :Club, 'chess_api/objects/club'
+  autoload :DailyPuzzle, 'chess_api/objects/daily_puzzle'
+  autoload :MonthlyGameArchive, 'chess_api/objects/monthly_game_archive'
   autoload :Player, 'chess_api/objects/player'
   autoload :TitledPlayer, 'chess_api/objects/titled_player'
-  autoload :Club, 'chess_api/objects/club'
 
   # Resources
+  autoload :DailyPuzzleResource, 'chess_api/resources/daily_puzzles'
+  autoload :MonthlyGameArchiveResource, 'chess_api/resources/monthly_game_archives'
   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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chess_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryan Caldwell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,11 +58,16 @@ files:
 - lib/chess_api/client.rb
 - lib/chess_api/collection.rb
 - lib/chess_api/error.rb
+- lib/chess_api/input_helpers.rb
 - lib/chess_api/object.rb
 - lib/chess_api/objects/club.rb
+- lib/chess_api/objects/daily_puzzle.rb
+- lib/chess_api/objects/monthly_game_archive.rb
 - lib/chess_api/objects/player.rb
 - lib/chess_api/objects/titled_player.rb
 - lib/chess_api/resource.rb
+- lib/chess_api/resources/daily_puzzles.rb
+- lib/chess_api/resources/monthly_game_archives.rb
 - lib/chess_api/resources/players.rb
 - lib/chess_api/resources/titled_players.rb
 - lib/chess_api/version.rb