<commit_before># 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

Add this line to your application's Gemfile:

```ruby
gem 'admiral_stats_parser'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install admiral_stats_parser

## Usage

```
# 基本情報
AdmiralStatsParser.parse_personal_basic_info(json, api_version)

# 海域情報
AdmiralStatsParser.parse_area_capture_info(json, api_version)

# 艦娘図鑑
AdmiralStatsParser.parse_tc_book_info(json, api_version)

# 装備図鑑
AdmiralStatsParser.parse_equip_book_info(json, api_version)

# 艦娘一覧
AdmiralStatsParser.parse_character_list_info(json, api_version)

# 装備一覧
AdmiralStatsParser.parse_equip_list_info(json, api_version)

# イベント海域情報
AdmiralStatsParser.parse_event_info(json, api_version)
```

## Specification

提督情報ページから返される JSON メッセージの形式は、過去に何度か変更されており、今後も変更される可能性があります。このツールでは、kancolle-arcade.net が返す JSON メッセージの形式のことを API version と呼びます。

AdmiralStatsParser は、以下の API version をサポートしています。

| API version | 期間 |
|------------:|:-----|
| 1           | 2016-04-26 〜 2016-06-29 |
| 2           | 2016-06-30（REVISION 2 のリリース日）〜 2016-09-14 |
| 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〜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

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/admiral_stats_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
<commit_msg>リリース手順のメモを追加<commit_after># 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

Add this line to your application's Gemfile:

```ruby
gem 'admiral_stats_parser'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install admiral_stats_parser

## Usage

```
# 基本情報
AdmiralStatsParser.parse_personal_basic_info(json, api_version)

# 海域情報
AdmiralStatsParser.parse_area_capture_info(json, api_version)

# 艦娘図鑑
AdmiralStatsParser.parse_tc_book_info(json, api_version)

# 装備図鑑
AdmiralStatsParser.parse_equip_book_info(json, api_version)

# 艦娘一覧
AdmiralStatsParser.parse_character_list_info(json, api_version)

# 装備一覧
AdmiralStatsParser.parse_equip_list_info(json, api_version)

# イベント海域情報
AdmiralStatsParser.parse_event_info(json, api_version)
```

## Specification

提督情報ページから返される JSON メッセージの形式は、過去に何度か変更されており、今後も変更される可能性があります。このツールでは、kancolle-arcade.net が返す JSON メッセージの形式のことを API version と呼びます。

AdmiralStatsParser は、以下の API version をサポートしています。

| API version | 期間 |
|------------:|:-----|
| 1           | 2016-04-26 〜 2016-06-29 |
| 2           | 2016-06-30（REVISION 2 のリリース日）〜 2016-09-14 |
| 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〜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

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Test

```
$ bundle exec rake spec
```

## Release

```
$ vi lib/admiral_stats_parser/version.rb
$ bundle exec rake build
$ bundle exec rake release
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/admiral_stats_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

{'fraction_non_alphanumeric': 0.14632384804275603, 'fraction_numerical': 0.022822475805286725, 'mean_word_length': 3.513689700130378, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '432279', 'n_tokens_mistral': 2871, 'n_tokens_neox': 2709, 'n_words': 630}