zombie_battleground-api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cfbd42e3ee6fc99aaa29e852a65df1ce64d76e495d4fd7c7c43c59e6fb52623
-  data.tar.gz: c9070372412198f6585622d88e939f6fdcf5e7071db27304ec3d03fe3f0ad157
+  metadata.gz: 34fc43e2507e55e1951d7129ce11c504c7e27062a6c0c2157dcc5d05a9519ebe
+  data.tar.gz: '0835fc5e45bb4e62520f3e3a6cee2f26af62f240c0d525145855b2cbe20a2617'
 SHA512:
-  metadata.gz: 252c4bd69e05f8b14b4fc549acf1bc180eb463337aa4c9b3ca630b2d257aa13e394eae5fe607481c8e164f47f170c891544f52dcb34d7b85df8e27852f3a0031
-  data.tar.gz: bbe4745ca75119c2d676e64c16d0b268864cf950088db549f0ce98ae1c02bbb62252309bbf00cde579450ef4f2b7ae43339d516c88145cca0a9b2bab19d78b17
+  metadata.gz: d8a1ee09f560723cf30110e2db8bde35e6aca2d0f9eae438e457d6f7a0c0706cb3c716bba18731f77403e1da2d05cf5c24dc2793535081f4eb11770f4adef30d
+  data.tar.gz: bf055508b468c05c5310af9c3037faed74695beb7fd84e98bf65d2f7cb3d42dc96bd0df1c84e10b0339428287a006ccb5873902bd2cb141dac0a552000b37e9b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zombie_battleground-api (0.2.1)
+    zombie_battleground-api (0.3.0)
       activerecord
       faraday
       json
@@ -22,15 +22,26 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     arel (9.0.0)
     ast (2.4.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.4)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.1)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     gem-release (2.0.1)
+    hashdiff (0.3.8)
     i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
@@ -48,6 +59,7 @@ GEM
     pry-doc (1.0.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -72,15 +84,24 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
     thread_safe (0.3.6)
+    tins (1.20.2)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     yard (0.9.18)
     yardstick (0.9.9)
       yard (~> 0.8, >= 0.8.7.2)
@@ -90,11 +111,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  coveralls
   gem-release
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop
   simplecov
+  webmock
   yard
   yardstick
   zombie_battleground-api!

data/README.md

@@ -1,5 +1,9 @@
 # ZombieBattleground::Api
 
+[![Gem Version](https://badge.fury.io/rb/zombie_battleground-api.svg)](https://badge.fury.io/rb/zombie_battleground-api)
+[![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)
+
 Ruby implementation of the Public API for Zombie Battleground
 
 ## Installation
@@ -20,25 +24,33 @@ Or install it yourself as:
 
 ## Usage
 
-See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api).
+See the [API documentation](https://www.rubydoc.info/gems/zombie_battleground-api/0.3.0).
 Every API call returns a response object that contains a complete modeled Ruby object of the response.
 
 Use the singleton class `ZombieBattleground::Api`
 
 ```ruby
-require 'zombie_battleground-api/api'
+require 'zombie_battleground/api'
 
-ZombieBattleground::Api.decks(limit: 1)
+ZombieBattleground::Api.decks_request(limit: 1)
 # => ZombieBattleground::Api::Responses::GetDecksResponse
+
+ZombieBattleground::Api.decks(limit: 1)
+# => [ZombieBattleground::Api::Models::Decks]
 ```
 
 Use the API client directly
 
 ```ruby
-require 'zombie_battleground-api/api/client'
+require 'zombie_battleground/api/client'
 
 client = ZombieBattleground::Api::Client.new
-client.decks(limit: 1) # => ZombieBattleground::Api::Responses::GetDecksResponse
+
+client.decks_request(limit: 1)
+# => ZombieBattleground::Api::Responses::GetDecksResponse
+
+client.decks(limit: 1)
+# => [ZombieBattleground::Api::Models::Decks]
 ```
 
 ## Development

data/lib/zombie_battleground/api/client.rb

@@ -3,17 +3,29 @@
 require 'faraday'
 
 require 'zombie_battleground/api/errors'
+require 'zombie_battleground/api/version'
 
+# decks
 require 'zombie_battleground/api/requests/get_decks_request'
 require 'zombie_battleground/api/responses/get_decks_response'
+
+# deck
 require 'zombie_battleground/api/requests/get_deck_request'
 require 'zombie_battleground/api/responses/get_deck_response'
+
+# matches
 require 'zombie_battleground/api/requests/get_matches_request'
 require 'zombie_battleground/api/responses/get_matches_response'
+
+# match
 require 'zombie_battleground/api/requests/get_match_request'
 require 'zombie_battleground/api/responses/get_match_response'
+
+# cards
 require 'zombie_battleground/api/requests/get_cards_request'
 require 'zombie_battleground/api/responses/get_cards_response'
+
+# card
 require 'zombie_battleground/api/requests/get_card_request'
 require 'zombie_battleground/api/responses/get_card_response'
 
@@ -25,10 +37,11 @@ module ZombieBattleground
       ##
       # Creates a new client
       #
-      # @return [void]
+      # @return [ZombieBattleground::Api::Client]
       #
       # @example
       #   client = ZombieBattleground::Api::Client.new
+      #   # => ZombieBattleground::Api::Client
       #
       # @api public
       def initialize
@@ -55,11 +68,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.decks(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetDecksResponse
+      #   response = client.decks_reuest(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetDecksResponse
       #
       # @api public
-      def decks(**args)
+      def decks_request(**args)
         request = ZombieBattleground::Api::Requests::GetDecksRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?
@@ -81,11 +94,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.deck(id: 1813)
-      #   response # => ZombieBattleground::Api::Responses::GetDeckResponse
+      #   response = client.deck_request(id: 1813)
+      #   # => ZombieBattleground::Api::Responses::GetDeckResponse
       #
       # @api public
-      def deck(**args)
+      def deck_request(**args)
         request = ZombieBattleground::Api::Requests::GetDeckRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?
@@ -114,11 +127,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.matches(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetMatchesResponse
+      #   response = client.matches_request(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetMatchesResponse
       #
       # @api public
-      def matches(**args)
+      def matches_request(**args)
         request = ZombieBattleground::Api::Requests::GetMatchesRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?
@@ -140,11 +153,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.match(id: 1454)
-      #   response # => ZombieBattleground::Api::Responses::GetMatchResponse
+      #   response = client.match_request(id: 1454)
+      #   # => ZombieBattleground::Api::Responses::GetMatchResponse
       #
       # @api public
-      def match(**args)
+      def match_request(**args)
         request = ZombieBattleground::Api::Requests::GetMatchRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?
@@ -179,11 +192,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.cards(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetCardsResponse
+      #   response = client.cards_request(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetCardsResponse
       #
       # @api public
-      def cards(**args)
+      def cards_request(**args)
         request = ZombieBattleground::Api::Requests::GetCardsRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?
@@ -206,11 +219,11 @@ module ZombieBattleground
       # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
       #
       # @example
-      #   response = client.card(mould_id: 2, version: 'v3')
-      #   response # => ZombieBattleground::Api::Responses::GetCardResponse
+      #   response = client.card_request(mould_id: 2, version: 'v3')
+      #   # => ZombieBattleground::Api::Responses::GetCardResponse
       #
       # @api public
-      def card(**args)
+      def card_request(**args)
         request = ZombieBattleground::Api::Requests::GetCardRequest.new
         args.each { |key, val| request.send("#{key}=", val) }
         raise ZombieBattleground::Api::Errors::InvalidInput, request.errors.messages unless request.valid?

data/lib/zombie_battleground/api/requests/get_deck_request.rb

@@ -27,7 +27,7 @@ module ZombieBattleground
         # @api public
         attr_accessor :id
 
-        validate :id_is_a_non_negative_integer
+        validate :id_is_a_non_negative_integer_and_not_null
 
         ##
         # The URI for the endpoint

data/lib/zombie_battleground/api/version.rb

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

data/lib/zombie_battleground/api.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'zombie_battleground/api/version'
 require 'zombie_battleground/api/client'
 
 module ZombieBattleground
@@ -11,7 +10,7 @@ module ZombieBattleground
 
     class << self
       ##
-      # Queries for Decks
+      # Queries for Decks and returns a modeled response
       #
       # @param id [Integer] Optionally filter on Deck id
       # @param user_id [String] Optionally filter on Deck user_id
@@ -27,32 +26,73 @@ module ZombieBattleground
       # @return [ZombieBattleground::Api::Responses::GetDecksResponse]
       #
       # @example
-      #   response = ZombieBattleground::Api.decks(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetDecksResponse
+      #   response = ZombieBattleground::Api.decks_request(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetDecksResponse
+      #
+      # @api public
+      def decks_request(**args)
+        @client.decks_request(**args)
+      end
+
+      ##
+      # Queries for Decks and returns the decks in the response
+      #
+      # @param id [Integer] Optionally filter on Deck id
+      # @param user_id [String] Optionally filter on Deck user_id
+      # @param deck_id [Integer] Optionally filter on Deck deck_id
+      # @param name [String] Optionally filter on Deck name
+      # @param hero_id [Integer] Optionally filter on Deck hero_id
+      # @param primary_skill_id [Integer] Optionally filter on Deck primary_skill_id
+      # @param secondary_skill_id [Integer] Optionally filter on Deck secondary_skill_id
+      # @param version [String] Optionally filter on Deck version
+      # @param page [Integer] Used for pagination of query results
+      # @param limit [Integer] Used for pagination of query results. Max 100
+      #
+      # @return [Array<ZombieBattleground::Api::Models::Deck>]
+      #
+      # @example
+      #   decks = ZombieBattleground::Api.decks(limit: 1)
+      #   # => [ZombieBattleground::Api::Models::Deck]
       #
       # @api public
       def decks(**args)
-        @client.decks(**args)
+        @client.decks_request(**args).decks
       end
 
       ##
-      # Queries for a Deck
+      # Queries for a Deck and returns the response
       #
       # @param id [Integer] Deck id to request
       #
       # @return [ZombieBattleground::Api::Responses::GetDeckResponse]
       #
       # @example
-      #   response = ZombieBattleground::Api.deck(id: 1813)
-      #   response # => ZombieBattleground::Api::Responses::GetDeckResponse
+      #   response = ZombieBattleground::Api.deck_request(id: 1813)
+      #   # => ZombieBattleground::Api::Responses::GetDeckResponse
+      #
+      # @api public
+      def deck_request(**args)
+        @client.deck_request(**args)
+      end
+
+      ##
+      # Queries for a Deck and returns deck in the response
+      #
+      # @param id [Integer] Deck id to request
+      #
+      # @return [ZombieBattleground::Api::Models::Deck]
+      #
+      # @example
+      #   deck = ZombieBattleground::Api.deck(id: 1813)
+      #   # => ZombieBattleground::Api::Models::Deck
       #
       # @api public
       def deck(**args)
-        @client.deck(**args)
+        @client.deck_request(**args).deck
       end
 
       ##
-      # Queries for Matches
+      # Queries for Matches and returns the response
       #
       # @param id [Integer] Optionally filter on Match id
       # @param player1_id [String] Optionally filter on Match player1_id
@@ -66,32 +106,71 @@ module ZombieBattleground
       # @return [ZombieBattleground::Api::Responses::GetMatchesResponse]
       #
       # @example
-      #   response = ZombieBattleground::Api.matches(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetMatchesResponse
+      #   response = ZombieBattleground::Api.matches_request(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetMatchesResponse
+      #
+      # @api public
+      def matches_request(**args)
+        @client.matches_request(**args)
+      end
+
+      ##
+      # Queries for Matches and returns the matches in the response
+      #
+      # @param id [Integer] Optionally filter on Match id
+      # @param player1_id [String] Optionally filter on Match player1_id
+      # @param player2_id [String] Optionally filter on Match player2_id
+      # @param status [String] Optionally filter on Match status
+      # @param version [String] Optionally filter on Match version
+      # @param winner_id [String] Optionally filter on Match winner_id
+      # @param page [Integer] Used for pagination of query results
+      # @param limit [Integer] Used for pagination of query results. Max 100
+      #
+      # @return [Array<ZombieBattleground::Api::Models::Match>]
+      #
+      # @example
+      #   matches = ZombieBattleground::Api.matches(limit: 1)
+      #   # => ZombieBattleground::Api::Models::Match
       #
       # @api public
       def matches(**args)
-        @client.matches(**args)
+        @client.matches_request(**args).matches
       end
 
       ##
-      # Queries for a Match
+      # Queries for a Match and returns the response
       #
       # @param id [Integer] Match id to request
       #
       # @return [ZombieBattleground::Api::Responses::GetMatchResponse]
       #
       # @example
-      #   response = ZombieBattleground::Api.match(id: 1454)
+      #   response = ZombieBattleground::Api.match_request(id: 1454)
       #   response # => ZombieBattleground::Api::Responses::GetMatchResponse
       #
       # @api public
+      def match_request(**args)
+        @client.match_request(**args)
+      end
+
+      ##
+      # Queries for a Match and returns the match in the response
+      #
+      # @param id [Integer] Match id to request
+      #
+      # @return [ZombieBattleground::Api::Models::Match]
+      #
+      # @example
+      #   match = ZombieBattleground::Api.match(id: 1454)
+      #   # => ZombieBattleground::Api::Models::Match
+      #
+      # @api public
       def match(**args)
-        @client.match(**args)
+        @client.match_request(**args).match
       end
 
       ##
-      # Queries for Cards
+      # Queries for Cards and returns the response
       #
       # @param id [Integer] Optionally filter on Card id
       # @param mould_id [String] Optionally filter on Card mould_id
@@ -111,16 +190,45 @@ module ZombieBattleground
       # @return [ZombieBattleground::Api::Responses::GetCardsResponse]
       #
       # @example
-      #   response = ZombieBattleground::Api.cards(limit: 1)
-      #   response # => ZombieBattleground::Api::Responses::GetCardsResponse
+      #   response = ZombieBattleground::Api.cards_request(limit: 1)
+      #   # => ZombieBattleground::Api::Responses::GetCardsResponse
+      #
+      # @api public
+      def cards_request(**args)
+        @client.cards_request(**args)
+      end
+
+      ##
+      # Queries for Cards and returns the cards in the response
+      #
+      # @param id [Integer] Optionally filter on Card id
+      # @param mould_id [String] Optionally filter on Card mould_id
+      # @param version [String] Optionally filter on Card version
+      # @param kind [String] Optionally filter on Card kind
+      # @param set [String] Optionally filter on Card set
+      # @param name [String] Optionally filter on Card name
+      # @param rank [String] Optionally filter on Card rank
+      # @param type [String] Optionally filter on Card type
+      # @param rarity [String] Optionally filter on Card rarity
+      # @param damage [Integer] Optionally filter on Card damage
+      # @param health [Integer] Optionally filter on Card health
+      # @param cost [Integer] Optionally filter on Card cost
+      # @param page [Integer] Used for pagination of query results
+      # @param limit [Integer] Used for pagination of query results. Max 100
+      #
+      # @return [Array<ZombieBattleground::Api::Models::Card>]
+      #
+      # @example
+      #   cards = ZombieBattleground::Api.cards(limit: 1)
+      #   # => [ZombieBattleground::Api::Models::Card]
       #
       # @api public
       def cards(**args)
-        @client.cards(**args)
+        @client.cards_request(**args).cards
       end
 
       ##
-      # Queries for a Card
+      # Queries for a Card and returns the response
       #
       # @param mould_id [String] Optionally filter on Card mould_id
       # @param version [String] Optionally filter on Card version
@@ -129,11 +237,28 @@ module ZombieBattleground
       #
       # @example
       #   response = ZombieBattleground::Api.card(mould_id: 2, version: 'v3')
-      #   response # => ZombieBattleground::Api::Responses::GetCardResponse
+      #   # => ZombieBattleground::Api::Responses::GetCardResponse
+      #
+      # @api public
+      def card_request(**args)
+        @client.card_request(**args)
+      end
+
+      ##
+      # Queries for a Card and returns the card in the response
+      #
+      # @param mould_id [String] Optionally filter on Card mould_id
+      # @param version [String] Optionally filter on Card version
+      #
+      # @return [ZombieBattleground::Api::Models::Card]
+      #
+      # @example
+      #   card = ZombieBattleground::Api.card(mould_id: 2, version: 'v3')
+      #   # => ZombieBattleground::Api::Models::Card
       #
       # @api public
       def card(**args)
-        @client.card(**args)
+        @client.card_request(**args).card
       end
     end
   end

data/zombie_battleground-api.gemspec

@@ -30,11 +30,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'yardstick'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zombie_battleground-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - John Shields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement