zombie_battleground-api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eed5214567ac570ecbdfcbeedc8269cd6ccb7b4b9a1478f319ef27a2e67ba8e
-  data.tar.gz: 92782a7faa90816774764b2d70f078d0f9e3c2a1d30f1c29253030935900d130
+  metadata.gz: 430fd528262b48c3e7957823bb13172e5f88e0055730681347f791317f748c78
+  data.tar.gz: 1b8c3e16c7a49bbb8c52844d1365ecdd22dc5e0e30f26b5dc5758642bd57b64a
 SHA512:
-  metadata.gz: 4b397cee1af935eb4f24084c325bd96cca10ffbeee7916611446057c88497d52c6d35c8a39648ec5292da05e6eea65c74d1414a9b86dbefe177db43656e13d27
-  data.tar.gz: '09ee97e39b13d6dd8e52811d9083c619e6e70a78b00514eb2d2b5c940d85b54bb2971d97f260d51e47fe27ac9f4bca193cb839d8220a5caa08b9cb8a009585f1'
+  metadata.gz: 0527fe9ff2693c3d9248ae10289cca07cd2f65419e30d3c9e85e7221868996915d48d53c5219cbffba9054d1cad82002f7df962c65379f048ada2e563188156e
+  data.tar.gz: 486b8abf7f16a582291e98ec174af67a8a7da4e674f0e9d4faebd8d49d3ebf0a2843b5f3fa2c439847768dd1b1fad9cb90d7c52c2cdac80ddf389e7dd34ca834

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zombie_battleground-api (0.5.0)
+    zombie_battleground-api (0.5.1)
       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.5.0).
+See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.5.1).
 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.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'zombie_battleground/api/extensions/cards'
+require 'zombie_battleground/api/extensions/decks'
 
 module ZombieBattleground
   class Api
@@ -8,6 +9,7 @@ module ZombieBattleground
     #  API Extensions
     module Extensions
       include ZombieBattleground::Api::Extensions::Cards
+      include ZombieBattleground::Api::Extensions::Decks
     end
   end
 end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'zombie_battleground/api/constants'
+
+module ZombieBattleground
+  class Api
+    module Extensions
+      ##
+      # API Extensions for Decks
+      module Decks
+        ##
+        # Returns an enumerator for all available decks, accepts a block for yields
+        #
+        # @return [Enumerator]
+        #
+        # @example Get an enumerator for the decks
+        #   ZombieBattleground::Api.all_decks
+        #   # => Enumerator
+        #
+        # @example Dump all decks as an array
+        #   ZombieBattleground::Api.all_decks.to_a
+        #   # => [ZombieBattleground::Api::Models::Deck]
+        #
+        # @example Return the first deck
+        #   ZombieBattleground::Api.all_decks.first
+        #   # => ZombieBattleground::Api::Models::Deck
+        #
+        # @example Pass it a block
+        #   ZombieBattleground::Api.all_decks do |deck|
+        #     do_something_with(deck) if deck.id == 1
+        #   end
+        #   # => nil
+        #
+        # @api public
+        def all_decks(**args)
+          args.delete(:limit) # query as many as possible
+          return enum_for(:all_decks, args) unless block_given?
+
+          page = 1
+
+          loop do
+            response = @client.decks_request(args.merge(page: page))
+            response.decks.each { |deck| yield deck }
+
+            break if response.decks_count < PAGE_MAX
+            # :nocov:
+            page += 1
+            # :nocov:
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zombie_battleground/api/responses/get_decks_response.rb

@@ -60,11 +60,23 @@ module ZombieBattleground
         # @return [Array<ZombieBattleground::Api::Models::Deck>]
         #
         # @example
-        #   response.deck #=> [ZombieBattleground::Api::Models::Deck]
+        #   response.decks #=> [ZombieBattleground::Api::Models::Deck]
         #
         # @api public
         attr_reader :decks
 
+        ##
+        # @!attribute [r] decks_count
+        # the deck found for the page and limit
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   response.decks_count #=> 1
+        #
+        # @api public
+        attr_reader :decks_count
+
         ##
         # @!attribute [a] remove_invalid
         # flag to remove objects in response that are invalid during validation
@@ -99,6 +111,9 @@ module ZombieBattleground
 
           JSON.parse(response.body).each do |key, value|
             if key == 'decks'
+              # Keep the API response count, it will differ when invalid decks are stripped
+              @decks_count = value.size
+
               instance_variable_set(
                 "@#{key}".to_sym, value.map { |deck| ZombieBattleground::Api::Models::Deck.new(deck) }
               )

data/lib/zombie_battleground/api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zombie_battleground-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - John Shields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -248,6 +248,7 @@ files:
 - lib/zombie_battleground/api/extensions.rb
 - lib/zombie_battleground/api/extensions/cards.rb
 - lib/zombie_battleground/api/extensions/cards.yml
+- lib/zombie_battleground/api/extensions/decks.rb
 - lib/zombie_battleground/api/models/card.rb
 - lib/zombie_battleground/api/models/deck.rb
 - lib/zombie_battleground/api/models/match.rb