chgk_rating 1.0.0.rc1

data/spec/lib/chgk_rating/models/tournament_player_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe ChgkRating::Models::TournamentPlayer do
+  subject do
+    VCR.use_cassette 'team_players_at_tournament' do
+      test_client.team_players_at_tournament(3506, 52853)[0]
+    end
+  end
+  let(:tournament_player_h) { subject.to_h }
+
+  it_behaves_like 'model without eager loading'
+  it_behaves_like 'model without lazy support'
+  it_behaves_like 'tournament team player' do
+    let(:player) { subject }
+  end
+
+  specify '#to_h' do
+    expect(tournament_player_h['idplayer']).to eq '51249'
+    expect(tournament_player_h['is_captain']).to eq '1'
+    expect(tournament_player_h['is_base']).to eq '1'
+    expect(tournament_player_h['is_foreign']).to eq '0'
+  end
+end

data/spec/lib/chgk_rating/models/tournament_spec.rb

@@ -0,0 +1,92 @@
+RSpec.describe ChgkRating::Models::Tournament do
+  subject do
+    VCR.use_cassette 'tournament' do
+      described_class.new 3506
+    end
+  end
+  let(:lazy_tournament) { described_class.new 3506, lazy: true }
+  let(:tournament_h) { subject.to_h }
+
+  it_behaves_like 'model with eager loading'
+  it_behaves_like 'model with lazy support'
+
+  specify('#id') { expect(subject.id).to eq '3506' }
+  specify('#name') { expect(subject.name).to eq 'Чемпионат Перми и Пермского края' }
+  specify('#long_name') { expect(subject.long_name).to eq 'XV Чемпионат Перми и Пермского края по игре "Что? Где? Когда?"' }
+  specify('#date_start') { expect(subject.date_start).to eq DateTime.parse('2015-11-08 14:00:00') }
+  specify('#date_end') { expect(subject.date_end).to eq DateTime.parse('2015-11-08 18:00:00') }
+  specify('#tour_count') { expect(subject.tour_count).to eq 4 }
+  specify('#tour_questions') { expect(subject.tour_questions).to eq 12 }
+  specify('#tour_ques_per_tour') { expect(subject.tour_ques_per_tour).to eq 0 }
+  specify('#questions_total') { expect(subject.questions_total).to eq 48 }
+  specify('#type_name') { expect(subject.type_name).to eq 'Обычный' }
+  specify('#main_payment_value') { expect(subject.main_payment_value).to eq 660 }
+  specify('#discounted_payment_value') { expect(subject.discounted_payment_value).to eq 360 }
+  specify('#discounted_payment_reason') { expect(subject.discounted_payment_reason).to eq 'для детских команд; 480 - для студенческих' }
+  specify('#date_requests_allowed_to') { expect(subject.date_requests_allowed_to).to be_nil }
+  specify('#comment') { expect(subject.comment).to eq '' }
+  specify('#town') { expect(subject.town).to eq 'Пермь' }
+  specify('#site_url') { expect(subject.site_url).to eq URI.parse('https://vk.com/chgk.perm.championship') }
+  specify '#to_h' do
+    expect(tournament_h['idtournament']).to eq '3506'
+    expect(tournament_h['date_start']).to eq '2015-11-08T14:00:00+00:00'
+    expect(tournament_h['date_end']).to eq '2015-11-08T18:00:00+00:00'
+    expect(tournament_h['tour_count']).to eq '4'
+    expect(tournament_h['tour_questions']).to eq '12'
+    expect(tournament_h['tour_ques_per_tour']).to eq '0'
+    expect(tournament_h['questions_total']).to eq '48'
+    expect(tournament_h['main_payment_value']).to eq '660.0'
+    expect(tournament_h['discounted_payment_value']).to eq '360.0'
+    expect(tournament_h['date_requests_allowed_to']).to eq ''
+    expect(tournament_h['site_url']).to eq 'https://vk.com/chgk.perm.championship'
+    expect(tournament_h['name']).to eq 'Чемпионат Перми и Пермского края'
+    expect(tournament_h['town']).to eq 'Пермь'
+    expect(tournament_h['long_name']).to eq 'XV Чемпионат Перми и Пермского края по игре "Что? Где? Когда?"'
+    expect(tournament_h['type_name']).to eq 'Обычный'
+    expect(tournament_h['discounted_payment_reason']).to eq 'для детских команд; 480 - для студенческих'
+    expect(tournament_h['comment']).to eq ''
+  end
+
+  specify '#eager_load!' do
+    VCR.use_cassette 'tournament' do
+      lazy_tournament.eager_load!
+    end
+    expect(lazy_tournament.name).to eq 'Чемпионат Перми и Пермского края'
+  end
+
+  describe '#team_results' do
+    let(:team_results) do
+      VCR.use_cassette 'team_results_at_tournament' do
+        subject.team_results(52853)
+      end
+    end
+
+    it { expect(team_results).to be_an_instance_of ChgkRating::Collections::TournamentTeamResults }
+  end
+
+  describe '#team_players' do
+    let(:players) do
+      VCR.use_cassette 'team_players_at_tournament' do
+        subject.team_players(52853)
+      end
+    end
+
+    it { expect(players).to be_an_instance_of ChgkRating::Collections::TournamentPlayers }
+  end
+
+  describe '#team' do
+    let(:team) { subject.team 52853 }
+
+    it { expect(team).to be_an_instance_of ChgkRating::Models::TournamentTeam }
+  end
+
+  describe '#team_list' do
+    let(:team_list) do
+      VCR.use_cassette 'teams_at_tournament' do
+        subject.team_list
+      end
+    end
+
+    it { expect(team_list).to be_an_instance_of ChgkRating::Collections::TournamentTeams }
+  end
+end

data/spec/lib/chgk_rating/models/tournament_team_result_spec.rb

@@ -0,0 +1,19 @@
+RSpec.describe ChgkRating::Models::TournamentTeamResult do
+  subject do
+    VCR.use_cassette 'team_results_at_tournament' do
+      test_client.team_results_at_tournament(3506, 52853)[0]
+    end
+  end
+  let(:tournament_team_result_h) { subject.to_h }
+
+  it_behaves_like 'model without eager loading'
+  it_behaves_like 'model without lazy support'
+  it_behaves_like 'tournament team result' do
+    let(:team_result) { subject }
+  end
+
+  specify '#to_h' do
+    expect(tournament_team_result_h['tour']).to eq '1'
+    expect(tournament_team_result_h['mask']).to eq %w(0 0 0 0 1 1 1 0 0 1 0 0)
+  end
+end

data/spec/lib/chgk_rating/models/tournament_team_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe ChgkRating::Models::TournamentTeam do
+  # this is always a lazily-loaded object as
+  # we cannot get info about a specific team participating in a tournament!
+  subject { described_class.new '52853', tournament: '3506', lazy: true }
+  let(:tournament_team_h) { subject.to_h }
+
+  it_behaves_like 'model without eager loading'
+  it_behaves_like 'model with lazy support'
+
+  specify('#tournament') { expect(subject.tournament.id).to eq '3506' }
+  specify('#team') { expect(subject.team.id).to eq '52853' }
+  specify('#id') { expect(subject.id).to eq '52853' }
+  specify '#to_h' do
+    expect(tournament_team_h['idteam']).to eq '52853'
+  end
+
+  describe '#players' do
+    let(:players) do
+      VCR.use_cassette 'team_players_at_tournament' do
+        subject.players
+      end
+    end
+
+    it { expect(players).to be_an_instance_of ChgkRating::Collections::TournamentPlayers }
+  end
+
+  describe '#results' do
+    let(:results) do
+      VCR.use_cassette 'team_results_at_tournament' do
+        subject.results
+      end
+    end
+
+    it { expect(results).to be_an_instance_of ChgkRating::Collections::TournamentTeamResults }
+  end
+end

data/spec/lib/chgk_rating/utils/snakecase_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe String do
+  describe '#snakecase_upcase' do
+    let(:result) { 'SNAKE_CASE' }
+
+    it 'should convert the string properly' do
+      expect('SnakeCase'.snakecase_upcase).to eq result
+      expect('Snake-Case'.snakecase_upcase).to eq result
+      expect('Snake Case'.snakecase_upcase).to eq result
+      expect('Snake  -  Case'.snakecase_upcase).to eq result
+    end
+  end
+end

data/spec/lib/chgk_rating/utils/transformations_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe ChgkRating::Utils::Transformations do
+  specify '.to_boolean' do
+    expect(described_class.send(:to_boolean).call('1')).to eq(true)
+    expect(described_class.send(:to_boolean).call('0')).to eq(false)
+  end
+
+  specify '.to_binary_boolean' do
+    expect(described_class.send(:to_binary_boolean).call(true)).to eq('1')
+    expect(described_class.send(:to_binary_boolean).call(false)).to eq('0')
+  end
+
+  specify '.to_star' do
+    expect(described_class.send(:to_star, :to_i).call('1')).to eq(1)
+    expect(described_class.send(:to_star, :to_sym, true).call(%w(one two apple))).to eq(%i(one two apple))
+  end
+end

data/spec/lib/chgk_rating_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe ChgkRating do
+  specify '.client' do
+    expect(ChgkRating.client).to be_an_instance_of(ChgkRating::Client)
+  end
+end

data/spec/lib/ext/date_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe Date do
+  specify '.parse_safely' do
+    expect(described_class.parse_safely('2017-09-28 12:00:33').to_s).to eq('2017-09-28')
+    expect(described_class.parse_safely('gibberish')).to be_nil
+    expect(described_class.parse_safely(nil)).to be_nil
+  end
+end

data/spec/lib/ext/date_time_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe DateTime do
+  subject { DateTime.new(2018,01,24,16,58,34) }
+
+  specify '#to_s_chgk' do
+    expect(subject.to_s_chgk).to eq '2018-01-24 16:58:34'
+  end
+
+  specify '.parse_safely' do
+    expect(described_class.parse_safely('2017-09-28 12:00:33').to_s).to eq('2017-09-28T12:00:33+00:00')
+  end
+end

data/spec/lib/ext/uri_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe URI do
+  specify '.parse_safely' do
+    expect(described_class.parse_safely('http://example.com/test').to_s).to eq('http://example.com/test')
+    expect(described_class.parse_safely('gibberish').to_s).to eq 'gibberish'
+    expect(described_class.parse_safely(nil)).to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "spec/"
+end
+
+require 'chgk_rating'
+
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include TestClient
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,63 @@
+RSpec.shared_examples_for 'an array' do
+  it { is_expected.to respond_to :to_a }
+end
+
+RSpec.shared_examples_for 'not a hash' do
+  it { is_expected.not_to respond_to :to_h }
+  it { expect( -> {subject.to_h} ).to raise_error(ChgkRating::Error::NotHashType).
+      with_message('This is not a hash-like collection, so it cannot be converted to an ordinary hash.')}
+end
+
+RSpec.shared_examples_for 'not an array' do
+  it { is_expected.not_to respond_to :to_a }
+  it { expect( -> {subject.to_a} ).to raise_error(ChgkRating::Error::NotArrayType).
+      with_message('This is not an array-like collection, so it cannot be converted to an ordinary array.')}
+end
+
+RSpec.shared_examples_for 'a hash' do
+  it { is_expected.to respond_to :to_h }
+end
+
+RSpec.shared_examples_for 'tournament team player' do
+  specify('#id') { expect(player.id).to eq '51249' }
+  specify('#is_captain') { expect(player.is_captain).to eq true }
+  specify('#is_base') { expect(player.is_base).to eq true }
+  specify('#is_foreign') { expect(player.is_foreign).to eq false }
+end
+
+RSpec.shared_examples_for 'tournament team result' do
+  specify('#result') { expect(team_result.result).to eq [false, false, false, false, true, true,
+                                                     true, false, false, true, false, false] }
+  specify('#tour') { expect(team_result.tour).to eq 1 }
+end
+
+RSpec.shared_examples_for 'model without eager loading' do
+  it 'should raise an EagerLoadingNotSupported error' do
+    expect( -> { subject.eager_load! }).to raise_error(ChgkRating::Error::EagerLoadingNotSupported).
+        with_message 'Eager loading is not supported for this resource.'
+  end
+end
+
+RSpec.shared_examples_for 'model with eager loading' do
+  it 'should not raise an EagerLoadingNotSupported error' do
+    expect( -> { subject.eager_load! }).not_to raise_error
+  end
+end
+
+RSpec.shared_examples_for 'model without lazy support' do
+  it { is_expected.not_to respond_to(:lazy) }
+
+  it 'should define NO_LAZY_SUPPORT constant' do
+    expect(subject.class::NO_LAZY_SUPPORT).to eq true
+  end
+end
+
+RSpec.shared_examples_for 'model with lazy support' do
+  it { is_expected.to respond_to(:lazy) }
+
+  it 'should not define NO_LAZY_SUPPORT constant' do
+    klass = subject.class
+    expect( -> { klass::NO_LAZY_SUPPORT }).to raise_error(NameError).
+        with_message "uninitialized constant #{klass}::NO_LAZY_SUPPORT"
+  end
+end

data/spec/support/test_client.rb

@@ -0,0 +1,6 @@
+module TestClient
+  def test_client
+    return @client if @client
+    @client = ChgkRating.client
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,10 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.ignore_hosts 'codeclimate.com'
+  c.hook_into :faraday
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
+  c.before_record do |i|
+    i.response.body.force_encoding("UTF-8")
+  end
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: chgk_rating
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Ilya Bodrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+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
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chgk_rating.gemspec
+- lib/chgk_rating.rb
+- lib/chgk_rating/attribute_mappings.rb
+- lib/chgk_rating/chgk_object.rb
+- lib/chgk_rating/client.rb
+- lib/chgk_rating/collections/base.rb
+- lib/chgk_rating/collections/players.rb
+- lib/chgk_rating/collections/ratings.rb
+- lib/chgk_rating/collections/recaps.rb
+- lib/chgk_rating/collections/teams.rb
+- lib/chgk_rating/collections/tournament_players.rb
+- lib/chgk_rating/collections/tournament_team_results.rb
+- lib/chgk_rating/collections/tournament_teams.rb
+- lib/chgk_rating/collections/tournaments.rb
+- lib/chgk_rating/concerns/searching.rb
+- lib/chgk_rating/connection.rb
+- lib/chgk_rating/error.rb
+- lib/chgk_rating/models/base.rb
+- lib/chgk_rating/models/player.rb
+- lib/chgk_rating/models/rating.rb
+- lib/chgk_rating/models/recap.rb
+- lib/chgk_rating/models/team.rb
+- lib/chgk_rating/models/tournament.rb
+- lib/chgk_rating/models/tournament_player.rb
+- lib/chgk_rating/models/tournament_team.rb
+- lib/chgk_rating/models/tournament_team_result.rb
+- lib/chgk_rating/request.rb
+- lib/chgk_rating/utils/snakecase.rb
+- lib/chgk_rating/utils/transformations.rb
+- lib/chgk_rating/version.rb
+- lib/ext/date.rb
+- lib/ext/date_time.rb
+- lib/ext/uri.rb
+- spec/lib/chgk_rating/client_spec.rb
+- spec/lib/chgk_rating/collections/players_spec.rb
+- spec/lib/chgk_rating/collections/ratings_spec.rb
+- spec/lib/chgk_rating/collections/recaps_spec.rb
+- spec/lib/chgk_rating/collections/teams_spec.rb
+- spec/lib/chgk_rating/collections/tournament_players_spec.rb
+- spec/lib/chgk_rating/collections/tournament_team_results_spec.rb
+- spec/lib/chgk_rating/collections/tournament_teams_spec.rb
+- spec/lib/chgk_rating/collections/tournaments_spec.rb
+- spec/lib/chgk_rating/models/base_spec.rb
+- spec/lib/chgk_rating/models/player_spec.rb
+- spec/lib/chgk_rating/models/rating_spec.rb
+- spec/lib/chgk_rating/models/recap_spec.rb
+- spec/lib/chgk_rating/models/team_spec.rb
+- spec/lib/chgk_rating/models/tournament_player_spec.rb
+- spec/lib/chgk_rating/models/tournament_spec.rb
+- spec/lib/chgk_rating/models/tournament_team_result_spec.rb
+- spec/lib/chgk_rating/models/tournament_team_spec.rb
+- spec/lib/chgk_rating/utils/snakecase_spec.rb
+- spec/lib/chgk_rating/utils/transformations_spec.rb
+- spec/lib/chgk_rating_spec.rb
+- spec/lib/ext/date_spec.rb
+- spec/lib/ext/date_time_spec.rb
+- spec/lib/ext/uri_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- spec/support/test_client.rb
+- spec/support/vcr.rb
+homepage: https://github.com/bodrovis/chgk_rating
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby interface to the competitive What? Where? When? rating API
+test_files:
+- spec/lib/chgk_rating/client_spec.rb
+- spec/lib/chgk_rating/collections/players_spec.rb
+- spec/lib/chgk_rating/collections/ratings_spec.rb
+- spec/lib/chgk_rating/collections/recaps_spec.rb
+- spec/lib/chgk_rating/collections/teams_spec.rb
+- spec/lib/chgk_rating/collections/tournaments_spec.rb
+- spec/lib/chgk_rating/collections/tournament_players_spec.rb
+- spec/lib/chgk_rating/collections/tournament_teams_spec.rb
+- spec/lib/chgk_rating/collections/tournament_team_results_spec.rb
+- spec/lib/chgk_rating/models/base_spec.rb
+- spec/lib/chgk_rating/models/player_spec.rb
+- spec/lib/chgk_rating/models/rating_spec.rb
+- spec/lib/chgk_rating/models/recap_spec.rb
+- spec/lib/chgk_rating/models/team_spec.rb
+- spec/lib/chgk_rating/models/tournament_player_spec.rb
+- spec/lib/chgk_rating/models/tournament_spec.rb
+- spec/lib/chgk_rating/models/tournament_team_result_spec.rb
+- spec/lib/chgk_rating/models/tournament_team_spec.rb
+- spec/lib/chgk_rating/utils/snakecase_spec.rb
+- spec/lib/chgk_rating/utils/transformations_spec.rb
+- spec/lib/chgk_rating_spec.rb
+- spec/lib/ext/date_spec.rb
+- spec/lib/ext/date_time_spec.rb
+- spec/lib/ext/uri_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- spec/support/test_client.rb
+- spec/support/vcr.rb