zombie_battleground-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fc43e2507e55e1951d7129ce11c504c7e27062a6c0c2157dcc5d05a9519ebe
-  data.tar.gz: '0835fc5e45bb4e62520f3e3a6cee2f26af62f240c0d525145855b2cbe20a2617'
+  metadata.gz: 61f183b1671a060cdcd4d32e604ecd8518691d1c160d6158a862a8c82a61c0ab
+  data.tar.gz: 38b45a305a6d3b7027165d5d46f607c26b2e4b224db45a45f8c0e0aeb79c9676
 SHA512:
-  metadata.gz: d8a1ee09f560723cf30110e2db8bde35e6aca2d0f9eae438e457d6f7a0c0706cb3c716bba18731f77403e1da2d05cf5c24dc2793535081f4eb11770f4adef30d
-  data.tar.gz: bf055508b468c05c5310af9c3037faed74695beb7fd84e98bf65d2f7cb3d42dc96bd0df1c84e10b0339428287a006ccb5873902bd2cb141dac0a552000b37e9b
+  metadata.gz: 776bc9c496ec436ef5f8a94ef94fbd69f17783fbfc3fb20066d42dd23eec3d0b2cf80dc20f17bbb973ebe2d84047bd8730afb5632b181316bedc26169264805d
+  data.tar.gz: 236108055ed121d07da4073bd54870b934b066e4ac49581920d9a45a3a103a4d2912c3b6380c4b39117862dc97962bf30da7260eda358ff14d511d8ab50545bd

data/Gemfile.lock

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

data/README.md

@@ -4,6 +4,8 @@
 [![Build Status](https://travis-ci.org/watmin/zombie_battleground-api.svg?branch=master)](https://travis-ci.org/watmin/zombie_battleground-api)
 [![Coverage Status](https://coveralls.io/repos/github/watmin/zombie_battleground-api/badge.svg?branch=master)](https://coveralls.io/github/watmin/zombie_battleground-api?branch=master)
 
+[Challenge Accepted](https://medium.com/loom-network/https-medium-com-loom-network-introducing-zombie-battleground-public-api-600-pack-giveaway-859fea0dc406)
+
 Ruby implementation of the Public API for Zombie Battleground
 
 ## Installation
@@ -24,7 +26,7 @@ Or install it yourself as:
 
 ## Usage
 
-See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.3.0).
+See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.4.0).
 Every API call returns a response object that contains a complete modeled Ruby object of the response.
 
 Use the singleton class `ZombieBattleground::Api`

data/lib/zombie_battleground/api/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+##
+# ZombieBattleground namespace
+module ZombieBattleground
+  class Api
+    ##
+    # Max items per page
+    PAGE_MAX = 100
+  end
+end

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

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require 'zombie_battleground/api/constants'
+
+module ZombieBattleground
+  class Api
+    ##
+    #  API Extensions
+    module Extensions
+      ##
+      # API Extensions for Cards
+      module Cards
+        ##
+        # Fetches all available cards
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.all_cards
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def all_cards(**args)
+          page = 1
+          cards = []
+
+          loop do
+            response = @client.cards_request(args.merge(page: page))
+            cards.push(*response.cards)
+            break if response.cards.size < PAGE_MAX
+            # :nocov:
+            page += 1
+            # :nocov:
+          end
+
+          cards
+        end
+
+        ##
+        # Fetches all available cards
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.all_cards
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def card_kinds
+          all_cards.map(&:kind).uniq
+        end
+
+        ##
+        # Fetches all card ranks
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   ranks = ZombieBattleground::Api.card_ranks
+        #   # => [String]
+        #
+        # @api public
+        def card_ranks
+          all_cards.map(&:rank).uniq
+        end
+
+        ##
+        # Fetches all card sets
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   sets = ZombieBattleground::Api.card_sets
+        #   # => [String]
+        #
+        # @api public
+        def card_sets
+          all_cards.map(&:set).uniq
+        end
+
+        ##
+        # Fetches all card types
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   types = ZombieBattleground::Api.card_types
+        #   # => [String]
+        #
+        # @api public
+        def card_types
+          all_cards.map(&:type).uniq
+        end
+
+        ##
+        # Fetches all card rarities
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   rarities = ZombieBattleground::Api.card_rarities
+        #   # => [String]
+        #
+        # @api public
+        def card_rarities
+          all_cards.map(&:rarity).uniq
+        end
+
+        ##
+        # Fetches all cards with selected kind
+        #
+        # @param kind [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.cards_by_kind(kind: "SPELL")
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def cards_by_kind(kind:)
+          all_cards(kind: kind)
+        end
+
+        ##
+        # Fetches all cards with selected rank
+        #
+        # @param rank [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.cards_by_rank(rank: "COMMANDER")
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def cards_by_rank(rank:)
+          all_cards(rank: rank)
+        end
+
+        ##
+        # Fetches all cards with selected set
+        #
+        # @param set [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.cards_by_set(set: "WATER")
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def cards_by_set(set:)
+          all_cards(set: set)
+        end
+
+        ##
+        # Fetches all cards with selected type
+        #
+        # @param type [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.cards_by_type(type: "WALKER")
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def cards_by_type(type:)
+          all_cards(type: type)
+        end
+
+        ##
+        # Fetches all cards with selected rarity
+        #
+        # @param rarity [String]
+        #
+        # @return [Array<ZombieBattleground::Api::Models::Card>]
+        #
+        # @example
+        #   cards = ZombieBattleground::Api.cards_by_rarity(rarity: "")
+        #   # => [ZombieBattleground::Api::Models::Card]
+        #
+        # @api public
+        def cards_by_rarity(rarity:)
+          all_cards(rarity: rarity)
+        end
+      end
+    end
+  end
+end

data/lib/zombie_battleground/api/extensions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'zombie_battleground/api/extensions/cards'
+
+module ZombieBattleground
+  class Api
+    ##
+    #  API Extensions
+    module Extensions
+      include ZombieBattleground::Api::Extensions::Cards
+    end
+  end
+end

data/lib/zombie_battleground/api/version.rb

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

data/lib/zombie_battleground/api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'zombie_battleground/api/client'
+require 'zombie_battleground/api/extensions'
 
 module ZombieBattleground
   ##
@@ -9,6 +10,8 @@ module ZombieBattleground
     @client = ZombieBattleground::Api::Client.new
 
     class << self
+      include ZombieBattleground::Api::Extensions
+
       ##
       # Queries for Decks and returns a modeled response
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zombie_battleground-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John Shields
@@ -244,7 +244,10 @@ files:
 - docker-compose.yml
 - lib/zombie_battleground/api.rb
 - lib/zombie_battleground/api/client.rb
+- lib/zombie_battleground/api/constants.rb
 - lib/zombie_battleground/api/errors.rb
+- lib/zombie_battleground/api/extensions.rb
+- lib/zombie_battleground/api/extensions/cards.rb
 - lib/zombie_battleground/api/models/card.rb
 - lib/zombie_battleground/api/models/deck.rb
 - lib/zombie_battleground/api/models/match.rb