bodrovis/ChgkRating

View on GitHub
docs/recap_ru.md

Summary

Maintainability
Test Coverage
# Составы команды

## Коллекция

Возвращает объект `Recaps`, созданный на основе хэша и содержащий в себе составы команды, сгруппированные по сезонам. В качестве ключей выступают номера сезонов, а в качестве значений - модели `Recap`.

```ruby
client.recaps team_or_id # Входные значения:
                         # team_or_id - String, Integer или Team. Команда, для которой требуется загрузить составы.
```

Обратите внимание, что если команда не участвовала в каком-либо сезоне, то он не включается в выдачу.

Коллекция `Recaps` отвечает на следующие методы:

```ruby
team # Team - "лениво" загруженная команда, для которой были получены составы
```

## Модель

Возвращает образец класса `Recap`, содержащий информацию о составе команды в заданном сезоне.

```ruby
client.recap team_id, season_id # Входные значения:
                                # team_or_id - String, Integer или Team
                                # season_id - Integer или String
```

Доступные методы:

```ruby
team        # "Лениво" загруженная модель Team
season_id   # String
players     # Игроки команды. Коллекция Players, содержащая в себе "лениво" загруженные модели Player
captain     # Капитан команды. "Лениво" загруженная модель Player
```