clash_of_clans_api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fad47340e0073d7662ff5a74424a1bf8e469271914da83d69ea0abfbb7650607
-  data.tar.gz: 6dfbe8e46d76a66d6fb4a62ee7fb998bab8436cf8a253de13a16c9d263aeb398
+  metadata.gz: 3ec05b82907166705220928be33463848e536b890e920eb023aff8b13a81ee4f
+  data.tar.gz: c9f2eeeef102ec3804aa35783e9add1d6cca3c813712497e903187c0e011f6d4
 SHA512:
-  metadata.gz: e1deb56184c6517f8443924d54043e8e8bfb6e8956d0c8f82ead906fc46a67ef0117e762ac154928f8cde886ee919966eab306b2d78d2c80a6c444f01fc1ae74
-  data.tar.gz: 33cac4957a5c6bfe30c9eb55deddcbc64027bc9091c36fe53ac095e78abd8b613f6f1ceb4cebd9301e9c7c2f0cd14b9cc24425fc2161b126ca79dc5c68130bed
+  metadata.gz: 915ed6c0f3a3ea43cf479ab834eccf524faef717682bcde0db1d3cc57c68989c245a18390184bbd19df950dde1b2ac4deb4da1fbbdbac193571ee24ec52a90d8
+  data.tar.gz: 56ab2cdd27e61a00a98f57c15a5bce647dd5e7136a80954051d1735df9929b2decd668eb6c819e4eba4141c5b49548a06da70e4ad6da0238cc61280b2185634f

data/lib/clash_of_clans_api/models/achievement.rb

@@ -3,13 +3,13 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class Achievement < Base
-			property :name,            'name',           required: true
-			property :stars,           'stars',          required: true
-			property :value,           'value',          required: true
-			property :target,          'target',         required: true
-			property :info,            'info',           required: true
-			property :completion_info, 'completionInfo', required: true
-			property :village,         'village',        required: true
+			property :name,            'name',           expected: true
+			property :stars,           'stars',          expected: true
+			property :value,           'value',          expected: true
+			property :target,          'target',         expected: true
+			property :info,            'info',           expected: true
+			property :completion_info, 'completionInfo', expected: true
+			property :village,         'village',        expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/base.rb

@@ -9,8 +9,6 @@ module ClashOfClansApi
 			def initialize(hash, client)
 				@hash   = hash
 				@client = client
-				
-				validate!
 			end
 			
 			def to_h
@@ -26,7 +24,7 @@ module ClashOfClansApi
 					@registered_properties ||= {}
 				end
 				
-				def property(method_name, key, type: nil, required: false, default: nil)
+				def property(method_name, key, type: nil, expected: false, default: nil)
 					define_method(method_name) do
 						deduced_type =
 							case type
@@ -63,7 +61,7 @@ module ClashOfClansApi
 					
 					registered_properties[key] = {
 						method_name: method_name,
-						required:    required,
+						expected:    expected,
 						default:     default,
 						type:        type,
 					}
@@ -84,14 +82,12 @@ module ClashOfClansApi
 				@property_cache[method_name]
 			end
 			
-			def validate!
+			def expected_properties?
 				missing = self.class.registered_properties.reject do |field_name, properties|
-					!properties[:required] || @hash.key?(field_name)
+					!properties[:expected] || @hash.key?(field_name)
 				end
 				
-				if missing.any?
-					raise InvalidDataError, "The following keys are required, but missing from the model data: #{missing.keys.map(&:inspect).join(', ')}"
-				end
+				missing.empty?
 			end
 		end
 	end

data/lib/clash_of_clans_api/models/builder_base_league.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class BuilderBaseLeague < Base
-			property :id,   'id',   required: true
-			property :name, 'name', required: true
+			property :id,   'id',   expected: true
+			property :name, 'name', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/capital_league.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class CapitalLeague < Base
-			property :id,   'id',   required: true
-			property :name, 'name', required: true
+			property :id,   'id',   expected: true
+			property :name, 'name', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/chat_language.rb

@@ -3,9 +3,9 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class ChatLanguage < Base
-			property :id,            'id',           required: true
-			property :name,          'name',         required: true
-			property :language_code, 'languageCode', required: true
+			property :id,            'id',           expected: true
+			property :name,          'name',         expected: true
+			property :language_code, 'languageCode', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan.rb

@@ -10,8 +10,8 @@ require_relative 'war_league'
 module ClashOfClansApi
 	module Models
 		class Clan < Base
-			property :tag,                            'tag',  required: true
-			property :name,                           'name', required: true
+			property :tag,                            'tag',  expected: true
+			property :name,                           'name', expected: true
 			property :type,                           'type'
 			property :description,                    'description'
 			property :location,                       'location',                    type: ClanLocation

data/lib/clash_of_clans_api/models/clan_capital.rb

@@ -4,8 +4,8 @@ require_relative 'clan_capital_district'
 module ClashOfClansApi
 	module Models
 		class ClanCapital < Base
-			property :capital_hall_level, 'capitalHallLevel', required: true
-			property :districts,          'districts',        required: true, type: ClanCapitalDistrict
+			property :capital_hall_level, 'capitalHallLevel', expected: true
+			property :districts,          'districts',        expected: true, type: ClanCapitalDistrict
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_capital_district.rb

@@ -3,9 +3,9 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class ClanCapitalDistrict < Base
-			property :id,                  'id',                required: true
-			property :name,                'name',              required: true
-			property :district_hall_level, 'districtHallLevel', required: true
+			property :id,                  'id',                expected: true
+			property :name,                'name',              expected: true
+			property :district_hall_level, 'districtHallLevel', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_location.rb

@@ -3,9 +3,9 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class ClanLocation < Base
-			property :id,       'id',        required: true
-			property :name,     'name',      required: true
-			property :country?, 'isCountry', required: true
+			property :id,       'id',        expected: true
+			property :name,     'name',      expected: true
+			property :country?, 'isCountry', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_war_league_clan.rb

@@ -5,11 +5,11 @@ require_relative 'icon_set'
 module ClashOfClansApi
 	module Models
 		class ClanWarLeagueClan < Base
-			property :tag,        'tag',       required: true
-			property :name,       'name',      required: true
-			property :clan_level, 'clanLevel', required: true
-			property :badge_urls, 'badgeUrls', required: true, type: IconSet
-			property :members,    'members',   required: true, type: ClanWarLeagueClanMember
+			property :tag,        'tag',       expected: true
+			property :name,       'name',      expected: true
+			property :clan_level, 'clanLevel', expected: true
+			property :badge_urls, 'badgeUrls', expected: true, type: IconSet
+			property :members,    'members',   expected: true, type: ClanWarLeagueClanMember
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_war_league_clan_member.rb

@@ -3,9 +3,9 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class ClanWarLeagueClanMember < Base
-			property :tag,             'tag',           required: true
-			property :name,            'name',          required: true
-			property :town_hall_level, 'townHallLevel', required: true
+			property :tag,             'tag',           expected: true
+			property :name,            'name',          expected: true
+			property :town_hall_level, 'townHallLevel', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_war_league_group.rb

@@ -5,10 +5,10 @@ require_relative 'clan_war_league_round'
 module ClashOfClansApi
 	module Models
 		class ClanWarLeagueGroup < Base
-			property :state,  'state',  required: true
-			property :season, 'season', required: true
-			property :clans,  'clans',  required: true, type: ClanWarLeagueClan
-			property :rounds, 'rounds', required: true, type: ClanWarLeagueRound
+			property :state,  'state',  expected: true
+			property :season, 'season'
+			property :clans,  'clans', type: ClanWarLeagueClan
+			property :rounds, 'rounds', type: ClanWarLeagueRound
 		end
 	end
 end

data/lib/clash_of_clans_api/models/clan_war_league_round.rb

@@ -3,7 +3,7 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class ClanWarLeagueRound < Base
-			property :war_tags, 'warTags', required: true
+			property :war_tags, 'warTags', expected: true
 
 			def prepared?
 				war_tags.all? do |war_tag|

data/lib/clash_of_clans_api/models/hero.rb

@@ -4,10 +4,10 @@ require_relative 'hero_equipment'
 module ClashOfClansApi
 	module Models
 		class Hero < Base
-			property :name,      'name',     required: true
-			property :level,     'level',    required: true
-			property :max_level, 'maxLevel', required: true
-			property :village,   'village',  required: true
+			property :name,      'name',     expected: true
+			property :level,     'level',    expected: true
+			property :max_level, 'maxLevel', expected: true
+			property :village,   'village',  expected: true
 			property :equipment, 'equipment', type: HeroEquipment
 		end
 	end

data/lib/clash_of_clans_api/models/hero_equipment.rb

@@ -3,10 +3,10 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class HeroEquipment < Base
-			property :name,      'name',     required: true
-			property :level,     'level',    required: true
-			property :max_level, 'maxLevel', required: true
-			property :village,   'village',  required: true
+			property :name,      'name',     expected: true
+			property :level,     'level',    expected: true
+			property :max_level, 'maxLevel', expected: true
+			property :village,   'village',  expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/label.rb

@@ -4,9 +4,9 @@ require_relative 'icon_set'
 module ClashOfClansApi
 	module Models
 		class Label < Base
-			property :id,        'id',       required: true
-			property :name,      'name',     required: true
-			property :icon_urls, 'iconUrls', required: true, type: IconSet
+			property :id,        'id',       expected: true
+			property :name,      'name',     expected: true
+			property :icon_urls, 'iconUrls', expected: true, type: IconSet
 		end
 	end
 end

data/lib/clash_of_clans_api/models/league.rb

@@ -4,9 +4,9 @@ require_relative 'icon_set'
 module ClashOfClansApi
 	module Models
 		class League < Base
-			property :id,        'id',       required: true
-			property :name,      'name',     required: true
-			property :icon_urls, 'iconUrls', required: true, type: IconSet
+			property :id,        'id',       expected: true
+			property :name,      'name',     expected: true
+			property :icon_urls, 'iconUrls', expected: true, type: IconSet
 		end
 	end
 end

data/lib/clash_of_clans_api/models/legend_season.rb

@@ -3,9 +3,9 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class LegendSeason < Base
-			property :id,       'id',       required: false
-			property :rank,     'rank',     required: true
-			property :trophies, 'trophies', required: true
+			property :id,       'id',       expected: false
+			property :rank,     'rank',     expected: true
+			property :trophies, 'trophies', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/legend_statistics.rb

@@ -4,10 +4,10 @@ require_relative 'legend_season'
 module ClashOfClansApi
 	module Models
 		class LegendStatistics < Base
-			property :legend_trophies, 'legendTrophies', required: true
-			property :previous_season, 'previousSeason', required: true, type: LegendSeason
-			property :best_season,     'bestSeason',     required: true, type: LegendSeason
-			property :current_season,  'currentSeason',  required: true, type: LegendSeason
+			property :legend_trophies, 'legendTrophies', expected: true
+			property :previous_season, 'previousSeason', expected: true, type: LegendSeason
+			property :best_season,     'bestSeason',     expected: true, type: LegendSeason
+			property :current_season,  'currentSeason',  expected: true, type: LegendSeason
 		end
 	end
 end

data/lib/clash_of_clans_api/models/paginated_response.rb

@@ -6,8 +6,8 @@ module ClashOfClansApi
 		class PaginatedResponse < Base
 			attr_accessor :item_type
 			
-			property :items,  'items',  required: true, type: :item_type
-			property :paging, 'paging', required: true, type: PaginationPaging
+			property :items,  'items',  expected: true, type: :item_type
+			property :paging, 'paging', expected: true, type: PaginationPaging
 			
 			def initialize(item_type, hash, client)
 				self.item_type = item_type

data/lib/clash_of_clans_api/models/pagination_paging.rb

@@ -4,7 +4,7 @@ require_relative 'pagination_cursors'
 module ClashOfClansApi
 	module Models
 		class PaginationPaging < Base
-			property :cursors, 'cursors', required: true, type: PaginationCursors
+			property :cursors, 'cursors', expected: true, type: PaginationCursors
 		end
 	end
 end

data/lib/clash_of_clans_api/models/player.rb

@@ -13,8 +13,8 @@ require_relative 'troop'
 module ClashOfClansApi
 	module Models
 		class Player < Base
-			property :tag,                        'tag',  required: true
-			property :name,                       'name', required: true
+			property :tag,                        'tag',  expected: true
+			property :name,                       'name', expected: true
 			property :town_hall_level,            'townHallLevel'
 			property :town_hall_weapon_level,     'townHallWeaponLevel'
 			property :exp_level,                  'expLevel'

data/lib/clash_of_clans_api/models/player_house.rb

@@ -4,7 +4,7 @@ require_relative 'player_house_element'
 module ClashOfClansApi
 	module Models
 		class PlayerHouse < Base
-			property :elements, 'elements', type: PlayerHouseElement, required: true
+			property :elements, 'elements', type: PlayerHouseElement, expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/player_house_element.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class PlayerHouseElement < Base
-			property :type, 'type', required: true
-			property :id,   'id',   required: true
+			property :type, 'type', expected: true
+			property :id,   'id',   expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/spell.rb

@@ -3,10 +3,10 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class Spell < Base
-			property :name,      'name',     required: true
-			property :level,     'level',    required: true
-			property :max_level, 'maxLevel', required: true
-			property :village,   'village',  required: true
+			property :name,      'name',     expected: true
+			property :level,     'level',    expected: true
+			property :max_level, 'maxLevel', expected: true
+			property :village,   'village',  expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/token.rb

@@ -3,16 +3,16 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class Token < Base
-			property :id,           'id',          required: true
+			property :id,           'id',          expected: true
 			property :developer_id, 'developerId'
 			property :tier,         'tier'
-			property :name,         'name',        required: true
-			property :description,  'description', required: true
+			property :name,         'name',        expected: true
+			property :description,  'description', expected: true
 			property :origins,      'origins'
 			property :scopes,       'scopes'
-			property :cidr_ranges,  'cidrRanges',  required: true
+			property :cidr_ranges,  'cidrRanges',  expected: true
 			property :valid_until,  'validUntil'
-			property :key,          'key',         required: true
+			property :key,          'key',         expected: true
 			
 			def revoke
 				self.client.revoke_api_key(self.id)

data/lib/clash_of_clans_api/models/troop.rb

@@ -3,11 +3,11 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class Troop < Base
-			property :name,                  'name',               required: true
-			property :level,                 'level',              required: true
-			property :max_level,             'maxLevel',           required: true
-			property :village,               'village',            required: true
-			property :super_troop_is_active, 'superTroopIsActive', required: false, default: false
+			property :name,                  'name',               expected: true
+			property :level,                 'level',              expected: true
+			property :max_level,             'maxLevel',           expected: true
+			property :village,               'village',            expected: true
+			property :super_troop_is_active, 'superTroopIsActive', expected: false, default: false
 		end
 	end
 end

data/lib/clash_of_clans_api/models/war.rb

@@ -11,8 +11,8 @@ module ClashOfClansApi
 			property :preparation_start_time, 'preparationStartTime',             type: DateTime
 			property :team_size,              'teamSize'
 			property :attacks_per_member,     'attacksPerMember'
-			property :clan,                   'clan',             required: true, type: WarClan
-			property :opponent,               'opponent',         required: true, type: WarClan
+			property :clan,                   'clan',             expected: true, type: WarClan
+			property :opponent,               'opponent',         expected: true, type: WarClan
 		end
 	end
 end

data/lib/clash_of_clans_api/models/war_attack.rb

@@ -3,12 +3,12 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class WarAttack < Base
-			property :attacker_tag,           'attackerTag',           required: true
-			property :defender_tag,           'defenderTag',           required: true
-			property :stars,                  'stars',                 required: true
-			property :destruction_percentage, 'destructionPercentage', required: true
-			property :order,                  'order',                 required: true
-			property :duration,               'duration',              required: true
+			property :attacker_tag,           'attackerTag',           expected: true
+			property :defender_tag,           'defenderTag',           expected: true
+			property :stars,                  'stars',                 expected: true
+			property :destruction_percentage, 'destructionPercentage', expected: true
+			property :order,                  'order',                 expected: true
+			property :duration,               'duration',              expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/models/war_clan_member.rb

@@ -4,8 +4,8 @@ require_relative 'war_attack'
 module ClashOfClansApi
 	module Models
 		class WarClanMember < Base
-			property :tag,                  'tag',  required: true
-			property :name,                 'name', required: true
+			property :tag,                  'tag',  expected: true
+			property :name,                 'name', expected: true
 			property :townhall_level,       'townhallLevel'
 			property :map_position,         'mapPosition'
 			property :attacks,              'attacks',            type: WarAttack

data/lib/clash_of_clans_api/models/war_league.rb

@@ -3,8 +3,8 @@ require_relative 'base'
 module ClashOfClansApi
 	module Models
 		class WarLeague < Base
-			property :id,   'id',   required: true
-			property :name, 'name', required: true
+			property :id,   'id',   expected: true
+			property :name, 'name', expected: true
 		end
 	end
 end

data/lib/clash_of_clans_api/token_client.rb

@@ -48,8 +48,6 @@ module ClashOfClansApi
 		
 		def revoke_api_key(id)
 			TokenApi.apikey_revoke(id: id, headers: @session_headers)
-			
-			true
 		end
 		
 		def create_or_get_api_key_for_current_ipv4_address(name, description=name, overwrite: false)

data/lib/clash_of_clans_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClashOfClansApi
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: clash_of_clans_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - expeehaa
 bindir: bin
 cert_chain: []
-date: 2025-04-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_frame
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Client library for interacting with the ClashOfClans API.
 test_files: []