rating-chgk-v2 1.0.0.rc1

data/lib/rating_chgk_v2/request.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Request
+    include RatingChgkV2::Connection
+    include RatingChgkV2::JsonHandler
+
+    def get(path, client, params = {})
+      respond_with(
+        connection(client).get(prepare(path), params),
+        client
+      )
+    end
+
+    def post(path, client, params = {})
+      respond_with(
+        connection(client).post(prepare(path), custom_dump(params)),
+        client
+      )
+    end
+
+    def put(path, client, params = {})
+      respond_with(
+        connection(client).put(prepare(path), custom_dump(params)),
+        client
+      )
+    end
+
+    def delete(path, client, _params = {})
+      respond_with(
+        # Rubocop tries to replace `delete` with `gsub` but that's a different method here!
+        connection(client).delete(prepare(path)),
+        client
+      )
+    end
+
+    private
+
+    # Get rid of double slashes in the `path`, leading and trailing slash
+    def prepare(path)
+      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
+    end
+
+    def respond_with(response, _client)
+      body = response.body.empty? ? response.body : custom_load(response.body)
+      status = response.status
+      respond_with_error status, body if status.between?(400, 599)
+
+      body
+    end
+
+    def respond_with_error(code, body)
+      raise(RatingChgkV2::Error, body) unless RatingChgkV2::Error::ERRORS.key? code
+
+      raise RatingChgkV2::Error::ERRORS[code].from_response(body)
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/authentication_token.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module AuthenticationToken
+      def authentication_token(params)
+        model_load name: 'AuthenticationToken', ep_params: [[], params], method: :do_post
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/countries.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Countries
+      def countries(params = {})
+        collection_load name: 'Countries', ep_params: [[], params]
+      end
+
+      def country(id)
+        model_load name: 'Country', ep_name: 'Countries', ep_params: id
+      end
+
+      def create_country(params)
+        model_load name: 'Country', ep_name: 'Countries', ep_params: [[], params], method: :do_post
+      end
+
+      def update_country(id, params)
+        model_load name: 'Country', ep_name: 'Countries', ep_params: [id, params], method: :do_put
+      end
+
+      def delete_country(id)
+        endpoint('Countries', id).do_delete
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/players.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Players
+      def players(params = {})
+        collection_load name: 'Players', ep_params: [[], params]
+      end
+
+      def player(id)
+        model_load name: 'Player', ep_name: 'Players', ep_params: id
+      end
+
+      def player_seasons(id, params = {})
+        collection_load name: 'PlayerSeasons', ep_name: 'Players', ep_params: [[id, :seasons], params]
+      end
+
+      def player_tournaments(id, params = {})
+        collection_load name: 'PlayerTournaments', ep_name: 'Players', ep_params: [[id, :tournaments], params]
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/regions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Regions
+      def regions(params = {})
+        collection_load name: 'Regions', ep_params: [[], params]
+      end
+
+      def region(id)
+        model_load name: 'Region', ep_name: 'Regions', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/releases.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Releases
+      def releases(params = {})
+        collection_load name: 'Releases', ep_params: [[], params]
+      end
+
+      def release(id)
+        model_load name: 'Release', ep_name: 'Releases', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/seasons.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Seasons
+      def seasons
+        collection_load name: 'Seasons', ep_params: [[]]
+      end
+
+      def season(id)
+        model_load name: 'Season', ep_name: 'Seasons', ep_params: id
+      end
+
+      def create_season(params)
+        model_load name: 'Season', ep_name: 'Seasons', ep_params: [[], params], method: :do_post
+      end
+
+      def update_season(id, params)
+        model_load name: 'Season', ep_name: 'Seasons', ep_params: [id, params], method: :do_put
+      end
+
+      def delete_season(id)
+        endpoint('Seasons', id).do_delete
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/teams.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Teams
+      def teams(params = {})
+        collection_load name: 'Teams', ep_params: [[], params]
+      end
+
+      def team(id)
+        model_load name: 'Team', ep_name: 'Teams', ep_params: id
+      end
+
+      def team_seasons(id, params = {})
+        collection_load name: 'PlayerSeasons', ep_name: 'Teams', ep_params: [[id, :seasons], params]
+      end
+
+      def team_tournaments(id, params = {})
+        collection_load name: 'TeamTournaments', ep_name: 'Teams', ep_params: [[id, :tournaments], params]
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournament_flags.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module TournamentFlags
+      def tournament_flags
+        collection_load name: 'TournamentFlags', ep_params: [[]]
+      end
+
+      def tournament_flag(id)
+        model_load name: 'TournamentFlag', ep_name: 'TournamentFlags', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournament_synch_appeals.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module TournamentSynchAppeals
+      def tournament_synch_appeal(id)
+        model_load name: 'TournamentSynchAppeal', ep_name: 'TournamentSynchAppeals', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournament_synch_controversials.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module TournamentSynchControversials
+      def tournament_synch_controversial(id)
+        model_load name: 'TournamentSynchControversial', ep_name: 'TournamentSynchControversials', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournament_synch_requests.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module TournamentSynchRequests
+      def tournament_synch_request(id)
+        model_load name: 'TournamentSynchRequest', ep_name: 'TournamentSynchRequests', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournament_types.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module TournamentTypes
+      def tournament_types
+        collection_load name: 'TournamentTypes', ep_params: [[]]
+      end
+
+      def tournament_type(id)
+        model_load name: 'TournamentType', ep_name: 'TournamentTypes', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/tournaments.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Tournaments
+      def tournaments(params = {})
+        collection_load name: 'Tournaments', ep_params: [[], params]
+      end
+
+      def tournament(id)
+        model_load name: 'Tournament', ep_name: 'Tournaments', ep_params: id
+      end
+
+      def tournament_appeals(id)
+        collection_load name: 'TournamentAppeals', ep_name: 'Tournaments', ep_params: [[id, :appeals]]
+      end
+
+      def tournament_requests(id)
+        collection_load name: 'TournamentRequests', ep_name: 'Tournaments', ep_params: [[id, :requests]]
+      end
+
+      def tournament_results(id, params = {})
+        collection_load name: 'TournamentResults', ep_name: 'Tournaments', ep_params: [[id, :results], params]
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/towns.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Towns
+      def towns(params = {})
+        collection_load name: 'Towns', ep_params: [[], params]
+      end
+
+      def town(id)
+        model_load name: 'Town', ep_name: 'Towns', ep_params: id
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/venue_types.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module VenueTypes
+      def venue_types(params = {})
+        collection_load name: 'VenueTypes', ep_params: [[], params]
+      end
+
+      def venue_type(id)
+        model_load name: 'VenueType', ep_name: 'VenueTypes', ep_params: id
+      end
+
+      def create_venue_type(params)
+        model_load name: 'VenueType', ep_name: 'VenueTypes', ep_params: [[], params], method: :do_post
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest/venues.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    module Venues
+      def venues(params = {})
+        collection_load name: 'Venues', ep_params: [[], params]
+      end
+
+      def venue(id)
+        model_load name: 'Venue', ep_name: 'Venues', ep_params: id
+      end
+
+      def create_venue(params)
+        model_load name: 'Venue', ep_name: 'Venues', ep_params: [[], params], method: :do_post
+      end
+
+      def update_venue(id, params)
+        model_load name: 'Venue', ep_name: 'Venues', ep_params: [id, params], method: :do_put
+      end
+
+      def delete_venue(id)
+        endpoint('Venues', id).do_delete
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/rest.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Rest
+    include RatingChgkV2::Rest::AuthenticationToken
+    include RatingChgkV2::Rest::Countries
+    include RatingChgkV2::Rest::Players
+    include RatingChgkV2::Rest::Regions
+    include RatingChgkV2::Rest::Releases
+    include RatingChgkV2::Rest::Seasons
+    include RatingChgkV2::Rest::Teams
+    include RatingChgkV2::Rest::TournamentFlags
+    include RatingChgkV2::Rest::TournamentSynchAppeals
+    include RatingChgkV2::Rest::TournamentSynchControversials
+    include RatingChgkV2::Rest::TournamentSynchRequests
+    include RatingChgkV2::Rest::TournamentTypes
+    include RatingChgkV2::Rest::Tournaments
+    include RatingChgkV2::Rest::Towns
+    include RatingChgkV2::Rest::VenueTypes
+    include RatingChgkV2::Rest::Venues
+
+    private
+
+    def endpoint(name, query, params = {})
+      klass = RatingChgkV2.const_get "Endpoints::#{name}Endpoint"
+      klass.new self, query, params
+    end
+
+    def collection_load(name:, ep_params:, ep_name: nil, method: :do_get)
+      collection(name).load method, endpoint(ep_name || name, *ep_params)
+    end
+
+    def model_load(name:, ep_params:, ep_name: nil, method: :do_get)
+      model(name).load method, endpoint(ep_name || name, *ep_params)
+    end
+
+    def collection(name)
+      RatingChgkV2.const_get("Collections::#{name}Collection")
+    end
+
+    def model(name)
+      RatingChgkV2.const_get("Models::#{name}Model")
+    end
+  end
+end

data/lib/rating_chgk_v2/utils/string_utils.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  module Utils
+    module StringUtils
+      refine String do
+        # Underscore a string such that camelcase, dashes and spaces are
+        # replaced by underscores.
+        # Initial code taken from Facets gem by Rubyworks
+        # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+        def snakecase
+          base_class_name.
+            gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr('-', '_').
+            gsub(/\s/, '_').
+            gsub(/__+/, '_').
+            downcase
+        end
+
+        # Turn `Module::Nested::ClassName` to just `ClassName`
+        def base_class_name
+          split('::').last
+        end
+      end
+    end
+  end
+end

data/lib/rating_chgk_v2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RatingChgkV2
+  VERSION = '1.0.0.rc1'
+end

data/lib/rating_chgk_v2.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'yaml'
+require 'faraday'
+require 'addressable/template'
+require 'forwardable'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module RatingChgkV2
+  class << self
+    def client(token: '', params: {})
+      @client ||= RatingChgkV2::Client.new token: token, params: params
+    end
+
+    def reset_client!
+      @client = nil
+    end
+  end
+end

data/rating-chgk-v2.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/rating_chgk_v2/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'rating-chgk-v2'
+  spec.version               = RatingChgkV2::VERSION
+  spec.authors               = ['Ilya Bodrov-Krukowski']
+  spec.email                 = ['golosizpru@gmail.com']
+  spec.summary               = 'Ruby interface for the new CHGK rating API'
+  spec.description           = 'Ruby client for the new CHGK rating API (api.rating.chgk.net).'
+  spec.homepage              = 'https://github.com/bodrovis/rating-chgk-v2'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.files = Dir['README.md', 'LICENSE',
+                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/rating_chgk_v2/data/*.yml',
+                   'rating-chgk-v2.gemspec', '.github/*.md',
+                   'Gemfile', 'Rakefile']
+  spec.test_files       = Dir['spec/**/*.rb']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_dependency 'addressable',                     '~> 2.5'
+  spec.add_dependency 'faraday',                         '~> 2'
+  spec.add_dependency 'json',                            '~> 2'
+  spec.add_dependency 'zeitwerk',                        '~> 2.4'
+
+  spec.add_development_dependency 'codecov',             '~> 0.1'
+  spec.add_development_dependency 'dotenv',              '~> 2.5'
+  spec.add_development_dependency 'oj',                  '~> 3.10'
+  spec.add_development_dependency 'rake',                '~> 13.0'
+  spec.add_development_dependency 'rspec',               '~> 3.6'
+  spec.add_development_dependency 'rubocop',             '~> 1.6'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
+  spec.add_development_dependency 'simplecov',           '~> 0.16'
+  spec.add_development_dependency 'vcr',                 '~> 6.0'
+  spec.add_development_dependency 'webmock',             '~> 3.14'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'wiki_uri' => 'https://github.com/bodrovis/rating-chgk-v2/wiki',
+    'changelog_uri' => 'https://github.com/bodrovis/rating-chgk-v2/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/bodrovis/rating-chgk-v2/issues'
+  }
+end

data/spec/lib/rating_chgk_v2/collections/base_collection_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::BaseCollection do
+  let(:players) do
+    described_class.new [{
+      id: 1,
+      name: 'Ivan',
+      surname: 'Petrov'
+    }, {
+      id: 2,
+      name: 'Petr',
+      surname: 'Ivanov'
+    }]
+  end
+
+  specify '#first' do
+    stub_const "#{described_class}::MODEL", 'Player'
+
+    player = players.first
+    expect(player).to be_an_instance_of(RatingChgkV2::Models::PlayerModel)
+    expect(player.id).to eq(1)
+  end
+
+  specify '#last' do
+    stub_const "#{described_class}::MODEL", 'Player'
+
+    player = players.last
+    expect(player).to be_an_instance_of(RatingChgkV2::Models::PlayerModel)
+    expect(player.id).to eq(2)
+  end
+
+  specify '#[]' do
+    stub_const "#{described_class}::MODEL", 'Player'
+
+    player = players[1]
+    expect(player.id).to eq(2)
+  end
+
+  specify '#each' do
+    stub_const "#{described_class}::MODEL", 'Player'
+
+    klass = RatingChgkV2::Models::PlayerModel
+
+    expect { |b| players.each(&b) }.to yield_successive_args(klass, klass)
+  end
+
+  specify '#map' do
+    stub_const "#{described_class}::MODEL", 'Player'
+
+    mapped = players.map(&:id)
+    expect(mapped).to include(1, 2)
+  end
+end

data/spec/lib/rating_chgk_v2/collections/countries_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::CountriesCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/player_seasons_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::PlayerSeasonsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/player_tournaments_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::PlayerTournamentsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/players_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::PlayersCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/regions_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::RegionsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/releases_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::ReleasesCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/seasons_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::SeasonsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/teams_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::TeamsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/tournaments_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::TournamentsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/towns_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::TownsCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/venue_types_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::VenueTypesCollection do
+  it_behaves_like 'paginated'
+end

data/spec/lib/rating_chgk_v2/collections/venues_collection_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe RatingChgkV2::Collections::VenuesCollection do
+  it_behaves_like 'paginated'
+end