zombie_battleground-api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f183b1671a060cdcd4d32e604ecd8518691d1c160d6158a862a8c82a61c0ab
-  data.tar.gz: 38b45a305a6d3b7027165d5d46f607c26b2e4b224db45a45f8c0e0aeb79c9676
+  metadata.gz: 11df9750d399535b01b26d87d68a25297f330f51dd0e347d31d1c0dbda43a032
+  data.tar.gz: 0c293f96164be6fe65eb072e56d7ff23d616d8e7f4d421a3e182cec36319ddaa
 SHA512:
-  metadata.gz: 776bc9c496ec436ef5f8a94ef94fbd69f17783fbfc3fb20066d42dd23eec3d0b2cf80dc20f17bbb973ebe2d84047bd8730afb5632b181316bedc26169264805d
-  data.tar.gz: 236108055ed121d07da4073bd54870b934b066e4ac49581920d9a45a3a103a4d2912c3b6380c4b39117862dc97962bf30da7260eda358ff14d511d8ab50545bd
+  metadata.gz: 727b93807b5a4ff030c2cb9877a38390a1c6dccb2b4a0a322348502fb9284fbaf593f1f3ee64e59ad7fd203d70ca41843c1e8f6974e9f49bc6ba67fdf153b663
+  data.tar.gz: 0f50bf8ea5c3af8523941303405486d23851c7e4b0f72c4d346a4f8d5f72afb199e78aacf63ff492597dfa88a5fc3edc2f1eab115ef9c07748a1305f55def3c2

data/Gemfile.lock

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

data/README.md

@@ -26,10 +26,10 @@ Or install it yourself as:
 
 ## Usage
 
-See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.4.0).
+See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.4.1).
 Every API call returns a response object that contains a complete modeled Ruby object of the response.
 
-Use the singleton class `ZombieBattleground::Api`
+Use the singleton class `ZombieBattleground::Api`. The singleton has additional extentions, the client implements the public API as is.
 
 ```ruby
 require 'zombie_battleground/api'
@@ -50,9 +50,6 @@ client = ZombieBattleground::Api::Client.new
 
 client.decks_request(limit: 1)
 # => ZombieBattleground::Api::Responses::GetDecksResponse
-
-client.decks(limit: 1)
-# => [ZombieBattleground::Api::Models::Decks]
 ```
 
 ## Development

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

@@ -4,46 +4,59 @@ require 'zombie_battleground/api/constants'
 
 module ZombieBattleground
   class Api
-    ##
-    #  API Extensions
     module Extensions
       ##
       # API Extensions for Cards
       module Cards
         ##
-        # Fetches all available cards
+        # Returns an enumerator for all available cards, accepts a block for yields
         #
-        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        # @return [Enumerator]
         #
-        # @example
-        #   cards = ZombieBattleground::Api.all_cards
+        # @example Get an enumerator for the cards
+        #   ZombieBattleground::Api.all_cards
+        #   # => Enumerator
+        #
+        # @example Dump all cards as an array
+        #   ZombieBattleground::Api.all_cards.to_a
         #   # => [ZombieBattleground::Api::Models::Card]
         #
+        # @example Return the first card
+        #   ZombieBattleground::Api.all_cards.first
+        #   # => ZombieBattleground::Api::Models::Card
+        #
+        # @example Pass it a block
+        #   ZombieBattleground::Api.all_cards do |card|
+        #     do_something_with(card) if card.mould_id == "1" && card.version == "v3"
+        #   end
+        #   # => nil
+        #
         # @api public
         def all_cards(**args)
+          args.delete(:limit) # query as many as possible
+          return enum_for(:all_cards) unless block_given?
+
           page = 1
-          cards = []
 
           loop do
             response = @client.cards_request(args.merge(page: page))
-            cards.push(*response.cards)
+            response.cards.each { |card| yield card }
+
             break if response.cards.size < PAGE_MAX
             # :nocov:
             page += 1
             # :nocov:
           end
-
-          cards
         end
 
         ##
-        # Fetches all available cards
+        # Fetches all card kinds
         #
-        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        # @return [Array<String>]
         #
         # @example
-        #   cards = ZombieBattleground::Api.all_cards
-        #   # => [ZombieBattleground::Api::Models::Card]
+        #   cards = ZombieBattleground::Api.card_kinds
+        #   # => [String]
         #
         # @api public
         def card_kinds
@@ -119,7 +132,7 @@ module ZombieBattleground
         #
         # @api public
         def cards_by_kind(kind:)
-          all_cards(kind: kind)
+          all_cards(kind: kind).to_a
         end
 
         ##
@@ -135,7 +148,7 @@ module ZombieBattleground
         #
         # @api public
         def cards_by_rank(rank:)
-          all_cards(rank: rank)
+          all_cards(rank: rank).to_a
         end
 
         ##
@@ -151,7 +164,7 @@ module ZombieBattleground
         #
         # @api public
         def cards_by_set(set:)
-          all_cards(set: set)
+          all_cards(set: set).to_a
         end
 
         ##
@@ -167,7 +180,7 @@ module ZombieBattleground
         #
         # @api public
         def cards_by_type(type:)
-          all_cards(type: type)
+          all_cards(type: type).to_a
         end
 
         ##
@@ -183,7 +196,7 @@ module ZombieBattleground
         #
         # @api public
         def cards_by_rarity(rarity:)
-          all_cards(rarity: rarity)
+          all_cards(rarity: rarity).to_a
         end
       end
     end

data/lib/zombie_battleground/api/version.rb

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

data/lib/zombie_battleground/api.rb

@@ -59,7 +59,7 @@ module ZombieBattleground
       #
       # @api public
       def decks(**args)
-        @client.decks_request(**args).decks
+        decks_request(**args).decks
       end
 
       ##
@@ -91,7 +91,7 @@ module ZombieBattleground
       #
       # @api public
       def deck(**args)
-        @client.deck_request(**args).deck
+        deck_request(**args).deck
       end
 
       ##
@@ -137,7 +137,7 @@ module ZombieBattleground
       #
       # @api public
       def matches(**args)
-        @client.matches_request(**args).matches
+        matches_request(**args).matches
       end
 
       ##
@@ -169,7 +169,7 @@ module ZombieBattleground
       #
       # @api public
       def match(**args)
-        @client.match_request(**args).match
+        match_request(**args).match
       end
 
       ##
@@ -227,7 +227,7 @@ module ZombieBattleground
       #
       # @api public
       def cards(**args)
-        @client.cards_request(**args).cards
+        cards_request(**args).cards
       end
 
       ##
@@ -261,7 +261,7 @@ module ZombieBattleground
       #
       # @api public
       def card(**args)
-        @client.card_request(**args).card
+        card_request(**args).card
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zombie_battleground-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - John Shields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -236,7 +236,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 John Shields
-
-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.