zombie_battleground-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b70c3c3d5dbcf87bd3104d85db5a99cdaefa0224cb6e3441a956cd7ade8290a
-  data.tar.gz: 214cbe7b928a264a1c55e80f99f6ad9096058a88addc89a28dfbe209007850be
+  metadata.gz: e39b7b110a3e45704b60e09b56a81b353ffc87347a06d759d8deb178c8b788b7
+  data.tar.gz: b369d8a886b27eae14908fd61b6a36767c259336ce0a7dcc5b1a4ee3880cd665
 SHA512:
-  metadata.gz: 4c4f80e80f1c4f463185f9d189ede2914bb41175fd9343e5d9ee82992c318c679c76fd1b8ac06887eeafc8df8159638b3ca431fd4687a0b2a42409591872fd8f
-  data.tar.gz: c49ecc117373b8f15b526242c12201a0fb48f0032815105dd6504ea00453948380e20209907302869dd287c3ac513dab6d422e7c0be75709e28ad775fce5e482
+  metadata.gz: 658ec416c5a8aad44dcbe57ef39b2f518ecfaa4b07c8f6b2265cfcef207f36631144a96e38bcc3d101e57c4956250b02d264fb7defcfd39dbe8bca95a4e25ea5
+  data.tar.gz: 7ac36a2d0f1339a2d03d40eb9a9a795443e24a54ffd58fd7d94a1ffd9c4a2116e0d03fd94fe20b1017add7150fc4fbf8f51d4b46b112ad5c8badd0cd7a98e16b

data/.gitignore

@@ -46,6 +46,9 @@ build-iPhoneSimulator/
 # .ruby-version
 # .ruby-gemset
 
+# Ignore Vim swaps
+*.sw*
+
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 =======
@@ -54,6 +57,7 @@ build-iPhoneSimulator/
 /_yardoc/
 /coverage/
 /doc/
+/out/
 /pkg/
 /spec/reports/
 /tmp/

data/Gemfile.lock

@@ -1,22 +1,23 @@
 PATH
   remote: .
   specs:
-    zombie_battleground-api (0.1.0)
+    zombie_battleground-api (0.2.0)
       activerecord
       faraday
       json
       pry
+      pry-doc
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
       arel (>= 9.0)
-    activesupport (5.2.1)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -24,24 +25,29 @@ GEM
     arel (9.0.0)
     ast (2.4.0)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
+    docile (1.3.1)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    i18n (1.1.1)
+    gem-release (2.0.1)
+    i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)
-    method_source (0.9.0)
+    method_source (0.9.2)
     minitest (5.11.3)
     multipart-post (2.0.0)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    pry (0.12.0)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -66,19 +72,31 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
+    yard (0.9.18)
+    yardstick (0.9.9)
+      yard (~> 0.8, >= 0.8.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  gem-release
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop
+  simplecov
+  yard
+  yardstick
   zombie_battleground-api!
 
 BUNDLED WITH

data/README.md

@@ -23,6 +23,8 @@ Or install it yourself as:
 Use the singleton class `ZombieBattleground::Api`
 
 ```ruby
+require 'zombie_battleground-api/api'
+
 ZombieBattleground::Api.decks(limit: 1)
 # => ZombieBattleground::Api::GetDecksResponse
 ```
@@ -30,6 +32,8 @@ ZombieBattleground::Api.decks(limit: 1)
 Use the API client directly
 
 ```ruby
+require 'zombie_battleground-api/api/client'
+
 client = ZombieBattleground::Api::Client.new
 client.decks(limit: 1) # => ZombieBattleground::Api::GetDecksResponse
 ```

data/Rakefile

@@ -3,14 +3,71 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
 
-RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+def empty_directory(directory)
+  FileUtils.remove_entry(directory)
+  FileUtils.mkdir(directory)
+end
+
+# clean up the workspace
+task(:clean) do
+  empty_directory('doc')
+  empty_directory('out')
+  empty_directory('pkg')
+end
 
+# unit tests
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--require spec_helper ' \
+                    '--format documentation ' \
+                    '--format html ' \
+                    '--out out/rspec_unit.html'
+end
+task(default: :spec)
+
+# configure rubocop
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.options = ['--display-cop-names']
+  task.options = [
+    '--format', 'simple',
+    '--format', 'html',
+    '--out', 'out/rubocop.html',
+    'lib/**/*.rb',
+    'spec/**/*.rb'
+  ]
+end
+task(default: :rubocop)
+
+# configure yard
+YARD::Rake::YardocTask.new(:yard) do |task|
+  task.files = Dir['lib/**/*.rb']
+  task.options = [
+    '--quiet' # YARD doesn't like the methods that received (**args)
+  ]
+  task.stats_options = [
+    '--list-undoc'
+  ]
+end
+task(default: :yard)
+
+# documentation coverage
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |task|
+  task.output = 'out/yard-report.txt'
+end
+task(default: :yardstick_measure)
+
+# documentation enforcement
+Yardstick::Rake::Verify.new(:yardstick_verify) do |task|
+  task.threshold = 100
 end
+task(default: :yardstick_verify)
 
-task default: :rubocop
+# Require tests, syntax and documentation to pass before building
+task(build: %i[spec rubocop yard yardstick_measure yardstick_verify])
 
-task build: %i[spec rubocop]
+# Require a succesful build before release
+task(release: %i[build])

data/lib/zombie_battleground/api.rb

@@ -10,30 +10,130 @@ module ZombieBattleground
     @client = ZombieBattleground::Api::Client.new
 
     class << self
-      attr_accessor :client
-
+      ##
+      # Queries for Decks
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetDecksResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.decks(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetDecksResponse
+      #
+      # @api public
       def decks(**args)
-        client.decks(**args)
+        @client.decks(**args)
       end
 
+      ##
+      # Queries for a Deck
+      #
+      # @param id [Integer] Deck id to request
+      #
+      # @return [ZombieBattleground::Api::Responses::GetDeckResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.deck(id: 1813)
+      #   response # => ZombieBattleground::Api::Responses::GetDeckResponse
+      #
+      # @api public
       def deck(**args)
-        client.deck(**args)
+        @client.deck(**args)
       end
 
+      ##
+      # Queries for Matches
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetMatchesResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.matches(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetMatchesResponse
+      #
+      # @api public
       def matches(**args)
-        client.matches(**args)
+        @client.matches(**args)
       end
 
+      ##
+      # Queries for a Match
+      #
+      # @param id [Integer] Match id to request
+      #
+      # @return [ZombieBattleground::Api::Responses::GetMatchResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.match(id: 1454)
+      #   response # => ZombieBattleground::Api::Responses::GetMatchResponse
+      #
+      # @api public
       def match(**args)
-        client.match(**args)
+        @client.match(**args)
       end
 
+      ##
+      # Queries for Cards
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetCardsResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.cards(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetCardsResponse
+      #
+      # @api public
       def cards(**args)
-        client.cards(**args)
+        @client.cards(**args)
       end
 
+      ##
+      # Queries for a Card
+      #
+      # @param mould_id [String] Optionally filter on Card mould_id
+      # @param version [String] Optionally filter on Card version
+      #
+      # @return [ZombieBattleground::Api::Responses::GetCardResponse]
+      #
+      # @example
+      #   response = ZombieBattleground::Api.card(mould_id: 2, version: 'v3')
+      #   response # => ZombieBattleground::Api::Responses::GetCardResponse
+      #
+      # @api public
       def card(**args)
-        client.card(**args)
+        @client.card(**args)
       end
     end
   end

data/lib/zombie_battleground/api/client.rb

@@ -22,93 +22,227 @@ module ZombieBattleground
     ##
     # The API Client for Zombie Battleground
     class Client
+      ##
+      # Creates a new client
+      #
+      # @return [void]
+      #
+      # @example
+      #   client = ZombieBattleground::Api::Client.new
+      #
+      # @api public
       def initialize
         @endpoint = 'https://api.loom.games/zb'
         @api_version = 'v1'
       end
 
-      def connection(uri:, params:)
-        Faraday.new(
-          url: "#{@endpoint}/#{@api_version}/#{uri}",
-          params: params,
-          headers: {
-            'User-Agent' => "RubyGem-zombie_battleground-api_#{VERSION}",
-            'Content-Type' => 'application/json'
-          }
-        )
-      end
-
+      ##
+      # Queries for Decks
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetDecksResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.decks(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetDecksResponse
+      #
+      # @api public
       def decks(**args)
-        request = ZombieBattleground::Api::GetDecksRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        decks = ZombieBattleground::Api::GetDecksResponse.new(response)
+        decks = ZombieBattleground::Api::Responses::GetDecksResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, decks) unless decks.valid?
 
         decks
       end
 
+      ##
+      # Queries for a Deck
+      #
+      # @param id [Integer] Deck id to request
+      #
+      # @return [ZombieBattleground::Api::Responses::GetDeckResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.deck(id: 1813)
+      #   response # => ZombieBattleground::Api::Responses::GetDeckResponse
+      #
+      # @api public
       def deck(**args)
-        request = ZombieBattleground::Api::GetDeckRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        deck = ZombieBattleground::Api::GetDeckResponse.new(response)
+        deck = ZombieBattleground::Api::Responses::GetDeckResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, deck) unless deck.valid?
 
         deck
       end
 
+      ##
+      # Queries for Matches
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetMatchesResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.matches(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetMatchesResponse
+      #
+      # @api public
       def matches(**args)
-        request = ZombieBattleground::Api::GetMatchesRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        matches = ZombieBattleground::Api::GetMatchesResponse.new(response)
+        matches = ZombieBattleground::Api::Responses::GetMatchesResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, matches) unless matches.valid?
 
         matches
       end
 
+      ##
+      # Queries for a Match
+      #
+      # @param id [Integer] Match id to request
+      #
+      # @return [ZombieBattleground::Api::Responses::GetMatchResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.match(id: 1454)
+      #   response # => ZombieBattleground::Api::Responses::GetMatchResponse
+      #
+      # @api public
       def match(**args)
-        request = ZombieBattleground::Api::GetMatchRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        match = ZombieBattleground::Api::GetMatchResponse.new(response)
+        match = ZombieBattleground::Api::Responses::GetMatchResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, match) unless match.valid?
 
         match
       end
 
+      ##
+      # Queries for Cards
+      #
+      # @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 [ZombieBattleground::Api::Responses::GetCardsResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.cards(limit: 1)
+      #   response # => ZombieBattleground::Api::Responses::GetCardsResponse
+      #
+      # @api public
       def cards(**args)
-        request = ZombieBattleground::Api::GetCardsRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        cards = ZombieBattleground::Api::GetCardsResponse.new(response)
+        cards = ZombieBattleground::Api::Responses::GetCardsResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, cards) unless cards.valid?
 
         cards
       end
 
+      ##
+      # Queries for a Card
+      #
+      # @param mould_id [String] Optionally filter on Card mould_id
+      # @param version [String] Optionally filter on Card version
+      #
+      # @return [ZombieBattleground::Api::Responses::GetCardResponse]
+      #
+      # @raise [ZombieBattleground::Api::Errors::InvalidInput, ZombieBattleground::Api::Errors::InvalidResponse]
+      #
+      # @example
+      #   response = client.card(mould_id: 2, version: 'v3')
+      #   response # => ZombieBattleground::Api::Responses::GetCardResponse
+      #
+      # @api public
       def card(**args)
-        request = ZombieBattleground::Api::GetCardRequest.new
+        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?
 
         response = connection(uri: request.uri, params: request.params).get
-        card = ZombieBattleground::Api::GetCardResponse.new(response)
+        card = ZombieBattleground::Api::Responses::GetCardResponse.new(response)
         raise ZombieBattleground::Api::Errors::InvalidResponse.new(response, card) unless card.valid?
 
         card
       end
+
+      private
+
+      ##
+      # Creates a new Faraday connection
+      #
+      # @param uri [String] the URI to append to the endpoint and API version
+      # @param params [Hash] the query paramaters for the request
+      #
+      # @return [Faraday::Connection]
+      #
+      # @api private
+      def connection(uri:, params:)
+        Faraday.new(
+          url: "#{@endpoint}/#{@api_version}/#{uri}",
+          params: params,
+          headers: {
+            'User-Agent' => "RubyGem-zombie_battleground-api_#{VERSION}",
+            'Content-Type' => 'application/json'
+          }
+        )
+      end
     end
   end
 end