rating-chgk-v2 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e53b64ea30c84c114b5b01ceb285985bb4ac2bb319fd5f6e4561fbca0b71bbc
+  data.tar.gz: 2f1dc39b971c9d27fce1ad4b19d8bc537cebc587ed4a16e20d630983bffa0cb5
+SHA512:
+  metadata.gz: d2dd209511a8b1ba0157a14170674d3050db1c957311d50e750c9e07b015457e210142cc107ddfc70a5b17a887803db8ef8ab1d7b72799220d124c4bf5d39a63
+  data.tar.gz: c6a48f19b76ef12a483fcf7e0e3d28b15dc97646400fd1a832d7afe417e9d74f4c30ff822886377ad5fd6d07ada01c6fdb9b79738cc8cc4030e9d5dd56483d93

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at golosizpru@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you. Run `rubocop -A` to make it more aggressive.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0.rc1 (11-Apr-22)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# RatingChgkV2
+
+![CI](https://github.com/bodrovis/rating-chgk-v2/actions/workflows/ci.yml/badge.svg)
+[![Test Coverage](https://codecov.io/gh/bodrovis/rating-chgk-v2/graph/badge.svg)](https://codecov.io/gh/bodrovis/rating-chgk-v2)
+
+Ruby client for [competitive "What? Where? When?" (aka "CHGK") API](http://api.rating.chgk.net/). This gem is a replacement for [ChgkRating](https://github.com/bodrovis/ChgkRating) which worked only with the deprecated API version.
+
+## Installation and requirements
+
+This gem requires Ruby 2.7+. Install it by running:
+
+```
+$ gem install rating-chgk-v2
+```
+
+Include it in your script:
+
+```ruby
+require 'rating_chgk_v2'
+```
+
+## Client initialization
+
+Initialize an API client:
+
+```ruby
+@client = RatingChgkV2.client
+```
+
+Optionally, provide your JWT token and connection options (please note that JWT is not required to access most of the endpoints):
+
+```ruby
+@client = RatingChgkV2.client token: 'MY_JWT', params: {open_timeout: 100, timeout: 500}
+```
+
+Now use client to perform API requests:
+
+```ruby
+teams = @client.teams itemsPerPage: 2, name: 'Н', page: 3
+```
+
+## Usage
+
+**[Please find documentation at our Wiki](https://github.com/bodrovis/rating-chgk-v2/wiki)**.
+
+## Running tests
+
+Tests are written in RSpec (all HTTP requests are stubbed):
+
+```
+rspec .
+```
+
+Observe test results and coverage.
+
+## Copyright and license
+
+Licensed under the [MIT license](./LICENSE.md).
+
+Copyright (c) 2022 [Ilya Bodrov-Krukowski](http://bodrovis.tech)

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/lib/rating_chgk_v2/client.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  class Client
+    include RatingChgkV2::Rest
+
+    attr_reader :token
+    attr_accessor :timeout, :open_timeout
+
+    def initialize(token: '', params: {})
+      @token = token
+      @timeout = params.fetch(:timeout, nil)
+      @open_timeout = params.fetch(:open_timeout, nil)
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/base_collection.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    # Base class for all collections. A collection contains an array of models, for example
+    # a collection of players, tournaments, or regions. Some collections are paginated but not all.
+    class BaseCollection
+      include Enumerable
+      extend Forwardable
+
+      MODEL = ''
+      attr_reader :items, :endpoint
+
+      def_delegators :items, :[], :last, :each
+
+      class << self
+        def load(method, endpoint)
+          new endpoint.send(method), endpoint
+        end
+
+        def paginated
+          include RatingChgkV2::Concerns::Paginated
+        end
+      end
+
+      def initialize(raw_data, endpoint = nil)
+        setup raw_data, endpoint
+      end
+
+      private
+
+      def setup(raw_data, endpoint)
+        @endpoint = endpoint
+        @items = produce_models_from raw_data
+      end
+
+      def produce_models_from(raw_data)
+        return [] if raw_data&.empty?
+
+        model_name = self.class.const_get :MODEL
+        model_klass = RatingChgkV2::Models.const_get "#{model_name}Model"
+        raw_data.map do |item|
+          model_klass.new item
+        end
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/countries_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class CountriesCollection < BaseCollection
+      paginated
+
+      MODEL = 'Country'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/player_seasons_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class PlayerSeasonsCollection < BaseCollection
+      paginated
+
+      MODEL = 'PlayerSeason'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/player_tournaments_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class PlayerTournamentsCollection < BaseCollection
+      paginated
+
+      MODEL = 'PlayerTournament'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/players_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class PlayersCollection < BaseCollection
+      paginated
+
+      MODEL = 'Player'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/regions_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class RegionsCollection < BaseCollection
+      paginated
+
+      MODEL = 'Region'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/releases_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class ReleasesCollection < BaseCollection
+      paginated
+
+      MODEL = 'Release'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/seasons_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class SeasonsCollection < BaseCollection
+      paginated
+
+      MODEL = 'Season'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/team_tournaments_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TeamTournamentsCollection < BaseCollection
+      paginated
+
+      MODEL = 'TeamTournament'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/teams_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TeamsCollection < BaseCollection
+      paginated
+
+      MODEL = 'Team'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournament_appeals_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentAppealsCollection < BaseCollection
+      MODEL = 'TournamentSynchAppeal'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournament_flags_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentFlagsCollection < BaseCollection
+      MODEL = 'TournamentFlag'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournament_requests_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentRequestsCollection < BaseCollection
+      MODEL = 'TournamentSynchRequest'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournament_results_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentResultsCollection < BaseCollection
+      MODEL = 'TournamentResult'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournament_types_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentTypesCollection < BaseCollection
+      MODEL = 'TournamentType'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/tournaments_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TournamentsCollection < BaseCollection
+      paginated
+
+      MODEL = 'Tournament'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/towns_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class TownsCollection < BaseCollection
+      paginated
+
+      MODEL = 'Town'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/venue_types_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class VenueTypesCollection < BaseCollection
+      paginated
+
+      MODEL = 'VenueType'
+    end
+  end
+end

data/lib/rating_chgk_v2/collections/venues_collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Collections
+    class VenuesCollection < BaseCollection
+      paginated
+
+      MODEL = 'Venue'
+    end
+  end
+end

data/lib/rating_chgk_v2/concerns/paginated.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Concerns
+    module Paginated
+      def next_page!
+        page_num = current_page + 1
+        params = endpoint.params.merge({page: page_num})
+        endpoint.reinitialize new_params: params
+        setup endpoint.do_get, endpoint
+        self
+      end
+
+      def prev_page!
+        return if current_page <= 1
+
+        page_num = current_page - 1
+        params = endpoint.params.merge({page: page_num})
+        endpoint.reinitialize new_params: params
+        setup endpoint.do_get, endpoint
+        self
+      end
+
+      private
+
+      def current_page
+        endpoint.params[:page] || 1
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/connection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Connection
+    BASE_URL = 'https://api.rating.chgk.net/'
+
+    def connection(client)
+      Faraday.new(options(client), request_params_for(client)) do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def options(client)
+      headers = {
+        accept: 'application/json',
+        user_agent: "rating-chgk-v2 gem/#{RatingChgkV2::VERSION}",
+        'Content-Type': 'application/json',
+        accept_encoding: 'gzip,deflate,br'
+      }
+
+      headers = headers.merge({Authorization: "Bearer #{client.token}"}) if client.token
+
+      {headers: headers, url: BASE_URL}
+    end
+
+    # Allows to customize request params per-client
+    def request_params_for(client)
+      {request: {timeout: client.timeout, open_timeout: client.open_timeout}}
+    end
+  end
+end

data/lib/rating_chgk_v2/data/authentication_token.yml

@@ -0,0 +1 @@
+- token

data/lib/rating_chgk_v2/data/country.yml

@@ -0,0 +1,2 @@
+- id
+- name

data/lib/rating_chgk_v2/data/player.yml

@@ -0,0 +1,4 @@
+- id
+- name
+- patronymic
+- surname

data/lib/rating_chgk_v2/data/player_season.yml

@@ -0,0 +1,6 @@
+- idplayer
+- idseason
+- idteam
+- dateAdded
+- dateRemoved
+- playerNumber

data/lib/rating_chgk_v2/data/player_tournament.yml

@@ -0,0 +1,3 @@
+- idplayer
+- idteam
+- idtournament

data/lib/rating_chgk_v2/data/region.yml

@@ -0,0 +1,3 @@
+- id
+- name
+- country

data/lib/rating_chgk_v2/data/release.yml

@@ -0,0 +1,4 @@
+- id
+- date
+- realDate
+- lastRunRefresh

data/lib/rating_chgk_v2/data/season.yml

@@ -0,0 +1,3 @@
+- id
+- dateStart
+- dateEnd

data/lib/rating_chgk_v2/data/team.yml

@@ -0,0 +1,3 @@
+- id
+- name
+- town

data/lib/rating_chgk_v2/data/team_tournament.yml

@@ -0,0 +1,2 @@
+- idteam
+- idtournament

data/lib/rating_chgk_v2/data/tournament.yml

@@ -0,0 +1,20 @@
+- id
+- name
+- lastEditDate
+- dateStart
+- dateEnd
+- type
+- orgcommittee
+- synchData
+- mainPayment
+- discountedPayment
+- discountedPaymentReason
+- currency
+- editors
+- tournamentInRatingBalanced
+- difficultyForecast
+- maiiAegis
+- maiiAegisUpdatedAt
+- maiiRating
+- maiiRatingUpdatedAt
+- questionQty

data/lib/rating_chgk_v2/data/tournament_flag.yml

@@ -0,0 +1,3 @@
+- id
+- shortName
+- longName

data/lib/rating_chgk_v2/data/tournament_result.yml

@@ -0,0 +1,10 @@
+- team
+- mask
+- current
+- rating
+- controversials
+- flags
+- teamMembers
+- questionsTotal
+- synchRequest
+- position

data/lib/rating_chgk_v2/data/tournament_synch_appeal.yml

@@ -0,0 +1,10 @@
+- id
+- idtournament
+- type
+- issuedAt
+- status
+- appeal
+- comment
+- overriddenBy
+- questionNumber
+- answer

data/lib/rating_chgk_v2/data/tournament_synch_controversial.yml

@@ -0,0 +1,8 @@
+- id
+- questionNumber
+- answer
+- issuedAt
+- status
+- comment
+- resolvedAt
+- appealJuryComment

data/lib/rating_chgk_v2/data/tournament_synch_request.yml

@@ -0,0 +1,8 @@
+- id
+- status
+- venue
+- representative
+- narrators
+- approximateTeamsCount
+- issuedAt
+- tournamentId

data/lib/rating_chgk_v2/data/tournament_type.yml

@@ -0,0 +1,2 @@
+- id
+- name

data/lib/rating_chgk_v2/data/town.yml

@@ -0,0 +1,4 @@
+- id
+- name
+- region
+- country