admiral_stats_parser 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6249a56ebe7373db336e171a31678f363a8c1e65
-  data.tar.gz: 4e8539b79295a4a2d5ad60f1c8d7ef03872bff28
+  metadata.gz: d3f2d0f49ebaf289106652ca0d113c9ad4a76599
+  data.tar.gz: 52ebd6874fe62e3efde5697e167f67cd70147f4c
 SHA512:
-  metadata.gz: e83aa86adb4781293bbcc1bac2e9c07bb763dee26d8d35c5c6e26000e38b8dc6768ebd50d6a45b22a6b3fcf71e49eb7dacd3c03b393fb3ec3eb9f7c4fc400e06
-  data.tar.gz: 2c5ea481dc84e741d9980e87508f9eccef24047d26192cd9e2a23c5226e58019adb00bc7ea2f89dfcf4385343efdfd6bfc64770851e414c243ba0235d1e582b9
+  metadata.gz: d6a7f4c3883e36d5b7a741153f2925c2a49f1b3dc28767333e81c86f17873c849d4bf7715c23a83b66f410155cfee4ef65c894c096a1e0cb1c5d6493f540038a
+  data.tar.gz: da6b4cc1efab62bf0ed05f6c6aff8664721894cf95cc9730cf5d4760dfad52a317f9192529b702960f300a93b9cb2381d11a4e026fa5ee0821de04036a87f20b

data/README.md

@@ -46,6 +46,9 @@ AdmiralStatsParser.parse_event_info(json, api_version)
 
 # 改装設計図一覧
 AdmiralStatsParser.parse_blueprint_list_info(json, api_version)
+
+# 輸送イベント海域情報
+AdmiralStatsParser.parse_cop_info(json, api_version)
 ```
 
 ## Specification
@@ -69,7 +72,8 @@ AdmiralStatsParser は、以下の API version をサポートしています。
 | 11          | 2018-02-01 （VERSION A REVISION 3 のリリース日） 〜 2018-02-15 |
 | 12          | 2018-02-16 （ケッコンカッコカリの実装日） 〜 2018-04-18 |
 | 13          | 2018-04-19 （第4回イベントの EO 開始日） 〜 2018-05-13 |
-| 14          | 2018-05-14 （大型艦建造の実装日） 〜 |
+| 14          | 2018-05-14 （大型艦建造の実装日） 〜 2018-07-23 |
+| 15          | 2018-07-24 （VERSION B のリリース日） 〜 |
 
 各 API version でパースできる JSON の種類は以下の通りです。また、同じ情報でも、API version によって、含まれる情報量が異なる場合があります。その場合は Supported (1), Supported (2) のように記載して区別しています。
 
@@ -80,7 +84,7 @@ AdmiralStatsParser は、以下の API version をサポートしています。
 | 7 〜 10     | Supported (3) | Supported (3) | Supported (2) | Supported |
 | 11         | Supported (3) | Supported (4) | Supported (2) | Supported |
 | 12 〜 13    | Supported (3) | Supported (4) | Supported (3) | Supported |
-| 14          | Supported (3) | Supported (4) | Supported (4) | Supported |
+| 14 〜 15    | Supported (3) | Supported (4) | Supported (4) | Supported |
 
 | API version | 艦娘一覧 | 装備一覧 | イベント海域情報 |
 |------------:|:-----|:-----|:-----|
@@ -93,13 +97,14 @@ AdmiralStatsParser は、以下の API version をサポートしています。
 | 9 〜 11     | Supported (4) | Supported (2) | Supported (2) |
 | 12          | Supported (5) | Supported (2) | Supported (2) |
 | 13          | Supported (5) | Supported (2) | Supported (3) |
-| 14          | Supported (6) | Supported (2) | Supported (3) |
-
-| API version | 改装設計図一覧 |
-|------------:|:-----|
-| 1 〜 6  | Unsupported |
-| 7       | Supported (1) |
-| 8 〜 14 | Supported (2) |
+| 14 〜 15     | Supported (6) | Supported (2) | Supported (3) |
+
+| API version | 改装設計図一覧 | 輸送イベント海域情報 |
+|------------:|:-----|:-----|
+| 1 〜 6  | Unsupported | Unsupported |
+| 7       | Supported (1) | Unsupported |
+| 8 〜 14 | Supported (2) | Unsupported |
+| 15      | Supported (2) | Supported (1) |
 
 ## Development
 

data/lib/admiral_stats_parser.rb

@@ -8,11 +8,12 @@ require 'admiral_stats_parser/parser/character_list_info_parser'
 require 'admiral_stats_parser/parser/equip_list_info_parser'
 require 'admiral_stats_parser/parser/event_info_parser'
 require 'admiral_stats_parser/parser/blueprint_list_info_parser'
+require 'admiral_stats_parser/parser/cop_info_parser'
 
 module AdmiralStatsParser
   # 最新の API バージョンを返します。
   def self.get_latest_api_version
-    return 14
+    return 15
   end
 
   # エクスポート時刻を元に、API バージョンを推測して返します。
@@ -56,6 +57,9 @@ module AdmiralStatsParser
     # version 14 の開始日
     return 13 if exported_at < Time.parse('2018-05-14T07:00:00+0900')
 
+    # version 15 の開始日
+    return 14 if exported_at < Time.parse('2018-07-24T07:00:00+0900')
+
     return self.get_latest_api_version
   end
 
@@ -66,7 +70,7 @@ module AdmiralStatsParser
         PersonalBasicInfoParser.parse(json, 1)
       when 2..6
         PersonalBasicInfoParser.parse(json, 2)
-      when 7..14
+      when 7..15
         PersonalBasicInfoParser.parse(json, 3)
       else
         raise 'unsupported API version'
@@ -82,7 +86,7 @@ module AdmiralStatsParser
         AreaCaptureInfoParser.parse(json, 2)
       when 7..10
         AreaCaptureInfoParser.parse(json, 3)
-      when 11..14
+      when 11..15
         AreaCaptureInfoParser.parse(json, 4)
       else
         raise 'unsupported API version'
@@ -98,7 +102,7 @@ module AdmiralStatsParser
         TcBookInfoParser.parse(json, 2)
       when 12..13
         TcBookInfoParser.parse(json, 3)
-      when 14
+      when 14..15
         TcBookInfoParser.parse(json, 4)
       else
         raise 'unsupported API version'
@@ -108,7 +112,7 @@ module AdmiralStatsParser
   # 装備図鑑をパースします。
   def self.parse_equip_book_info(json, api_version)
     case api_version
-      when 1..14
+      when 1..15
         EquipBookInfoParser.parse(json)
       else
         raise 'unsupported API version'
@@ -130,7 +134,7 @@ module AdmiralStatsParser
         CharacterListInfoParser.parse(json, 4)
       when 12..13
         CharacterListInfoParser.parse(json, 5)
-      when 14
+      when 14..15
         CharacterListInfoParser.parse(json, 6)
       else
         raise 'unsupported API version'
@@ -144,7 +148,7 @@ module AdmiralStatsParser
         raise 'API version 1 does not support equip list info'
       when 2..8
         EquipListInfoParser.parse(json, 1)
-      when 9..14
+      when 9..15
         EquipListInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
@@ -156,7 +160,7 @@ module AdmiralStatsParser
     case api_version
       when 1..8
         EquipListInfoParser.parse_max_slot_num(json, 1)
-      when 9..14
+      when 9..15
         EquipListInfoParser.parse_max_slot_num(json, 2)
       else
         raise 'unsupported API version'
@@ -172,7 +176,7 @@ module AdmiralStatsParser
         EventInfoParser.parse(json, 1)
       when 7..12
         EventInfoParser.parse(json, 2)
-      when 13..14
+      when 13..15
         EventInfoParser.parse(json, 3)
       else
         raise 'unsupported API version'
@@ -184,7 +188,7 @@ module AdmiralStatsParser
     case api_version
       when 1..3
         raise "API version #{api_version} does not support event info"
-      when 4..14
+      when 4..15
         {
             opened: EventInfoParser.opened?(event_info_list, level, period),
             all_cleared: EventInfoParser.all_cleared?(event_info_list, level, period),
@@ -205,10 +209,22 @@ module AdmiralStatsParser
         raise "API version #{api_version} does not support blueprint list info"
       when 7
         BlueprintListInfoParser.parse(json, 1)
-      when 8..14
+      when 8..15
         BlueprintListInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
     end
   end
+
+  # 輸送イベント海域情報をパースします。
+  def self.parse_cop_info(json, api_version)
+    case api_version
+      when 1..14
+        raise "API version #{api_version} does not support cop info"
+      when 15
+        CopInfoParser.parse(json, 1)
+      else
+        raise 'unsupported API version'
+    end
+  end
 end

data/lib/admiral_stats_parser/model/cop_info.rb

@@ -0,0 +1,53 @@
+# 輸送イベント海域情報
+class CopInfo
+  # TPゲージの残量
+  attr_accessor :numerator
+
+  # TPゲージの最大数
+  attr_accessor :denominator
+
+  # 現在の周回数（1周目＝クリア周回数0の場合は1）
+  attr_accessor :achievement_number
+
+  # 次回達成ボーナス(IndividualAchievement)のリスト
+  attr_accessor :individual_achievement
+
+  # "全提督協力作戦 達成報酬獲得権利" の権利獲得済かどうか
+  attr_accessor :area_achievement_claim
+
+  # 限定フレームの所持数
+  attr_accessor :limited_frame_num
+
+  # 海域データ(AreaData)のリスト
+  attr_accessor :area_data_list
+
+  # 次回達成ボーナス
+  class CopInfoIndividualAchievement
+    # 表示順（0 〜）
+    attr_accessor :data_id
+
+    # ボーナスの種類
+    # "RESULT_POINT": 戦果
+    # "STRATEGY_POINT": 戦略ポイント
+    # "ROOM_ITEM_ICON": 家具コイン
+    # "EQUIP": 装備
+    # "TRC_FRAME": 限定フレーム
+    attr_accessor :kind
+
+    # 数値（戦果の場合はポイント数、家具コインの場合はコイン枚数）
+    attr_accessor :value
+  end
+
+  # 海域データ
+  # 情報量が多いが、Admiral Statsではその大半が不要なため、
+  # Admiral Statsで最低限必要なデータだけパースする
+  class CopInfoAreaData
+    # 海域番号
+    # 期間限定作戦「兵站輸送作戦」では、共通して 3000
+    attr_accessor :area_id
+
+    # サブ海域番号
+    # 期間限定作戦「兵站輸送作戦」では、1 〜 3
+    attr_accessor :area_sub_id
+  end
+end

data/lib/admiral_stats_parser/parser/cop_info_parser.rb

@@ -0,0 +1,142 @@
+require 'json'
+require 'admiral_stats_parser/model/cop_info'
+
+class CopInfoParser
+  MANDATORY_KEYS = {
+      1 => {
+          numerator: Integer,
+          denominator: Integer,
+          achievement_number: Integer,
+          individual_achievement: :individual_achievement,
+          area_achievement_claim: :boolean,
+          limited_frame_num: Integer,
+          area_data_list: :area_data_list
+      },
+  }
+
+  OPTIONAL_KEYS = {
+      1 => {},
+  }
+
+  INDIVIDUAL_ACHIEVEMENT_MANDATORY_KEYS = {
+      data_id: Integer,
+      kind: String,
+      value: Integer,
+  }
+
+  AREA_DATA_LIST_MANDATORY_KEYS = {
+      area_id: Integer,
+      area_sub_id: Integer,
+  }
+
+  def self.parse(json, api_version)
+    items = JSON.parse(json)
+
+    # イベント期間外はnilを返す
+    return nil if items.empty?
+
+    result = CopInfo.new
+
+    MANDATORY_KEYS[api_version].each do |key, key_class|
+      # 必須のキーが含まれなければエラー
+      camel_case_key = key.to_s.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+      unless items.include?(camel_case_key)
+        raise "Mandatory key #{key} does not exist"
+      end
+
+      # 結果のクラスが合わなければエラー
+      # 海域撃破ボーナスを格納するために、特別な処理を追加
+      if key_class == :individual_achievement
+        result.instance_variable_set(
+            "@#{key.to_s}", CopInfoParser.parse_individual_achievement(items[camel_case_key]))
+        next
+      elsif key_class == :area_data_list
+        result.instance_variable_set(
+            "@#{key.to_s}", CopInfoParser.parse_area_data_list(items[camel_case_key]))
+        next
+      end
+
+      # ruby には Boolean クラスがないので、そこだけ特別な処理を用意する
+      if key_class == :boolean
+        unless [true, false].include?(items[camel_case_key])
+          raise "Mandatory key #{key} is not boolean"
+        end
+      else
+        unless items[camel_case_key].is_a?(key_class)
+          raise "Mandatory key #{key} is not class #{key_class}"
+        end
+      end
+
+      result.instance_variable_set("@#{key.to_s}", items[camel_case_key])
+    end
+
+    OPTIONAL_KEYS[api_version].each do |key, key_class|
+      # キーが含まれなければ、処理をスキップ
+      camel_case_key = key.to_s.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+      next unless items.include?(camel_case_key)
+
+      # 結果のクラスが合わなければエラー
+      unless items[camel_case_key].is_a?(key_class)
+        raise "Optional key #{key} is not class #{key_class}"
+      end
+
+      result.instance_variable_set("@#{key.to_s}", items[camel_case_key])
+    end
+
+    result
+  end
+
+  def self.parse_individual_achievement(achievements)
+    results = []
+
+    achievements.each do |achievement|
+      result = CopInfo::CopInfoIndividualAchievement.new
+
+      INDIVIDUAL_ACHIEVEMENT_MANDATORY_KEYS.each do |key, key_class|
+        # 必須のキーが含まれなければエラー
+        camel_case_key = key.to_s.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+        unless achievement.include?(camel_case_key)
+          raise "Mandatory key #{key} does not exist"
+        end
+
+        # 結果のクラスが合わなければエラー
+        unless achievement[camel_case_key].is_a?(key_class)
+          raise "Mandatory key #{key} is not class #{key_class}"
+        end
+
+        result.instance_variable_set("@#{key.to_s}", achievement[camel_case_key])
+      end
+
+      results << result
+    end
+
+    results
+  end
+
+  def self.parse_area_data_list(area_data_list)
+    results = []
+
+    area_data_list.each do |area_data|
+      result = CopInfo::CopInfoAreaData.new
+
+      AREA_DATA_LIST_MANDATORY_KEYS.each do |key, key_class|
+        # 必須のキーが含まれなければエラー
+        camel_case_key = key.to_s.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+        unless area_data.include?(camel_case_key)
+          raise "Mandatory key #{key} does not exist"
+        end
+
+        # 結果のクラスが合わなければエラー
+        unless area_data[camel_case_key].is_a?(key_class)
+          raise "Mandatory key #{key} is not class #{key_class}"
+        end
+
+        result.instance_variable_set("@#{key.to_s}", area_data[camel_case_key])
+      end
+
+      results << result
+    end
+
+    results
+  end
+end

data/lib/admiral_stats_parser/version.rb

@@ -1,3 +1,3 @@
 module AdmiralStatsParser
-  VERSION = '1.14.1'
+  VERSION = '1.15.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: admiral_stats_parser
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - Masahiro Yoshizawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ files:
 - lib/admiral_stats_parser/model/area_capture_info.rb
 - lib/admiral_stats_parser/model/blueprint_list_info.rb
 - lib/admiral_stats_parser/model/character_list_info.rb
+- lib/admiral_stats_parser/model/cop_info.rb
 - lib/admiral_stats_parser/model/equip_book_info.rb
 - lib/admiral_stats_parser/model/equip_list_info.rb
 - lib/admiral_stats_parser/model/event_info.rb
@@ -82,6 +83,7 @@ files:
 - lib/admiral_stats_parser/parser/area_capture_info_parser.rb
 - lib/admiral_stats_parser/parser/blueprint_list_info_parser.rb
 - lib/admiral_stats_parser/parser/character_list_info_parser.rb
+- lib/admiral_stats_parser/parser/cop_info_parser.rb
 - lib/admiral_stats_parser/parser/equip_book_info_parser.rb
 - lib/admiral_stats_parser/parser/equip_list_info_parser.rb
 - lib/admiral_stats_parser/parser/event_info_parser.rb