admiral_stats_parser 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 796696607ab5a39710315dc1ed6600d0c369c288
-  data.tar.gz: 9c4a7460c5b6d327fc7e40df0336d26c474d9e41
+  metadata.gz: 1252d0f0a0892001344347cf23dcde7b91c31026
+  data.tar.gz: c52f091e0cedcafdb7d7b09dede68d5c62f7dcf5
 SHA512:
-  metadata.gz: c5c2a4c39242db212e3f008c5e3ac265127452d88d197fdd1644180d2da1aa00cb34d90060553720813769bd570e08eee3c6e7e9b0555237c8aa81b330fa19ba
-  data.tar.gz: a41747e0b954ccff156a99deb229c49a8db1c058d3e70a6b70a381fbf05b815ebd826dc1eb21e1a85834f364a0cc5f79257701b82cbf249528b71fd38c261fa0
+  metadata.gz: e1f668fedae8dc76698784d09cc14200aa1495b45c0c0b8441c15a299071c28c340e22147b139959b101d1eadfe7c4eb4de056470524f69861283f33a6467841
+  data.tar.gz: bf5a5db1862efee5fe6b9b7365fe20f6cf738c2c83119e00df7f1edbd9411c2aada3670c45c7241ea15a39da43ee1a43f4d0bb3abb58e2143bc8f50721741dd5

data/README.md

@@ -1,5 +1,7 @@
 # admiral_stats_parser
 
+[![Join the chat at https://gitter.im/muziyoshiz/admiral_stats](https://badges.gitter.im/muziyoshiz/admiral_stats.svg)](https://gitter.im/muziyoshiz/admiral_stats?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 Parser for admiral stats JSON data exported from kancolle-arcade.net
 
 ## Installation
@@ -38,6 +40,9 @@ AdmiralStatsParser.parse_character_list_info(json, api_version)
 
 # 装備一覧
 AdmiralStatsParser.parse_equip_list_info(json, api_version)
+
+# イベント海域情報
+AdmiralStatsParser.parse_event_info(json, api_version)
 ```
 
 ## Specification
@@ -50,19 +55,27 @@ AdmiralStatsParser は、以下の API version をサポートしています。
 |------------:|:-----|
 | 1           | 2016-04-26 〜 2016-06-29 |
 | 2           | 2016-06-30（REVISION 2 のリリース日）〜 2016-09-14 |
-| 3           | 2016-09-15 〜 |
+| 3           | 2016-09-15 〜 2016-10-26 |
+| 4           | 2016-10-27 〜 |
 
 各 API version でパースできる JSON の種類は以下の通りです。また、同じ情報でも、API version によって、含まれる情報量が異なる場合があります。その場合は Supported (1), Supported (2) のように記載して区別しています。
 
-| 提督情報での表示 | URL | API version 1 | API version 2 | API version 3 |
-|:----------------|:----|:--------------|:--------------|:-------------|
-| 基本情報 | Personal/basicInfo | Supported (1) | Supported (2) | Supported (2) |
-| 海域情報 | Area/captureInfo   | Supported (1) | Supported (2) | Supported (2) |
-| 艦娘図鑑 | TcBook/info        | Supported (1) | Supported (2) | Supported (2) |
-| 装備図鑑 | EquipBook/info     | Supported     | Supported     | Supported     |
-| 艦娘一覧 | CharacterList/info | -             | Supported (1) | Supported (2) |
-| 装備一覧 | EquipList/info     | -             | Supported     | Supported     |
-| 任務一覧 | Quest/info         | -             | Unsupported   | Unsupported   |
+| 提督情報での表示 | URL | API version 1 | API version 2〜4 |
+|:----------------|:----|:--------------|:--------------|
+| 基本情報 | Personal/basicInfo | Supported (1) | Supported (2) |
+| 海域情報 | Area/captureInfo   | Supported (1) | Supported (2) |
+| 艦娘図鑑 | TcBook/info        | Supported (1) | Supported (2) |
+| 装備図鑑 | EquipBook/info     | Supported     | Supported     |
+
+| 提督情報での表示 | URL | API version 2 | API version 3〜4 |
+|:----------------|:----|:--------------|:-------------|
+| 艦娘一覧 | CharacterList/info | Supported (1) | Supported (2) |
+| 装備一覧 | EquipList/info     | Supported     | Supported     |
+| 任務一覧 | Quest/info         | Unsupported   | Unsupported   |
+
+| 提督情報での表示 | URL | API version 4 |
+|:----------------|:----|:--------------|
+| イベント海域情報 | Event/info | Supported (1) |
 
 ## Development
 

data/lib/admiral_stats_parser.rb

@@ -6,11 +6,12 @@ require 'admiral_stats_parser/parser/tc_book_info_parser'
 require 'admiral_stats_parser/parser/equip_book_info_parser'
 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'
 
 module AdmiralStatsParser
   # 最新の API バージョンを返します。
   def self.get_latest_api_version
-    return 3
+    return 4
   end
 
   # エクスポート時刻を元に、API バージョンを推測して返します。
@@ -21,6 +22,9 @@ module AdmiralStatsParser
     # version 3 の開始日
     return 2 if exported_at < Time.parse('2016-09-15T07:00:00+0900')
 
+    # version 4 の開始日
+    return 3 if exported_at < Time.parse('2016-10-27T07:00:00+0900')
+
     return self.get_latest_api_version
   end
 
@@ -29,7 +33,7 @@ module AdmiralStatsParser
     case api_version
       when 1
         PersonalBasicInfoParser.parse(json, 1)
-      when 2, 3
+      when 2..4
         PersonalBasicInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
@@ -41,7 +45,7 @@ module AdmiralStatsParser
     case api_version
       when 1
         AreaCaptureInfoParser.parse(json, 1)
-      when 2, 3
+      when 2..4
         AreaCaptureInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
@@ -53,7 +57,7 @@ module AdmiralStatsParser
     case api_version
       when 1
         TcBookInfoParser.parse(json, 1)
-      when 2, 3
+      when 2..4
         TcBookInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
@@ -63,7 +67,7 @@ module AdmiralStatsParser
   # 装備図鑑をパースします。
   def self.parse_equip_book_info(json, api_version)
     case api_version
-      when 1, 2, 3
+      when 1..4
         EquipBookInfoParser.parse(json)
       else
         raise 'unsupported API version'
@@ -75,8 +79,10 @@ module AdmiralStatsParser
     case api_version
       when 1
         raise 'API version 1 does not support character list info'
-      when 2, 3
-        CharacterListInfoParser.parse(json, api_version)
+      when 2
+        CharacterListInfoParser.parse(json, 1)
+      when 3..4
+        CharacterListInfoParser.parse(json, 2)
       else
         raise 'unsupported API version'
     end
@@ -87,10 +93,22 @@ module AdmiralStatsParser
     case api_version
       when 1
         raise 'API version 1 does not support equip list info'
-      when 2, 3
+      when 2..4
         EquipListInfoParser.parse(json)
       else
         raise 'unsupported API version'
     end
   end
+
+  # イベント海域情報をパースします。
+  def self.parse_event_info(json, api_version)
+    case api_version
+      when 1..3
+        raise "API version #{api_version} does not support event info"
+      when 4
+        EventInfoParser.parse(json, 1)
+      else
+        raise 'unsupported API version'
+    end
+  end
 end

data/lib/admiral_stats_parser/model/event_info.rb

@@ -0,0 +1,174 @@
+# 限定海域情報
+class EventInfo
+  # イベント回数
+  EVENT_NUMBERS = {
+      1000 => 1,
+  }
+
+  # 海域番号と海域名の対応関係
+  EVENT_AREA_NAMES = {
+      1000 => '敵艦隊前線泊地殴り込み',
+  }
+
+  # サブ海域番号と海域名の対応関係
+  EVENT_AREA_SUB_NAMES = {
+      1000 => {
+          1 => '前哨戦',
+          2 => '警戒線突破',
+          3 => '湾内突入！',
+          4 => '敵泊地強襲！',
+          5 => '掃討戦',
+          6 => '前哨戦',
+          7 => '警戒線突破',
+          8 => '湾内突入！',
+          9 => '敵泊地強襲！',
+          10 => '掃討戦',
+      },
+  }
+
+  # 海域番号
+  # 期間限定海域「敵艦隊前線泊地殴り込み」では、共通して 1000
+  attr_accessor :area_id
+
+  # サブ海域番号
+  # 期間限定海域「敵艦隊前線泊地殴り込み」では、1 〜 10
+  attr_accessor :area_sub_id
+
+  # 難易度
+  # "HEI": 丙
+  # "OTU": 乙
+  attr_accessor :level
+
+  # 海域の種類
+  # ボス戦は "BOSS"
+  # 掃討戦は "SWEEP"
+  # それ以外は "NORMAL"
+  attr_accessor :area_kind
+
+  # 作戦時間（秒）
+  # 未表示の場合は 0
+  attr_accessor :limit_sec
+
+  # 必要GP
+  # 未表示の場合は 0
+  attr_accessor :require_gp
+
+  # 出撃条件の有無（true ならある）
+  attr_accessor :sortie_limit
+
+  # 海域画像のファイル名
+  attr_accessor :stage_image_name
+
+  # 作戦名
+  # 未表示の場合は "？"
+  attr_accessor :stage_mission_name
+
+  # 作戦内容
+  # 未表示の場合は "？"
+  attr_accessor :stage_mission_info
+
+  # 海域撃破ボーナス(EventInfoReward)のリスト
+  attr_accessor :reward_list
+
+  # 主な出現アイテム
+  # アイテムを表す文字列の配列（要素数は4固定）
+  attr_accessor :stage_drop_item_info
+
+  # クリア状態を表す文字列
+  # CLEAR: クリア済み
+  # NOTCLEAR: 出撃可能だが未クリア
+  # NOOPEN: 出撃不可
+  attr_accessor :area_clear_state
+
+  # 海域ゲージの状態
+  # "NORMAL": 攻略中
+  # "BREAK": 攻略後
+  attr_accessor :military_gauge_status
+
+  # 海域ゲージの最大値
+  # E-1 攻略開始前は 1000、攻略後も 1000
+  attr_accessor :ene_military_gauge_val
+
+  # 海域ゲージの現在値
+  # E-1 攻略開始前は 1000、攻略後は 0
+  attr_accessor :military_gauge_left
+
+  # ボスのランク
+  # 泊地棲鬼は "ONI"
+  # ゲージ半減して泊地棲姫になると "HIME"
+  # それ以外は "NONE"
+  attr_accessor :boss_status
+
+  # 周回数
+  # E-1 攻略開始前は 1、攻略後も 1
+  attr_accessor :loop_count
+
+  # イベント回数を返します。
+  # 第壱回期間限定海域「敵艦隊前線泊地殴り込み」は 1
+  def event_no
+    EVENT_NUMBERS[@area_id]
+  end
+
+  # 海域を表す数値を、海域名に変換して返します。
+  def area_id_to_s
+    EVENT_AREA_NAMES.include?(@area_id) ? EVENT_AREA_NAMES[@area_id] : @area_id.to_s
+  end
+
+  # サブ海域を表す数値を、海域名に変換して返します。
+  def area_sub_id_to_s
+    return "#{@area_id}-#{@area_sub_id}" unless EVENT_AREA_SUB_NAMES.include?(@area_id)
+
+    if EVENT_AREA_SUB_NAMES[@area_id].include?(@area_sub_id)
+      EVENT_AREA_SUB_NAMES[@area_id][@area_sub_id]
+    else
+      "#{@area_id}-#{@area_sub_id}"
+    end
+  end
+
+  # 与えられたリストから、現在の周回数を返します。
+  def self.current_loop_counts(event_info_list, level)
+    # 指定されたレベルの情報のみ取り出し
+    list = event_info_list.select{|info| info.level == level }
+
+    # 現在の周回数
+    list.map{|i| i.loop_count }.max
+  end
+
+  # 与えられたリストから、クリア済みの周回数を返します。
+  def self.cleared_loop_counts(event_info_list, level)
+    # 指定されたレベルの情報のみ取り出し
+    list = event_info_list.select{|info| info.level == level }
+
+    # その周回をクリア済みかどうか
+    cleared = (list.size == list.select{|i| i.area_clear_state == 'CLEAR' }.size)
+
+    # 現在の周回数
+    loop_count = EventInfo.current_loop_counts(event_info_list, level)
+
+    cleared ? loop_count : loop_count - 1
+  end
+
+  # 海域撃破ボーナス
+  class EventInfoReward
+    # 初回攻略時か2回目以降かを表すフラグ
+    # "FIRST": 初回
+    # "SECOND": 2回目以降
+    # 未公開状態の場合は、項目なし
+    attr_accessor :reward_type
+
+    # 表示順（0 〜）
+    attr_accessor :data_id
+
+    # ボーナスの種類
+    # "NONE": 未公開状態
+    # "RESULT_POINT": 戦果
+    # "STRATEGY_POINT": 戦略ポイント
+    # "ROOM_ITEM_ICON": 家具コイン
+    # "ROOM_ITEM_MEISTER": 特注家具職人
+    # "EQUIP": 装備
+    attr_accessor :kind
+
+    # 数値（戦果の場合はポイント数、家具コインの場合はコイン枚数）
+    attr_accessor :value
+  end
+end

data/lib/admiral_stats_parser/parser/character_list_info_parser.rb

@@ -3,7 +3,7 @@ require 'admiral_stats_parser/model/character_list_info'
 
 class CharacterListInfoParser
   MANDATORY_KEYS = {
-      2 => {
+      1 => {
           :book_no => Integer,
           :lv => Integer,
           :ship_type => String,
@@ -12,7 +12,7 @@ class CharacterListInfoParser
           :ship_name => String,
           :status_img => String,
       },
-      3 => {
+      2 => {
           :book_no => Integer,
           :lv => Integer,
           :ship_type => String,

data/lib/admiral_stats_parser/parser/event_info_parser.rb

@@ -0,0 +1,123 @@
+require 'json'
+require 'admiral_stats_parser/model/event_info'
+
+class EventInfoParser
+  MANDATORY_KEYS = {
+      1 => {
+          :area_id => Integer,
+          :area_sub_id => Integer,
+          :level => String,
+          :area_kind => String,
+          :limit_sec => Integer,
+          :require_gp => Integer,
+          :sortie_limit => :boolean,
+          :stage_image_name => String,
+          :stage_mission_name => String,
+          :stage_mission_info => String,
+          :reward_list => :reward_list,
+          :stage_drop_item_info => Array,
+          :area_clear_state => String,
+          :military_gauge_status => String,
+          :ene_military_gauge_val => Integer,
+          :military_gauge_left => Integer,
+          :boss_status => String,
+          :loop_count => Integer,
+      }
+  }
+
+  REWARD_LIST_MANDATORY_KEYS = {
+      :data_id => Integer,
+      :kind => String,
+      :value => Integer,
+  }
+
+  REWARD_LIST_OPTIONAL_KEYS = {
+      :reward_type => String,
+  }
+
+  def self.parse(json, api_version)
+    items_array = JSON.parse(json)
+
+    unless items_array.is_a?(Array)
+      raise 'json is not an Array'
+    end
+
+    results = []
+    items_array.each do |items|
+      result = EventInfo.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 == :reward_list
+          result.instance_variable_set(
+              "@#{key.to_s}", EventInfoParser.parse_reward_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
+
+      results << result
+    end
+
+    results
+  end
+
+  def self.parse_reward_list(rewards)
+    results = []
+
+    rewards.each do |reward|
+      result = EventInfo::EventInfoReward.new
+
+      REWARD_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 reward.include?(camel_case_key)
+          raise "Mandatory key #{key} does not exist"
+        end
+
+        # 結果のクラスが合わなければエラー
+        unless reward[camel_case_key].is_a?(key_class)
+          raise "Mandatory key #{key} is not class #{key_class}"
+        end
+
+        result.instance_variable_set("@#{key.to_s}", reward[camel_case_key])
+      end
+
+      REWARD_LIST_OPTIONAL_KEYS.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 reward.include?(camel_case_key)
+
+        # 結果のクラスが合わなければエラー
+        unless reward[camel_case_key].is_a?(key_class)
+          raise "Optional key #{key} is not class #{key_class}"
+        end
+
+        result.instance_variable_set("@#{key.to_s}", reward[camel_case_key])
+      end
+
+      results << result
+    end
+
+    results
+  end
+end

data/lib/admiral_stats_parser/version.rb

@@ -1,3 +1,3 @@
 module AdmiralStatsParser
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: admiral_stats_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Masahiro Yoshizawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Parser for admiral stats JSON data exported from kancolle-arcade.net
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -75,12 +75,14 @@ files:
 - lib/admiral_stats_parser/model/character_list_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
 - lib/admiral_stats_parser/model/personal_basic_info.rb
 - lib/admiral_stats_parser/model/tc_book_info.rb
 - lib/admiral_stats_parser/parser/area_capture_info_parser.rb
 - lib/admiral_stats_parser/parser/character_list_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
 - lib/admiral_stats_parser/parser/personal_basic_info_parser.rb
 - lib/admiral_stats_parser/parser/tc_book_info_parser.rb
 - lib/admiral_stats_parser/version.rb
@@ -94,17 +96,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JSON data parser for kancolle-arcade.net