chgk_rating 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f40e4500f25b4c4fa174235cdfb13a5d5262800d7128ab412f50e85efcb2e3
-  data.tar.gz: 65054a1c6ec251becfbc8a5fb73a221aa36ff2841c097d921464eeebc942b11b
+  metadata.gz: e4f4ca06ab6d5493cf307d4d0c69a9286d6306e821ee186a1efa5f59ee90e6ac
+  data.tar.gz: fe44eff613828362a3bd6e1347d1bffcb3eddaf9ec6b2ab74974271526e3c29e
 SHA512:
-  metadata.gz: f045d2354e6f6f35cf1486611bbe3954bf5e400914c71fa7c1a47154542aa197cf9b61a0dba0334840f318b1d02a890dc426f7a09bd444ab1715ab2e9c2f61c8
-  data.tar.gz: c93f31ee95abe8900dce72730fda98a18f09737fa4b29026df0d6d077d8e1692b60c3302109c06c6d35a33db1c1e17380cc9746a0cf5fa31cafce419b040c888
+  metadata.gz: bf3d999776bcf5f32a2f2f763c7d04b47a4ee32738b526da7de9b54c0d8a79ddddc7d499dc0d251c3d7d02be9ce2e87b08afcef61c9e94788f25ac3d498d7012
+  data.tar.gz: fef80b06f8457b2ce82a58a5fb8b183d5bab8c88c53e0c6de80462bba6822157ec53b19283f27c8d67f2e2fbabec8f6fcb47567c9e59e375861cdefccdaadaca

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## v2.0.0 (2021-12-28)
+
+Breaking changes:
+
+* `client.rating` is now `client.team_rating`
+* `client.ratings` is now `client.team_ratings`
+* `tournament.team` is now `tournament.team_by`
+
+New features:
+
+* Faraday now follows redirects (thanks, @L-Eugene)
+* Added ability to fetch ratings for players using `#player_rating` and `#player_ratings`
+* `Player` now also responds to `#rating`, `#ratings`, `#tournaments` methods
+*  Added ability to fetch tournaments for a player. `#tournaments` now also accepts `player_or_id`.
+
+Testing:   
+
+* Tested against more recent Ruby versions
+
 ## v1.0.0 (2018-02-23)
 
 * First stable version at last

data/README.md

@@ -3,30 +3,18 @@
 [![Gem Version](https://badge.fury.io/rb/chgk_rating.svg)](https://badge.fury.io/rb/chgk_rating)
 [![Build Status](https://travis-ci.org/bodrovis/ChgkRating.svg?branch=master)](https://travis-ci.org/bodrovis/ChgkRating)
 [![Code Climate](https://codeclimate.com/github/bodrovis/ChgkRating/badges/gpa.svg)](https://codeclimate.com/github/bodrovis/ChgkRating)
-[![Test Coverage](https://codeclimate.com/github/bodrovis/ChgkRating/badges/coverage.svg)](https://codeclimate.com/github/bodrovis/ChgkRating/coverage)
-[![Dependency Status](https://gemnasium.com/bodrovis/ChgkRating.svg)](https://gemnasium.com/bodrovis/ChgkRating)
+
+**This gem is in passive maintenance mode. I won't release any new features or introduce any complex enhancements as ChgkRating v1 is deprecated.**
 
 Ruby interface for the [rating.chgk.info](http://rating.chgk.info/index.php/api) WebAPI. This is not just a wrapper, but rather a quite complex opinionated client that allows to easily work with various API resources.
 
 [Competitive CHGK (aka "What? Where? When?")](https://en.wikipedia.org/wiki/What%3F_Where%3F_When%3F#Competitive_game) is a popular intellectual game where teams of up to six people are trying to find an answers to various questions.
 
-## Contents
+The main documentation can be found at the [official website](http://chgk-rating.bodrovis.tech/).
+
+Документация на русском языке также доступна на [официальном сайте](http://chgk-rating.bodrovis.tech/index_ru).
 
-* [Installation and Requirements](#installation-and-requirements)
-* [Usage](#usage)
-  + [A Very Quick Example](#a-very-quick-example)
-  + [Before You Start](#before-you-start)
-  + [Initializing the Client](#initializing-the-client)
-  + [Players](#players)
-  + [Teams](#teams)
-  + [Recap (Team's Roster)](#recap-teams-roster)
-  + [Team Ratings](#team-ratings)
-  + [Tournaments](#tournaments)
-  + [Teams at Tournament](#teams-at-tournament)
-  + [Team Results at Tournament](#team-results-at-tournament)
-  + [Team Players at Tournament](#team-players-at-tournament)
-* [Testing](#testing)
-* [License](#license)
+Documentation can also be found on [RubyDoc](http://www.rubydoc.info/github/bodrovis/ChgkRating/master).
 
 ## Installation and Requirements
 
@@ -36,11 +24,7 @@ Install it by running:
 
     $ gem install chgk_rating
     
-## Usage
-
-Remember that ChgkRating API is **read-only**.
-
-### A Very Quick Example
+## A Very Quick Example
 
 ```ruby
 # Instantiate the client:
@@ -69,481 +53,6 @@ team.at_tournament(tournament).results
 client.team_results_at_tournament tournament, team
 ```
 
-### Before You Start
-
-As long as this gem is not just a wrapper, there are a bunch of things that you might want to know before starting to use it. This information, however, is optional and if you just want to quickly fetch some info about a specific resource, ignore it.
-
-* [Types of resources](https://github.com/bodrovis/ChgkRating/wiki/Types-of-resources) - explains what are models and collections are in terms of this gem and how to convert resources back to their raw form
-* [Pagination](https://github.com/bodrovis/ChgkRating/wiki/Pagination) 
-* [Lazy and eager loading](https://github.com/bodrovis/ChgkRating/wiki/Lazy-and-eager-loading) - explains why you might not see full information about some resource and how to forcibly load it
-
-### Initializing the Client
-
-Initialize the client with the following shortcut:
-
-```ruby
-client = ChgkRating.client
-```
-
-This method does not accept any arguments because the client requires no configuration. You don't need any API keys, access tokens and that stuff - just go ahead and send any queries you like. Seems like the API has no quota limitation as well but of course it does not mean you should abuse it.
-
-Now you may utilize the `client` local variable to perform various requests described below.
-
-### Players
-
-#### Players - Collection
-
-Returns an array-like `Players` object containing list of `Player` models sorted by their IDs:
-
-```ruby
-client.players params={} # Input:
-                         # (optional) params - Hash
-                         ## Supported params:
-                         ## :page - Integer or String. The requested page. Default is 1, and there are 1000 results per page.
-                         ## :lazy - Boolean. Should the Player models be marked as lazily loaded? Note that the models will still contain all the information returned by the API.
-                         ## :collection - Enumerable. An array or collection of Players that will be used to build a new collection. If this option is provided, API request will not be sent. This param is mostly used for internal purposes, but you may take advantage of it as well.
-```
-
-Note that the information returned for each `Player` is a bit limited: specifically, `db_chgk_info_tag` and `comment` attributes are `nil` (actually, most players have no value for these attributes anyways). However, you are free to forcibly eager load one or more players:
-
-```ruby
-players = client.players.take(3)
-players.map! {|p| p.eager_load! true}
-```
-
-#### Player - Model
-
-Returns information about a single `Player`:
-
-```ruby
-client.player id, lazy=false # Input:
-                             # id - Integer or String, player's id
-                             # (optional) lazy - Boolean   
-```
-
-Getter methods:
-
-```ruby
-id               # String
-name             # String
-surname          # String
-patronymic       # String
-comment          # String
-db_chgk_info_tag # String
-```
-
-Special notes:
-
-* Can be lazily-loaded and eager-loaded.
-
-#### Players - Search
-
-Search for players by a given criteria:
-
-```ruby
-client.search_players params   # Input:
-                               # params - Hash
-                               ## Supported search params:
-                               ## :name - String
-                               ## :surname - String
-                               ## :patronymic  - String
-                               ## :page - String or Integer. Default is 1, and there are 1000 results per page.
-```
-
-Returns an array-like `Players::Search` collection consisting of `Player` models. 
-
-### Teams
-
-#### Teams - Collection
-
-Get a list of all teams sorted by their IDs:
-
-```ruby
-client.teams params={}   # Input:
-                         # (optional) params - Hash
-                         ## Supported params:
-                         ## :page - Integer or String. The requested page. Default is 1, and there are 1000 results per page.
-                         ## :lazy - Boolean. Should the Team models be marked as lazily loaded? Note that the models will still contain all the information returned by the API.
-                         ## :collection - Enumerable. An array or collection of Teams that will be used to build a new collection. If this option is provided, API request will not be sent. This param is mostly used for internal purposes, but you may take advantage of it as well.
-```
-
-Returns an array-like `Teams` object. A bit limited set of information is returned for each `Team` model: specifically, a `comment` attribute is set to `nil`.
-
-#### Team - Model
-
-Get full information about a single `Team`:
-
-```ruby
-client.team id, lazy=false # Input:
-                           # id - Integer or String. Team's id
-                           # (optional) lazy - Boolean    
-```
-
-Getter methods:
-
-```ruby
-id       # String
-name     # String
-town     # String
-comment  # String
-```
-
-Special notes:
-
-* Can be lazily-loaded and eager-loaded. 
-
-##### Interface Methods
-
-`Team` model respond to the following convenience methods:
-
-```ruby
-team.recap(season_id)                        # Returns a single Recap for the current Team at a given season. Input:
-                                             # season_id - Integer or String
-
-team.at_tournament(tournament_or_id)         # Returns TournamentTeam model that contains information about the
-                                             # team's results at the given tournament. Input:
-                                             # tournament_or_id - String, Integer or Tournament
-
-team.rating(release_id)                      # Returns Rating for the current Team in a given release. Input:
-                                             # release_id - String or Integer
-
-team.ratings                                 # Returns an array-like Ratings collection for the current team.
-
-team.recaps                                  # Returns an hash-like Recaps collection for the current team, grouped by seasons. Seasons act
-                                             # as keys, whereas Recap models - as values.
-
-team.tournaments(season_id: nil, params: {}) # Returns a collection of Tournaments that the current team participated at
-                                             # based on the given criteria. Input:
-                                             # (optional) season_id - Integer or String
-                                             # (optional) params - Hash
-                                             ## Supported params:
-                                             ## :page - String or Integer. Default is 1
-```
-
-#### Teams - Search
-
-Search for teams by a given criteria:
-
-```ruby
-client.search_teams params   # Input:
-                             # params - Hash
-                             ## Supported search params:
-                             ## :name - String
-                             ## :town - String
-                             ## :page - String or Integer. Default is 1, and there are 1000 results per page.
-```
-
-Returns `Teams::Search` collection consisting of `Team` models. 
-
-### Recap (Team's Roster)
-
-The term "recap" is used by the ChgkRating API but I do not think it is suitable. Basically, it means "team's roster", "team list", or "team's lineup".
-
-#### Recaps - Collection
-
-Get recaps grouped by seasons for a single team:
-
-```ruby
-client.recaps team_or_id # Input:
-                         # team_or_id - String, Integer or Team. Team to load recaps for.
-```
-
-Returns a hash-like `Recaps` object with the season numbers as the keys and the `Recap` model as values.
-If the team has not participated in a season, it is **not** included in the response.
-
-The `Recaps` collection responds to the following methods:
-
-```ruby
-team # Team - lazily-loaded Team model
-```
-
-#### Recap - Model
-
-Get information about a team's recap in a given season:
-
-```ruby
-client.recap team_id, season_id # Input:
-                                # team_or_id - String, Integer or Team
-                                # season_id - Integer or String
-```
-
-Returns a `Recap` model that has the following getters:
-
-```ruby
-team        # Team - lazily-loaded model
-season_id   # String
-players     # Players collection consisting of lazily-loaded Player models
-captain     # Player model, lazily-loaded
-```
-
-### Team Ratings
-
-#### Team Ratings - Collection
-
-Get all ratings for a single team:
-
-```ruby
-client.ratings team_or_id # Input:
-                          # team_or_id - String, Integer or Team. Team to load ratings for.
-```
-
-Returns an array-like `Ratings` collection containing `Rating` models.
-
-Collection responds to the following methods:
-
-```ruby
-team # Team - lazily-loaded model
-```
-
-#### Team Rating - Model
-
-Get `Rating` for a team in a given release:
-
-```ruby
-client.rating team_or_id, release_id  # Input:
-                                      # team_or_id - String, Integer or Team
-                                      # release_id - String or Integer  
-```
-
-Getters:
-
-```ruby
-team            # Team - lazily-loaded model
-release_id      # String
-rating          # Integer
-rating_position # Integer
-date            # Date
-formula         # Symbol - :a or :b
-```
-
-### Tournaments
-
-#### Tournaments - Collection
-
-```ruby
-client.tournaments team_or_id: nil, season_id: nil, params: {} # Input (arguments are passed in a hash-like format):
-                                                               # (optional) team_or_id - String, Integer or Team
-                                                               # (optional) season_id - String or Integer
-                                                               # (optional) params - Hash
-                                                               ## Supported params:
-                                                               ## :page - String or Integer. Default is 1
-```
-
-**When both `team_or_id` and `season_id` are not set**, returns an array-like `Tournaments` collection with all the tournaments. In this case `Tournament` models have only the following attributes set:
-
-```ruby
-id          # String
-name        # String
-date_start  # Date
-date_end    # Date
-type_name   # String
-```
-
-**When only `team_or_id` is set**, returns a hash-like `Tournaments` collection. This collection has season numbers as keys and array of `Tournament` models as values. `Tournament` models are lazily-loaded and have only `id` attribute set.
-
-**When both `team` and `season_id` are set**, returns an array-like `Tournaments` collection with lazily-loaded `Tournament` models that have only `id` attribute set.
-
-The collection responds to the following methods:
-
-```ruby
-team        # Nil or lazily-loaded Team
-season_id   # Nil or String
-```
-
-#### Tournament - Model
-
-Get information about a single tournament:
-
-```ruby
-client.tournament id, lazy=false  # Input:
-                                  # id - Integer or String
-                                  # (optional) lazy - Boolean
-```
-
-`Tournament` has the following getters:
-
-```ruby
-id                        # String
-name                      # String
-date_start                # DateTime
-date_end                  # DateTime
-type_name                 # String
-town                      # String
-long_name                 # String
-tour_count                # Integer
-tour_questions            # Integer
-tour_ques_per_tour        # Integer
-questions_total           # Integer
-type_name                 # String
-main_payment_value        # Float
-discounted_payment_value  # Float
-discounted_payment_reason # String
-date_requests_allowed_to  # DateTime
-comment                   # String
-site_url                  # URI
-```
-
-Special notes:
-
-* Lazy-loading and eager-loading is supported.
-
-##### Interface Methods
-
-`Tournament` model respond to the following convenience methods:
-
-```ruby
-tournament.team_players(team_or_id) # Returns an array-like TournamentPlayers collection containing roster
-                                    # for a team at the current tournament. Input:
-                                    # team_or_id - String, Integer or Team
-
-tournament.team_results(team_or_id) # Returns an array-like TournamentTeamResults collection with results
-                                    # for a given team in the current tournament. Input:
-                                    # team_or_id - String, Integer or Team
-
-tournament.team_list                # Returns an array-like TournamentTeams collection specifying which
-                                    # teams participated in the current tournament
-
-tournament.team(team_or_id)         # Returns information about a single TournamentTeam in the current tournament
-                                    # team_or_id - String, Integer or Team
-```
-
-### Teams at Tournament
-
-#### Teams at Tournament - Collection
-
-Get a list of all teams which participated in a given tournament:
-
-```ruby
-client.teams_at_tournament tournament_or_id  # Input:
-                                             # tournament_id - Integer, String or Tournament
-```
-
-Returns an array-like `TournamentTeams` collection that responds to the following methods:
-
-```ruby
-tournament # Tournament. Lazily-loaded model
-```
-
-#### Team at Tournament - Model
-
-Instantiate a `TournamentTeam` model:
-
-```ruby
-client.team_at_tournament tournament_or_id, team_or_id # Input:
-                                                       # tournament_or_id - Integer, String or Tournament
-                                                       # team_or_id -  Integer, String or Team
-```
-
-Note that this method **always** returns a lazily-loaded model that cannot be eager-loaded later. This is
-because the API does not allow to fetch information for a single tournament team. Therefore only the following
-attributes are set:
-
-```ruby
-id              # String 
-tournament      # Tournament. Lazily-loaded model
-```
-
-This `TournamentTeam` object, however, can be used to perform interface methods listed below. 
-
-`TournamentTeam` models loaded with the `teams_at_tournament` method (see above) have the following attributes:
-
-```ruby
-id                  # String
-current_name        # String
-base_name           # String
-position            # Float
-questions_total     # Integer
-result              # Array - contains Boolean values. Each value corresponds to a single question and
-                    # marks whether the team answered this question or not. The length of the array equals to the
-                    # value returned by the questions_total method 
-bonus_a             # Integer
-bonus_b             # Integer
-tech_rating         # Integer
-predicted_position  # Integer
-real_bonus_b        # Integer
-d_bonus_b           # Integer
-included_in_rating  # Boolean
-```
-
-##### Interface Methods
-
-`TournamentTeam` model respond to the following convenience methods:
-
-```ruby
-tournament_team.players # Returns an array-like TournamentPlayers collection containing roster for the current TournamentTeam
-
-tournament_team.results # Returns an array-like TournamentTeamResults collection containing results for the current TournamentTeam
-```
-
-### Team Results at Tournament
-
-#### Team Results at Tournament - Collection
-
-Get team results at a given tournament:
-
-```ruby
-client.team_results_at_tournament tournament_or_id, team_or_id # Input:
-                                                               # tournament_or_id - Integer, String or Tournament
-                                                               # team_or_id -  Integer, String or Team
-```
-
-Returns an array-like `TournamentTeamResults` collection with `TournamentTeamResult` models. Each model contains results for a single tour. 
-
-The collection responds to the following methods:
-
-```ruby
-team       # Team. Lazily-loaded model
-tournament # Tournament. Lazily-loaded model
-```
-
-#### Team Result at Tournament - Model
-
-API does not allow to load team result for a given tour separately, so use the `team_results_at_tournament` method listed above.
-
-`TournamentTeamResult` model has the following getters:
-
-```ruby
-tour    # Integer
-result  # Array containing Boolean values. Each value corresponds to a single question and
-        # says whether the team answered the question or not
-```
-
-### Team Players at Tournament
-
-#### Team Players at Tournament - Collection
-
-Get information about the team's roster at the given tournament:
-
-```ruby
-client.team_players_at_tournament tournament_or_id, team_or_id  # Input:
-                                                                # tournament_or_id - Integer, String or Tournament
-                                                                # team_or_id -  Integer, String or Team
-```
-
-Returns an array-like `TournamentPlayers` collection containing `TournamentPlayer` models (each model represents one player).
-
-The collection responds to the following getters: 
-
-```ruby
-id              # String
-tournament      # Tournament. Lazily-loaded model
-```
-
-#### Team Players at Tournament - Model
-
-It is not possible to load information about a specific player at the given tournament, so use the `team_players_at_tournament` method listed above.
-
-Note that `TournamentPlayer` **is a different model** which is not equal to the `Player` model. It has, however, the same id, so you may easily find the corresponding `Player` layer.
-
-`TournamentPlayer` has the following getters:
-
-```ruby
-id          # String
-is_captain  # Boolean
-is_base     # Boolean
-is_foreign  # Boolean
-```
-
 ## Testing
 
 Tests run against mock responses so you don't need to perform any special setup. Simply pull the code and run:
@@ -555,4 +64,4 @@ Tests run against mock responses so you don't need to perform any special setup.
 
 This plugin is licensed under the [MIT License](https://github.com/bodrovis/ChgkRating/blob/master/LICENSE).
 
-Copyright (c) 2017 [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) [Ilya Bodrov](http://bodrovis.tech)

data/chgk_rating.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email                 = ['golosizpru@gmail.com']
   spec.summary               = 'Ruby interface to the competitive What? Where? When? rating API'
   spec.description           = 'Opinionated Ruby client for the competitive What? Where? When? rating WebAPI (rating.chgk.info) that allows to work with data as with Ruby objects'
-  spec.homepage              = 'https://github.com/bodrovis/ChgkRating'
+  spec.homepage              = 'http://chgk-rating.bodrovis.tech/'
   spec.license               = 'MIT'
   spec.platform              = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4.0'
@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'faraday',                       '~> 0.13'
-  spec.add_dependency 'multi_json',                    '~> 1.12'
+  spec.add_dependency 'faraday',                       '~> 1.8'
+  spec.add_dependency 'faraday_middleware',            '~> 1.2'
+  spec.add_dependency 'multi_json',                    '~> 1.15'
 
-  spec.add_development_dependency 'rake',                      '~> 12.1'
+  spec.add_development_dependency 'rake',                      '~> 13.0'
   spec.add_development_dependency 'rspec',                     '~> 3.6'
-  spec.add_development_dependency 'vcr',                       '~> 4.0'
+  spec.add_development_dependency 'vcr',                       '~> 6.0'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
-end
+end

data/lib/chgk_rating/attribute_mappings.rb

@@ -4,7 +4,11 @@ module ChgkRating
 
     class << self
       def find(name)
-        const_get name.snakecase_upcase
+        begin
+          const_get name.snakecase_upcase
+        rescue NameError
+          {}
+        end
       end
 
       def generate_mappings_for(data)
@@ -66,11 +70,18 @@ module ChgkRating
                                   :db_chgk_info_tag
                               ],
                               RATING: {
-                                  team: ['idteam', :team_id],
                                   release_id: 'idrelease',
                                   rating: [],
                                   rating_position: [],
-                                  date: ['date', :date],
+                                  date: ['date', :date]
+                              },
+                              PLAYER_RATING: {
+                                  player: ['idplayer', :player_id],
+                                  tournaments_in_year: [],
+                                  tournament_count_total: []
+                              },
+                              TEAM_RATING: {
+                                  team: ['idteam', :team_id],
                                   formula: ['formula', :sym]
                               },
                               RECAP: {
@@ -79,6 +90,11 @@ module ChgkRating
                                   captain: ['captain', :player_id],
                                   players: ['players', :players_ids]
                               },
+                              PLAYER_TOURNAMENT: [
+                                  tournament: ['idtournament', :tournament_id],
+                                  team: ['idteam', :team_id],
+                                  in_base_team: ['in_base_team', :boolean_binboolean]
+                              ],
                               TOURNAMENT: [
                                   {
                                       id: 'idtournament',
@@ -100,7 +116,7 @@ module ChgkRating
                                   :discounted_payment_reason,
                                   :comment
                               ],
-                              TOURNAMENT_PLAYER: {
+                              TOURNAMENT_TEAM_PLAYER: {
                                   id: 'idplayer',
                                   is_captain: ['is_captain', :boolean_binboolean],
                                   is_base: ['is_base', :boolean_binboolean],

data/lib/chgk_rating/chgk_object.rb

@@ -6,6 +6,7 @@ module ChgkRating
     end
 
     def extract_id_from(obj, klass = ChgkRating::Models::Team)
+      return unless obj
       return obj unless obj.is_a? klass
       obj&.id
     end