zombie_battleground-api 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61fa4788a9a18c5b357099bffb1adebb95d9b9369592496f029117bbb29b9eb9
-  data.tar.gz: 679e14c63f4b1f59bc0cf9c21bbe7dae3248a090b4bd914e5f6db760c817e166
+  metadata.gz: 2acaf3416a0f31d86fcff302d3379ed5884176681dcc15e76a98ce5a3747ba42
+  data.tar.gz: f766298c75216df689c2e46f8ec573de5969637d620da1391128f9d3c20ce4ce
 SHA512:
-  metadata.gz: 439b92ff692eaaec9f3d1cd89f96788942ef87af81a443565e7f3419a150a42ae866c316a1b2dddf82d6b82410409ba48ebd6094d24c6d93836ef667d6dbf5cd
-  data.tar.gz: 47a991a46b7cfdcccfd0b55d1d0cf3413cd85a4ce186ac1e7710d7f488243725c33ab8989a356ae46c3fed1486a9093faa5e73ae7df80ab1a52e7ae2ea7a9185
+  metadata.gz: 611408f4ef29cc8c24ac1c905242361cd9675549d0a8a7606560cb204e689117fd4cd42aae0d04abc9b40abb25d6cbe3c82c2e9924e277fa69a1f7a4c6fef201
+  data.tar.gz: 68d8e0552e801dfc97d8490d08dc50b9832c92596a2f43ed35ab36b8fce1aa22766b57b090f46fd0fba81ae39a121b657587f5df5dd025e572205e1f4e98bddd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zombie_battleground-api (0.6.1)
+    zombie_battleground-api (0.7.0)
       activerecord
       faraday
       json

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 
 ## Usage
 
-See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.6.1).
+See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.7.0).
 Every API call returns a response object that contains a complete modeled Ruby object of the response.
 
 Use the singleton class `ZombieBattleground::Api`. The singleton has additional extentions, the client implements the public API as is.

data/lib/zombie_battleground/api/extensions/matches.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'zombie_battleground/api/constants'
+
+module ZombieBattleground
+  class Api
+    module Extensions
+      ##
+      # API Extensions for Matches
+      module Matches
+        ##
+        # Returns an enumerator for all available matches, accepts a block for yields
+        #
+        # @return [Enumerator]
+        #
+        # @example Get an enumerator for the matches
+        #   ZombieBattleground::Api.all_matches
+        #   # => Enumerator
+        #
+        # @example Dump all matches as an array
+        #   ZombieBattleground::Api.all_matches.to_a
+        #   # => [ZombieBattleground::Api::Models::Match]
+        #
+        # @example Return the first matche
+        #   ZombieBattleground::Api.all_matches.first
+        #   # => ZombieBattleground::Api::Models::Match
+        #
+        # @example Pass it a block
+        #   ZombieBattleground::Api.all_matches do |match|
+        #     do_something_with(match) if match.id == 1
+        #   end
+        #   # => nil
+        #
+        # @api public
+        def all_matches(**args)
+          args.delete(:limit) # query as many as possible
+          return enum_for(:all_matches, args) unless block_given?
+
+          page = 1
+
+          loop do
+            response = @client.matches_request(args.merge(page: page))
+            response.matches.each { |match| yield match }
+
+            break if response.matches.size < PAGE_MAX
+            # :nocov:
+            page += 1
+            # :nocov:
+          end
+        end
+
+        ##
+        # Returns the most recently created matches
+        #
+        # @param limit [Integer]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Match>]
+        #
+        # @example
+        #   two_most_recent = ZombieBattleground::Api.recently_created_matches(3)
+        #   # => [ZombieBattleground::Api::Models::Match]
+        #
+        # @api public
+        def recently_created_matches(limit)
+          # the `.sort` calls are dodging coverage?...
+          # :nocov:
+          all_matches.to_a
+                     .sort { |a, b| b.created_at <=> a.created_at }
+                     .first(limit)
+          # :nocov:
+        end
+
+        ##
+        # Returns the most recently updated matches
+        #
+        # @param limit [Integer]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Match>]
+        #
+        # @example
+        #   two_most_recent = ZombieBattleground::Api.recently_updated_matches(3)
+        #   # => [ZombieBattleground::Api::Models::Match]
+        #
+        # @api public
+        def recently_updated_matches(limit)
+          # the `.sort` calls are dodging coverage?...
+          # :nocov:
+          all_matches.to_a
+                     .sort { |a, b| b.updated_at <=> a.updated_at }
+                     .first(limit)
+          # :nocov:
+        end
+
+        ##
+        # Returns the most recently ended matches
+        #
+        # @param limit [Integer]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Match>]
+        #
+        # @example
+        #   two_most_recent = ZombieBattleground::Api.recently_ended_matches(3)
+        #   # => [ZombieBattleground::Api::Models::Match]
+        #
+        # @api public
+        def recently_ended_matches(limit)
+          # the `.sort` calls are dodging coverage?...
+          # :nocov:
+          all_matches.to_a
+                     .select { |match| match.status == 'Ended' }
+                     .sort { |a, b| b.ended_at <=> a.ended_at }
+                     .first(limit)
+          # :nocov:
+        end
+
+        ##
+        # Returns the matches for the player_id
+        #
+        # @param player_id [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Match>]
+        #
+        # @example
+        #   player_matches = ZombieBattleground::Api.matches_for_player("ZombieSlayer_5699")
+        #   # => [ZombieBattleground::Api::Models::Match]
+        #
+        # @api public
+        def matches_for_player(player_id)
+          # the `.sort` calls are dodging coverage?...
+          # :nocov:
+          all_matches(player1_id: player_id)
+            .to_a
+            .push(*all_matches(player2_id: player_id).to_a)
+            .uniq(&:id)
+            .sort { |a, b| b.created_at <=> a.created_at }
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/lib/zombie_battleground/api/extensions.rb

@@ -2,6 +2,7 @@
 
 require 'zombie_battleground/api/extensions/cards'
 require 'zombie_battleground/api/extensions/decks'
+require 'zombie_battleground/api/extensions/matches'
 
 module ZombieBattleground
   class Api
@@ -10,6 +11,7 @@ module ZombieBattleground
     module Extensions
       include ZombieBattleground::Api::Extensions::Cards
       include ZombieBattleground::Api::Extensions::Decks
+      include ZombieBattleground::Api::Extensions::Matches
     end
   end
 end

data/lib/zombie_battleground/api/version.rb

@@ -6,6 +6,6 @@ module ZombieBattleground
   class Api
     ##
     # Verion of the Gem
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zombie_battleground-api
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - John Shields
@@ -250,6 +250,7 @@ files:
 - lib/zombie_battleground/api/extensions/cards.yml
 - lib/zombie_battleground/api/extensions/decks.rb
 - lib/zombie_battleground/api/extensions/decks.yml
+- lib/zombie_battleground/api/extensions/matches.rb
 - lib/zombie_battleground/api/models/card.rb
 - lib/zombie_battleground/api/models/deck.rb
 - lib/zombie_battleground/api/models/match.rb